dtd.pl

dtd.pl is a Perl library that parses an SGML document type defintion (DTD) and builds up data structures containing the structural content of the DTD.

Note:: dtd.pl is distributed with dtd2html. Later releases may come out without a public announcement (especially for bux fix releases). For the latest release and information on dtd2html/dtd.pl, look at my home page at the University of California: Irvine.

Audience

I assume the reader knows about the scope of packages and how to access variables/subroutines defined in packages. If not, refer to perl(1) or any book on Perl. The reader should be familiar with the basic concepts of SGML.

Unless stated, or implied, otherwise, all Perl variables mentioned are within the scope of package dtd.

Usage

If installed correctly, the following Perl statement can be used to access the dtd library routines:

require "dtd/dtd.pl";

The following routines are defined:

Parsing Routines

main'DTDread_dtd
Parse an SGML DTD. This routine is the heart of the dtd.pl library. Its description describes the features and limitations of dtd.pl when parsing a SGML DTD.
main'DTDread_mapfile
Read in the contents of an entity map file.
main'DTDset_comment_callback
Set callback function for SGML comment declarations.
main'DTDset_pi_callback
Set callback function for processing instructions.
main'DTDset_verbosity
Set verbosity mode for DTDread_dtd.

Data Access Routines

main'DTDget_base_children
Get elements in an element's base content group.
main'DTDget_elem_attr
Get the attributes of an element.
main'DTDget_elements
Get all elements defined in the DTD.
main'DTDget_exc_children
Get elements in an element's exclusion content group.
main'DTDget_inc_children
Get elements in an element's inclusion content group.
main'DTDget_parents
Get all possible parent elements of an element.
main'DTDget_top_elements
Get top-most elements defined in the DTD.

Utility Routines