==================================================
                  LiveDTD README
==================================================

A LiveDTD is an SGML or XML Document Type Definition
converted to HTML. It can then be explored with
any web browser.

This package contains the tools needed to convert
any DTD to a LiveDTD.

livedtd.pl       - main perl5 script that parses a DTD and
                   generates an HTML version and associated files.

OASIS/Catalog.pm - perl module to handle SGML catalogs.

scrubdtd.pl      - perl script to remove HTML markup from
                   a LiveDTD file.

livedtd.html     - documentation.


Usage
---------------------------

1.  Unzip the distribution into a place where you
    put other executable programs.  

2.  Read livedtd.html to see how to use the livedtd.pl
    script.  This same doc is available as POD doc
    inside the script.

3.  Run the script to generate an HTML version of your DTD.

You will need Perl 5 to run the scripts.

For example, to generate an HTML version of
the DocBook XML 4.1 DTD (located in /usr/dtd/docbook41)
and to put the HTML files into /home/html/docbook:

 livedtd.pl --outdir  /home/html/docbook  /usr/dtd/docbook41/docbookx.dtd

Then point your browser at /usr/http/docbook/index.html
to browse the hypertext version of the DTD.

Add the --sgml option if yours is an SGML DTD
instead of an XML DTD.  See the documentation
for other useful options.

If your perl executable is not located in /usr/bin/perl,
then run the command as:

 perl livedtd.pl  etc.

Version 1.2
---------------------------
Changes since 1.1:

Comments now print in italic grey so easier to read around.

Removed leading spaces in POD section before B<.


Version 1.1
---------------------------
Changes since 1.0:

Javascript: replace self.parent with parent to fix Mac bug.

Fixed warning where "type" not set for some PUBLIC entities.

Added <META> tags to index.html output to identify
livedtd.pl.


Copyright
--------------------------------------
Copyright (c) 2000-2003 Robert Stayton

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the ``Software''), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

Except as contained in this notice, the names of individuals
credited with contribution to this software shall not be used in
advertising or otherwise to promote the sale, use or other
dealings in this Software without prior written authorization
from the individuals in question.

Any program derived from this Software that is publically
distributed will be identified with a different name and the
version strings in any derived Software will be changed so that
no possibility of confusion between the derived package and this
Software will exist.

Warranty
--------

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT.  IN NO EVENT SHALL ROBERT STAYTON OR ANY OTHER
CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Contacting the Author
---------------------
This program is maintained by Robert Stayton <bobs@sagehill.net>.
It is available through http://www.sagehill.net/livedtd
