[%# # 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 = 'FAQ' page = 'FAQ' %] [% WRAPPER toc; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="Template Toolkit Language" subs = [ "Why doesn't $tt_start_tag a = b IF c $tt_end_tag work as expected?", "If I'm using TT to write out a TT template, is there a good way to escape $tt_start_tag and $tt_end_tag?", "How do I iterate over a hash?" ]; PROCESS tocitem title ="Plugins" subs = [ "How do I get the Table plugin to order data across rather than down?", "Accessing Cookies" ]; PROCESS tocitem title ="Extending the Template Toolkit" subs = [ "Can I serve templates from a database?", "Can I fetch templates via http?" ]; PROCESS tocitem title ="Miscellaneous" subs = [ "How can I find out the name of the main template being processed?", "How can I find out the name of the current template being processed?", "How do I print the modification time of the template or component?", "How can I configure variables on a per-request basis?" ]; PROCESS tocitem title ="AUTHOR" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; END %] [% WRAPPER section title="DESCRIPTION" -%][%- END %] [% WRAPPER section title="Template Toolkit Language" -%][% WRAPPER subsection title = "Why doesn't $tt_start_tag a = b IF c $tt_end_tag work as expected?" -%]

Because the parser interprets it as

        [% tt_start_tag %] a = (b IF c) [% tt_end_tag %]

Do this instead:

        [% tt_start_tag %] SET a = b IF c [% tt_end_tag %]

[%- END %] [% WRAPPER subsection title = "If I'm using TT to write out a TT template, is there a good way to escape $tt_start_tag and $tt_end_tag?" -%]

You can do this: [% tt_start_tag %] stag = "[\%" etag = "%\]" [% tt_end_tag %] and then: [% tt_start_tag %] stag; 'hello'; etag [% tt_end_tag %]

Or something like:

      [% tt_start_tag %] TAGS [- -] [% tt_end_tag %]
      [- INCLUDE foo -]   # is a directive
      [% tt_start_tag %] INCLUDE foo [% tt_end_tag %]   # not a directive, just plain text, passed through

[%- END %] [% WRAPPER subsection title = "How do I iterate over a hash?" -%]

This is covered in the [% ttlink('VMethods', 'Template::Manual::VMethods') -%] section of the manual page. A list of all the keys that are in the hash can be obtained with the 'keys' virtual method. You can then iterate over that list and by looking up each key in turn get the value.

        [% tt_start_tag %] FOREACH key = product.keys [% tt_end_tag %]
           [% tt_start_tag %] key [% tt_end_tag %] => [% tt_start_tag %] product.$key [% tt_end_tag %]
        [% tt_start_tag %] END [% tt_end_tag %]

[%- END %] [%- END %] [% WRAPPER section title="Plugins" -%][% WRAPPER subsection title = "How do I get the Table plugin to order data across rather than down?" -%]

Order the data into rows:

         Steve     Karen     Jeff
         Brooklyn  Nantucket Fairfax
         NY        MA        VA

        [% tt_start_tag %] USE table(data, rows=3) [% tt_end_tag %]

    Then ask for each column

        [% tt_start_tag %] FOREACH column = table.cols [% tt_end_tag %]

    And then print each item in the column going across the output rows

        [% tt_start_tag %] FOREACH item = column [% tt_end_tag %]
    	<td>[% tt_start_tag %] item [% tt_end_tag %]</td>
        [% tt_start_tag %] END [% tt_end_tag %]

[%- END %] [% WRAPPER subsection title = "Accessing Cookies" -%]

Jeff Boes <jboes@nexcerpt.com> asks:

        Does anyone have a quick-n-dirty approach to accessing
        cookies from templates?

Jonas Liljegren answers:

        [% tt_start_tag %] USE CGI [% tt_end_tag %]

        <p>The value is [% tt_start_tag %] CGI.cookie('cookie_name') | html [% tt_end_tag %]

[%- END %] [%- END %] [% WRAPPER section title="Extending the Template Toolkit" -%][% WRAPPER subsection title = "Can I serve templates from a database?" -%]

Short answer: yes, Chris Nandor has done this for Slash. You need to subclass Template::Provider. See the mailing list archives for further info.

[%- END %] [% WRAPPER subsection title = "Can I fetch templates via http?" -%]

To do the job properly, you should sublcass Template::Provider to Template::Provider::HTTP and use a PREFIX_MAP option to bind the 'http' template prefix to that particular provider (you may want to go digging around in the Changes file around version 2.01 for more info on PREFIX_MAP - it may not be properly documented anywhere else...yet!). e.g. (untested due to lack of existing HTTP Provider - patches welcome!).

        use Template::Provider::HTTP;

        my $file = Template::Provider( INCLUDE_PATH => [...] );
        my $http = Template::Provider::HTTP->new(...);
        my $tt2  = Template->new({
    	LOAD_TEMPLATES => [ $file, $http ],
    	PREFIX_MAP => {
    	    file    => '0',	# file:foo.html
    	    http    => '1',	# http:foo.html
    	    default => '0',	# foo.html => file:foo.html
    	}
        });

Now a template specified as:

        [% tt_start_tag %] INCLUDE foo [% tt_end_tag %]

will be served by the 'file' provider (the default). Otherwise you can explicitly add a prefix:

        [% tt_start_tag %] INCLUDE file:foo.html [% tt_end_tag %]
        [% tt_start_tag %] INCLUDE http:foo.html [% tt_end_tag %]
        [% tt_start_tag %] INCLUDE http://www.xyz.com/tt2/header.tt2 [% tt_end_tag %]

This same principal can be used to create a DBI template provider. e.g.

        [% tt_start_tag %] INCLUDE dbi:foo.html [% tt_end_tag %]

But similarly, alas, we don't yet have a DBI provider as part of the Template Toolkit. There has been some talk on the mailing list about efforts to develop DBI and/or HTTP providers but as yet no-one has stepped forward to take up the challenge...

In the mean time, Craig's post from the mailing list has some useful pointers on how to acheive this using existing modules:

        To: Adam Theo <adamtheo@theoretic.com>
        From: Craig Barratt <craig@arraycomm.com>
        Date: Fri, 18 May 2001 17:06:59 -0700

        > i was wondering if there is anyway to fetch a file using http:// or
        > ftp:// and include that?

        Here's one way.  Set the LOAD_PERL option:

        	use Template;

        	my $template = Template->new({
        	    LOAD_PERL => 1
        	});
        	$template->process("example.tt", { stdout => *STDOUT })
        				     || die $template->error();

        and then use LWP::UserAgent and HTTP::Request:

        	[% tt_start_tag %]
        	    USE ua = LWP.UserAgent;
        	    ua.proxy("http", "http://your_proxy/");
        	    USE req = HTTP.Request("GET", "http://www.cpan.org");
        	    ua.request(req).content;
        	-[% tt_end_tag %]

        For FTP use Net::FTP:

        	[% tt_start_tag %]
        	    USE ftp = Net.FTP("ftp.cpan.org");
        	    x = ftp.login("anonymous", "me@here.there");
        	    x = ftp.cwd("/");
        	    x = ftp.get("welcome.msg", stdout);
        	    x = ftp.quit;
        	-[% tt_end_tag %]

        Normally ftp.get would write the file into the current directory.
        Instead we pass stdout as a second argument so that it is written
        to stdout.  We set stdout to STDOUT in the variables we pass to
        process.

        Craig

[%- END %] [%- END %] [% WRAPPER section title="Miscellaneous" -%][% WRAPPER subsection title = "How can I find out the name of the main template being processed?" -%]

The `'template'` variable contains a reference to the Template::Document object for the main template you're processing (i.e. the one provided as the first argument to the Template process() method). The `'name'` method returns its name.

        [% tt_start_tag %] template.name [% tt_end_tag %]     # e.g. index.html

[%- END %] [% WRAPPER subsection title = "How can I find out the name of the current template being processed?" -%]

The `'template'` variable always references the main template being processed. So even if you call [% tt_start_tag %] INCLUDE header [% tt_end_tag %], and that calls [% tt_start_tag %] INCLUDE menu [% tt_end_tag %], the `'template'` variable will be unchanged.

index.html:

        [% tt_start_tag %] template.name  [% tt_end_tag %]     # index.html
        [% tt_start_tag %] INCLUDE header [% tt_end_tag %]

header:

        [% tt_start_tag %] template.name  [% tt_end_tag %]     # index.html
        [% tt_start_tag %] INCLUDE menu   [% tt_end_tag %]

menu:

        [% tt_start_tag %] template.name  [% tt_end_tag %]     # index.html

In constrast, the `'component'` variable always references the current template being processed.

index.html

        [% tt_start_tag %] component.name [% tt_end_tag %]     # index.html
        [% tt_start_tag %] INCLUDE header [% tt_end_tag %]

header:

        [% tt_start_tag %] component.name [% tt_end_tag %]     # header
        [% tt_start_tag %] INCLUDE menu   [% tt_end_tag %]

menu:

        [% tt_start_tag %] component.name  [% tt_end_tag %]     # menu

[%- END %] [% WRAPPER subsection title = "How do I print the modification time of the template or component?" -%]

The `'template'` and `'component'` variables reference the main template and the current template being processed (see previous questions). The `'modtime'` method returns the modification time of the corresponding template file as a number of seconds since the Unix epoch (00:00:00 GMT 1st January 1970).

This number doesn't mean much to anyone (except perhaps serious Unix geeks) so you'll probably want to use the Date plugin to format it for human consumption.

        [% tt_start_tag %] USE Date [% tt_end_tag %]

        [% tt_start_tag %] template.name [% tt_end_tag %] last modified [% tt_start_tag %] Date.format(template.modtime) [% tt_end_tag %]

[%- END %] [% WRAPPER subsection title = "How can I configure variables on a per-request basis?" -%]

One easy way to acheive this is to define a single PRE_PROCESS template which loads in other configuration files based on variables defined or other conditions.

For example, my setup usually looks something like this:

        PRE_PROCESS => 'config/main'

config/main:

        [% tt_start_tag %]  DEFAULT  style   = 'text'
                     section =  template.section or 'home';

            PROCESS  config/site
                  +  config/urls
                  +  config/macros
                  + "config/style/$style"
                  + "config/section/$section"
                  + ...
        [% tt_end_tag %]

This allows me to set a single 'style' variable to control which config file gets pre-processed to set my various style options (colours, img paths, etc). For example:

config/style/basic:

        [% tt_start_tag %]  style = {
    	    name = style    # save existing 'style' var as 'style.name'

    	    # define various other style variables....
                col = {
        		back => '#ffffff'
    	    	text => '#000000'
    		    # ...etc...
    	    }

    	    logo = {
    		    # ...etc...
    	    }

    	    # ...etc...
    	}
        [% tt_end_tag %]

Each source template can declare which section it's in via a META directive:

      [% tt_start_tag %] META
           title   = 'General Information'
           section = 'info'
      [% tt_end_tag %]

      ...

This controls which section configuration file gets loaded to set various other variables for defining the section title, menu, etc.

config/section/info:

        [% tt_start_tag %]  section = {
    	        name   = section  # save 'section' var as 'section.name'
    	        title  = 'Information'
    	        menu   = [ ... ]
    	        # ...etc...
    	    }
        [% tt_end_tag %]

This illustrates the basic principal but you can extend it to perform pretty much any kind of per-document initialisation that you require.

[%- END %] [%- END %] [% WRAPPER section title="AUTHOR" -%]

Andy Wardley <abw@wardley.org>

[% ttlink('http://wardley.org/', 'http://wardley.org/') -%]

[%- END %] [% WRAPPER section title="VERSION" -%]

2.68, distributed as part of the Template Toolkit version 2.19, released on 27 April 2007.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

      Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

[%- END %]