Man pages sections > man1 > dtdformat

dtdformat - Read a DTDParse XML file and produce formatted documentation

DTDFORMAT(1p) User Contributed Perl Documentation DTDFORMAT(1p)

NAME

dtdformat - Read a DTDParse XML file and produce formatted documentation

SYNOPSIS

 dtdformat [options] xmlfile

DESCRIPTION

dtdformat generated formatted documentation based upon a DTDParse XML file created by dtdparse. The following documentation formats are supported:
HTML
Designated by the "--html" option.
DocBook Refentry
Designated by the "--refenty" option.
One of the above formats must be specified, or dtdformat will abort with an error.

OPTIONS

--appears-in
--noappears-in
Include what an entity and/or element appears in. The default is to include.
--attributes
--noattributes
Include, or not include, element attributes in documentation. The default is to include.
--base-dir
Root directory to place documentation.
--base-id name
Entity name prefix for entities defined in DocBook RefEntry, "--refentry", output. If not specific, "dtdparse" is used.
--chilren
--nochilren
Include, or not include, list of children for elements. The default is to include.
--content-model
Include, or not include, element content models in documentation.
--debug
Enable debugging output.
--description
Include, or not include, Description sections in documentation. The default is to include.
--examples
--noexamples
Include, or not include, Example sections in documentation. The default is to include.
--exclusions
--noexclusions
Include, or not include, element exclusions in documentation. The default is to include.
--html
Generate HTML documentation.
--inclusions
--noinclusions
Include, or not include, element inclusions in documentation. The default is to include.
--parents
--noparents
Include, or not include, possible element parents in documentation. The default is to include.
--refentry
Generate DocBook Refentry (manpage) documentation.
--synopsis
--nosynopsis
Include, or not include, element synopses in documentation. The default is to include.
--tag-minimization
--notag-minimization
Include, or not include, element tag minization settings in documentation. The default is to include.
--unexpanded
--nounexpanded
Included, or not include, unexpanded content models in element documentation. The default is to include.
--verbose
--noverbose
Output progress (the default).
--version
Print program version and synopsis.
--help
Print program synopsis and options available.
--man
Print program manual page.

SEE ALSO

dtdparse
See SGML::DTDParse for an overview of the DTDParse package.

PREREQUISITES

Getopt::Long, XML::DOM

AVAILABILITY

< http://dtdparse.sourceforge.net/>

AUTHORS

Originally developed by Norman Walsh, <ndw@nwalsh.com>.
Earl Hood <earl@earlhood.com> picked up support and maintenance. See SGML::DTDParse for copyright and license information.
2005-07-16 perl v5.14.2