Google

[%# # 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_XPath' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="PRE-REQUISITES" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="AUTHORS" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; PROCESS tocitem title ="SEE ALSO" subs = []; END %] [% WRAPPER section title="SYNOPSIS" -%]
    # load plugin and specify XML file to parse

    # load plugin and specify XML text to parse

    # then call any XPath methods (see XML::XPath docs)
    [% tt_start_tag %] FOREACH page = xpath.findnodes('/html/body/page') [% tt_end_tag %]
       [% tt_start_tag %] page.getAttribute('title') [% tt_end_tag %]
    [% tt_start_tag %] END [% tt_end_tag %]


    # define VIEW to present node(s)
       # 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.getAttribute('title') | html [% tt_end_tag %]</h1>
       [% tt_start_tag %] item.content(view) [% tt_end_tag %]
       [% tt_start_tag %] END [% tt_end_tag %]


       # default template block passes tags through and renders
       # out the children recursivly
          item.starttag; item.content(view); item.endtag;
       END [% tt_end_tag %]
       
       # block to generate simple text
       [% tt_start_tag %] BLOCK text; item | html; END [% tt_end_tag %]
    [% tt_start_tag %] END [% tt_end_tag %]


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


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

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

This plugin requires that the XML::Parser and XML::XPath modules be 
installed.  These are available from CPAN:



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

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

This is a Template Toolkit plugin interfacing to the XML::XPath module.




All methods implemented by the XML::XPath modules are available.  In
addition, the XML::XPath::Node::Element module implements
present($view) and content($view) methods method for seamless
integration with Template Toolkit VIEWs.  The XML::XPath::Node::Text
module is also adorned with a present($view) method which presents
itself via the view using the 'text' template.




To aid the reconstruction of XML, methods starttag and endtag are
added to XML::XPath::Node::Element which return the start and
end tag for that element.  This means that you can easily do:



  [% tt_start_tag %] item.starttag [% tt_end_tag %][% tt_start_tag %] item.content(view) [% tt_end_tag %][% tt_start_tag %] item.endtag [% tt_end_tag %]



To render out the start tag, followed by the content rendered in the
view "view", followed by the end tag.


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

This plugin module was written by Andy Wardley <abw@kfs.org>.




The XML::XPath module is by Matt Sergeant <matt@sergeant.org>.


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

2.54, distributed as part of the
Template Toolkit version 2.08, released on 30 July 2002.


[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]
  Copyright (C) 1996-2002 Andy Wardley.  All Rights Reserved.
  Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.



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::XPath', 'XML::XPath') -%], [% ttlink('XML::Parser', 'XML::Parser') -%]


[%- END %]