Library.xml: Difference between revisions

From OLPC
Jump to navigation Jump to search
mNo edit summary
(do we want to duplicate library-level metadata?)
 
(3 intermediate revisions by 2 users not shown)
Line 33: Line 33:
</library>
</library>
</pre>
</pre>

==Elements and Attributes==


The <tt>library.xml</tt> file contains the following elements and attributes:
The <tt>library.xml</tt> file contains the following elements and attributes:


; <tt><library name=""></tt> : <tt>library</tt> is the root element that defines the collection. <tt>name</tt> refers to the name of the collection.
; <tt><library name=""></tt> : <tt>library</tt> is the root element that defines the collection.
: The <tt>name</tt> attribute refers to the name of the collection.


; <tt><entry url=""></tt> : The <tt>entry</tt> element contains the metadata for a single item in a collection. <tt>url</tt> refers to the url for that item.
; <tt><entry url=""></tt> : The <tt>entry</tt> element contains the metadata for a single item in a collection.
: The <tt>url</tt> attribute refers to the url for that item.


; <tt><title></tt> ''(optional)'': The <tt>title</tt> element contains the item's title.
; <tt><title></tt> ''(optional)'': The <tt>title</tt> element contains the item's title.


; <tt><author></tt> ''(optional)'': The <tt>author</tt> element contains the item's author.
; <tt><author></tt> ''(optional)'': The <tt>author</tt> element contains the item's author. ''can have multiple entries''


; <tt><language></tt> ''(optional)'': The <tt>language</tt> element contains the item's language.
; <tt><language></tt> ''(optional)'': The <tt>language</tt> element contains the item's language.
''can have multiple entries''


; <tt><date></tt> ''(optional)'': The <tt>date</tt> element contains the item's date of composition/creation or publication/release.
; <tt><date></tt> ''(optional)'': The <tt>date</tt> element contains the item's date of composition/creation or publication/release.


; <tt><publisher></tt> ''(optional)'': The <tt>publisher</tt> element contains the item's publisher.
; <tt><publisher></tt> ''(optional)'': The <tt>publisher</tt> element contains the item's publisher.
''can have multiple entries''


; <tt><icon></tt> ''(optional)'': The <tt>icon</tt> element contains the filename of the thumbnail image that is displayed next to the item's library listing.
; <tt><icon></tt> ''(optional)'': The <tt>icon</tt> element contains the filename (including path) of the thumbnail image that is displayed next to the item's library listing.


; <tt><description></tt> ''(optional)'': The <tt>description</tt> element contains the item's description.
; <tt><description></tt> ''(optional)'': The <tt>description</tt> element contains the item's description.

Latest revision as of 23:28, 10 August 2007

Here is a generic library.xml file:

<?xml version="1.0" encoding="ISO-8859-1"?>
<library name="">
	<entry url="">
		<title></title>
		<author></author>
		<language></language>
		<date></date>
		<publisher></publisher>
		<icon></icon>
		<description></description>
	</entry>
	<entry url="">
		<title></title>
		<author></author>
		<language></language>
		<date></date>
		<publisher></publisher>
		<icon></icon>
		<description></description>
	</entry>
	<entry url="">
		<title></title>
		<author></author>
		<language></language>
		<date></date>
		<publisher></publisher>
		<icon></icon>
		<description></description>
	</entry>
</library>

Elements and Attributes

The library.xml file contains the following elements and attributes:

<library name="">
library is the root element that defines the collection.
The name attribute refers to the name of the collection.
<entry url="">
The entry element contains the metadata for a single item in a collection.
The url attribute refers to the url for that item.
<title> (optional)
The title element contains the item's title.
<author> (optional)
The author element contains the item's author. can have multiple entries
<language> (optional)
The language element contains the item's language.

can have multiple entries

<date> (optional)
The date element contains the item's date of composition/creation or publication/release.
<publisher> (optional)
The publisher element contains the item's publisher.

can have multiple entries

<icon> (optional)
The icon element contains the filename (including path) of the thumbnail image that is displayed next to the item's library listing.
<description> (optional)
The description element contains the item's description.