ScrollKeeper Cataloging System

ScrollKeeper is a cataloging system for documentation. Its primary function is to manage the information in OMF files for the help browser. When you install an application, the OMF file is copied to the $prefix/share/omf/<application-name> directory.

ScrollKeeper builds a table of contents from the collection of OMF files in the directories specified in $prefix/etc/scrollkeeper.conf file. This file usually consists of a single line with the OMF_DIR set to a comma separated list of directories to recursively search.

OMF_DIR=/usr/share/omf:/usr/local/share/omf:/opt/gnome2/share/omf:/opt/kde/omf

ScrollKeeper contains a hierarchy of subject categories to which a help document can belong. The subject category of the document in the OMF file determines the location of the document in the table of contents presented by the help browser.

The hierarchy of subject categories is defined in the file $prefix/scrollkeeper/Templates/<lang>/scrollkeeper_cl.xml. The subject category of a document must correspond to a category specified in this file.

For more information on the Scrollkeeper system, visit the website at https://scrollkeeper.sourceforge.net/.

	Note
	If the help document XML file is moved to a new location, then the location in the OMF file needs to be updated.