[%# # IMPORTANT NOTE # This documentation is generated automatically from source # templates. Any changes you make here may be lost. # # The 'docsrc' documentation source bundle is available for download # from http://www.template-toolkit.org/docs.html and contains all # the source templates, XML files, scripts, etc., from which the # documentation for the Template Toolkit is built. -%] [% META book = 'Modules' page = 'Plugin_XML_DOM' %] [% WRAPPER toc; INCLUDE tocitem title = 'SYNOPSIS'; INCLUDE tocitem title = 'PRE-REQUISITES'; INCLUDE tocitem title = 'DESCRIPTION'; INCLUDE tocitem title = 'METHODS' subs = [ 'parse()', 'toTemplate()', 'childrenToTemplate()', 'allChildrenToTemplate()' ]; INCLUDE tocitem title = 'PRESENTING DOM NODES USING VIEWS'; INCLUDE tocitem title = 'AUTHORS'; INCLUDE tocitem title = 'VERSION'; INCLUDE tocitem title = 'HISTORY'; INCLUDE tocitem title = 'BUGS'; INCLUDE tocitem title = 'COPYRIGHT'; INCLUDE tocitem title = 'SEE ALSO'; END %] [% WRAPPER section title='SYNOPSIS' -%]

        # load plugin
        [% tt_start_tag %] USE dom = XML.DOM [% tt_end_tag %]

        # also provide XML::Parser options
        [% tt_start_tag %] USE dom = XML.DOM(ProtocolEncoding =E<gt> 'ISO-8859-1') [% tt_end_tag %]

        # parse an XML file
        [% tt_start_tag %] doc = dom.parse(filename) [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse(file => filename) [% tt_end_tag %]

        # parse XML text
        [% tt_start_tag %] doc = dom.parse(xmltext) [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse(text => xmltext) [% tt_end_tag %]

        # call any XML::DOM methods on document/element nodes
        [% tt_start_tag %] FOREACH node = doc.getElementsByTagName('report') [% tt_end_tag %]
           * [% tt_start_tag %] node.getAttribute('title') [% tt_end_tag %]     # or just '[% tt_start_tag %] node.title [% tt_end_tag %]'
        [% tt_start_tag %] END [% tt_end_tag %]

        # define VIEW to present node(s)
        [% tt_start_tag %] VIEW report notfound='xmlstring' [% tt_end_tag %]
           # handler block for a <report>...</report> element
           [% tt_start_tag %] BLOCK report [% tt_end_tag %]
              [% tt_start_tag %] item.content(view) [% tt_end_tag %]
           [% tt_start_tag %] END [% tt_end_tag %]

           # handler block for a <section title="...">...</section> element
           [% tt_start_tag %] BLOCK section [% tt_end_tag %]
           <h1>[% tt_start_tag %] item.title [% tt_end_tag %]</h1>
           [% tt_start_tag %] item.content(view) [% tt_end_tag %]
           [% tt_start_tag %] END [% tt_end_tag %]

           # default template block converts item to string representation
           [% tt_start_tag %] BLOCK xmlstring; item.toString; END [% tt_end_tag %]

           # block to generate simple text
           [% tt_start_tag %] BLOCK text; item; END [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

        # now present node (and children) via view
        [% tt_start_tag %] report.print(node) [% tt_end_tag %]

        # or print node content via view
        [% tt_start_tag %] node.content(report) [% tt_end_tag %]

        # following methods are soon to be deprecated in favour of views
        [% tt_start_tag %] node.toTemplate [% tt_end_tag %]
        [% tt_start_tag %] node.childrenToTemplate [% tt_end_tag %]
        [% tt_start_tag %] node.allChildrenToTemplate [% tt_end_tag %]

[%- END %] [% WRAPPER section title='PRE-REQUISITES' -%]

This plugin requires that the XML::Parser (2.19 or later) and XML::DOM (1.27 or later) modules be installed. These are available from CPAN:

        http://www.cpan.org/modules/by-module/XML

Note that the XML::DOM module is now distributed as part of the 'libxml-enno' bundle.

[%- END %] [% WRAPPER section title='DESCRIPTION' -%]

This is a Template Toolkit plugin interfacing to the XML::DOM module. The plugin loads the XML::DOM module and creates an XML::DOM::Parser object which is stored internally. The parse() method can then be called on the plugin to parse an XML stream into a DOM document.

        [% tt_start_tag %] USE dom = XML.DOM [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse('/tmp/myxmlfile') [% tt_end_tag %]

NOTE: earlier versions of this XML::DOM plugin expected a filename to be passed as an argument to the constructor. This is no longer supported due to the fact that it caused a serious memory leak. We apologise for the inconvenience but must insist that you change your templates as shown:

        # OLD STYLE: now fails with a warning
        [% tt_start_tag %] USE dom = XML.DOM('tmp/myxmlfile') [% tt_end_tag %]

        # NEW STYLE: do this instead
        [% tt_start_tag %] USE dom = XML.DOM [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse('tmp/myxmlfile') [% tt_end_tag %]

The root of the problem lies in XML::DOM creating massive circular references in the object models it constructs. The dispose() method must be called on each document to release the memory that it would otherwise hold indefinately. The XML::DOM plugin object (i.e. 'dom' in these examples) acts as a sentinel for the documents it creates ('doc' and any others). When the plugin object goes out of scope at the end of the current template, it will automatically call dispose() on any documents that it has created. Note that if you dispose of the the plugin object before the end of the block (i.e. by assigning a new value to the 'dom' variable) then the documents will also be disposed at that point and should not be used thereafter.

        [% tt_start_tag %] USE dom = XML.DOM [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse('/tmp/myfile') [% tt_end_tag %]
        [% tt_start_tag %] dom = 'new value' [% tt_end_tag %]     # releases XML.DOM plugin and calls
                                    # dispose() on 'doc', so don't use it!

Any template processing parameters (see toTemplate() method and friends, below) can be specified with the constructor and will be used to define defaults for the object.

        [% tt_start_tag %] USE dom = XML.DOM(prefix => 'theme1/') [% tt_end_tag %]

The plugin constructor will also accept configuration options destined for the XML::Parser object:

        [% tt_start_tag %] USE dom = XML.DOM(ProtocolEncoding => 'ISO-8859-1') [% tt_end_tag %]

[%- END %] [% WRAPPER section title='METHODS' -%][% WRAPPER subsection title = 'parse()' -%]

The parse() method accepts a positional parameter which contains a filename or XML string. It is assumed to be a filename unless it contains a < character.

        [% tt_start_tag %] xmlfile = '/tmp/foo.xml' [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse(xmlfile) [% tt_end_tag %]

        [% tt_start_tag %] xmltext = BLOCK [% tt_end_tag %]
        <xml>
          <blah><etc/></blah>
          ...
        </xml>
        [% tt_start_tag %] END [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse(xmltext) [% tt_end_tag %]

The named parameters 'file' (or 'filename') and 'text' (or 'xml') can also be used:

        [% tt_start_tag %] doc = dom.parse(file = xmlfile) [% tt_end_tag %]
        [% tt_start_tag %] doc = dom.parse(text = xmltext) [% tt_end_tag %]

The parse() method returns an instance of the XML::DOM::Document object representing the parsed document in DOM form. You can then call any XML::DOM methods on the document node and other nodes that its methods may return. See [% ttlink('XML::DOM') -%] for full details.

        [% tt_start_tag %] FOREACH node = doc.getElementsByTagName('CODEBASE') [% tt_end_tag %]
           * [% tt_start_tag %] node.getAttribute('href') [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

This plugin also provides an AUTOLOAD method for XML::DOM::Node which calls getAttribute() for any undefined methods. Thus, you can use the short form of

        [% tt_start_tag %] node.attrib [% tt_end_tag %]

in place of

        [% tt_start_tag %] node.getAttribute('attrib') [% tt_end_tag %]

[%- END %] [% WRAPPER subsection title = 'toTemplate()' -%]

NOTE: This method will soon be deprecated in favour of the VIEW based approach desribed below.

This method will process a template for the current node on which it is called. The template name is constructed from the node TagName with any optional 'prefix' and/or 'suffix' options applied. A 'default' template can be named to be used when the specific template cannot be found. The node object is available to the template as the 'node' variable.

Thus, for this XML fragment:

        <page title="Hello World!">
           ...
        </page>

and this template definition:

        [% tt_start_tag %] BLOCK page [% tt_end_tag %]
        Page: [% tt_start_tag %] node.title [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

the output of calling toTemplate() on the <page> node would be:

        Page: Hello World!

[%- END %] [% WRAPPER subsection title = 'childrenToTemplate()' -%]

NOTE: This method will soon be deprecated in favour of the VIEW based approach desribed below.

Effectively calls toTemplate() for the current node and then for each of the node's children. By default, the parent template is processed first, followed by each of the children. The 'children' closure can be called from within the parent template to have them processed and output at that point. This then suppresses the children from being processed after the parent template.

Thus, for this XML fragment:

        <foo>
          <bar id="1"/>
          <bar id="2"/>
        </foo>

and these template definitions:

        [% tt_start_tag %] BLOCK foo [% tt_end_tag %]
        start of foo
        end of foo
        [% tt_start_tag %] END [% tt_end_tag %]

        [% tt_start_tag %] BLOCK bar [% tt_end_tag %]
        bar [% tt_start_tag %] node.id [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

the output of calling childrenToTemplate() on the parent <foo> node would be:

        start of foo
        end of foo
        bar 1
        bar 2

Adding a call to [% tt_start_tag %] children [% tt_end_tag %] in the 'foo' template:

        [% tt_start_tag %] BLOCK foo [% tt_end_tag %]
        start of foo
        [% tt_start_tag %] children [% tt_end_tag %]
        end of foo
        [% tt_start_tag %] END [% tt_end_tag %]

then creates output as:

        start of foo
        bar 1
        bar 2
        end of foo

The 'children' closure can also be called as a method of the node, if you prefer:

        [% tt_start_tag %] BLOCK foo [% tt_end_tag %]
        start of foo
        [% tt_start_tag %] node.children [% tt_end_tag %]
        end of foo
        [% tt_start_tag %] END [% tt_end_tag %]

The 'prune' closure is also defined and can be called as [% tt_start_tag %] prune [% tt_end_tag %] or [% tt_start_tag %] node.prune [% tt_end_tag %]. It prunes the currrent node, preventing any descendants from being further processed.

        [% tt_start_tag %] BLOCK anynode [% tt_end_tag %]
        [% tt_start_tag %] node.toString; node.prune [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

[%- END %] [% WRAPPER subsection title = 'allChildrenToTemplate()' -%]

NOTE: This method will soon be deprecated in favour of the VIEW based approach desribed below.

Similar to childrenToTemplate() but processing all descendants (i.e. children of children and so on) recursively. This is identical to calling the childrenToTemplate() method with the 'deep' flag set to any true value.

[%- END %] [%- END %] [% WRAPPER section title='PRESENTING DOM NODES USING VIEWS' -%]

You can define a VIEW to present all or part of a DOM tree by automatically mapping elements onto templates. Consider a source document like the following:

        <report>
          <section title="Introduction">
            <p>
            Blah blah.
            <ul>
              <li>Item 1</li>
              <li>item 2</li>
            </ul>
            </p>
          </section>
          <section title="The Gory Details">
            ...
          </section>
        </report>

We can load it up via the XML::DOM plugin and fetch the node for the <report> element.

        [% tt_start_tag %] USE dom = XML.DOM;
           doc = dom.parse(file => filename);
           report = doc.getElementsByTagName('report')
        [% tt_end_tag %]

We can then define a VIEW as follows to present this document fragment in a particular way. The [% ttlink('Template::Manual::Views') -%] documentation contains further details on the VIEW directive and various configuration options it supports.

        [% tt_start_tag %] VIEW report_view notfound='xmlstring' [% tt_end_tag %]
           # handler block for a <report>...</report> element
           [% tt_start_tag %] BLOCK report [% tt_end_tag %]
              [% tt_start_tag %] item.content(view) [% tt_end_tag %]
           [% tt_start_tag %] END [% tt_end_tag %]

           # handler block for a <section title="...">...</section> element
           [% tt_start_tag %] BLOCK section [% tt_end_tag %]
           <h1>[% tt_start_tag %] item.title [% tt_end_tag %]</h1>
           [% tt_start_tag %] item.content(view) [% tt_end_tag %]
           [% tt_start_tag %] END [% tt_end_tag %]

           # default template block converts item to string representation
           [% tt_start_tag %] BLOCK xmlstring; item.toString; END [% tt_end_tag %]

           # block to generate simple text
           [% tt_start_tag %] BLOCK text; item; END [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

Each BLOCK defined within the VIEW represents a presentation style for a particular element or elements. The current node is available via the 'item' variable. Elements that contain other content can generate it according to the current view by calling [% tt_start_tag %] item.content(view) [% tt_end_tag %]. Elements that don't have a specific template defined are mapped to the 'xmlstring' template via the 'notfound' parameter specified in the VIEW header. This replicates the node as an XML string, effectively allowing general XML/XHTML markup to be passed through unmodified.

To present the report node via the view, we simply call:

        [% tt_start_tag %] report_view.print(report) [% tt_end_tag %]

The output from the above example would look something like this:

        <h1>Introduction</h1>
        <p>
        Blah blah.
        <ul>
          <li>Item 1</li>
          <li>item 2</li>
        </ul>
        </p>

        <h1>The Gory Details</h1>
        ...

To print just the content of the report node (i.e. don't process the 'report' template for the report node), you can call:

        [% tt_start_tag %] report.content(report_view) [% tt_end_tag %]

[%- END %] [% WRAPPER section title='AUTHORS' -%]

This plugin module was written by Andy Wardley <abw@kfs.org> and Simon Matthews <sam@knowledgepool.com>.

The XML::DOM module is by Enno Derksen <enno@att.com> and Clark Cooper <coopercl@sch.ge.com>. It extends the the XML::Parser module, also by Clark Cooper which itself is built on James Clark's expat library.

[%- END %] [% WRAPPER section title='VERSION' -%]

2.6, distributed as part of the Template Toolkit version 2.06, released on 07 November 2001.

[%- END %] [% WRAPPER section title='HISTORY' -%]

Version 2.5 : updated for use with version 1.27 of the XML::DOM module.

- XML::DOM 1.27 now uses array references as the underlying data type for DOM nodes instead of hash array references. User data is now bound to the _UserData node entry instead of being forced directly into the node hash.

[%- END %] [% WRAPPER section title='BUGS' -%]

The childrenToTemplate() and allChildrenToTemplate() methods can easily slip into deep recursion.

The 'verbose' and 'nospace' options are not documented. They may change in the near future.

[%- END %] [% WRAPPER section title='COPYRIGHT' -%]

Copyright (C) 2000-2001 Andy Wardley, Simon Matthews. All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

[%- END %] [% WRAPPER section title='SEE ALSO' -%]

[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('XML::DOM', 'XML::DOM') -%], [% ttlink('XML::Parser', 'XML::Parser') -%]

[%- END %]