.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "XML::Handler::CanonXMLWriter 3"
.TH XML::Handler::CanonXMLWriter 3 2024-07-12 "perl v5.38.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
XML::Handler::CanonXMLWriter \- output XML in canonical XML format
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use XML::Handler::CanonXMLWriter;
\&
\& $writer = XML::Handler::CanonXMLWriter OPTIONS;
\& $parser\->parse(Handler => $writer);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`XML::Handler::CanonXMLWriter\*(C'\fR is a PerlSAX handler that will return
a string or write a stream of canonical XML for an XML instance and it's
content.
.PP
\&\f(CW\*(C`XML::Handler::CanonXMLWriter\*(C'\fR objects hold the options used for
writing the XML objects.  Options can be supplied when the the object
is created,
.PP
.Vb 1
\&    $writer = new XML::Handler::CanonXMLWriter PrintComments => 1;
.Ve
.PP
or modified at any time before calling the parser's `\f(CWparse()\fR' method:
.PP
.Vb 1
\&    $writer\->{PrintComments} = 0;
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
.IP IOHandle 4
.IX Item "IOHandle"
IOHandle contains a handle for writing the canonical XML to.  If an
IOHandle is not provided, the canonical XML string will be returned
from `\f(CWparse()\fR'.
.IP PrintComments 4
.IX Item "PrintComments"
By default comments are not written to the output.  Setting comment to
a true value will include comments in the output.
.SH AUTHOR
.IX Header "AUTHOR"
Ken MacLeod, ken@bitsko.slc.ut.us
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), PerlSAX
.PP
James Clark's Canonical XML definition
<http://www.jclark.com/xml/canonxml.html>