Doc Toolkit 1.1.0 - E-Text Tools for PalmPilot Users

Copyright 1998-1999 Rob Tillotson <robt@debian.org>

This program is free software; see the file doc/COPYING in the
distribution for details.

For more information and the most up-to-date version, see:
  http://purl.oclc.org/net/n9mtb/cq/

Description:

  Doc Toolkit is a set of tools for building e-texts in the de facto
  standard "Doc" format used on the Palm Computing(R) platform.  It is
  written in the Python programming language, and thus requires the
  Python interpreter, v1.5 or newer.  It also requires Pyrite (0.7.1
  or newer), my package of Palm Computing platform data access tools,
  and Sulfur (0.0.2 or newer), the application framework upon which
  both Doc Toolkit and Pyrite are based.  Pyrite and Sulfur are
  available at the URL above.


Installation:

  This version of Doc Toolkit must be installed in a directory on your
  Python path.  A simple Makefile is provided; check the "MODULE_PATH"
  near the top to make sure it lists the location of your Python
  library, and then do "make install".  Alternately, you can just copy
  all of Doc Toolkit into your Python path somewhere; call the
  directory it is in "DocToolkit".  You can make a symbolic link to
  the "dtk" script, but the actual script must remain in the same
  location as the rest of Doc Toolkit.

  A manual page for "dtk" is provided in the "doc" subdirectory; you
  can copy it to /usr/local/man/man1 or wherever the manuals are on
  your system.  (If you just want to read them without installing, try
  "nroff -man htmltodoc.1 | less" or a similar command).


Features:

  Doc Toolkit is modular; separate sets of plug-ins do input parsing
  and output formatting, so that you can select whatever combination
  of input format and output format you want to use.

  Core features:
    - input may come from local files or http: or ftp: URLs
    - input files may be gzipped
    - documents may be installed directly to a connected palmtop, or
      spooled for installation at the next sync (using Pyrite)
    - Doc category support
    - user-specified creator, type, and backup settings
    - bookmarks are written directly into the document, eliminating
      the need for auto-scan or TealDoc <BOOKMARK> tags

  Input Modules:
    - Raw (unprocessed text)
    - Text (text with paragraph reflowing)
    - TaggedText (text with paragraph reflowing and embedded tags for
      adding headers, rules, etc.)
    - HTML
      * converts <H1>...<H6> to headings depending on output format
      * converts <HR> to rules depending on output format
      * automatic bookmarking of named anchors (<A NAME="...">...</A>)
      * optional footnoting and summary of links
      * <UL TYPE="..."> and <OL TYPE="..."> support
      * supports entire palmtop character set using HTML entities

  Output Modules:
    - Basic (standard Doc format, text only)
    - TealDoc (enhanced reader from TealPoint www.tealpoint.com)
      * renders headings using <HEADER> tags, with word wrap based on
        actual palmtop font metrics
      * renders rules using <HRULE> tags


Usage:

  The "dtk" script provides the main command-line user interface to
  Doc Toolkit.  For detailed information, please read the manual page
  (in doc/dtk.1); here is a quick summary:

  - use the -I option to specify an input format, eg. "dtk -I Text".
    The default is "Raw".

  - use the -O option to specify an output format, eg. "dtk -O
    TealDoc".  The default is "Basic".

  - some other useful options:

    -t STRING  - set the document title
    -b         - set the backup bit
    -c NUMBER  - set the category number

  - instead of dropping converted documents in the current directory,
    you can dump them directly into a cradled palmtop by giving the
    "-S" option.

  - the "-i" option tells DTK to put the converted documents in the
    Pyrite installation directory, so they will be installed at the
    next full sync.  The "-U" option does not work yet, but will allow
    you to pick what user to install as.

  - some input and output plug-ins have options of their own; use "-h"
    to get help.

  - instead of a filename, you can specify a http: or ftp: URL.
    Anything ending in .gz (local or not) will be un-gzipped
    automatically.

  - you can set the defaults for some options persistently, in the
    Pyrite configuration file, for example:

        DocToolkit {
            input-format Text;
            output-format TealDoc;
            backup 1;
            install 1;

            Input "HTML" {
                no-anchor-bookmarks 1;
            }

            Output "RichReader" {
                stylesheet "richreader-dtk.css";
            }
        }

    (I admit, that last one is just a dream.  Maybe. ;-)


Palm Computing is a registered trademark of Palm Computing Inc., 3com
Corporation, or its subsidiaries.