home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Plugins.pod < prev    next >
Encoding:
Text File  |  2004-01-30  |  15.8 KB  |  553 lines
  1. #============================================================= -*-perl-*-
  2. #
  3. # Template::Manual::Plugins
  4. #
  5. # DESCRIPTION
  6. #   This section lists the standard plugins which can be used to extend
  7. #   the runtime functionality of the Template Toolkit. The plugins are
  8. #   distributed with the Template Toolkit but may required additional
  9. #   modules from CPAN.
  10. #
  11. # AUTHOR
  12. #   Andy Wardley  <abw@andywardley.com>
  13. #
  14. # COPYRIGHT
  15. #   Copyright (C) 1996-2001 Andy Wardley.  All Rights Reserved.
  16. #   Copyright (C) 1998-2001 Canon Research Centre Europe Ltd.
  17. #
  18. #   This module is free software; you can redistribute it and/or
  19. #   modify it under the same terms as Perl itself.
  20. #
  21. # REVISION
  22. #   
  23. #
  24. #========================================================================
  25.  
  26.  
  27. #------------------------------------------------------------------------
  28. # IMPORTANT NOTE
  29. #   This documentation is generated automatically from source
  30. #   templates.  Any changes you make here may be lost.
  31. # 
  32. #   The 'docsrc' documentation source bundle is available for download
  33. #   from http://www.template-toolkit.org/docs.html and contains all
  34. #   the source templates, XML files, scripts, etc., from which the
  35. #   documentation for the Template Toolkit is built.
  36. #------------------------------------------------------------------------
  37.  
  38. =head1 NAME
  39.  
  40. Template::Manual::Plugins - Standard plugins
  41.  
  42. =head1 DESCRIPTION
  43.  
  44. This section lists the standard plugins which can be used to extend the
  45. runtime functionality of the Template Toolkit. The plugins are
  46. distributed with the Template Toolkit but may required additional
  47. modules from CPAN.
  48.  
  49.  
  50.  
  51. =head1 TEMPLATE TOOLKIT PLUGINS
  52.  
  53. The following plugin modules are distributed with the Template
  54. Toolkit.  Some of the plugins interface to external modules (detailed
  55. below) which should be downloaded from any CPAN site and installed
  56. before using the plugin.
  57.  
  58. =head2 Autoformat
  59.  
  60. The Autoformat plugin is an interface to Damian Conway's Text::Autoformat 
  61. Perl module which provides advanced text wrapping and formatting.  See
  62. L<Template::Plugin::Autoformat> and L<Text::Autoformat> for further 
  63. details.
  64.  
  65.     [% USE autoformat(left=10, right=20) %]
  66.     [% autoformat(mytext) %]        # call autoformat sub
  67.     [% mytext FILTER autoformat %]  # or use autoformat filter
  68.  
  69. The Text::Autoformat module is available from CPAN:
  70.  
  71.     http://www.cpan.org/modules/by-module/Text/
  72.  
  73. =head2 CGI
  74.  
  75. The CGI plugin is a wrapper around Lincoln Stein's 
  76. E<lt>lstein@genome.wi.mit.eduE<gt> CGI.pm module.  The plugin is 
  77. distributed with the Template Toolkit (see L<Template::Plugin::CGI>)
  78. and the CGI module itself is distributed with recent versions Perl,
  79. or is available from CPAN.
  80.  
  81.     [% USE CGI %]
  82.     [% CGI.param('param_name') %]
  83.     [% CGI.start_form %]
  84.     [% CGI.popup_menu( Name   => 'color', 
  85.                        Values => [ 'Green', 'Brown' ] ) %]
  86.     [% CGI.end_form %]
  87.  
  88. =head2 Datafile
  89.  
  90. Provides an interface to data stored in a plain text file in a simple
  91. delimited format.  The first line in the file specifies field names
  92. which should be delimiter by any non-word character sequence.
  93. Subsequent lines define data using the same delimiter as int he first
  94. line.  Blank lines and comments (lines starting '#') are ignored.  See
  95. L<Template::Plugin::Datafile> for further details.
  96.  
  97. /tmp/mydata:
  98.  
  99.     # define names for each field
  100.     id : email : name : tel
  101.     # here's the data
  102.     fred : fred@here.com : Fred Smith : 555-1234
  103.     bill : bill@here.com : Bill White : 555-5678
  104.  
  105. example:
  106.  
  107.     [% USE userlist = datafile('/tmp/mydata') %]
  108.  
  109.     [% FOREACH user = userlist %]
  110.        [% user.name %] ([% user.id %])
  111.     [% END %]
  112.  
  113. =head2 Date
  114.  
  115. The Date plugin provides an easy way to generate formatted time and date
  116. strings by delegating to the POSIX strftime() routine.   See
  117. L<Template::Plugin::Date> and L<POSIX> for further details.
  118.  
  119.     [% USE date %]
  120.     [% date.format %]        # current time/date
  121.  
  122.     File last modified: [% date.format(template.modtime) %]
  123.  
  124. =head2 Directory
  125.  
  126. The Directory plugin provides a simple interface to a directory and
  127. the files within it.  See L<Template::Plugin::Directory> for further
  128. details.
  129.  
  130.     [% USE dir = Directory('/tmp') %]
  131.     [% FOREACH file = dir.files %]
  132.         # all the plain files in the directory
  133.     [% END %]
  134.     [% FOREACH file = dir.dirs %]
  135.         # all the sub-directories
  136.     [% END %]
  137.  
  138. =head2 DBI
  139.  
  140. The DBI plugin, developed by Simon Matthews
  141. E<lt>sam@knowledgepool.comE<gt>, brings the full power of Tim Bunce's
  142. E<lt>Tim.Bunce@ig.co.ukE<gt> database interface module (DBI) to your
  143. templates.  See L<Template::Plugin::DBI> and L<DBI> for further details.
  144.  
  145.     [% USE DBI('dbi:driver:database', 'user', 'pass') %]
  146.  
  147.     [% FOREACH user = DBI.query( 'SELECT * FROM users' ) %]
  148.        [% user.id %] [% user.name %]
  149.     [% END %]
  150.  
  151. The DBI and relevant DBD modules are available from CPAN:
  152.  
  153.   http://www.cpan.org/modules/by-module/DBI/
  154.  
  155. =head2 Dumper
  156.  
  157. The Dumper plugin provides an interface to the Data::Dumper module.  See
  158. L<Template::Plugin::Dumper> and L<Data::Dumper> for futher details.
  159.  
  160.     [% USE dumper(indent=0, pad="<br>") %]
  161.     [% dumper.dump(myvar, yourvar) %]
  162.  
  163. =head2 File
  164.  
  165. The File plugin provides a general abstraction for files and can be
  166. used to fetch information about specific files within a filesystem.
  167. See L<Template::Plugin::File> for further details.
  168.  
  169.     [% USE File('/tmp/foo.html') %]
  170.     [% File.name %]     # foo.html
  171.     [% File.dir %]      # /tmp
  172.     [% File.mtime %]    # modification time
  173.  
  174. =head2 Filter
  175.  
  176. This module implements a base class plugin which can be subclassed
  177. to easily create your own modules that define and install new filters.
  178.  
  179.     package MyOrg::Template::Plugin::MyFilter;
  180.  
  181.     use Template::Plugin::Filter;
  182.     use base qw( Template::Plugin::Filter );
  183.  
  184.     sub filter {
  185.     my ($self, $text) = @_;
  186.  
  187.     # ...mungify $text...
  188.  
  189.     return $text;
  190.     }
  191.  
  192.     # now load it...
  193.     [% USE MyFilter %]
  194.  
  195.     # ...and use the returned object as a filter
  196.     [% FILTER $MyFilter %]
  197.       ...
  198.     [% END %]
  199.  
  200. See L<Template::Plugin::Filter> for further details.
  201.  
  202. =head2 Format
  203.  
  204. The Format plugin provides a simple way to format text according to a
  205. printf()-like format.   See L<Template::Plugin::Format> for further 
  206. details.
  207.  
  208.     [% USE bold = format('<b>%s</b>') %]
  209.     [% bold('Hello') %]
  210.  
  211. =head2 GD::Image, GD::Polygon, GD::Constants
  212.  
  213. These plugins provide access to the GD graphics library via Lincoln
  214. D. Stein's GD.pm interface.  These plugins allow PNG, JPEG and other
  215. graphical formats to be generated.
  216.  
  217.     [% FILTER null;
  218.         USE im = GD.Image(100,100);
  219.         # allocate some colors
  220.         black = im.colorAllocate(0,   0, 0);
  221.         red   = im.colorAllocate(255,0,  0);
  222.         blue  = im.colorAllocate(0,  0,  255);
  223.         # Draw a blue oval
  224.         im.arc(50,50,95,75,0,360,blue);
  225.         # And fill it with red
  226.         im.fill(50,50,red);
  227.         # Output image in PNG format
  228.         im.png | stdout(1);
  229.        END;
  230.     -%]
  231.  
  232. See L<Template::Plugin::GD::Image> for further details.
  233.  
  234. =head2 GD::Text, GD::Text::Align, GD::Text::Wrap
  235.  
  236. These plugins provide access to Martien Verbruggen's GD::Text,
  237. GD::Text::Align and GD::Text::Wrap modules. These plugins allow the
  238. layout, alignment and wrapping of text when drawing text in GD images.
  239.  
  240.     [% FILTER null;
  241.         USE gd  = GD.Image(200,400);
  242.         USE gdc = GD.Constants;
  243.         black = gd.colorAllocate(0,   0, 0);
  244.         green = gd.colorAllocate(0, 255, 0);
  245.         txt = "This is some long text. " | repeat(10);
  246.         USE wrapbox = GD.Text.Wrap(gd,
  247.          line_space  => 4,
  248.          color       => green,
  249.          text        => txt,
  250.         );
  251.         wrapbox.set_font(gdc.gdMediumBoldFont);
  252.         wrapbox.set(align => 'center', width => 160);
  253.         wrapbox.draw(20, 20);
  254.         gd.png | stdout(1);
  255.       END;
  256.     -%]
  257.  
  258. See L<Template::Plugin::GD::Text>, L<Template::Plugin::GD::Text::Align>
  259. and L<Template::Plugin::GD::Text::Wrap> for further details.
  260.  
  261. =head2 GD::Graph::lines, GD::Graph::bars, GD::Graph::points, GD::Graph::linespoin
  262. ts, GD::Graph::area, GD::Graph::mixed, GD::Graph::pie
  263.  
  264. These plugins provide access to Martien Verbruggen's GD::Graph module
  265. that allows graphs, plots and charts to be created. These plugins allow
  266. graphs, plots and charts to be generated in PNG, JPEG and other
  267. graphical formats.
  268.  
  269.     [% FILTER null;
  270.         data = [
  271.             ["1st","2nd","3rd","4th","5th","6th"],
  272.             [    4,    2,    3,    4,    3,  3.5]
  273.         ];
  274.         USE my_graph = GD.Graph.pie(250, 200);
  275.         my_graph.set(
  276.                 title => 'A Pie Chart',
  277.                 label => 'Label',
  278.                 axislabelclr => 'black',
  279.                 pie_height => 36,
  280.                 transparent => 0,
  281.         );
  282.         my_graph.plot(data).png | stdout(1);
  283.       END;
  284.     -%]
  285.  
  286. See
  287. L<Template::Plugin::GD::Graph::lines>,
  288. L<Template::Plugin::GD::Graph::bars>,
  289. L<Template::Plugin::GD::Graph::points>,
  290. L<Template::Plugin::GD::Graph::linespoints>,
  291. L<Template::Plugin::GD::Graph::area>,
  292. L<Template::Plugin::GD::Graph::mixed>,
  293. L<Template::Plugin::GD::Graph::pie>, and
  294. L<GD::Graph>,
  295. for more details.
  296.  
  297. =head2 GD::Graph::bars3d, GD::Graph::lines3d, GD::Graph::pie3d
  298.  
  299. These plugins provide access to Jeremy Wadsack's GD::Graph3d
  300. module.  This allows 3D bar charts and 3D lines plots to
  301. be generated.
  302.  
  303.     [% FILTER null;
  304.         data = [
  305.             ["1st","2nd","3rd","4th","5th","6th","7th", "8th", "9th"],
  306.             [    1,    2,    5,    6,    3,  1.5,    1,     3,     4],
  307.         ];
  308.         USE my_graph = GD.Graph.bars3d();
  309.         my_graph.set(
  310.             x_label         => 'X Label',
  311.             y_label         => 'Y label',
  312.             title           => 'A 3d Bar Chart',
  313.             y_max_value     => 8,
  314.             y_tick_number   => 8,
  315.             y_label_skip    => 2,
  316.             # shadows
  317.             bar_spacing     => 8,
  318.             shadow_depth    => 4,
  319.             shadowclr       => 'dred',
  320.             transparent     => 0,
  321.         my_graph.plot(data).png | stdout(1);
  322.       END;
  323.     -%]
  324.  
  325. See
  326. L<Template::Plugin::GD::Graph::lines3d>,
  327. L<Template::Plugin::GD::Graph::bars3d>, and
  328. L<Template::Plugin::GD::Graph::pie3d>
  329. for more details.
  330.  
  331. =head2 HTML
  332.  
  333. The HTML plugin is very new and very basic, implementing a few useful
  334. methods for generating HTML.  It is likely to be extended in the future
  335. or integrated with a larger project to generate HTML elements in a generic
  336. way (as discussed recently on the mod_perl mailing list).
  337.  
  338.     [% USE HTML %]
  339.     [% HTML.escape("if (a < b && c > d) ..." %]
  340.     [% HTML.attributes(border => 1, cellpadding => 2) %]
  341.     [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
  342.  
  343. See L<Template::Plugin::HTML> for further details.
  344.  
  345. =head2 Iterator
  346.  
  347. The Iterator plugin provides a way to create a Template::Iterator
  348. object to iterate over a data set.  An iterator is created
  349. automatically by the FOREACH directive and is aliased to the 'loop'
  350. variable.  This plugin allows an iterator to be explicitly created
  351. with a given name, or the default plugin name, 'iterator'.  See
  352. L<Template::Plugin::Iterator> for further details.
  353.  
  354.     [% USE iterator(list, args) %]
  355.  
  356.     [% FOREACH item = iterator %]
  357.        [% '<ul>' IF iterator.first %]
  358.        <li>[% item %]
  359.        [% '</ul>' IF iterator.last %]
  360.     [% END %]
  361.  
  362. =head2 Pod
  363.  
  364. This plugin provides an interface to the L<Pod::POM|Pod::POM> module
  365. which parses POD documents into an internal object model which can
  366. then be traversed and presented through the Template Toolkit.
  367.  
  368.     [% USE Pod(podfile) %]
  369.  
  370.     [% FOREACH head1 = Pod.head1;
  371.      FOREACH head2 = head1/head2;
  372.        ...
  373.          END;
  374.        END
  375.     %]
  376.  
  377. =head2 String
  378.  
  379. The String plugin implements an object-oriented interface for 
  380. manipulating strings.  See L<Template::Plugin::String> for further 
  381. details.
  382.  
  383.     [% USE String 'Hello' %]
  384.     [% String.append(' World') %]
  385.  
  386.     [% msg = String.new('Another string') %]
  387.     [% msg.replace('string', 'text') %]
  388.  
  389.     The string "[% msg %]" is [% msg.length %] characters long.
  390.  
  391. =head2 Table
  392.  
  393. The Table plugin allows you to format a list of data items into a 
  394. virtual table by specifying a fixed number of rows or columns, with 
  395. an optional overlap.  See L<Template::Plugin::Table> for further 
  396. details.
  397.  
  398.     [% USE table(list, rows=10, overlap=1) %]
  399.  
  400.     [% FOREACH item = table.col(3) %]
  401.        [% item %]
  402.     [% END %]
  403.  
  404. =head2 URL
  405.  
  406. The URL plugin provides a simple way of contructing URLs from a base
  407. part and a variable set of parameters.  See L<Template::Plugin::URL>
  408. for further details.
  409.  
  410.     [% USE mycgi = url('/cgi-bin/bar.pl', debug=1) %]
  411.  
  412.     [% mycgi %]
  413.        # ==> /cgi/bin/bar.pl?debug=1
  414.  
  415.     [% mycgi(mode='submit') %]
  416.        # ==> /cgi/bin/bar.pl?mode=submit&debug=1
  417.  
  418. =head2 Wrap
  419.  
  420. The Wrap plugin uses the Text::Wrap module by David Muir Sharnoff 
  421. E<lt>muir@idiom.comE<gt> (with help from Tim Pierce and many many others)
  422. to provide simple paragraph formatting.  See L<Template::Plugin::Wrap>
  423. and L<Text::Wrap> for further details.
  424.  
  425.     [% USE wrap %]
  426.     [% wrap(mytext, 40, '* ', '  ') %]    # use wrap sub
  427.     [% mytext FILTER wrap(40) -%]    # or wrap FILTER
  428.  
  429. The Text::Wrap module is available from CPAN:
  430.  
  431.     http://www.cpan.org/modules/by-module/Text/
  432.  
  433. =head2 XML::DOM
  434.  
  435. The XML::DOM plugin gives access to the XML Document Object Module via
  436. Clark Cooper E<lt>cooper@sch.ge.comE<gt> and Enno Derksen's 
  437. E<lt>enno@att.comE<gt> XML::DOM module.  See L<Template::Plugin::XML::DOM> 
  438. and L<XML::DOM> for further details.
  439.  
  440.     [% USE dom = XML.DOM %]
  441.     [% doc = dom.parse(filename) %]
  442.  
  443.     [% FOREACH node = doc.getElementsByTagName('CODEBASE') %]
  444.        * [% node.getAttribute('href') %]
  445.     [% END %]
  446.  
  447. The plugin requires the XML::DOM module, available from CPAN:
  448.  
  449.     http://www.cpan.org/modules/by-module/XML/
  450.  
  451. =head2 XML::RSS
  452.  
  453. The XML::RSS plugin is a simple interface to Jonathan Eisenzopf's
  454. E<lt>eisen@pobox.comE<gt> XML::RSS module.  A RSS (Rich Site Summary)
  455. file is typically used to store short news 'headlines' describing
  456. different links within a site.  This plugin allows you to parse RSS
  457. files and format the contents accordingly using templates.  
  458. See L<Template::Plugin::XML::RSS> and L<XML::RSS> for further details.
  459.  
  460.     [% USE news = XML.RSS(filename) %]
  461.    
  462.     [% FOREACH item = news.items %]
  463.        <a href="[% item.link %]">[% item.title %]</a>
  464.     [% END %]
  465.  
  466. The XML::RSS module is available from CPAN:
  467.  
  468.     http://www.cpan.org/modules/by-module/XML/
  469.  
  470. =head2 XML::Simple
  471.  
  472. This plugin implements an interface to the L<XML::Simple|XML::Simple>
  473. module.
  474.  
  475.     [% USE xml = XML.Simple(xml_file_or_text) %]
  476.  
  477.     [% xml.head.title %]
  478.  
  479. See L<Template::Plugin::XML::Simple> for further details.
  480.  
  481. =head2 XML::Style
  482.  
  483. This plugin defines a filter for performing simple stylesheet based 
  484. transformations of XML text.  
  485.  
  486.     [% USE xmlstyle 
  487.            table = { 
  488.                attributes = { 
  489.                    border      = 0
  490.                    cellpadding = 4
  491.                    cellspacing = 1
  492.                }
  493.            }
  494.     %]
  495.  
  496.     [% FILTER xmlstyle %]
  497.     <table>
  498.     <tr>
  499.       <td>Foo</td> <td>Bar</td> <td>Baz</td>
  500.     </tr>
  501.     </table>
  502.     [% END %]
  503.  
  504. See L<Template::Plugin::XML::Style> for further details.
  505.  
  506. =head2 XML::XPath
  507.  
  508. The XML::XPath plugin provides an interface to Matt Sergeant's
  509. E<lt>matt@sergeant.orgE<gt> XML::XPath module.  See 
  510. L<Template::Plugin::XML::XPath> and L<XML::XPath> for further details.
  511.  
  512.     [% USE xpath = XML.XPath(xmlfile) %]
  513.     [% FOREACH page = xpath.findnodes('/html/body/page') %]
  514.        [% page.getAttribute('title') %]
  515.     [% END %]
  516.  
  517. The plugin requires the XML::XPath module, available from CPAN:
  518.  
  519.     http://www.cpan.org/modules/by-module/XML/
  520.  
  521. =head1 AUTHOR
  522.  
  523. Andy Wardley E<lt>abw@andywardley.comE<gt>
  524.  
  525. L<http://www.andywardley.com/|http://www.andywardley.com/>
  526.  
  527.  
  528.  
  529.  
  530. =head1 VERSION
  531.  
  532. Template Toolkit version 2.13, released on 30 January 2004.
  533.  
  534. =head1 COPYRIGHT
  535.  
  536.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  537.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  538.  
  539. This module is free software; you can redistribute it and/or
  540. modify it under the same terms as Perl itself.
  541.  
  542.  
  543.  
  544. =cut
  545.  
  546. # Local Variables:
  547. # mode: perl
  548. # perl-indent-level: 4
  549. # indent-tabs-mode: nil
  550. # End:
  551. #
  552. # vim: expandtab shiftwidth=4:
  553.