Scrollkeeper

From LSDevLinux
Jump to: navigation, search

ScrollKeeper is a metadata manager used by applications to register documentation, and by help browsers (such as GNOME's yelp) to find documentation.

This is a guide to registering documents with ScrollKeeper

Manual install

OMF File

An OMF file must be created for each content file that is to be added to ScrollKeeper.

Note: Every program which has OMF files has one with a language of "C" (which is in English on my system). This seems to be a special language code, but I'm not exactly sure of what it means.

Docbook file

Each docbook file can be split into several articles (shown in the left hand pane of yelp) using the <sect1> or <section>tags.

Installation

Use scrollkeeper-update -o <directory containing OMF files>

Via package

http://scrollkeeper.sourceforge.net/documentation/scrollkeeper_example2_manual/