X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FGitalist.git;a=blobdiff_plain;f=local-lib5%2Fman%2Fman3%2FTemplate%3A%3AToolkit.3pm;fp=local-lib5%2Fman%2Fman3%2FTemplate%3A%3AToolkit.3pm;h=ff2a5095ee7fdb66b6372687ca3a69447ca3cb2b;hp=0000000000000000000000000000000000000000;hb=3fea05b9fbf95091f4522528b9980a33e0235603;hpb=af746827daa7a8feccee889e1d12ebc74cc9201e diff --git a/local-lib5/man/man3/Template::Toolkit.3pm b/local-lib5/man/man3/Template::Toolkit.3pm new file mode 100644 index 0000000..ff2a509 --- /dev/null +++ b/local-lib5/man/man3/Template::Toolkit.3pm @@ -0,0 +1,242 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "Template::Toolkit 3" +.TH Template::Toolkit 3 "2009-07-20" "perl v5.8.7" "User Contributed Perl Documentation" +.SH "NAME" +Template::Toolkit \- Template Processing System +.SH "Introduction" +.IX Header "Introduction" +The Template Toolkit is a collection of Perl modules which implement a +fast, flexible, powerful and extensible template processing system. +.PP +It is \*(L"input\-agnostic\*(R" and can be used equally well for processing any +kind of text documents: \s-1HTML\s0, \s-1XML\s0, \s-1CSS\s0, Javascript, Perl code, plain text, +and so on. However, it is most often used for generating static and +dynamic web content, so that's what we'll focus on here. +.PP +Although the Template Toolkit is written in Perl, you don't need to be a Perl +programmer to use it. It was designed to allow non-programmers to easily +create and maintain template-based web sites without having to mess around +writing Perl code or going crazy with cut\-n\-paste. +.PP +However, the Template Toolkit is also designed to be extremely flexible and +extensible. If you are a Perl programmer, or know someone who is, then you can +easily hook the Template Toolkit into your existing code, data, databases and +web applications. Furthermore, you can easily extend the Template Toolkit +through the use of its plugin mechanism and other developer APIs. +.PP +Whatever context you use it in, the primary purpose of the Template Toolkit is +to allow you to create a clear separation between the presentation elements of +your web site and everything else. +.PP +If you're generating static web pages, then you can use it to separate the +commonly repeated user interface elements on each page (headers, menus, +footers, etc.) from the core content. If you're generating dynamic web pages +for the front end of a web application, then you'll also be using it to keep +the back-end Perl code entirely separate from the front-end \s-1HTML\s0 templates. +Either way, a \fIclear separation of concerns\fR is what allow you to +concentrate on one thing at a time without the other things getting in your +way. And that's what the Template Toolkit is all about. +.SH "Documentation" +.IX Header "Documentation" +The documentation for the Template Toolkit is organised into five sections. +.PP +The Template::Manual contains detailed information about using the Template +Toolkit. It gives examples of its use and includes a full reference of the +template language, configuration options, filters, plugins and other component +parts. +.PP +The Template::Modules page lists the Perl modules that comprise the +Template Toolkit. It gives a brief explanation of what each of them does, and +provides a link to the complete documentation for each module for further +information. If you're a Perl programmer looking to use the Template Toolkit +from your Perl programs then this section is likely to be of interest. +.PP +Most, if not all of the information you need to call the Template Toolkit from +Perl is in the documentation for the Template module. You only really need +to start thinking about the other modules if you want to extend or modify the +Template Toolkit in some way, or if you're interested in looking under the +hood to see how it all works. +.PP +The documentation for each module is embedded as \s-1POD\s0 in each +module, so you can always use \f(CW\*(C`perldoc\*(C'\fR from the command line to read a +module's documentation. e.g. +.PP +.Vb 3 +\& $ perldoc Template +\& $ perldoc Template::Context +\& ...etc... +.Ve +.PP +It's worth noting that all the other documentation, including the user manual +is available as \s-1POD\s0. e.g. +.PP +.Vb 3 +\& $ perldoc Template::Manual +\& $ perldoc Template::Manual::Config +\& ...etc... +.Ve +.PP +The Template::Tools section contains the documentation for +Template::Tools::tpage and Template::Tools::ttree. +These are two command line programs that are distributed with the +Template Toolkit. tpage is used to process +a single template file, ttree for processing +entire directories of template files. +.PP +The Template::Tutorial section contains two introductory tutorials on using +the Template Toolkit. The first is Template::Tutorial::Web on generating +web content. The second is Template::Tutorial::Datafile on using the +Template Toolkit to generate other data formats including \s-1XML\s0. +.PP +The final section of the manual is Template::FAQ which contains answers +to some of the Frequently Asked Questions about the Template Toolkit. +.PP +You can read the documentation in \s-1HTML\s0 format either online at the Template +Toolkit web site, , or by downloading the +\&\s-1HTML\s0 version of the documentation from + and unpacking +it on your local machine. +.SH "Author" +.IX Header "Author" +The Template Toolkit was written by Andy Wardley ( +) with assistance and contributions from a great +number of people. Please see Template::Manual::Credits for a full list. +.SH "Copyright" +.IX Header "Copyright" +Copyright (C) 1996\-2008 Andy Wardley. All Rights Reserved. +.PP +This module is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. +.SH "See Also" +.IX Header "See Also" +Template, Template::Manual, Template::Modules, Template::Tools, +Template::Tutorial