debian man page for template::plugin::xml::xpath

Template::Plugin::XML::XPath(3pm)			User Contributed Perl Documentation			 Template::Plugin::XML::XPath(3pm)

NAME
       Template::Plugin::XML::XPath - Plugin interface to XML::XPath

SYNOPSIS
	   # load plugin and specify XML file to parse
	   [% USE xpath = XML.XPath(xmlfile) %]
	   [% USE xpath = XML.XPath(file => xmlfile) %]
	   [% USE xpath = XML.XPath(filename => xmlfile) %]

	   # load plugin and specify XML text to parse
	   [% USE xpath = XML.XPath(xmltext) %]
	   [% USE xpath = XML.XPath(xml => xmltext) %]
	   [% USE xpath = XML.XPath(text => xmltext) %]

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

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

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

	      # default template block passes tags through and renders
	      # out the children recursivly
	      [% BLOCK xmlstring;
		 item.starttag; item.content(view); item.endtag;
	      END %]

	      # block to generate simple text
	      [% BLOCK text; item | html; END %]
	   [% END %]

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

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

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:

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

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

AUTHORS
       This plugin module was written by Andy Wardley.

       The XML::XPath module is by Matt Sergeant.

COPYRIGHT
       Copyright (C) 1996-2006 Andy Wardley.  All Rights Reserved.

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

SEE ALSO
       Template::Plugin, XML::XPath, XML::Parser

perl v5.8.8							    2008-03-01					 Template::Plugin::XML::XPath(3pm)