ScrollKeeper Manual

Dan Mueth

Copyright © 2000 by Dan Mueth

Table of Contents

1. Introduction

What is ScrollKeeper?
About This Document
Authors
ScrollKeeper License

2. The Open Metadata Framework (OMF)

What is the OMF?
The OMF Specification
Writing OMF Files
Making Things Easier
Example OMF Files

3. ScrollKeeper Administration

Rebuilding the ScrollKeeper Database
Installing A Document By Hand
Uninstalling A Document By Hand

4. How to Make Your Packages Use ScrollKeeper

The Pre-Installation Script
Installing Documents and OMF Files
The Post-Installation Script
Uninstalling Documents and OMF Files
Packaging with RPMs
Packaging with Debs

5. The ScrollKeeper API

The Contents List API

dewey-get-contents-list
dewey-get-extended-contents-list

Table of Contents API

dewey-get-toc-from-docpath

The Index API

6. ScrollKeeper's Internal Files

ScrollKeeper's Home
scrollkeeper-docs
contents-tree
scrollkeeper-contents-list.xml
Table of Contents Files
scrollkeeper-extended-contents-list.xml

A.

		Next
		Introduction