Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 234 lines (152 sloc) 7.371 kb
9d8f7867 »
2001-09-21 *** empty log message ***
1
2 Template Toolkit
3
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
4 Version 2.24
9d8f7867 »
2001-09-21 *** empty log message ***
5
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
6 February 2012
9d8f7867 »
2001-09-21 *** empty log message ***
7
d7926403 »
2012-01-21 Updated README, Changes, etc, for release
8 Copyright (C) 1996-2012 Andy Wardley. All Rights Reserved
9d8f7867 »
2001-09-21 *** empty log message ***
9
10 This is free software; you can redistribute it and/or
11 modify it under the same terms as Perl itself.
12
13 QUICK INSTALL
14 -------------
15
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
16 If you have the CPAN module installed then you can install the Template
17 Toolkit like this from the command line:
18
19 $ cpan Template
20
21 Otherwise you can install from source code. The latest version of the Template
22 Toolkit can be retrieved from:
9d8f7867 »
2001-09-21 *** empty log message ***
23
24 http://www.cpan.org/modules/by-module/Template/
25
d56b9a8c »
2006-01-30 commit for 2.14a
26 Fetch and install AppConfig 1.56 if you don't already have it installed.
9d8f7867 »
2001-09-21 *** empty log message ***
27 Available from CPAN in:
28
29 http://www.cpan.org/authors/Andy_Wardley/
30
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
31 To install the Template Toolkit from the command line:
9d8f7867 »
2001-09-21 *** empty log message ***
32
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
33 $ tar zxf Template-Toolkit-2.24.tar.gz
34 $ cd Template-Toolkit-2.24
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
35 $ perl Makefile.PL
36 $ make
37 $ make test
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
38 $ make install
9d8f7867 »
2001-09-21 *** empty log message ***
39
ea1f16ef »
2008-08-13 Final updates to README, etc., for 2.20
40 The Makefile.PL will prompt for any additional configuration options.
9d8f7867 »
2001-09-21 *** empty log message ***
41
42 For further details, see the sections below on CONFIGURATION, BUILDING
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
43 AND TESTING, and INSTALLATION. The Template Toolkit web site also has
44 further information about installation.
45
46 http://template-toolkit.org/download/index.html
9d8f7867 »
2001-09-21 *** empty log message ***
47
48
49 PREREQUISITES
50 -------------
51
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
52 The Template Toolkit is written entirely in Perl and should run on any
c942c1b4 »
2006-05-26 Version 2.15
53 platform on which Perl is available. It requires Perl 5.006 or later.
9d8f7867 »
2001-09-21 *** empty log message ***
54
c942c1b4 »
2006-05-26 Version 2.15
55 The 'ttree' utility uses the AppConfig module (version 1.56 or above)
9d8f7867 »
2001-09-21 *** empty log message ***
56 for parsing command line options and configuration files. It is
57 available from CPAN:
58
59 http://www.cpan.org/authors/Andy_Wardley/
60
61 The Template Toolkit implements a "plugin" architecture which allow
62 you to incorporate the functionality of virtually any Perl module into
63 your templates. A number of plugin modules are included with the
d56b9a8c »
2006-01-30 commit for 2.14a
64 distribution for adding extra functionality or interfacing to external
65 CPAN modules. You don't need to install any of these external modules
66 unless you plan to use those particular plugins. See Template::Plugins
67 and Template::Manual::Plugins for further details.
9d8f7867 »
2001-09-21 *** empty log message ***
68
69
70 OBTAINING AND INSTALLING THE TEMPLATE TOOLKIT
71 ---------------------------------------------
72
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
73 The latest release version of the Template Toolkit can be downloaded
9d8f7867 »
2001-09-21 *** empty log message ***
74 from any CPAN site:
75
76 http://www.cpan.org/modules/by-module/Template/
77
78 Interim and development versions may also be available, along with
79 other useful information, news, publications, mailing list archives,
80 etc., from the Template Toolkit web site:
81
ea1f16ef »
2008-08-13 Final updates to README, etc., for 2.20
82 http://template-toolkit.org/
9d8f7867 »
2001-09-21 *** empty log message ***
83
84 The Template Toolkit is distributed as a gzipped tar archive file:
85
86 Template-Toolkit-<version>.tar.gz
87
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
88 where <version> represents the current version number, e.g. 2.24.
9d8f7867 »
2001-09-21 *** empty log message ***
89
90 To install the Template Toolkit, unpack the distribution archive to
91 create an installation directory. Something like this:
92
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
93 $ tar zxf Template-Toolkit-2.24.tar.gz
9d8f7867 »
2001-09-21 *** empty log message ***
94 or
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
95 $ gunzip Template-Toolkit-2.24.tar.gz
96 $ tar xf Template-Toolkit-2.24.tar
9d8f7867 »
2001-09-21 *** empty log message ***
97
98 You can then 'cd' into the directory created,
99
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
100 $ cd Template-Toolkit-2.24
9d8f7867 »
2001-09-21 *** empty log message ***
101
102 and perform the usual Perl installation procedure:
103
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
104 $ perl Makefile.PL
105 $ make
106 $ make test
107 $ make install # may need root access
9d8f7867 »
2001-09-21 *** empty log message ***
108
109 The Makefile.PL performs various sanity checks and then prompts for a
110 number of configuration items. The following CONFIGURATION section
111 covers this in greater detail.
112
113 If you choose to install the optional components then you may need to
114 perform some post-installation steps to ensure that the template
115 libraries, HTML documentation and examples can be correctly viewed via
116 your web browser. The INSTALLATION section covers this.
117
118
72df2bfc »
2001-11-06 2.05d prep
119 INSTALLING ON MICROSOFT WIN32 PLATFORMS
120 ---------------------------------------
121
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
122 For advice on using Perl under Microsoft Windows, have a look here:
123
8c1caef2 »
2008-08-13 Updated README, INSTALL, HACKING, TODO, etc for 2.20 release
124 http://win32.perl.org/
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
125
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
126 If you're using Strawberry Perl then you can install the Template
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
127 Toolkit using the CPAN module as described above.
128
129 If you're using ActivePerl then you can install it using the Perl Package
130 Manager (ppm) with the pre-compiled packages built by Chris Winters. For
131 further details, see:
72df2bfc »
2001-11-06 2.05d prep
132
133 http://openinteract.sourceforge.net/
134 http://activestate.com/
135
136 If you prefer, you can manually install the Template Toolkit on Win32
137 systems by following the instructions in this installation guide.
138 However, please note that you are likely to encounter problems using
139 'make' and should instead download and use 'nmake' as a replacement.
140 This is available from Microsoft's ftp site.
141
142 ftp://ftp.microsoft.com/Softlib/MSLFILES/nmake15.exe
143
144 In this case, you should substitute 'nmake' for 'make' in all the
145 instructions contained herein.
146
147
9d8f7867 »
2001-09-21 *** empty log message ***
148 CONFIGURATION
149 -------------
150
151 This section covers the configuration of the Template Toolkit via
152 the Makefile.PL program. If you've successfully run this and didn't
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
153 have any problems answering any of the questions then you probably
9d8f7867 »
2001-09-21 *** empty log message ***
154 don't need to read this section.
155
156 The Makefile.PL Perl program performs the module configuration and
157 generates the Makefile which can then be used to build, test and
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
158 install the Template Toolkit.
9d8f7867 »
2001-09-21 *** empty log message ***
159
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
160 $ perl Makefile.PL
9d8f7867 »
2001-09-21 *** empty log message ***
161
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
162 The Template Toolkit now boasts a high-speed implementation of
9d8f7867 »
2001-09-21 *** empty log message ***
163 Template::Stash written in XS. You can choose to build this as
164 an optional module for using explicitly as an alternative to
165 the regular pure-perl stash module. In additional, you can opt
166 to use the XS Stash as the default, typically making the Template
167 Toolkit run twice as fast!
168
169 When prompted, answer 'y' or 'n' to build and optionally use
170 the XS Stash module by default:
171
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
172 Do you want to build the XS Stash module? [y]
173 Do you want to use the XS Stash for all Templates? [n]
9d8f7867 »
2001-09-21 *** empty log message ***
174
175 BUILDING AND TESTING
176 --------------------
177
178 This section describes the "make" and "make test" commands which build
179 and test the Template Toolkit. If you ran these without incident,
180 then you can probably skip this section.
181
b95e0ae2 »
2012-02-07 Bumped version number to 2.24, updated Changes, README, etc
182 The 'make' command will build the Template Toolkit modules in the
183 usual manner.
9d8f7867 »
2001-09-21 *** empty log message ***
184
185 make
186
187 The 'make test' command runs the test scripts in the 't' subdirectory.
188
c942c1b4 »
2006-05-26 Version 2.15
189 make test
9d8f7867 »
2001-09-21 *** empty log message ***
190
191 You can set the TEST_VERBOSE flag when running 'make test' to see the
192 results of the individual tests:
193
194 make test TEST_VERBOSE=1
195
196
197 INSTALLATION
198 ------------
199
200 This section describes the final installation of the Template Toolkit
201 via the "make install" and covers any additional steps you may need to
202 take if you opted to build the HTML documentation and/or examples.
203
204 The 'make install' will install the modules and scripts on your
205 system. You may need administrator privileges to perform this task.
206 Alternately you can can install the Template Toolkit to a local
207 directory (see ExtUtils::MakeMaker for full details), e.g.
208
ed4f3da5 »
2008-08-13 Updated README and INSTALL for 2.20 release
209 $ perl Makefile.PL PREFIX=/home/abw/
9d8f7867 »
2001-09-21 *** empty log message ***
210
211 Don't forget to update your PERL5LIB environment variable if you do
212 this, or add a line to your script to tell Perl where to find the files,
213 e.g.
214
8c1caef2 »
2008-08-13 Updated README, INSTALL, HACKING, TODO, etc for 2.20 release
215 use lib qw( /home/abw/lib/perl5/site_perl/5.10.0 );
9d8f7867 »
2001-09-21 *** empty log message ***
216
217
218 AUTHOR
219 ------
220
d9145459 »
2003-04-23 version 2.09
221 The Template Toolkit was written by Andy Wardley <abw@wardley.org> with
9d8f7867 »
2001-09-21 *** empty log message ***
222 the invaluable assistance and contributions from many other people.
223 See Template::Manual::Credits for details.
224
225
226 COPYRIGHT
227 ---------
228
d7926403 »
2012-01-21 Updated README, Changes, etc, for release
229 Copyright (C) 1996-2012 Andy Wardley. All Rights Reserved.
9d8f7867 »
2001-09-21 *** empty log message ***
230
231 This is free software; you can redistribute it and/or modify it under
232 the same terms as Perl itself.
233
Something went wrong with that request. Please try again.