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 / ttree.pod < prev    next >
Encoding:
Text File  |  2004-01-30  |  11.1 KB  |  333 lines
  1.  
  2. #------------------------------------------------------------------------
  3. # IMPORTANT NOTE
  4. #   This documentation is generated automatically from source
  5. #   templates.  Any changes you make here may be lost.
  6. # 
  7. #   The 'docsrc' documentation source bundle is available for download
  8. #   from http://www.template-toolkit.org/docs.html and contains all
  9. #   the source templates, XML files, scripts, etc., from which the
  10. #   documentation for the Template Toolkit is built.
  11. #------------------------------------------------------------------------
  12.  
  13. =head1 NAME
  14.  
  15. Template::Tools::ttree - Process entire directory trees of templates
  16.  
  17. =head1 SYNOPSIS
  18.  
  19.     ttree [options] [files]
  20.  
  21. =head1 DESCRIPTION
  22.  
  23. The F<ttree> script is used to process entire directory trees containing
  24. template files.  The resulting output from processing each file is then 
  25. written to a corresponding file in a destination directory.  The script
  26. compares the modification times of source and destination files (where
  27. they already exist) and processes only those files that have been modified.
  28. In other words, it is the equivalent of 'make' for the Template Toolkit.
  29.  
  30. It supports a number of options which can be used to configure
  31. behaviour, define locations and set Template Toolkit options.  The
  32. script first reads the F<.ttreerc> configuration file in the HOME
  33. directory, or an alternative file specified in the TTREERC environment
  34. variable.  Then, it processes any command line arguments, including
  35. any additional configuration files specified via the C<-f> (file)
  36. option.
  37.  
  38. =head2 The F<.ttreerc> Configuration File
  39.  
  40. When you run F<ttree> for the first time it will ask you if you want
  41. it to create a F<.ttreerc> file for you.  This will be created in your
  42. home directory.
  43.  
  44.     $ ttree
  45.     Do you want me to create a sample '.ttreerc' file for you?
  46.     (file: /home/abw/.ttreerc)   [y/n]: y
  47.     /home/abw/.ttreerc created.  Please edit accordingly and re-run ttree
  48.  
  49. The purpose of this file is to set any I<global> configuration options
  50. that you want applied I<every> time F<ttree> is run.  For example, you
  51. can use the C<ignore> and C<copy> option to provide regular expressions
  52. that specify which files should be ignored and which should be copied 
  53. rather than being processed as templates.  You may also want to set 
  54. flags like C<verbose> and C<recurse> according to your preference.
  55.  
  56. A minimal F<.ttreerc>:
  57.  
  58.     # ignore these files
  59.     ignore = \b(CVS|RCS)\b
  60.     ignore = ^#
  61.     ignore = ~$
  62.  
  63.     # copy these files
  64.     copy   = \.(gif|png|jpg|pdf)$ 
  65.  
  66.     # recurse into directories
  67.     recurse
  68.  
  69.     # provide info about what's going on
  70.     verbose
  71.  
  72. In most cases, you'll want to create a different F<ttree> configuration 
  73. file for each project you're working on.  The C<cfg> option allows you
  74. to specify a directory where F<ttree> can find further configuration 
  75. files.
  76.  
  77.     cfg = /home/abw/.ttree
  78.  
  79. The C<-f> command line option can be used to specify which configuration
  80. file should be used.  You can specify a filename using an absolute or 
  81. relative path:
  82.  
  83.     $ ttree -f /home/abw/web/example/etc/ttree.cfg
  84.     $ ttree -f ./etc/ttree.cfg
  85.     $ ttree -f ../etc/ttree.cfg
  86.  
  87. If the configuration file does not begin with C</> or C<.> or something
  88. that looks like a MS-DOS absolute path (e.g. C<C:\\etc\\ttree.cfg>) then
  89. F<ttree> will look for it in the directory specified by the C<cfg> option.
  90.  
  91.     $ ttree -f test1          # /home/abw/.ttree/test1
  92.  
  93. The C<cfg> option can only be used in the F<.ttreerc> file.  All the
  94. other options can be used in the F<.ttreerc> or any other F<ttree>
  95. configuration file.  They can all also be specified as command line
  96. options.
  97.  
  98. Remember that F<.ttreerc> is always processed I<before> any
  99. configuration file specified with the C<-f> option.  Certain options
  100. like C<lib> can be used any number of times and accumulate their values.
  101.  
  102. For example, consider the following configuration files:
  103.  
  104. F</home/abw/.ttreerc>:
  105.  
  106.     cfg = /home/abw/.ttree
  107.     lib = /usr/local/tt2/templates
  108.  
  109. F</home/abw/.ttree/myconfig>:
  110.  
  111.     lib = /home/abw/web/example/templates/lib
  112.  
  113. When F<ttree> is invoked as follows:
  114.  
  115.     $ ttree -f myconfig
  116.  
  117. the C<lib> option will be set to the following directories:
  118.  
  119.     /usr/local/tt2/templates
  120.     /home/abw/web/example/templates/lib
  121.  
  122. Any templates located under F</usr/local/tt2/templates> will be used
  123. in preference to those located under
  124. F</home/abw/web/example/templates/lib>.  This may be what you want,
  125. but then again, it might not.  For this reason, it is good practice to
  126. keep the F<.ttreerc> as simple as possible and use different
  127. configuration files for each F<ttree> project.
  128.  
  129. =head2 Directory Options
  130.  
  131. The C<src> option is used to define the directory containing the
  132. source templates to be processed.  It can be provided as a command
  133. line option or in a configuration file as shown here:
  134.  
  135.     src = /home/abw/web/example/templates/src
  136.  
  137. Each template in this directory typically corresponds to a single
  138. web page or other document. 
  139.  
  140. The C<dest> option is used to specify the destination directory for the
  141. generated output.
  142.  
  143.     dest = /home/abw/web/example/html
  144.  
  145. The C<lib> option is used to define one or more directories containing
  146. additional library templates.  These templates are not documents in
  147. their own right and typically comprise of smaller, modular components
  148. like headers, footers and menus that are incorporated into pages templates.
  149.  
  150.     lib = /home/abw/web/example/templates/lib
  151.     lib = /usr/local/tt2/templates
  152.  
  153. The C<lib> option can be used repeatedly to add further directories to
  154. the search path.
  155.  
  156. A list of templates can be passed to F<ttree> as command line arguments.
  157.  
  158.     $ ttree foo.html bar.html
  159.  
  160. It looks for these templates in the C<src> directory and processes them
  161. through the Template Toolkit, using any additional template components
  162. from the C<lib> directories.  The generated output is then written to 
  163. the corresponding file in the C<dest> directory.
  164.  
  165. If F<ttree> is invoked without explicitly specifying any templates
  166. to be processed then it will process every file in the C<src> directory.
  167. If the C<-r> (recurse) option is set then it will additionally iterate
  168. down through sub-directories and process and other template files it finds
  169. therein.
  170.  
  171.     $ ttree -r
  172.  
  173. If a template has been processed previously, F<ttree> will compare the
  174. modification times of the source and destination files.  If the source
  175. template (or one it is dependant on) has not been modified more
  176. recently than the generated output file then F<ttree> will not process
  177. it.  The F<-a> (all) option can be used to force F<ttree> to process
  178. all files regardless of modification time.
  179.  
  180.     $ tree -a
  181.  
  182. Any templates explicitly named as command line argument are always
  183. processed and the modification time checking is bypassed.
  184.  
  185. =head2 File Options
  186.  
  187. The C<ignore>, C<copy> and C<accept> options are used to specify Perl
  188. regexen to filter file names.  Files that match any of the C<ignore>
  189. options will not be processed.  Remaining files that match any of the
  190. C<copy> regexen will be copied to the destination directory.  Remaining
  191. files that then match any of the C<accept> criteria are then processed
  192. via the Template Toolkit.  If no C<accept> parameter is specified then 
  193. all files will be accepted for processing if not already copied or
  194. ignored.
  195.  
  196.     # ignore these files
  197.     ignore = \b(CVS|RCS)\b
  198.     ignore = ^#
  199.     ignore = ~$
  200.  
  201.     # copy these files
  202.     copy   = \.(gif|png|jpg|pdf)$ 
  203.  
  204.     # accept only .tt2 templates
  205.     accept = \.tt2$
  206.  
  207. The C<suffix> option is used to define mappings between the file
  208. extensions for source templates and the generated output files.  The
  209. following example specifies that source templates with a C<.tt2>
  210. suffix should be output as C<.html> files:
  211.  
  212.     suffix tt2=html
  213.  
  214. Or on the command line, 
  215.  
  216.     --suffix tt2=html
  217.  
  218. You can provide any number of different suffix mappings by repeating 
  219. this option.
  220.  
  221. =head2 Template Dependencies
  222.  
  223. The C<depend> and C<depend_file> options allow you to specify
  224. how any given template file depends on another file or group of files. 
  225. The C<depend> option is used to express a single dependency.
  226.  
  227.   $ ttree --depend foo=bar,baz
  228.  
  229. This command line example shows the C<--depend> option being used to
  230. specify that the F<foo> file is dependant on the F<bar> and F<baz>
  231. templates.  This option can be used many time on the command line:
  232.  
  233.   $ ttree --depend foo=bar,baz --depend crash=bang,wallop
  234.  
  235. or in a configuration file:
  236.  
  237.   depend foo=bar,baz
  238.   depend crash=bang,wallop
  239.  
  240. The file appearing on the left of the C<=> is specified relative to
  241. the C<src> or C<lib> directories.  The file(s) appearing on the right
  242. can be specified relative to any of these directories or as absolute
  243. file paths.
  244.  
  245. For example:
  246.  
  247.   $ ttree --depend foo=bar,/tmp/baz
  248.  
  249. To define a dependency that applies to all files, use C<*> on the 
  250. left of the C<=>.
  251.  
  252.   $ ttree --depend *=header,footer
  253.  
  254. or in a configuration file:
  255.  
  256.   depend *=header,footer
  257.  
  258. Any templates that are defined in the C<pre_process>, C<post_process>,
  259. C<process> or C<wrapper> options will automatically be added to the
  260. list of global dependencies that apply to all templates.
  261.  
  262. The C<depend_file> option can be used to specify a file that contains
  263. dependency information.  
  264.  
  265.     $ ttree --depend_file=/home/abw/web/example/etc/ttree.dep
  266.  
  267. Here is an example of a dependency file:
  268.  
  269.    # This is a comment. It is ignored.
  270.   
  271.    index.html: header footer menubar 
  272.   
  273.    header: titlebar hotlinks
  274.   
  275.    menubar: menuitem
  276.   
  277.    # spanning multiple lines with the backslash
  278.    another.html: header footer menubar \
  279.    sidebar searchform
  280.  
  281. Lines beginning with the C<#> character are comments and are ignored.
  282. Blank lines are also ignored.  All other lines should provide a
  283. filename followed by a colon and then a list of dependant files
  284. separated by whitespace, commas or both.  Whitespace around the colon
  285. is also optional.  Lines ending in the C<\> character are continued
  286. onto the following line.
  287.  
  288. Files that contain spaces can be quoted. That is only necessary
  289. for files after the colon (':'). The file before the colon may be
  290. quoted if it contains a colon. 
  291.  
  292. As with the command line options, the C<*> character can be used
  293. as a wildcard to specify a dependency for all templates.
  294.  
  295.     * : config,header
  296.  
  297. =head2 Template Toolkit Options
  298.  
  299. F<ttree> also provides access to the usual range of Template Toolkit
  300. options.  For example, the C<--pre_chomp> and C<--post_chomp> F<ttree>
  301. options correspond to the C<PRE_CHOMP> and C<POST_CHOMP> options.
  302.  
  303. Run C<ttree -h> for a summary of the options available.
  304.  
  305. =head1 AUTHORS
  306.  
  307. Andy Wardley E<lt>abw@andywardley.comE<gt>
  308.  
  309. L<http://www.andywardley.com/|http://www.andywardley.com/>
  310.  
  311. With contributions from Dylan William Hardison (support for
  312. dependencies), Bryce Harrington (C<absolute> and C<relative> options),
  313. Mark Anderson (C<suffix> and C<debug> options), Harald Joerg and Leon
  314. Brocard who gets everywhere, it seems.
  315.  
  316. =head1 VERSION
  317.  
  318. 2.69, distributed as part of the
  319. Template Toolkit version 2.13, released on 30 January 2004.
  320.  
  321. =head1 COPYRIGHT
  322.  
  323.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  324.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  325.  
  326. This module is free software; you can redistribute it and/or
  327. modify it under the same terms as Perl itself.
  328.  
  329. =head1 SEE ALSO
  330.  
  331. L<tpage|Template::Tools::tpage>
  332.  
  333.