A list of tasks that need doing in and around Rarian

Primary Goal
------------

The current primary goal of Rarian is to get into decent enough state to be
proposed for GNOME 2.20 (Around September 2007).  To do this, a number of tasks
are required.

When 2.18 is branched and work commences on 2.20 (Approx. April 2007),
   Rarian should be able to drop in as a scrollkeeper replacement immediately.

This means, jhbuild should be adapted to build rarian instead of
   scrollkeeper and a full build of jhbuild moduleset for GNOME
   2.20should be able to run through and install correctly, with all
   current documentation available within yelp (within the jhbuild
   environment).

Gnome-doc-utils needs some work to stop looking for scrollkeeper and
   instead install scrolls (or install omfs and run rarian-sk-update).

Yelp will need a lot of work done to make full use of librarian.  In
   addition, several things need done to comply with the spec itself.

A guide will need to be created for app developers on how to handle
   the New World Order.  This should cover how to call yelp and what
   needs to be done to ensure documentation shows up.

3rd May 2007: Additional stuff needed now!
* Whatever is required from the yelp mega function
DONE Mostly completed
* Scrollkeeper replacements:
DONE scrollkeeper-config
 - return various "useful" pieces of info:
 (Pretty much direct from configure script)
DONE scrollkeeper-extract
 - Applys stylesheets to xml docs
DONE scrollkeeper-gen-seriesid
 - Generate series id's
 - own program
DONE scrollkeeper-get-cl
 - ???
DONE scrollkeeper-get-content-list
 - ???
MOSTLY DONE scrollkeeper-get-extended-content-list
 - doesn't copy with extended stuff (mainly because it isn't used)
DONE scrollkeeper-get-index-from-docpath
 - No idea Blank
DONE scrollkeeper-get-toc-from-docpath
 - No idea Blank
DONE scrollkeeper-get-toc-from-id
 - No idea blank
DONE scrollkeeper-install
 - rarian-sk-install
DONE scrollkeeper-preinstall
 - rarian-sk-install
 - Looks like I've actually got to do the preinstall stuff properly
DONE scrollkeeper-rebuilddb
 - Rebuilds the internal tree (rarian-sk-update) - rarian-sk-rebuild
DONE scrollkeeper-uninstall
 - rarian-sk-install
DONE scrollkeeper-update
 - Adds file to tree (rarian-sk-update)


Now, on to stuff that needs doing within Rarian
----------------------------------------------

(In no particular order)

* Handle escape codes within strings as specified in Desktop Entry Spec

* Cleanup of code.  Add comments and API reference documentation

* Add more API.  Yelp will need many new functions to fully utilise the power
  of librarian

* Add overview document, detailing how Rarian is built (for easy replacement)

* Test the bejeesus out of it.  Test on malformed files.  Ensure it doesn't
  crash.

* Ensure its portable to other UNIX-like systems

* Ensure it can migrate and handle all omf files

* Add rarian-validate program to validate rarian files
