Ken MacLeod > XML-Grove-0.46alpha > XML::Grove::AsCanonXML

Download:
XML-Grove-0.46alpha.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Source  

NAME ^

XML::Grove::AsCanonXML - output XML objects in canonical XML

SYNOPSIS ^

 use XML::Grove::AsCanonXML;

 # Using as_canon_xml method on XML::Grove objects:
 $string = $xml_object->as_canon_xml( OPTIONS );

 # Using an XML::Grove::AsCanonXML instance:
 $writer = XML::Grove::AsCanonXML->new( OPTIONS );

 $string = $writer->as_canon_xml($xml_object);
 $writer->as_canon_xml($xml_object, $file_handle);

DESCRIPTION ^

XML::Grove::AsCanonXML will return a string or write a stream of canonical XML for an XML object and it's content (if any).

XML::Grove::AsCanonXML objects hold the options used for writing the XML objects. Options can be supplied when the the object is created,

    $writer = XML::Grove::AsCanonXML->new( Comments => 1 );

or modified at any time before writing an XML object by setting the option directly in the `$writer' hash.

OPTIONS ^

Comments

By default comments are not written to the output. Setting comment to TRUE will include comments in the output.

AUTHOR ^

Ken MacLeod, ken@bitsko.slc.ut.us

SEE ALSO ^

perl(1), XML::Parser(3), XML::Grove(3).

James Clark's Canonical XML definition <http://www.jclark.com/xml/canonxml.html>

syntax highlighting: