Library

From OLPC

(Difference between revisions)
Jump to: navigation, search
(..)
(Repositories)
 
(37 intermediate revisions not shown)
Line 1: Line 1:
-
''for notes on an international library catalog for childrens materials, see [[Library catalog]]''
 
-
{{OLPC}}
 
{{Translations}}
{{Translations}}
 +
{{Olpcboxtop|toptext=[[{{PAGENAME}}|Library]]}}
 +
{{ OBX source dev|library/library-activity}}
 +
{{ OBX devtickets |library}}
 +
{{ OBX team |[[user:sj|SJ Klein]], [[user:Eben|Eben]], [[user:Jacobolus|Jacobolus]]}}
 +
{{Olpcboxbottom}}
-
{{Status box
+
== A library of content ==
-
|icon=
+
The home page of the [[Browse]] activity is titled "OLPC Library".
-
|activity=Library
+
It displays an expandable navigation box that links to available '''content''' on the XO — textbooks, maps, images, music, etc.
-
|status=part of Browse atm
+
-
|version=3
+
-
|base=Yes
+
-
|source=git
+
-
|contributors=[[user:sj|Sj]], [[user:Eben|Eben]], [[user:Jacobolus|Jacobolus]]
+
-
}}
+
-
== Current sample library release ==
+
'''Users''' can install new content on their XO  by downloading a ''collection'' from the [[Collections]] page.
 +
A collection is just a compressed bundle of files with a <tt>.xol</tt> extension.
 +
Downloading a new collection updates the library navigation in the browser's home page.
-
You can find a collection of sample content formatted for the XO '''[http://dev.laptop.org/pub/content/library online]'''. Materials in the library should be formatted as [[Creating a content bundle|content bundles]] and added to the [[library grid]]. The current version is release 0 and is a draft; the first release will be frozen on '''July 20, 2007.''' This is not "''the''" OLPC library (anyone can make library materials and libraries for use on the laptop, and there will be different libraries for each country), but a sample library that we've made to test ways to share modular materials. The latest software builds for the XO include this library for testing; see [[Library Release Notes]] for more, and a high-level description of the activity below.
+
[[Creating a collection]] tells '''content providers''' how to package content materials into a collection that users or deployments can install on the XO.
 +
[[File formats]] discusses some of the formats for library content that the XO supports.
-
=== How to contribute ===
+
[[Release notes/8.2.0|Release 8.2.0]] has a [[Software update]] control panel that can install and update ''activity groups'' that include content and activities, such as [[Activities/G1G1/8.2]].   
-
If you have been porting your own collections, books or other works to display neatly on the XO, they can be included in this collection. To suggest a collection, leave a note on this talk page with a description and link to the latest version.  (Some suggested collections, specifically those in languages other than the current targets of English, Spanish, Portuguese, Arabic, French, Thai, and Urdu, are linked on this site but have not yet been incorporated beyond the wiki.) Also see the list of [[Library contributors]].
+
Earlier "ship.2" releases (distributed with the [[G1G1 2007|2007 Give One, Get One]] laptops) included a default or "core" content library.
-
== Library activity ==
+
== Developers: How it works ==
 +
Library handling is called an "activity" but it was built-in to OLPC releases.  I think it's the [[rpm]] package olpc-library-common.
-
The Library activity will be an activity for browsing books and media in SugarThis should provide an intuitive way to search and browse through different kinds of text and media, including granular reference works, classical texts, image galleries, audio books, and videos. It should display rich information about highly collaborative materials, with ongoing updates, version #s, and dozens of authors.
+
* Somehow when you download or run a .xol file from the Journal, Sugar's bundle/contentbundle.py code handles installing it, similar to when you install an activity.  contentbundle.py's Install():
 +
** unzips the .xol file to the user's library (~/Library)
 +
** runs /usr/share/library-commonmake_index.py
-
The activity should make it easy to search for and request new materials for the library from outside sources (international digital libraries, regional or national repositories, the local mesh).  It should provide a way to publish new material for others to access. And its infrastructure should allow users to change its layout and what kinds of data it displays.
+
* The [[rpm]] package olpc-library-common installed code in /usr/share/library-common.
 +
/usr/share/library-common/make-index.py runs make_index.py, which:
 +
** determines information (section in library, name, path) about all installed collections in ~olpc/Library (and the obsolete? /usr/share/activities)
 +
** uses the "Jinja" templating engine and templates in /usr/share/library-common to build a new page including the information about installed collections
 +
** writes a new index.html in
 +
  output_path = '/home/olpc/.library_pages' # old but kept around for upgrades
-
The initial Library activity is rolled into the browser -- the browser is planned to have a small icon that takes you back to your library from wherever you are, and browsing to leaf nodes of the library will take you away from library navigation elements. In the future these two activities may be separated.
+
* The Browse activity source code (in webactivity.py) hardcodes loading
 +
  _LIBRARY_PATH = '/usr/share/library-common/index.html'
 +
this file is provided by the same olpc-library-common package.  Its contents are simply hardcoded to be a meta-equiv redirect to file:///home/olpc/.library_pages/index.html
 +
And thus, when the user starts Browse, she sees an OLPC Library home page that was re-generated by library-common/make_index.py to include the new collection.
-
== Purpose and Goals  ==
+
== A future library activity ==
-
=== An intuitive interface for finding media ===
+
=== Sugar Labs' status and plans ===
 +
The Sugar Labs Sugar releases lacks the machinery to update library navigation in a browser page upon installing a bundle ({{SugarLabs Ticket|574}}).
 +
 
 +
Sugar Labs' plans for a [http://wiki.sugarlabs.org/go/Activities/Library Library activity] and [http://wiki.sugarlabs.org/go/Features/Content_support content support] are quite different to what is present in OLPC releases; it envisions presenting content in the Home view on an equal footing with activities.
 +
 
 +
=== OLPC's old plans ===
 +
See [[Dynamic library]] for future (possibly release [[9.1.0]]) plans.
 +
In the future browsing the Web and browsing the library may be separated.
 +
 
 +
The Library activity will be an activity for browsing books and media in Sugar.  This should provide an intuitive way to search and browse through different kinds of text and media, including granular reference works, classical texts, image galleries, audio books, and videos.  It should display rich information about highly collaborative materials, with ongoing updates, version #s, and dozens of authors.
 +
 
 +
The activity should make it easy to search for and request new materials for the library from outside sources (international digital libraries, regional or national repositories, the local mesh).  It should provide a way to publish new material for others to access.  And its infrastructure should allow users to change its layout and what kinds of data it displays.
 +
 
 +
=== Initial purpose and goals (from 2007) ===
 +
 
 +
==== An intuitive interface for finding media ====
The Library should provide a layer of abstraction on top of the available reading, editing, and searching activities.  It should offer a single place to look for information and media, though there may be separate text-readers, video-viewers, audio-players, and editors for each of these materials.
The Library should provide a layer of abstraction on top of the available reading, editing, and searching activities.  It should offer a single place to look for information and media, though there may be separate text-readers, video-viewers, audio-players, and editors for each of these materials.
Line 37: Line 63:
Through the default interfaces, we can suggest some of the useful metadata that can be filtered up to the highest levels of indexing and browsing.
Through the default interfaces, we can suggest some of the useful metadata that can be filtered up to the highest levels of indexing and browsing.
-
== Initial targets ==
+
=== Initial targets ===
The simplest initial targets are a library of image-light books, in text or crossmark; a subset of these available as audiobooks; 5000 encyclopedia entries; 1000 dictionary terms, with words in 10 languages; a library of images, each with short metadata strings and sources; and a set of short videos.
The simplest initial targets are a library of image-light books, in text or crossmark; a subset of these available as audiobooks; 5000 encyclopedia entries; 1000 dictionary terms, with words in 10 languages; a library of images, each with short metadata strings and sources; and a set of short videos.
 +
 +
=== Repositories ===
 +
 +
Sources: http://dev.laptop.org/git/users/dsd/olpc-library/
 +
 +
''for notes on an international library catalog for childrens materials, see [[Library catalog]]''
 +
 +
[http://fedora-commons.org FEDORA] (the repository backend, not the Linux distribution; see the 2003 trademark dispute for a cute story) is a good modular and scalable system for providing access to large collections of materials.
 +
: Fedora appeals to me because it is a pure web service. OLPC could develop a very intuitive front-end for kids without compromising the back-end reliability and power. Here is an [[Install fedora library server|install guide]] I put together for a very basic install of fedora. I installed fedora on top of Ubuntu 7.04  [[User:Berrybw|Berrybw]]
== See also ==
== See also ==

Current revision as of 22:42, 14 June 2012

  english | español | 日本語 | 한국어 HowTo [ID# 271644]  +/-  
Library
Tickets all - active - new

Contents

A library of content

The home page of the Browse activity is titled "OLPC Library". It displays an expandable navigation box that links to available content on the XO — textbooks, maps, images, music, etc.

Users can install new content on their XO by downloading a collection from the Collections page. A collection is just a compressed bundle of files with a .xol extension. Downloading a new collection updates the library navigation in the browser's home page.

Creating a collection tells content providers how to package content materials into a collection that users or deployments can install on the XO. File formats discusses some of the formats for library content that the XO supports.

Release 8.2.0 has a Software update control panel that can install and update activity groups that include content and activities, such as Activities/G1G1/8.2. Earlier "ship.2" releases (distributed with the 2007 Give One, Get One laptops) included a default or "core" content library.

Developers: How it works

Library handling is called an "activity" but it was built-in to OLPC releases. I think it's the rpm package olpc-library-common.

  • Somehow when you download or run a .xol file from the Journal, Sugar's bundle/contentbundle.py code handles installing it, similar to when you install an activity. contentbundle.py's Install():
    • unzips the .xol file to the user's library (~/Library)
    • runs /usr/share/library-commonmake_index.py
  • The rpm package olpc-library-common installed code in /usr/share/library-common.
/usr/share/library-common/make-index.py runs make_index.py, which:
    • determines information (section in library, name, path) about all installed collections in ~olpc/Library (and the obsolete? /usr/share/activities)
    • uses the "Jinja" templating engine and templates in /usr/share/library-common to build a new page including the information about installed collections
    • writes a new index.html in
 output_path = '/home/olpc/.library_pages' # old but kept around for upgrades
  • The Browse activity source code (in webactivity.py) hardcodes loading
  _LIBRARY_PATH = '/usr/share/library-common/index.html'

this file is provided by the same olpc-library-common package. Its contents are simply hardcoded to be a meta-equiv redirect to file:///home/olpc/.library_pages/index.html

And thus, when the user starts Browse, she sees an OLPC Library home page that was re-generated by library-common/make_index.py to include the new collection.

A future library activity

Sugar Labs' status and plans

The Sugar Labs Sugar releases lacks the machinery to update library navigation in a browser page upon installing a bundle (#574).

Sugar Labs' plans for a Library activity and content support are quite different to what is present in OLPC releases; it envisions presenting content in the Home view on an equal footing with activities.

OLPC's old plans

See Dynamic library for future (possibly release 9.1.0) plans. In the future browsing the Web and browsing the library may be separated.

The Library activity will be an activity for browsing books and media in Sugar. This should provide an intuitive way to search and browse through different kinds of text and media, including granular reference works, classical texts, image galleries, audio books, and videos. It should display rich information about highly collaborative materials, with ongoing updates, version #s, and dozens of authors.

The activity should make it easy to search for and request new materials for the library from outside sources (international digital libraries, regional or national repositories, the local mesh). It should provide a way to publish new material for others to access. And its infrastructure should allow users to change its layout and what kinds of data it displays.

Initial purpose and goals (from 2007)

An intuitive interface for finding media

The Library should provide a layer of abstraction on top of the available reading, editing, and searching activities. It should offer a single place to look for information and media, though there may be separate text-readers, video-viewers, audio-players, and editors for each of these materials.

Through the default interfaces, we can suggest some of the useful metadata that can be filtered up to the highest levels of indexing and browsing.

Initial targets

The simplest initial targets are a library of image-light books, in text or crossmark; a subset of these available as audiobooks; 5000 encyclopedia entries; 1000 dictionary terms, with words in 10 languages; a library of images, each with short metadata strings and sources; and a set of short videos.

Repositories

Sources: http://dev.laptop.org/git/users/dsd/olpc-library/

for notes on an international library catalog for childrens materials, see Library catalog

FEDORA (the repository backend, not the Linux distribution; see the 2003 trademark dispute for a cute story) is a good modular and scalable system for providing access to large collections of materials.

Fedora appeals to me because it is a pure web service. OLPC could develop a very intuitive front-end for kids without compromising the back-end reliability and power. Here is an install guide I put together for a very basic install of fedora. I installed fedora on top of Ubuntu 7.04 Berrybw

See also

http://lists.laptop.org/pipermail/library/

Personal tools
  • Log in
  • Login with OpenID
About OLPC
About the laptop
About the tablet
Projects
OLPC wiki
Toolbox