Copyright © 2001-2002 Sun Microsystems, Eazel Inc., and Dan Mueth
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this link or in the file COPYING-DOCS distributed with this manual.
Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any ScrollKeeper documentation, and the members of the ScrollKeeper Project are made aware of those trademarks, then the names are in capital letters or initial capital letters.
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT:
DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND
UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear, and those trademarks are made aware to the members of the ScrollKeeper Project, the names have been printed in caps or initial caps.
Table of Contents
The package scrollkeeper-example2 illustrates how one can easily create a package which installs documentation and OMF metadata and registers it with ScrollKeeper. This document is part of the scrollkeeper-example2 package and explains how the package is constructed and how you can modify an existing package to install and register its documentation with ScrollKeeper. To make things as easy as possible, this package also provides template Makefiles which can be used as-is with most packages, eliminating the need for packagers to write or customize Makefiles for the documentation in their package.
Note that this document is meant to be brief in order to keep things simple, and thus it is not an exhaustive explanation of how ScrollKeeper works. For additional information, look inside the various files in this package and at the ScrollKeeper Manual and man pages, available in the scrollkeeper package.
This package is maintained in SourceForge CVS for ScrollKeeper in the scrollkeeper_examples module. You can easily download this example from CVS by following these instructions and then by checking out the scrollkeeper_examples module. Or, you can download the latest packaged version here. Note that if you download and install a binary package for scrollkeeper-example2, you should also unpack the tarball into a directory to refer to as you read this document and update your package.
ScrollKeeper is an open documentation cataloging system. It manages document metadata (as specified by the Open Source Metadata Framework (OMF)) and provides a simple API to allow help browsers to find, sort, and search the document catalog. It will eventually be able to communicate with catalog servers on the Net to search for documents which are not on the local system. Right now it is a very simple system, but we have many powerful features planned for it.
For more information on ScrollKeeper, see the ScrollKeeper web site and read the ScrollKeeper Manual and man pages which are part of the scrollkeeper package.
ScrollKeeper is in development. This package illustrates how to set up packages to work with ScrollKeeper 0.3.x and 0.4.x. Future versions of ScrollKeeper will take advantage of more metadata in the OMF files than is currently used, and may introduce features which will require modifications to the installation setup to use.
Please send feedback, questions, etc. to the scrollkeeper-devel mailing mailing list. You will need to subscribe to the mailing list before you can post to it. Alternately, you can also email directly to the author of this document at <email@example.com>.