Debian Codegraph @

README

raw
1
2 Template Toolkit LaTeX Plugin
3
4 Version 3.09
5
6 09 July 2016
7
8 Copyright (C) 2014-2016 Chris Travers. All Rights Reserved.
9 Copyright (C) 2006-2014 Andrew Ford. All Rights Reserved
10 Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved
11
12 This is free software; you can redistribute it and/or
13 modify it under the same terms as Perl itself.
14
15
16 DESCRIPTION
17 -----------
18
19 The Template Toolkit is a collection of modules which implement a
20 fast, flexible, powerful and extensible template processing system.
21 The LaTeX plugin provides the facility to filter content through
22 LaTeX, provided of course that the content is valid LaTeX source.
23
24 The LaTeX plugin takes care of running and re-running latex so that
25 forward references, tables of contents, and lists of figures and
26 tables are resolved. It will also run bibtex and makeindex if it
27 detects that a bibliography or in index have been specified, and will
28 re-run latex again one or more times until the formatting of the
29 document has stabilized. (This functionality is new in version 3.00
30 of the module.)
31
32
33
34 QUICK START
35 -----------
36
37 The latest version of the Template Toolkit LaTeX Plugin can be
38 retrieved from:
39
40 http://www.cpan.org/modules/by-module/Template-Latex/
41
42 Fetch and install Template Toolkit (2.16 or newer) if you don't
43 already have it installed. Available from CPAN in:
44
45 http://www.cpan.org/authors/Andy_Wardley/
46
47 To install the Template Toolkit Latex Plugin:
48
49 tar zxf Template-Latex-3.00_05.tar.gz
50 cd Template-Latex-3.00_05
51 perl Makefile.PL
52 make
53 make test
54 make install
55
56 The Makefile.PL will prompt for additional configuration options,
57 including the installation of optional template libraries, HTML
58 documentation and examples. You can safely answer 'n' to all of these
59 questions for a quick and basic installation.
60
61 If you're running ActivePerl on a Win32 platform then you can use the
62 Perl Package Manager (PPM) to install the Template Toolkit. Chris
63 Winters maintains a repository of pre-compiled PPM packages which contains
64 the Template Toolkit, AppConfig and others. For further information, see:
65
66 http://openinteract.sourceforge.net/
67
68
69 For further details on installation, see the separate INSTALL file.
70
71
72 WHAT'S NEW?
73 -----------
74
75 Version 3.00 is a complete rewrite of Template-Latex.
76
77 Version 2.16 was the first release of Template-Latex. It was created
78 by moving the code out of the core Template Toolkit distribution
79 (version 2.15).
80
81 See the Changes file for further details of the changes in these
82 releases.
83
84
85 GENERAL FEATURES
86 ----------------
87
88 Some of the key features of the Template Toolkit Latex Plugin are listed below.
89 See the documentation for further detail.
90
91
92 DOCUMENTATION
93 -------------
94
95 The Template Toolkit is provided with enough documentation to keep all
96 but the most voracious reader happy for quite some time.
97
98 The 'Changes' file in the distribution directory documents all visible
99 changes between versions of the Template Toolkit. See the section
100 'VERSION COMPATABILITY' below for further details.
101
102 The 'TODO' file, also in the distribution directory, lists known bugs,
103 planned enhancements and possible new features for future versions.
104
105 The rest of the documentation is distributed in Pod and HTML formats.
106 The Pod pages are installed when you 'make install' and can be viewed
107 using 'perldoc', e.g.
108
109
110 SUPPORT
111 -------
112
113 The Template Toolkit mailing list provides a forum for discussing
114 issues relating to the use and abuse of the Template Toolkit. There
115 are a number of knowledgeable and helpful individuals who frequent the
116 list (including the author) who can often offer help or suggestions.
117 Please respect their time and patience by checking the documentation
118 and/or mailing list archives before asking questions that may already
119 have been answered.
120
121 To subscribe to the mailing list, send an email to:
122
123 [email protected]
124
125 with the message 'subscribe' in the body. You can also use the web
126 interface to subscribe or browse the archives:
127
128 http://www.template-toolkit.org/mailman/listinfo/templates
129
130 A low-volume, moderated mailing list exists for announcements about new
131 releases of the Template Toolkit and related products. To subscribe, send
132 an email to:
133
134 [email protected]
135
136 with the message 'subscribe' in the body. A web interface also exists
137 for subscription and browsing the archives:
138
139 http://www.template-toolkit.org/mailman/listinfo/templates-announce
140
141 For information about commercial support and consultancy for the Template
142 Toolkit, please contact the author.
143
144
145 AUTHOR
146 ------
147
148 The Template Toolkit Latex plugin was originally written as part of
149 the Template Toolkit distribution by Andy Wardley <[email protected]>
150 with the assistance and contributions from many other people. In 2006
151 the Latex plugin was separated out into its own distribution and
152 Andrew Ford <[email protected]> the took over as maintainer.
153
154 See Template::Manual::Credits for details.
155
156
157 COPYRIGHT
158 ---------
159
160 Copyright (C) 2006-2007 Andrew Ford. All Rights Reserved.
161 Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.
162
163 This is free software; you can redistribute it and/or modify it under
164 the same terms as Perl itself.
165