none
[openafs-wiki.git] / TWiki / TWikiTemplates.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Template System"> TWiki Template System</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Major changes from the previous"> Major changes from the previous template system</a></li>
6         <li><a href="#Functional Specifications"> Functional Specifications</a></li>
7         <li><a href="#New Template System by Example"> New Template System by Example</a><ul>
8             <li><a href="#Base template oopsbase.tmpl"> Base template oopsbase.tmpl</a></li>
9             <li><a href="#Test template oopstest.tmpl"> Test template oopstest.tmpl</a></li>
10             <li><a href="#Sample screen shot of oopstest.t"> Sample screen shot of oopstest.tmpl</a></li>
11           </ul>
12         </li>
13         <li><a href="#Known Issues"> Known Issues</a></li>
14       </ul>
15     </li>
16   </ul>
17 </div>
18
19 # <a name="TWiki Template System"></a> TWiki Template System
20
21 _Definition of the templates used to render all HTML pages displayed in TWiki_
22
23 ## <a name="Overview"></a> Overview
24
25 The new modular template system is more flexible, efficient, and easily updated than the old set-up, where each template is a complete HTML file. The new master template approach places common templates parts, like headers and footers, in one shared file. This simplifies the conversion of templates into XHTML format, and provides a more versatile solution for templates and for [[skins|Main/TWikiDocumentation#TWiki_Skins]].
26
27 ## <a name="Major changes from the previous"></a><a name="Major changes from the previous "></a> Major changes from the previous template system
28
29 The main difference is that templates are now defined using variables to include template parts. You change one stored instance of a common element to update all occurrences. The new system:
30
31 - separates a set of common template parts into a base template that is included by all of the related templates;
32
33 - defines common variables, like a standard separator (ex: "|"), in the base template;
34
35 - defines variable text in the individual templates and passes it back to the base template.
36
37 ## <a name="Functional Specifications"></a> Functional Specifications
38
39 - Special template directives (or preprocessor commands) are embedded in normal templates.
40 - Use of template directives is optional, templates work without them.
41 - All template preprocessing is done in `&TWiki::Store::readTemplate()` so that the caller simply gets an expanded template file (the same as before).
42 - Directives are of the form `%TMPL:<key>%` and `%TMPL:<key>{"attr"}%`.
43 - Initial set of directives:
44   - `%TMPL:INCLUDE{"file"}%`: Includes a template file. The usual search path is applied.
45   - `%TMPL:DEF{"var"}%`: Define a variable. Text between this and the END directive is not returned, but put into a hash for later use.
46   - `%TMPL:END%`: Ends variable definition.
47   - `%TMPL:P{"var"}%`: Prints a previously defined variable.
48 - New directives can be added over time when needed, ex: IF-THEN-ELSE.
49 - Variables are live in a global name space, there is no parameter passing.
50 - Two-pass processing, so that you can use a variable before declaring it or after.
51 - Templates and [[skins|Main/TWikiDocumentation#TWiki_Skins]] work transparently and interchangeably. For example, you can create a skin that overloads just the `twiki.tmpl`, like `twiki.print.tmpl`, that redefines the header and footer.
52 - **_Note:_** The template directives work only for templates, they do not get processed in topic text.
53
54 ## <a name="New Template System by Example"></a> New Template System by Example
55
56 Attached is an example of an oops base template `oopsbase.tmpl` and a example oops dialog `oopstest.tmpl` which is based on the base template. **_NOTE:_** This isn't the release version, just a quick, simple demo.
57
58 ### <a name="Base template oopsbase.tmpl"></a> Base template oopsbase.tmpl
59
60 The first line declares the delimiter variable called "sep", used to separate multiple link items. The variable can be called anywhere by writing `%TMPL:P{"sep"}%`
61
62 **_NOTE:_** Added a dot to escape rendering of variables, i.e. read <code>**%.WEB%**</code> as <code>**%WEB%**</code>.
63
64 > <table border="1" cellspacing="0" cellpadding="1">
65 >     <tr><td>
66 >     <verbatim>
67 >     %.TMPL:DEF{"sep"}% | %.TMPL:END%
68 >     <html>
69 >     <head>
70 >       <title> %.WIKITOOLNAME% . %.WEB% . %.TOPIC% %.TMPL:P{"titleaction"}%</title>
71 >       <base href="%.SCRIPTURL%/view%.SCRIPTSUFFIX%/%.WEB%/%.TOPIC%">
72 >       <meta name="robots" content="noindex">
73 >     </head>
74 >     <body bgcolor="#FFFFFF">
75 >     <table width="100%" border="0" cellpadding="3" cellspacing="0">
76 >       <tr>
77 >        <td bgcolor="%.WEBBGCOLOR%" rowspan="2" valign="top" width="1%">
78 >               <a href="%.WIKIHOMEURL%">
79 >               <img src="%.PUBURLPATH%/wikiHome.gif" border="0"></a>
80 >        </td>
81 >        <td>
82 >               <b>%.WIKITOOLNAME% . %.WEB% . </b><font size="+2">
83 >               <B>%.TOPIC%</b> %.TMPL:P{"titleaction"}%</font>
84 >        </td>
85 >       </tr>
86 >       <tr bgcolor="%.WEBBGCOLOR%">
87 >        <td colspan="2">
88 >               %.TMPL:P{"webaction"}%
89 >        </td>
90 >       </tr>
91 >     </table>
92 >     --- ++ %.TMPL:P{"heading"}%
93 >     %.TMPL:P{"message"}%
94 >     <table width="100%" border="0" cellpadding="3" cellspacing="0">
95 >       <tr bgcolor="%.WEBBGCOLOR%">
96 >        <td valign="top">
97 >               Topic <b>%TOPIC%</b> . {
98 >                 %.TMPL:P{"topicaction"}%
99 >               }
100 >        </td>
101 >       </tr>
102 >     </table>
103 >     </body>
104 >     </verbatim>
105 >     </td></tr>
106 >     </table >
107
108 ### <a name="Test template oopstest.tmpl"></a> Test template oopstest.tmpl
109
110 Each oops template basically just defines some variables and includes the base template that does the layout work.
111
112 > <table border="1" cellpadding="1" cellspacing="0">
113 >   <tr>
114 >     <td><pre>
115 > %.TMPL:DEF{"titleaction"}% (test =titleaction=) %.TMPL:END%
116 > %.TMPL:DEF{"webaction"}% test =webaction= %.TMPL:END%
117 > %.TMPL:DEF{"heading"}%
118 > Test heading %.TMPL:END%
119 > %.TMPL:DEF{"message"}%
120 > Test =message=. Blah blah blah blah blah blah blah blah blah blah blah...
121 >
122 >    * Some more blah blah blah blah blah blah blah blah blah blah...
123 >    * Param1: %PARAM1%
124 >    * Param2: %PARAM2%
125 >    * Param3: %PARAM3%
126 >    * Param4: %PARAM4%
127 > %.TMPL:END%
128 > %.TMPL:DEF{"topicaction"}%
129 > Test =topicaction=:
130 > [[%.WEB%.%TOPIC%][OK]] %.TMPL:P{"sep"}%
131 > [[%.TWIKIWEB%.TWikiRegistration][Register]] %.TMPL:END%
132 > %.TMPL:INCLUDE{"oopsbase"}%
133 > </pre></td>
134 >   </tr>
135 >   <tr>
136 >     <td> &lt;/table &gt; </td>
137 >   </tr>
138 > </table>
139
140 ### <a name="Sample screen shot of oopstest.t"></a> Sample screen shot of oopstest.tmpl
141
142 With URL: <code>**.../bin/oops/Test/TestTopic2?template=oopstest&amp;param1=WebHome&amp;param2=WebNotify**</code>
143
144 > <table border="1" cellpadding="0" cellspacing="0">
145 >   <tr>
146 >     <td><img alt="testscreen.gif" height="304" src="http://www.dementia.org/twiki//view/testscreen.gif" width="554" /></td>
147 >   </tr>
148 > </table>
149
150 All common template parts are defined in one master template, `twiki.tmpl`, that all other templates include.
151
152 <table border="1" cellpadding="0" cellspacing="0">
153   <tr>
154     <th bgcolor="#99CCCC"><strong> Template variable: </strong></th>
155     <th bgcolor="#99CCCC"><strong> Defines: </strong></th>
156   </tr>
157   <tr>
158     <td> %TMPL:DEF{"sep"}% </td>
159     <td> "|" separator </td>
160   </tr>
161   <tr>
162     <td> %TMPL:DEF{"htmldoctype"}% </td>
163     <td> Start of all HTML pages </td>
164   </tr>
165   <tr>
166     <td> %TMPL:DEF{"standardheader"}% </td>
167     <td> Standard header (ex: view, index, seach) </td>
168   </tr>
169   <tr>
170     <td> %TMPL:DEF{"simpleheader"}% </td>
171     <td> Simple header with reduced links (ex: edit, attach, oops) </td>
172   </tr>
173   <tr>
174     <td> %TMPL:DEF{"standardfooter"}% </td>
175     <td> Footer, excluding revision and copyright parts </td>
176   </tr>
177   <tr>
178     <td> %TMPL:DEF{"oops"}% </td>
179     <td> Skeleton of oops dialog </td>
180   </tr>
181 </table>
182
183 > **Example: `preview.tmpl` template**
184 >
185 >     %TMPL:INCLUDE{"twiki"}%
186 >     %TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
187 >     %TMPL:DEF{"webaction"}% *Attention* %TMPL:END%
188 >     %TMPL:DEF{"heading"}% Topic is not saved yet %TMPL:END%
189 >     %TMPL:DEF{"message"}% Please go back in your browser and save the topic. %TMPL:END%
190 >     %TMPL:DEF{"topicaction"}%
191 >     %TMPL:END%
192 >     %TMPL:P{"oops"}%
193
194 ## <a name="Known Issues"></a> Known Issues
195
196 - A drawback of referring to a master template is that you can only test a template from within TWiki, where the include variables are resolved. In the previous system, each template is a structurally complete HTML document with a `.tmpl` filename extension - it contains unresolved `%VARIABLES%`, but can still be previewed directly in a browser.
197
198 -- [[PeterThoeny]] - 23 Jul 2001 <br /> -- [[MikeMannix]] - 30 Aug 2001