ScrollKeeper Cataloging System

ScrollKeeper is a cataloging system for documentation. The Yelp Help browser uses ScrollKeeper to catalog the manuals on the system. ScrollKeeper manages the information in the OMF files for the Yelp Help browser.

ScrollKeeper uses the information in the OMF files to enable the Yelp Help browser to find Help documents on a system. When you install an application, the installation process installs an OMF file to a directory of OMF files.

ScrollKeeper builds a table of contents for each Help document that has an associated OMF file. ScrollKeeper builds the table of contents from the XML file specified in the OMF file. The table of contents for the Help document is displayed in the left pane of the Yelp Help browser window, and enables users to navigate the Help document in the left pane. The title of the document in the OMF file is also displayed in the left pane of the Yelp Help browser window.

ScrollKeeper contains a hierarchy of subject categories to which a Help document can belong. The Help documents are organized into this hierarchy of subject categories in the left pane of the Yelp Help browser window. The subject category of the document in the OMF file determines the location of the document in the hierarchy. The hierarchy of subject categories is defined in the following file:

/usr/share/scrollkeeper/Templates/C/scrollkeeper_cl.xml

The subject category of a document must correspond to a subject category in the following file:

/usr/share/scrollkeeper/Templates/C/scrollkeeper_cl.xml

If the Help document XML file is moved to a new location, then you might need to update the location in the OMF file.