[%#
# 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_Simple'
%]
[% WRAPPER toc;
PROCESS tocitem
title ="SYNOPSIS"
subs = [];
PROCESS tocitem
title ="DESCRIPTION"
subs = [];
PROCESS tocitem
title ="PRE-REQUISITES"
subs = [];
PROCESS tocitem
title ="AUTHORS"
subs = [];
PROCESS tocitem
title ="VERSION"
subs = [];
PROCESS tocitem
title ="COPYRIGHT"
subs = [];
PROCESS tocitem
title ="SEE ALSO"
subs = [];
END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
title="SYNOPSIS"
-%]<pre> # load plugin and specify XML text or file to parse
[% tt_start_tag %] USE xml = XML.Simple(xml_file_or_text) [% tt_end_tag %]</pre>
<pre> # or load plugin as an object...
[% tt_start_tag %] USE xml = XML.Simple [% tt_end_tag %]</pre>
<pre> # ...then use XMLin or XMLout as usual
[% tt_start_tag %] xml.XMLout(data_ref, args) [% tt_end_tag %]
[% tt_start_tag %] xml.XMLin(xml_file_or_text, args) [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
title="DESCRIPTION"
-%]<p>
This is a Template Toolkit plugin interfacing to the XML::Simple module.
</p>
[%- END %]
[% WRAPPER section
title="PRE-REQUISITES"
-%]<p>
This plugin requires that the XML::Parser and XML::Simple modules be
installed. These are available from CPAN:
</p>
<pre> http://www.cpan.org/modules/by-module/XML</pre>
[%- END %]
[% WRAPPER section
title="AUTHORS"
-%]<p>
This plugin wrapper module was written by Andy Wardley
<abw@wardley.org>.
</p>
<p>
The XML::Simple module which implements all the core functionality
was written by Grant McLean <grantm@web.co.nz>.
</p>
[%- END %]
[% WRAPPER section
title="VERSION"
-%]<p>
2.65, distributed as part of the
Template Toolkit version 2.14, released on 04 October 2004.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
-%]<pre> Copyright (C) 1996-2004 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
title="SEE ALSO"
-%]<p>
[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('XML::Simple', 'XML::Simple') -%], [% ttlink('XML::Parser', 'XML::Parser') -%]
</p>
[%- END %]