XML::Handler::XMLWriter − a PerlSAX handler for writing readable XML


 use XML::Parser::PerlSAX;
 use XML::Handler::XMLWriter;
 $my_handler = XML::Handler::XMLWriter−>new( I<OPTIONS> );
 XML::Parser::PerlSAX−>new−>parse(Source => { SystemId => 'REC−xml−19980210.xml' },
                                  Handler => $my_handler);


"XML::Handler::XMLWriter" is a PerlSAX handler for writing readable XML (in contrast to Canonical XML , for example). XML::Handler::XMLWriter can be used with a parser to reformat XML , with XML::DOM or XML::Grove to write out XML , or with other PerlSAX modules that generate events.

"XML::Handler::XMLWriter" is intended to be used with PerlSAX event generators and does not perform any checking itself (for example, matching start and end element events). If you want to generate XML directly from your Perl code, use the XML::Writer module. XML::Writer has an easy to use interface and performs many checks to make sure that the XML you generate is well-formed.

"XML::Handler::XMLWriter" is a subclass of "XML::Handler::Subs". "XML::Handler::XMLWriter" can be further subclassed to alter it’s behavior or to add element-specific handling. In the subclass, each time an element starts, a method by that name prefixed with ‘s_’ is called with the element to be processed. Each time an element ends, a method with that name prefixed with ‘e_’ is called. Any special characters in the element name are replaced by underscores. If there isn’t a start or end method for an element, the default action is to write the start or end tag. Start and end methods can use the ‘"print_start_element()"’ and ‘"print_end_element()"’ methods to print start or end tags. Subclasses can call the ‘"print()"’ method to write additional output.

Subclassing XML::Handler::XMLWriter in this way is similar to XML::Parser’s Stream style.

XML::Handler::Subs maintains a stack of element names, ‘"$self−"{Names}’, and a stack of element nodes, ‘"$self−"{Nodes}>’ that can be used by subclasses. The current element is pushed on the stacks before calling an element-name start method and popped off the stacks after calling the element-name end method.

See XML::Handler::Subs for additional methods.

In addition to the standard PerlSAX handler methods (see PerlSAX for descriptions), XML::Handler::XMLWriter supports the following methods:
new( OPTIONS )

Creates and returns a new instance of XML::Handler::XMLWriter with the given OPTIONS . Options may be changed at any time by modifying them directly in the hash returned. OPTIONS can be a list of key, value pairs or a hash. The following OPTIONS are supported:

An IO::Handle or one of it’s subclasses (such as IO::File), if this parameter is not present and the AsString option is not used, the module will write to standard output.


Return the generated XML as a string from the ‘"parse()"’ method of the PerlSAX event generator.


A true or false value; if this parameter is present and its value is true, then the module will insert an extra newline before the closing delimiter of start, end, and empty tags to guarantee that the document does not end up as a single, long line. If the paramter is not present, the module will not insert the newlines.


A true or false value; if this parameter is present and its value is true, then the module will generate SGML rather than XML .


Print a start tag for ‘$element’. This is the default action for the PerlSAX ‘"start_element()"’ handler, but subclasses may use this if they define a start method for an element.


Prints an end tag for ‘$element’. This is the default action for the PerlSAX ‘"end_element()"’ handler, but subclasses may use this if they define a start method for an element.


Write ‘$output’ to Output and/or append it to the string to be returned. Subclasses may use this to write additional output.


An Elements option that provides finer control over newlines than the Newlines option, where you can choose before and after newline for element start and end tags. Inspired by the Python XMLWriter.

Support Doctype and XML declarations.


Ken MacLeod, ken@bitsko.slc.ut.us This module is partially derived from XML::Writer by David Megginson.


perl(1), PerlSAX.pod(3)


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.