Sample library.info file: Difference between revisions

From OLPC
Jump to navigation Jump to search
Line 26: Line 26:
; <tt>[Library]</tt> ''(required)'': The <tt>library.info</tt> file must begin with <tt>[Library]</tt>, and only that, on the first line of the file.
; <tt>[Library]</tt> ''(required)'': The <tt>library.info</tt> file must begin with <tt>[Library]</tt>, and only that, on the first line of the file.
; <tt>name</tt> ''(required)'':
; <tt>name</tt> ''(required)'': This entry is the name is displayed in the library navigation sidebar that refers to the collection. Visit the online version of the [http://dev.laptop.org/pub/content/library/ OLPC Library] to view the current navigation sidebar and categories.


; <tt>global_name</tt> ''(required)'':
; <tt>library_version</tt> ''(required)'': The version is a single positive integer that refers to the version of the collection. Larger numbers are considered "newer". For now, the version is 1.

; <tt>long_name</tt> ''(required)'': This entry is the name is displayed in the library navigation sidebar that refers to the collection.

; <tt>library_version</tt> ''(required)'': The version is a single positive integer that refers to the version of the collection. Larger numbers are considered "newer". For now, the version is 2.


; <tt>host_version</tt> ''(required)'': The host version is a single positive integer that refers to the version of Sugar which the collection is compatible with. For now, the version is 1.
; <tt>host_version</tt> ''(required)'': The host version is a single positive integer that refers to the version of Sugar which the collection is compatible with. For now, the version is 1.


; <tt>l10n</tt> ''(required)'': This entry indicates whether the bundle is "officially" localized. The value is either <tt>true</tt> or <tt>false</tt>.
; <tt>l10n</tt> ''(required)'': This entry indicates whether the bundle is localized or not. The value is either <tt>true</tt> or <tt>false</tt>.


:''Note: What it means to be "officially" localized hasn't been entirely worked out yet, so the value of this entry is always <tt>false</tt> for now.
:''Note: What it means to be "officially" localized hasn't been entirely worked out yet, so the value of this entry is always <tt>false</tt> (for now).
; <tt>locale</tt> ''(required)'': This is the ISO code for the language of the collection, in lowercase, followed by an underscore, and then its localization information (also represented in ISO code). For example, US-localized English is represented as en_US. UK-localized English, for example, would be represented as en_UK.
; <tt>locale</tt> ''(required)'': This is the ISO code for the language of the collection, in lowercase, followed by an underscore, and then its localization information (also represented in ISO code). For example, US-localized English is represented as en_US. UK-localized English, for example, would be represented as en_UK.


:In the case of collections that are "unofficially" localized and/or contain content in multiple languages, you can indicate multiple locales. An example would be:
:In the case of collections that are "unofficially" localized and/or contain content in multiple languages, you can indicate multiple locales. An example would be:
:<pre>locales = en_US;en_UK;es_PE;es_AR;</pre>
:<code>locales = en_US;en_UK;es_PE;es_AR;</code>


:Note that <tt>locales</tt> is pluralized in order to indicate multiple values. Note also that values are separated by semi-colons, and that the final value must end with a semi-colon as well.
:Note that <tt>locales</tt> is pluralized in order to indicate multiple values. Note also that values are separated by semi-colons, and that the final value must end with a semi-colon as well.
Line 47: Line 51:
: For a list of ISO country codes, see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
: For a list of ISO country codes, see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements


; <tt>category</tt> ''(required)'': This refers to the category classification in the OLPC Library (visible on navigation sidebar). See the category chart below for current options. As always, if you don't like what you see, you can add your own.
; <tt>category</tt> ''(required)'': This refers to the category classification in the OLPC Library (visible on navigation sidebar). See the category chart below for current options.

; <tt>category_icon</tt> ''(optional)'': This is the filename of the icon that represents the collection in the library navigation sidebar. The actual image file is stored in the <tt>library</tt> directory (see [[Creating_a_content_bundle#Configuration_Files|configuration files]]. This entry is only required if you decide to place your collection in a new top-level category in the library navigation sidebar. Otherwise, the pre-defined category icon is used.

; <tt>category_class</tt> ''(optional)'': This entry refers to the category's CSS class. This is required if you decide to place your bundle into a new top-level category. Otherwise, the default class for the category is used. See the category chart below for current categories and related classes.

; <tt>subcategory</tt> ''(optional)'' : This refers to the subcategory classification within a category (visible on the navigation sidebar). If no subcategory is provided, the collection will be placed in its own subcategory. See category chart for current options. Again, and as always, if you don't like what you see, you can add your own.

; <tt>bundle_class</tt> ''(optional)'': This entry is required if the collection is using a customized <tt>[[library.css]]</tt> file. The <tt>bundle_class</tt> value should be the same name as the collection's <tt>.xol file</tt>, except in lower case (and without the ".xol"). No whitespace or special characters are allowed. Otherwise, the category class is used.


; <tt>subcategory</tt> ''(optional))'': This refers to the subcategory classification within a category (visible on the navigation sidebar). If no subcategory is provided, the collection will be placed in its own subcategory. See category chart for current options. Again, and as always, if you don't like what you see, you can add your own.
The core categories are : '''activities, books, health, images, media, science, search'''


; <tt>icon</tt> ''(optional)'': This is the filename of the icon that represents the collection in the library navigation sidebar. The actual image file is stored in the <tt>library</tt> directory (see [[Creating_a_content_bundle#Configuration_Files|configuration files]]. This entry is only required if you decide to place your collection in a new top-level category in the library navigation sidebar. Otherwise, the pre-defined category icon is used.
See [[library.info]] for a description of keys and values.
Other optional keys include:
activity = Browse
activity_start = index.html


Browse is the only supported activity at the moment; you could change your
; <tt>activity</tt> ''(optional)'': This refers to the [[Activity]] used to read the content bundle. Browse is the only supported activity at the moment, and is the default value if no Activity is specified.
start page, however, for instance if you were converting a collection of OCW
courses to be content bundles (they name their homepage differently).


; <tt>activity_start</tt> ''(optional)'': This refers to the start page of your content bundle. The default is <tt>index.html</tt>. You might change the start page of the bundle, for instance, if you were converting a collection of OCW courses to be content bundles. (They name their homepage differently.)


==Category Chart==
==Category Chart==

Revision as of 17:53, 18 December 2007

Here is an example library.info configuration file for a collection called Dictionary.

[Library]
name = Dictionary
global_name = org.logos.dictionary
long_name = children's dictionary
library_version = 1
host_version = 1
l10n = false
locale = en
category =  books
subcategory = reference
icon = library-dictionary.jpg
activity = Browse
activity_start = index.html

To create a configuration file for your own collection, follow the instructions below or use the web-based library.info file generator.

General Notes

Entries
Entries are key/value pairs in the format: Key = Value. Space before and after the equals sign is ignored; the = sign is the actual delimiter.
Multiple Values
Some keys can have multiple values. In such a case, the key is specified as a plural: for example, locales. The multiple values should each be separated by a semicolon. Keys that have multiple values must have a semicolon as the trailing character. Semicolons in these values need to be escaped using \;.

Keys/Values

[Library] (required)
The library.info file must begin with [Library], and only that, on the first line of the file.
name (required)
global_name (required)
long_name (required)
This entry is the name is displayed in the library navigation sidebar that refers to the collection.
library_version (required)
The version is a single positive integer that refers to the version of the collection. Larger numbers are considered "newer". For now, the version is 2.
host_version (required)
The host version is a single positive integer that refers to the version of Sugar which the collection is compatible with. For now, the version is 1.
l10n (required)
This entry indicates whether the bundle is localized or not. The value is either true or false.
Note: What it means to be "officially" localized hasn't been entirely worked out yet, so the value of this entry is always false (for now).
locale (required)
This is the ISO code for the language of the collection, in lowercase, followed by an underscore, and then its localization information (also represented in ISO code). For example, US-localized English is represented as en_US. UK-localized English, for example, would be represented as en_UK.
In the case of collections that are "unofficially" localized and/or contain content in multiple languages, you can indicate multiple locales. An example would be:
locales = en_US;en_UK;es_PE;es_AR;
Note that locales is pluralized in order to indicate multiple values. Note also that values are separated by semi-colons, and that the final value must end with a semi-colon as well.
For a list of ISO 639 language codes, see http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
For a list of ISO country codes, see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
category (required)
This refers to the category classification in the OLPC Library (visible on navigation sidebar). See the category chart below for current options.
subcategory (optional))
This refers to the subcategory classification within a category (visible on the navigation sidebar). If no subcategory is provided, the collection will be placed in its own subcategory. See category chart for current options. Again, and as always, if you don't like what you see, you can add your own.
icon (optional)
This is the filename of the icon that represents the collection in the library navigation sidebar. The actual image file is stored in the library directory (see configuration files. This entry is only required if you decide to place your collection in a new top-level category in the library navigation sidebar. Otherwise, the pre-defined category icon is used.
activity (optional)
This refers to the Activity used to read the content bundle. Browse is the only supported activity at the moment, and is the default value if no Activity is specified.
activity_start (optional)
This refers to the start page of your content bundle. The default is index.html. You might change the start page of the bundle, for instance, if you were converting a collection of OCW courses to be content bundles. (They name their homepage differently.)

Category Chart

The current category and subcategory options are:

Icon Category Category Class Category Icon Subcategories
Books.png books & reference books books.png children's books, encyclopedia, reference, stories
Science.png math & science science science.png biology
Images.png images & maps images images.png nature, atlas, history
Music.png music & video music music.png media, music
Activities.png activities & games activities activities.png games
Links.png web links links links.png search the web
Uniwiki.png uniwiki uniwiki uniwiki.png water & sanitation

Visit the OLPC Library to see these categories in action.