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 / HTML.pod < prev    next >
Encoding:
Text File  |  2004-01-30  |  6.4 KB  |  317 lines
  1. #============================================================= -*-perl-*-
  2. #
  3. # Template::Library::HTML
  4. #
  5. # DESCRIPTION
  6. #   The HTML library provides a number of basic templates for use in
  7. #   building HTML pages.
  8. #
  9. # AUTHOR
  10. #   Andy Wardley  <abw@andywardley.com>
  11. #
  12. # COPYRIGHT
  13. #   Copyright (C) 1996-2001 Andy Wardley.  All Rights Reserved.
  14. #   Copyright (C) 1998-2001 Canon Research Centre Europe Ltd.
  15. #
  16. #   This module is free software; you can redistribute it and/or
  17. #   modify it under the same terms as Perl itself.
  18. #
  19. # REVISION
  20. #   2.69
  21. #
  22. #========================================================================
  23.  
  24.  
  25. #------------------------------------------------------------------------
  26. # IMPORTANT NOTE
  27. #   This documentation is generated automatically from source
  28. #   templates.  Any changes you make here may be lost.
  29. # 
  30. #   The 'docsrc' documentation source bundle is available for download
  31. #   from http://www.template-toolkit.org/docs.html and contains all
  32. #   the source templates, XML files, scripts, etc., from which the
  33. #   documentation for the Template Toolkit is built.
  34. #------------------------------------------------------------------------
  35.  
  36. =head1 NAME
  37.  
  38. Template::Library::HTML - Template library for building basic HTML pages
  39.  
  40. =head1 DESCRIPTION
  41.  
  42. B<NOTE:> This documentation is incomplete and may be incorrect
  43. in places. 
  44.  
  45. The 'html' template library is distributed as part of the Template
  46. Toolkit.  It can be found in the 'templates' sub-directory of the
  47. installation directory.
  48.  
  49.     use Template;
  50.  
  51.     my $tt2 = Template->new({
  52.     INCLUDE_PATH => '/usr/local/tt2/templates',
  53.     });
  54.  
  55. For a portable way to determine the installation 'templates' directory,
  56. you can use the C<Template::Config-E<gt>instdir()> class method.
  57.  
  58.     use Template;
  59.  
  60.     my $tt2 = Template->new({
  61.     INCLUDE_PATH => Template::Config->instdir('templates'),
  62.     });
  63.  
  64. You should now be able to access the html library as, for example:
  65.  
  66.     [% INCLUDE html/header %]
  67.  
  68. Note that some of the more basic elements don't give you much more
  69. than the raw HTML tags.  In many cases you might be well advised to
  70. stick to regular HTML rather than complicating matters by the use
  71. of template elements.
  72.  
  73. e.g.
  74.  
  75.     <table>
  76.       . . .
  77.     </table>
  78.  
  79. vs
  80.  
  81.     [% WRAPPER html/table %]
  82.        . . .
  83.     [% END %]
  84.  
  85. However, the use of template elements to generate the underlying HTML
  86. does have some important benefits, particularly as the constructs start
  87. to get more complicated and more magical.
  88.  
  89. See the example in the 'examples' sub-directory of the distribution
  90. directory for further examples and enlightenment on using this library.
  91.  
  92. =head2 Headers, Footers and Pages
  93.  
  94. =over 4
  95.  
  96. =item header
  97.  
  98. The 'header' element generates the regular header required as the 
  99. pre-amble for an HTML document.  That is, everything from the initial
  100. E<lt>htmlE<gt> to the opening E<lt>bodyE<gt>.
  101.  
  102.     [% INCLUDE html/header
  103.          title = 'This is a Test'
  104.      bgcol = '#ffffff'
  105.     %]
  106.  
  107. Additional header items can be provided by explicitly setting the 'headers'
  108. variable, e.g.
  109.  
  110.     [% headers = BLOCK %]
  111.     <META name="description" content="Template Toolkit">
  112.     <META name="REVISIT-AFTER" content="14 days">    
  113.     <META name="keywords" content="Templates, Web, ...etc...">
  114.     [% END %]
  115.  
  116.     [% INCLUDE html/header
  117.      title = 'This is a Test'
  118.      bgcol = '#ffffff'
  119.     %]
  120.  
  121. =item footer
  122.  
  123. The 'footer' element generates the terminating E<lt>/bodyE<gt> and
  124. E<lt>/htmlE<gt> element to balance the header.
  125.  
  126.     [% PROCESS html/header %]
  127.  
  128.     ...page content here...
  129.  
  130.     [% PROCESS html/footer %]
  131.  
  132. =item page
  133.  
  134. The 'page' element combines the 'html/header' and 'html/footer' elements.
  135.  
  136.     [% WRAPPER html/page %]
  137.  
  138.     ...page content here...
  139.  
  140.     [% END %]
  141.  
  142. Page content should be defined in the 'content' variable (e.g. via WRAPPER).
  143. Additional HTML headers should be defined in the 'headers' variable.
  144.  
  145.     [% WRAPPER html/page
  146.         headers = '<META name="keywords" content="foo, bar, ...">'
  147.     %]
  148.  
  149.     ...page content here...
  150.  
  151.     [% END %]
  152.  
  153. =back
  154.  
  155. =head2 Tables, Bars and Boxes
  156.  
  157. =over 4
  158.  
  159. =item table
  160.  
  161. A basic element for creating HTML tables.
  162.  
  163.     [% WRAPPER html/table pad=10 space=4 col='#404040' %]
  164.        <tr>
  165.     <td>Hello</td> <td>World</td>
  166.        </tr>
  167.     [% END %]
  168.  
  169. The following variables may be defined:
  170.  
  171. =over 4
  172.  
  173. =item border
  174.  
  175. Set the border width (default: 0)
  176.  
  177. =item col
  178.  
  179. Set the background colour (default: none).
  180.  
  181. =item width
  182.  
  183. Set a fixed table width.
  184.  
  185. =item pad
  186.  
  187. Set the cellpadding.
  188.  
  189. =item space
  190.  
  191. Set the cellspacing.
  192.  
  193. =item content
  194.  
  195. Content for the box.  Supplied automatically if used via WRAPPER.
  196.  
  197. =back
  198.  
  199. =item row
  200.  
  201. A basic element for creating HTML table rows.
  202.  
  203.     [% WRAPPER html/table %]
  204.        [% WRAPPER html/row %]
  205.     <td>Hello</td> <td>World</td>
  206.        [% END %]
  207.     [% END %]
  208.  
  209. The following variables may be defined:
  210.  
  211. =over 4
  212.  
  213. =item col
  214.  
  215. Set the background colour (default: none).
  216.  
  217. =item valign
  218.  
  219. Set the vertical alignment.
  220.  
  221. =item rowspan
  222.  
  223. Specify the number of rows to span.
  224.  
  225. =item content
  226.  
  227. Content for the box.  Supplied automatically if used via WRAPPER.
  228.  
  229. =back
  230.  
  231. =item cell
  232.  
  233. A basic element for creating HTML table cells.
  234.  
  235.     [% WRAPPER html/table %]
  236.        [% WRAPPER html/row %]
  237.       [% INCLUDE html/cell 
  238.         FOREACH content = ['Hello', 'World'] %]
  239.        [% END %]
  240.     [% END %]
  241.  
  242. The following variables may be defined:
  243.  
  244. =over 4
  245.  
  246. =item col
  247.  
  248. Set the background colour (default: none).
  249.  
  250. =item align
  251.  
  252. Set the horizontal alignment.
  253.  
  254. =item colspan
  255.  
  256. Specify the number of columns to span.
  257.  
  258. =item content
  259.  
  260. Content for the cell.  Supplied automatically if used via WRAPPER.
  261.  
  262. =back
  263.  
  264. =item bar
  265.  
  266. The bar element is a wrapping of html/table + html/row.
  267.  
  268.     [% WRAPPER html/bar %]
  269.        <td>Foo</td>  <td>Bar</td>
  270.     [% END %]
  271.  
  272. =item box
  273.  
  274. The box element is a wrapping of html/table + html/row + html/cell
  275.  
  276.     [% WRAPPER html/box %]
  277.        Hello World!
  278.     [% END %]
  279.  
  280. =back
  281.  
  282. =head1 AUTHOR
  283.  
  284. Andy Wardley E<lt>abw@andywardley.comE<gt>
  285.  
  286. L<http://www.andywardley.com/|http://www.andywardley.com/>
  287.  
  288.  
  289.  
  290.  
  291. =head1 VERSION
  292.  
  293. 2.69, distributed as part of the
  294. Template Toolkit version 2.13, released on 30 January 2004.
  295.  
  296. =head1 COPYRIGHT
  297.  
  298.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  299.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  300.  
  301. This module is free software; you can redistribute it and/or
  302. modify it under the same terms as Perl itself.
  303.  
  304. =head1 SEE ALSO
  305.  
  306. L<Template::Library::Splash|Template::Library::Splash>
  307.  
  308. =cut
  309.  
  310. # Local Variables:
  311. # mode: perl
  312. # perl-indent-level: 4
  313. # indent-tabs-mode: nil
  314. # End:
  315. #
  316. # vim: expandtab shiftwidth=4:
  317.