Resources

<= Previous Change | Next Change =>

Diff Summary
Title
Date	2007-10-11 00:24	2007-10-11 00:31
Editor	Andrew Plotkin (zarf)	Andrew Plotkin (zarf)

	2007-10-11 00:24 by Andrew Plotkin			2007-10-11 00:31 by Andrew Plotkin
n	1	Resources are any readable files in a [package]. T	n	1	A Resource is any feature provided by a [package].
	>	ypically, these are sound files, but other resourc		>	Resources currently include sound (sample) files
	>	e types may come along in the future.		>	and Boodler agents. Other resource types may come
				>	along in the future.
	2			2
	3	Resources should be listed in a file called `Resou		3	Resources should be listed in a file called `Resou
	>	rces`, in the package directory. (See [package for		>	rces`, in the package directory. (See [package for
	>	mat].) Resources do not have to be listed, but the		>	mat].) Resources do not have to be listed, but the
	>	`Resources` listing is how package management too		>	`Resources` listing is how package management too
	>	ls know about them.		>	ls know about them.
	4			4
	5	## Resources file format		5	## Resources file format
	6			6
	7	The file is divided into sections, one for each re		7	The file is divided into sections, one for each re
	>	source. A section begins with a line that begins w		>	source. A section begins with a line that begins w
	>	ith a colon:		>	ith a colon:
	8			8
	9	:resourcename		9	:resourcename
	10			10
n	11	A resource name must be a valid Python identifier	n	11	A resource name must be a valid Python identifier
	>	(possibly including dots). For example: `resname`		>	(possibly including dots). For example: `resname`
	>	or `modname.resname`.		>	or `modname.resname`. This identifier is where the
				>	resource can be found in its root module.
	12			12
	13	The resource name is followed by the resource's me		13	The resource name is followed by the resource's me
	>	tadata; zero or more lines defining key-value pair		>	tadata; zero or more lines defining key-value pair
	>	s. These have the same format as in the [Metadata]		>	s. These have the same format as in the [Metadata]
	>	file.		>	file.
	14			14
	15	## Resource metadata		15	## Resource metadata
	16			16
	17	Dublin Core metadata terms may be used to describe		17	Dublin Core metadata terms may be used to describe
	>	the title of a resource, its author, and so on. S		>	the title of a resource, its author, and so on. S
	>	ee the [Metadata] page for details.		>	ee the [Metadata] page for details.
	18			18
	19	Besides those, Boodler pays special attention to t		19	Besides those, Boodler pays special attention to t
	>	he following terms:		>	he following terms:
	20			20
t			t	21	* `boodler.use` : The purpose this resource serves
				>	. The uses currently defined are `sound` and `agen
				>	t`.
	21	* `boodler.filename` : The filename, for a file re		22	* `boodler.filename` : The filename, for a resourc
	>	source. This must be in universal format: relative		>	e stored in a data file. This must be in universal
	>	to the module root, and written with forward slas		>	format: relative to the module root, and written
	>	hes, not backslashes.		>	with forward slashes, not backslashes.