.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SGML::DTDParse 3pm"
.TH SGML::DTDParse 3pm "2005-07-16" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SGML::DTDParse \- Parse an SGML or XML DTD
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use SGML::DTDParse;
\&  print "This is DTDParse v$SGML::DTDParse::VERSION\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The DTDParse collection is a set of Perl modules and scripts for
manipulating \s-1SGML\s0 an \s-1XML\s0 Document Type Definitions (DTDs). DTDParse
is designed primarily to aid in the understanding and documentation
of DTDs.
.PP
Typical usage of this package is as follows:
.IP "1." 4
Parse the \s-1DTD\s0 with dtdparse. This produces an \s-1XML\s0
representation of the \s-1DTD\s0. This representation exposes both the logical
structure of the \s-1DTD\s0 (the actual meta-structure of its grove) and the
organizational structure of the \s-1DTD\s0 (the declarations and parameter
entities) that comprise its textual form.
.IP "2." 4
Manipulate the \s-1XML\s0 document produced by dtdparse to do whatever you
want. DTDParse is shipped with several programs that demonstrate
various capabilities, including \fBdtdformat\fR which can produce \s-1HTML\s0
or DocBook http://www.oasis\-open.org/docbook/ <http://www.oasis-open.org/docbook/> RefEntry pages for
each element and parameter entity in the \s-1DTD\s0.
.SH "DTDParse XML DTD"
.IX Header "DTDParse XML DTD"
The following is the \s-1XML\s0 \s-1DTD\s0 for \s-1XML\s0 documents created with
dtdparse (the \s-1DTD\s0 is also provided in the file \f(CW\*(C`etc/dtd.dtd\*(C'\fR
of the DTDParse distribution):
.PP
.Vb 2
\&  <!\-\- This is the DTD for the documents produced by DTDParse.
\&       The public identifier for this DTD is:
\&
\&        "\-//Norman Walsh//DTD DTDParse V2.0//EN"
\&
\&    \-\->
\&
\&  <!ELEMENT dtd (notation|entity|element|attlist)+>
\&  <!ATTLIST dtd
\&          version               CDATA   #REQUIRED
\&          unexpanded    CDATA   #IMPLIED
\&          title         CDATA   #IMPLIED
\&          namecase\-general      CDATA   #IMPLIED
\&          namecase\-entity       CDATA   #IMPLIED
\&          xml           CDATA   #IMPLIED
\&          system\-id     CDATA   #IMPLIED
\&          public\-id     CDATA   #IMPLIED
\&          declaration   CDATA   #IMPLIED
\&          created\-by    CDATA   #IMPLIED
\&          created\-on    CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT notation EMPTY>
\&  <!ATTLIST notation
\&          name          CDATA   #REQUIRED
\&          public                CDATA   #IMPLIED
\&          system                CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT entity (text\-expanded?, text?)>
\&  <!ATTLIST entity
\&          name          CDATA   #REQUIRED
\&          type          CDATA   #REQUIRED
\&          notation      CDATA   #IMPLIED
\&          public                CDATA   #IMPLIED
\&          system                CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT text        (#PCDATA)*>
\&  <!ELEMENT text\-expanded       (#PCDATA)*>
\&
\&  <!ELEMENT element (content\-model\-expanded, content\-model?,
\&                     inclusions?, exclusions?)>
\&  <!ATTLIST element
\&          name          CDATA   #REQUIRED
\&          stagm         CDATA   #IMPLIED
\&          etagm         CDATA   #IMPLIED
\&          content\-type  (element|mixed|cdata|empty|rcdata)      #IMPLIED
\&  >
\&
\&  <!ENTITY % cm.mix "sequence\-group|or\-group|and\-group
\&                     |element\-name|parament\-name
\&                     |pcdata|cdata|rcdata|empty">
\&
\&  <!ELEMENT content\-model\-expanded (%cm.mix;)>
\&  <!ELEMENT content\-model (%cm.mix;)>
\&  <!ELEMENT inclusions (%cm.mix;)>
\&  <!ELEMENT exclusions (%cm.mix;)>
\&
\&  <!ELEMENT sequence\-group (%cm.mix;)*>
\&  <!ATTLIST sequence\-group
\&          occurrence    CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT or\-group (%cm.mix;)*>
\&  <!ATTLIST or\-group
\&          occurrence    CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT and\-group (%cm.mix;)*>
\&  <!ATTLIST and\-group
\&          occurrence    CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT element\-name EMPTY>
\&  <!ATTLIST element\-name
\&          name          CDATA   #REQUIRED
\&          occurrence    CDATA   #IMPLIED
\&  >
\&
\&  <!ELEMENT parament\-name EMPTY>
\&  <!ATTLIST parament\-name
\&          name          CDATA   #REQUIRED
\&  >
\&
\&  <!ELEMENT empty EMPTY>
\&  <!ELEMENT pcdata EMPTY>
\&  <!ELEMENT cdata EMPTY>
\&  <!ELEMENT rcdata EMPTY>
\&
\&  <!ELEMENT attlist (attdecl, attribute+)>
\&  <!ATTLIST attlist
\&          name  CDATA   #REQUIRED
\&  >
\&
\&  <!ELEMENT attdecl (#PCDATA)>
\&
\&  <!ELEMENT attribute EMPTY>
\&  <!ATTLIST attribute
\&          name          CDATA   #REQUIRED
\&          type          CDATA   #REQUIRED
\&          enumeration   (yes|no|notation)       #IMPLIED
\&          value         CDATA   #REQUIRED
\&          default               CDATA   #REQUIRED
\&  >
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
dtdparse,
dtdformat,
dtddiff,
dtdflatten,
SGML::DTDParse::DTD
.SH "PREREQUISITES"
.IX Header "PREREQUISITES"
The prerequisites listed are for all modules and scripts:
.PP
\&\fBGetopt::Long\fR,
\&\fBText::DelimMatch\fR,
\&\fBXML::Parser\fR,
\&\fB\s-1XML::DOM\s0\fR
.PP
For prerequisites that apply for a specific script or module,
see the individual scripts' and modules' reference pages.
.SH "AVAILABILITY"
.IX Header "AVAILABILITY"
<\fIhttp://dtdparse.sourceforge.net/\fR>
.SH "AUTHORS"
.IX Header "AUTHORS"
DTDParse package originally developed by Norman Walsh,
<ndw@nwalsh.com>.
.PP
Earl Hood, <earl@earlhood.com>, picked up support and
maintenance.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 2
\&  Copyright (C) 1999\-2001, 2003 Norman Walsh
\&  Copyright (C) 2005, Earl Hood
.Ve
.PP
DTDParse may be copied only under the terms of either the Artistic
License or the \s-1GNU\s0 General Public License, which may be found in the
DTDParse distribution.