<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
<!ENTITY GFDL SYSTEM "fdl.sgml">

]>

<!-- =============Document Header ============================= -->

<book id="index">

 <bookinfo>
  <title>ScrollKeeper Manual</title>
  <edition>v0.0.1</edition>
  <authorgroup>
   <author>
    <firstname>Dan</firstname>
    <surname>Mueth</surname>
    <authorblurb>
     <para>
      <email>
       d-mueth@uchicago.edu
      </email>
     </para>
    </authorblurb>
   </author>
  </authorgroup>

  <copyright>
   <year>2000</year>
   <holder>Dan Mueth</holder>
  </copyright>

  <!-- translators: uncomment this:

  <copyright>
   <year>2000</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->


  <legalnotice id="legalnotice">
   <para>
    Permission is granted to copy, distribute and/or modify this
    document under the terms of the <ulink type="help" url="gnome-help:fdl">
    <citetitle>GNU Free Documentation License</citetitle></ulink>, 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 may obtain a copy
    of the <citetitle>GNU Free Documentation License</citetitle> from
    the Free Software Foundation by visiting <ulink type="http"
    url="http://www.fsf.org/">their Web site</ulink> or by writing to:
    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
   </para>

   <para> 
    Many of the names used by companies to distinguish their
    products and services are claimed as trademarks. Where those
    names appear in any GNOME documentation, and those trademarks
    are made aware to the members of the GNOME Documentation
    Project, the names have been printed in caps or initial
    caps.
   </para>
  </legalnotice>


  <!-- this is the version of manual, not application --> 
  <releaseinfo>
   This is version 0.0.1 of the ScrollKeeper Manual.
  </releaseinfo>

 </bookinfo>

 <!-- ============= Document Body ============================= -->

 <!-- ============= Introduction ============================== -->
 <chapter id="intro">
  <title>Introduction</title>
   <para>
    NOTE: This document, like ScrollKeeper itself, is a work in
    progress.
   </para>

  <!-- ============ Introduction: What is ScrollKeeper? ======= -->
  <sect1 id="whatisscrollkeeper">
   <title>What is ScrollKeeper?</title>
   <para>
    Scrollkeeper is a Free electronic cataloging system for documentation.
    It stores metadata specified by the <ulink type="http"
    url="http://www.ibiblio.org/osrt/omf/">OMF</ulink> (Open Source 
    Metadata Framework) as well as certain metadata extracted directly
    from documents (such as the table of contents).  It provides various
    functionality pertaining to this metadata to help browsers, such as
    sorting the registered documents or searching the metadata for
    documents which satisfy a set of criteria. 
   </para>

   <para>
    ScrollKeeper will solve a number of serious problems with how 
    documentation is handled on Free systems.  Currently, one does not
    have a central repository listing the documents on the system 
    (except for man pages and info pages).  Thus, one generally has to
    manually browse the filesystem to find documents; a help browser
    application cannot easily find all the documents on the system.  
    The help browser needs to know basic information about each document
    such as the title, author, subject, language, and format to allow
    basic levels of functionality to the user.  To provide the user with
    a subject-sorted contents list and other important features, more 
    metadata is required.  The OMF is the specification for how the metadata
    and ScrollKeeper is the registration mechanism, database, and interface
    to the help browser.  ScrollKeeper provides a single uniform 
    cross-desktop and cross-platform document registration system which
    abstracts much of this work away from the help browser itself.  It also
    provides a stable and uniform target for applications and packages which
    want to register documents.
   </para>
 
  </sect1>

  <!-- ============ Introduction: About This Document ========= -->
  <sect1 id="aboutthisdoc">
   <title>About This Document</title>
   <para>
    FIXME. (Who this is for.  Read the Glossary.  What sections are
    about what.  Who should read which chapters/sections.)
   </para>
  </sect1>

  <!-- ============ Introduction: Authors ===================== -->
  <sect1 id="authors">
   <title>Authors</title>
   <para>
    ScrollKeeper was written by Laszlo Kovacs 
    (<email>laszlo.kovacs@Sun.COM</email>).  It would not
    be possible without contributions from Ali Abdin, Eric Bischoff,
    Jonathan Blandford, Christopher Gabriel, Paul Jones,
    Gregory Leblanc, Dan Mueth, and all the people in the
    MetaLab project who created the OMF.
   </para> 
   <para>
    For more information about ScrollKeeper, visit 
    <ulink url="http://scrollkeeper.sourceforge.net" 
    type="http">the ScrollKeeper home page</ulink>.  
    Please send all comments, suggestions, and bug reports 
    for ScrollKeeper to <ulink 
    url="http://lists.sourceforge.net/mailman/listinfo/scrollkeeper-devel" 
    type="http">the ScrollKeeper-devel mailing list</ulink>. 
   </para>

   <para>
    This manual was written by Dan Mueth
    (<email>d-mueth@uchicago.edu</email>). Please send all 
    comments and suggestions regarding this manual to the author
    or to the ScrollKeeper mailing list at 
    <email>scrollkeeper-devel@lists.sourceforge.net</email>.
   </para>

   <!-- For translations: uncomment this:

   <para>
    Latin translation was done by ME
    (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
    suggestions regarding this translation to SOMEWHERE.
   </para>

   -->

  </sect1>

  <!-- ============ Introduction: ScrollKeeper License ======== -->
  <sect1 id="scrollkeeperlicense">
   <title>ScrollKeeper License</title>
   <para>
    This program is free software; you can redistribute it and/or
    modify it under the terms of the <citetitle>GNU General Public
    License</citetitle> as published by the Free Software Foundation;
    either version 2 of the License, or (at your option) any later
    version.
   </para>
   <para>
    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    <citetitle>GNU General Public License</citetitle> for more details.
   </para>
   <para>
    A copy of the <citetitle>GNU General Public License</citetitle> is
    included as an appendix to the <citetitle>GNOME Users
    Guide</citetitle>.  You may also obtain a copy of the
    <citetitle>GNU General Public License</citetitle> from the Free
    Software Foundation by visiting <ulink type="http"
    url="http://www.fsf.org">their Web site</ulink> or by writing to
    <address>
     Free Software Foundation, Inc.
     <street>59 Temple Place</street> - Suite 330
     <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
     <country>USA</country>
    </address>
   </para>
  </sect1>

 </chapter>

 <!-- ============= The OMF =================================== -->
 <chapter id="theomf">
  <title>The Open Metadata Framework (OMF)</title>
  <para>
   FIXME.
  </para>

  <!-- ============ The OMF: What is the OMF?  ================ -->
  <sect1 id="whatistheomf">
   <title>What is the OMF?</title>
   <para>
    FIXME. 
   </para>
  </sect1>

  <!-- ============ The OMF: The OMF Specification  =========== -->
  <sect1 id="theomfspecification">
   <title>The OMF Specification</title>
   <para>
    FIXME. 
   </para>
  </sect1>

  <!-- ============ The OMF: Writing OMF Files  =============== -->
  <sect1 id="writingomffiles">
   <title>Writing OMF Files</title>
   <para>
    FIXME. 
   </para>
  </sect1>

  <!-- ============ The OMF: Making Things Easier ============= -->
  <sect1 id="makingthingseasier">
   <title>Making Things Easier</title>
   <para>
    FIXME.  (Talk about scripts, web-based tools,  and adding OMF 
    to DocBook.)
   </para>
  </sect1>

  <!-- ============ The OMF: Example OMF Files  =============== -->
  <sect1 id="exampleomffiles">
   <title>Example OMF Files</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 </chapter>


 <!-- ============= Administration ============================ -->
 <chapter id="administration">
  <title>ScrollKeeper Administration</title>
  <para>
   FIXME. (Doesn't usually need administration.  Can do some
   things by hand if you want.  Can rebuild database if something
   goes wrong.)
  </para>

 <!-- ============= Administration: Rebuilding the Database === -->
  <sect1 id="rebuildingdb">
   <title>Rebuilding the ScrollKeeper Database</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Administration: Installing by Hand ======== -->
  <sect1 id="installbyhand">
   <title>Installing A Document By Hand</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Administration: Uninstalling by Hand ====== -->
  <sect1 id="uninstallbyhand">
   <title>Uninstalling A Document By Hand</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 </chapter>


 <!-- ============= Shipping Packages ========================= -->
 <chapter id="packaging">
  <title>How to Make Your Packages Use ScrollKeeper</title>
  <para>
   FIXME.  (In order for scrollkeeper to know about a document,
   it must be registered with scrollkeeper when it is installed...)
  </para>

 <!-- ============= Shipping Packages: Pre-Installation ======= -->
  <sect1 id="preinstallationscript">
   <title>The Pre-Installation Script</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Shipping Packages: Installing  ============ -->
  <sect1 id="installingdocsandomf">
   <title>Installing Documents and OMF Files</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Shipping Packages: Post-Installation ====== -->
  <sect1 id="postinstallationscript">
   <title>The Post-Installation Script</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Shipping Packages: Uninstalling  ========== -->
  <sect1 id="uninstalling">
   <title>Uninstalling Documents and OMF Files</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Shipping Packages: Packaging with RPM ===== -->
  <sect1 id="packagingrpm">
   <title>Packaging with RPMs</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Shipping Packages: Packaging with Debs ==== -->
  <sect1 id="packagingdeb">
   <title>Packaging with Debs</title>
   <para>
    FIXME. 
   </para>
  </sect1>
 </chapter>

 <!-- ============= ScrollKeeper API ========================== -->
 <chapter id="scrollkeeperapi">
  <title>The ScrollKeeper API</title>
  <para>
   FIXME. (Scrollkeeper exports an API for use by help browsers...)
  </para>

 <!-- ============= ScrollKeeper API: Contents List API ======= -->
  <sect1 id="contentslistapi">
   <title>The Contents List API</title>
   <para>
    FIXME. 
   </para>
   <sect2 id="dewey-get-contents-list">
    <title>dewey-get-contents-list</title>
    <para>
     FIXME. 
    </para>
   </sect2>
   <sect2 id="dewey-get-extended-contents-list">
    <title>dewey-get-extended-contents-list</title>
    <para>
     FIXME. 
    </para>
   </sect2>
  </sect1>

 <!-- ============= ScrollKeeper API: Table of Contents API === -->
  <sect1 id="tableofcontentsapi">
   <title>Table of Contents API</title>
   <para>
    FIXME. 
   </para>
   <sect2 id="dewey-get-toc-from-docpath">
    <title>dewey-get-toc-from-docpath</title>
    <para>
     FIXME. 
    </para>
   </sect2>
  </sect1>

 <!-- ============= ScrollKeeper API: The Index API =========== -->
  <sect1 id="indexapi">
   <title>The Index API</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 </chapter>


 <!-- ============= Internal Files ============================ -->
 <chapter id="scrollkeeperfiles">
  <title>ScrollKeeper's Internal Files</title>
  <para>
   FIXME.
  </para>

 <!-- ============= Internal Files: Home ====================== -->
  <sect1 id="scrollkeepershome">
   <title>ScrollKeeper's Home</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Internal Files: scrollkeeper-docs ========= -->
  <sect1 id="scrollkeeper-docs">
   <title>scrollkeeper-docs</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Internal Files: contents-tree ============= -->
  <sect1 id="contents-tree">
   <title>contents-tree</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Internal Files: scrollkeeper-contents-list.xml = -->
  <sect1 id="scrollkeeper-contents-list">
   <title>scrollkeeper-contents-list.xml</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Internal Files: toc ======================= -->
  <sect1 id="toc-file">
   <title>Table of Contents Files</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 <!-- ============= Internal Files: scrollkeeper-extended-contents-list.xml = -->
  <sect1 id="scrollkeeper-extended-contents-list">
   <title>scrollkeeper-extended-contents-list.xml</title>
   <para>
    FIXME. 
   </para>
  </sect1>

 </chapter>

 <!-- ============= Glossary ================================== -->
 <glossary id="glossary">
  <title>Glossary</title>
  <glossentry id="contentslist-def">
   <glossterm>
    Contents List
   </glossterm>
   <glossdef>
    <para>
     FIXME
    </para>
   </glossdef>
  </glossentry>
  <glossentry id="extendedcontentslist-def">
   <glossterm>
    Extended Contents List
   </glossterm>
   <glossdef>
    <para>
     FIXME
    </para>
   </glossdef>
  </glossentry>
  <glossentry id="index-def">
   <glossterm>
    Index
   </glossterm>
   <glossdef>
    <para>
     FIXME
    </para>
   </glossdef>
  </glossentry>
  <glossentry id="metadata-def">
   <glossterm>
    Metadata
   </glossterm>
   <glossdef>
    <para>
     FIXME
    </para>
   </glossdef>
  </glossentry>
  <glossentry id="tableofcontents-def">
   <glossterm>
    Table of Contents
   </glossterm>
   <glossdef>
    <para>
     FIXME
    </para>
   </glossdef>
  </glossentry>
 </glossary>

&GFDL;
</book>




