Sample library.info file: Difference between revisions

From OLPC
Jump to navigation Jump to search
Line 18: Line 18:
== General Notes ==
== General Notes ==


; Entries : Entries are {key,value} pairs in the format: <code>Key = Value</code>. Space before and after the equals sign is ignored; the <code>=</code> sign is the actual delimiter.
; Entries : Entries are key/value pairs in the format: <code>Key = Value</code>. Space before and after the equals sign is ignored; the <code>=</code> sign is the actual delimiter.


; Multiple Values : Some keys can have multiple values. In such a case, the value of the key is specified as a plural: for example, <tt>locales</tt>. The multiple values should each be separated by a semicolon. Those keys which have several values should have a semicolon as the trailing character. Semicolons in these values need to be escaped using \;.
; Multiple Values : Some keys can have multiple values. In such a case, the key is specified as a plural: for example, <code>locales</code>. 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 and Values==
==Keys and Values==

Revision as of 17:37, 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 and Values

The core categories are : activities, books, health, images, media, science, search

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 start page, however, for instance if you were converting a collection of OCW courses to be content bundles (they name their homepage differently).