Perl Template Toolkit by Cross, Dave -- Read -- Imperial Library of Trantor

Creating a Project Directory ttree Configuration File Running ttree for the First Time Using a Build Script ttree Configuration Directory Calling ttree Through the Build Script A Place for Everything, and Everything in Its Place Running the Build Script Skipping Unmodified Templates

Adding Headers and Footers Automatically

Defining META Tags

More Template Components

The INCLUDE Directive Setting Default Values

The DEFAULT directive Expressions

= versus = = Setting variables using expressions Setting variables using directives

The IF Directive

Wrapper and Layout Templates

The WRAPPER Directive Using an Automatic Wrapper Template Using Layout Templates Layout Example

Side-effect wrappers Separating layout concerns Plugins and the USE directive

Menu Components

Simple Menu Template

The BLOCK directive

Component Libraries

The EXPOSE_BLOCKS option

The FOREACH Directive

Defining and Using Complex Data

Structured Configuration Templates Layered Configuration Templates Choosing Global Variables Wisely Passing Around Data Structures

Assessment

3. The Template Language

Template Syntax

Text and Directives

Template parser Parse errors Caching templates Flexible syntax

Template Tags Interpolated Variables Comments Whitespace Chomping

Chomping flags Chomping options Chomping constants

Multiple Directive Tags Side-Effect Notation Capturing Directive Output Template Filenames

Template Variables

What’s in a Name? Simple Data Types Complex Data Types

Lists Hashes

Dot Operator

Compound dot operations Interpolated variables names Private variables

Dynamic Data Types

Subroutines Objects Passing arguments Pointless arguments Named parameters Mixing dynamic and static data Returning values Error handling

Special Variables

template component loop error content global view, item

Variable Scope Compile-Time Constant Folding

Virtual Methods

Scalar Virtual Methods

chunk(size) defined hash length list match(pattern) repeat(n) replace(search, replace) size split(pattern)

List Virtual Methods

first(n) grep(pattern) join(delimiter) last(n) max merge(list) pop reverse shift size slice(from, to) sort, nsort splice(offset, length, list) unique unshift(item) push(item)

Hash Virtual Methods

defined(key) each exists(key) import(hash) item(key) keys list size sort, nsort values

Defining New Virtual Methods

Stash package variables Stash and context methods

4. Template Directives

Accessing Variables

GET SET CALL DEFAULT

Accessing External Templates and Files

INSERT INCLUDE PROCESS WRAPPER

Defining Local Template Blocks Loops

FOREACH

Complex data Importing hash array items Iterating over entries in a hash array The loop iterator object Nested FOREACH loops

WHILE

Flow control: NEXT and LAST

Conditionals

IF, ELSIF, ELSE, and UNLESS SWITCH and CASE

Filters Plugins

USE

Macros

MACRO

Template Metadata

META

Exception Handling

TRY / THROW / CATCH / FINAL CLEAR

Flow Control

RETURN STOP NEXT LAST

Debugging Perl Blocks

PERL RAWPERL

5. Filters

Using Filters Standard Template Toolkit Filters

collapse eval / evaltt format(fmt) html html_break / html_para_break html_entity html_line_break html_para indent(pad) latex(outputType) lcfirst lower null perl / evalperl redirect(file, options) remove(string) repeat(iterations) replace(search, replace) stderr stdout(options) trim truncate(length) ucfirst upper uri

6. Plugins

Using Plugins Standard Template Toolkit Plugins

Autoformat CGI Datafile Date Directory DBI Dumper File Format GD HTML Image Iterator Pod String Table URL Wrap XML::DOM XML::RSS XML::Style XML::XPath

7. Anatomy of the Template Toolkit

Template Modules

Template::Service Template::Context Template::Stash Template::Provider Template::Parser Template::Grammar Template::Directive Template::Namespace::Constants Template::Document

The Runtime Engine Module Interfaces

Template’s process Method

The process method

Input template Template variables Redirecting template output Processing options

The error method

Template::Config

load preload instdir

Template::Constants

:status :error :chomp :debug

Template::Base

new error debug

Template::Context

stash insert, include, and process template plugin and filter define_filter

Template::Provider

fetch($name) store($name, $template) paths

Template::Stash

get, set clone, declone

Template::Filters

new fetch store

Template::Plugin

load new error

Template::Plugins

new fetch

Template::Parser and Template::Grammar Template::Directive Template::Document

new process write_perl_file AUTOLOAD

Template::Exception Template::Iterator

8. Extending the Template Toolkit

Using and Implementing Noncore Components

A Provider That Can Fetch Files over HTTP Restricting Access to Plugins A chrooted Provider

Creating Filters

Static Filters Dynamic Filters Template::Plugin::Filter Writing New Filters

Digest::MD5 Text::Bastardize Text::FIGlet Normalizing HTML: HTML::Clean

Creating Plugins

The Template::Plugin Module Installing Functions into the Stash from Within a Plugin Defining Filters from Within a Plugin Defining New Virtual Methods from Within a Plugin Writing New Plugins

A simple wrapper plugin A more complex wrapper plugin A plugin that sends mail GoogleSearch Normalizing URLs

Building a New Frontend

Mail::Template Custom Apache Handlers

Changing the Language

Building the Grammar Extending the Existing Grammar Replacing the Default Grammar

Template::Simple The Template::Simple grammar

9. Accessing Databases

Using the DBI Plugin

Simple Database Access with the DBI Plugin A More Complex Example: Web Access Logs

Using Class::DBI Using DBIx::Table2Hash

Writing Your Own Database Abstraction Layer

10. XML

Simple XML Processsing Creating XML Documents

Modeling Data About a TV Show DTD for a TV Show XML Template

Processing RSS Files with XML.RSS Processing XML Documents with XML.DOM Processing XML Documents with XML.XPath Processing XML Documents with XML.LibXML Using Views to Transform XML Content

11. Advanced Static Web Page Techniques

Getting Started

Directory Structure Web Server Configuration ttree Configuration Simple pre_process and wrapper Templates Creating the Build Script A First HTML Page Automating the Project Configuration Process

Library Templates

Configuration Templates Layout Templates

Page wrappers Layout components

Content Templates

HTML Pages CSS and Other Non-HTML Pages Content Components Debugging Pages

Navigation Components

Adding Site Structure

Map nodes XML site map Selective mapmaking

Walking the Structure Building a Nested Menu A Stacked Menu Bread-Crumb Trail Previous and Next Pages

Structuring Page Content

Defining Sections

Section headers Section wrappers Sections and subsections

A Table of Contents

Anchor points Better page macros Generating the table of contents Reusing menu components Adding the table of contents automatically

Declarative Markup Using XML

XML page content XML page wrapper XML view templates

Creating a New Skin

Creating a Skin Custom Navigation Components

Nested menu Menu elements Stacked menu Other page components

12. Dynamic Web Content and Web Applications

CGI Scripts

Simple CGI Script

Using standard templates

Using the DATA Section Using the CGI Module

Setting cookies

CGI Script Web Application

CGI script

Preparation Application Presentation

Template components Page templates

CGI Templates

Using the CGI Plugin Web Programming in Templates

Dispatching CGI script Main control template Additional control templates Perl or template?

Apache and mod_perl

Apache::Template Custom Apache Handler

A Complete Web Application

Storage

TTBook::H2G2::Database

Configuration Application Apache mod_perl Interface Module Apache Configuration

A. Appendix: Configuration Options

Template Toolkit Configuration Options

ABSOLUTE ANYCASE AUTO_RESET BLOCKS CACHE_SIZE COMPILE_EXT COMPILE_DIR CONSTANTS CONSTANT_NAMESPACE NAMESPACE CONTEXT DEBUG DEBUG_FORMAT DEFAULT DELIMITER ERROR EVAL_PERL FACTORY FILTERS GRAMMAR INCLUDE_PATH INTERPOLATE LOAD_FILTERS LOAD_PERL LOAD_PLUGINS LOAD_TEMPLATES OUTPUT_PATH OUTPUT PARSER PLUGIN_BASE PLUGINS PRE_CHOMP, POST_CHOMP PRE_DEFINE, VARIABLES PRE_PROCESS, POST_PROCESS PROCESS RECURSION RELATIVE SERVICE STASH START_TAG, END_TAG TAG_STYLE TOLERANT TRIM VARIABLES, PRE_DEFINE V1DOLLAR

Apache::Template Configuration Options

TT2Tags TT2PreChomp TT2PostChomp TT2Trim TT2AnyCase TT2Interpolate TT2IncludePath TT2Absolute TT2Relative TT2Delimiter TT2PreProcess TT2PostProcess TT2Process TT2Default TT2Error TT2EvalPerl TT2LoadPerl TT2Recursion TT2PluginBase TT2AutoReset TT2CacheSize TT2CompileExt TT2CompileDir TT2Debug TT2Headers TT2Params TT2ServiceModule

Index About the Authors Colophon SPECIAL OFFER: Upgrade this ebook with O’Reilly

← Prev
Back
Next →

← Prev
Back
Next →