XML::DTD - Perl module for parsing XML DTDs


XML-DTD documentation  | view source Contained in the XML-DTD distribution.

Index


NAME

Top

XML::DTD - Perl module for parsing XML DTDs

SYNOPSIS

Top

  use XML::DTD;

  my $dtd = new XML::DTD;
  open(FH,'<file.dtd');
  $dtd->fread(*FH);
  close(FH);
  $dtd->fwrite(*STDOUT);

ABSTRACT

Top

  XML::DTD is a Perl module for parsing XML DTD files.

DESCRIPTION

Top

  XML::DTD is a Perl module for parsing XML DTDs. The following
  methods are provided.

new
  $dtd = new XML::DTD [ ($val) ];

Constructs a new XML::DTD object.

Its parser will be validating, and hence will make parameter entity substitutions, if the argument $val is present and has a boolean value of true.

fread
  $dtd->fread(*FILEHANDLE [, $uri]);

Parse a DTD file. If the URI is passed, it is used as the URI for the document entity.

sread
  $dtd->sread($string [, $uri]);

Parse DTD text in a string. If the URI is passed, it is used as the URI for the document entity.

fwrite
  $dtd->fwrite(*FILEHANDLE);

Write the DTD to a file.

swrite
  $string = $dtd->swrite();

Return the DTD text as a string.

fwritexml
  $dtd->fwritexml(*FILEHANDLE);

Write an XML representation of the DTD to a file.

swritexml
  $string = $dtd->swritexml();

Return an XML representation of the DTD text as a string.

elementnames
  $elts = $dtd->elementnames;

Return an array of element names as an array reference.

element
  $eltobj = $dtd->element('elementname');

Return the element object (of type XML::DTD::Element) associated with the specified name.

attlist
  $attlistobj = $dtd->attlist('elementname');

Return the attribute list object (of type XML::DTD::AttList) associated with the specified name.

entman
  $entmanobj = $dtd->entman;

Return the associated entity manager object (of type XML::DTD::EntityManager).

CAVEATS

Top

The DTD parser is an ugly hack, and while any valid DTD should be parsed correctly, some types of DTD errors may be ignored, and when detected, the error messages are often not very useful. In summary, use other tools, such as xmllint for checking the validity of a DTD.

SEE ALSO

Top

XML::DTD::Parser, XML::DTD::Element, XML::DTD::Attlist, XML::DTD::EntityManager, The XML 1.0 W3C Recommendation at http://www.w3.org/TR/REC-xml/

AUTHOR

Top

Brendt Wohlberg <wohl@cpan.org>

COPYRIGHT AND LICENSE

Top

ACKNOWLEDGMENTS

Top

Peter Lamb <Peter.Lamb@csiro.au> added fetching of external entities and improved entity substitution.


XML-DTD documentation  | view source Contained in the XML-DTD distribution.