f1a63b72ffe201203a80a8dd0e450b4ee28f7d2f
[openafs-wiki.git] / TWiki / TWikiTemplates.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Templates"> TWiki Templates</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#The TWiki Template System"> The TWiki Template System</a><ul>
6             <li><a href="#How Template Directives Work"> How Template Directives Work</a></li>
7             <li><a href="#Finding Templates"> Finding Templates</a></li>
8           </ul>
9         </li>
10         <li><a href="#Master Templates"> Master Templates</a></li>
11         <li><a href="#HTML Page Templates"> HTML Page Templates</a></li>
12         <li><a href="#Template Topics"> Template Topics</a><ul>
13             <li><a href="#Edit Template Topics and Variabl"> Edit Template Topics and Variable Expansion</a></li>
14             <li><a href="#Template Topics in Action"> Template Topics in Action</a></li>
15             <li><a href="#Automatically Generated Topicnam"> Automatically Generated Topicname</a></li>
16           </ul>
17         </li>
18         <li><a href="#Master Templates by Example"> Master Templates by Example</a><ul>
19             <li><a href="#Base template oopsbase.tmpl"> Base template oopsbase.tmpl</a></li>
20             <li><a href="#Test template oopstest.tmpl"> Test template oopstest.tmpl</a></li>
21             <li><a href="#Sample screen shot of oopstest.t"> Sample screen shot of oopstest.tmpl</a></li>
22           </ul>
23         </li>
24       </ul>
25     </li>
26   </ul>
27 </div>
28
29 # <a name="TWiki Templates"></a> TWiki Templates
30
31 _Definition of the templates used to render all HTML pages displayed in TWiki_
32
33 ## <a name="Overview"></a> Overview
34
35 There are three types of template:
36
37 - **Master Templates**: Define blocks of text for use in other templates
38 - **HTML Page Templates**: Define the layout of %WIKITOOLNAME% pages
39 - **Template Topics**: Define default text when you create a new topic
40
41 All three types of template use the TWiki template system.
42
43 ## <a name="The TWiki Template System"></a> The TWiki Template System
44
45 _Templates_ are plain text with embedded _template directives_ that tell TWiki how to compose blocks of text together to create something new.
46
47 <a name="TemplateVariables"></a>
48
49 ### <a name="How Template Directives Work"></a> How Template Directives Work
50
51 - Template directives are embedded in templates.
52 - Directives are of the form <code>**%TMPL:&lt;key&gt;%**</code> and <code>**%TMPL:&lt;key&gt;\{"attr"\}%**</code>.
53 - Directives:
54   - <code>**%TMPL:INCLUDE\{"file"\}%**</code>: Includes a template file. The file is found as described [[below|Main/WebHome#FindingTemplates]].
55   - <code>**%TMPL:DEF\{"block"\}%**</code>: Define a block. Text between this and the `%TMPL:END%` directive is not used in-place, but is saved for later use with `%TMPL:P`. Leading and trailing whitespace is ignored.
56   - <code>**%TMPL:END%**</code>: Ends a block definition.
57   - <code>**%TMPL:P\{"var"\}%**</code>: Includes a previously defined block.
58   - <code>**%\{...\}%**</code>: is a comment.
59 - Two-pass processing lets you use a variable before or after declaring it.
60 - Templates and [[TWikiSkins]] work transparently and interchangeably. For example, you can create a skin that overloads only the `twiki.tmpl` master template, like `twiki.print.tmpl`, that redefines the header and footer.
61 - %H% Use of template directives is optional: templates work without them.
62 - %X% **NOTE:** Template directives work only for templates: they do not get processed in normal topic text.
63
64 TMPL:P also supports simple parameters. For example, given the definition `%TMPL:DEF{"x"}% x%P%z%TMPL:END%` then `%TMPL:P{"x" P="y"}%` will expand to `xyz`.
65
66 Note that parameters can simply be ignored; for example=%TMPL:P\{"x"\}%= will expand to x%P%z.
67
68 Any alphanumeric characters can be used in parameter names. You are highly recommended to use parameter names that cannot be confused with [[TWikiVariables]].
69
70 Note that three parameter names, `context`, `then` and `else` are **reserved**. They are used to support a limited form of "if" condition that you can use to select which of two templates to use, based on a _context identifier_:
71
72     %TMPL:DEF{"link_inactive"}%<input type="button" disabled value="Link>%TMPL:END%
73     %TMPL:DEF{"link_active"}%<input type="button" onclick="link()" value="Link" />%TMPL:END%
74     %TMPL:P{context="inactive" then="inactive_link" else="active_link"}% for %CONTEXT%
75
76 When the "inactive" context is set, then this will expand the "link\_inactive" template; otherwise it will expand the "link\_active" template. See [[IfStatements]] for details of supported context identifiers.
77
78 ### <a name="Finding Templates"></a> Finding Templates
79
80 Templates are stored either in the <code>**twiki/templates**</code> directory, or can also be read from user topics. As an example, <code>**twiki/templates/view.tmpl**</code> is the default template file for the <code>**twiki/bin/view**</code> script.
81
82 Templates that are included using `%TMPL:INCLUDE%` are also found using the same search algorithm, unless you explicitly put `'.tmpl'` at the end of the template name. In this case, the string is assumed to be the full name of a template in the `templates` directory, and the algorithm isn't used.
83
84 TWiki uses the following search order to determine which template file or topic to use for a particular script. The _skin path_ is set as described in [[TWikiSkins]].
85
86 > 1. templates/%RED%web%ENDCOLOR%/%RED%script%ENDCOLOR%.%RED%skin%ENDCOLOR%.tmpl for each %RED%skin%ENDCOLOR% on the skin path
87 >   - %X% this usage is supported **for compatibility only** and is **deprecated**. Store web-specific templates in TWiki topics instead.
88 > 2. templates/%RED%script%ENDCOLOR%.%RED%skin%ENDCOLOR%.tmpl for each %RED%skin%ENDCOLOR% on the skin path
89 > 3. templates/%RED%web%ENDCOLOR%/%RED%script%ENDCOLOR%.tmpl
90 >   - %X% this usage is supported **for compatibility only** and is **deprecated**. Store web-specific templates in TWiki topics instead.
91 > 4. templates/%RED%script%ENDCOLOR%.tmpl
92 > 5. The TWiki topic %RED%web%ENDCOLOR%.%RED%topic%ENDCOLOR% if the template name can be parsed into %RED%web%ENDCOLOR%.%RED%topic%ENDCOLOR%
93 > 6. The TWiki topic %RED%web%ENDCOLOR%.%RED%Skin%ENDCOLOR%Skin%RED%Script%ENDCOLOR%Template for each %RED%skin%ENDCOLOR% on the skin path
94 > 7. The TWiki topic %RED%web%ENDCOLOR%.%RED%Script%ENDCOLOR%Template
95 > 8. The TWiki topic TWiki.%RED%Skin%ENDCOLOR%Skin%RED%Script%ENDCOLOR%Template for each %RED%skin%ENDCOLOR% on the skin path
96 > 9. The TWiki topic TWiki.%RED%Script%ENDCOLOR%Template
97 >
98 > **Legend:**
99 >
100 > - %RED%script%ENDCOLOR% refers to the script name, e.g `view`, `edit`
101 > - %RED%Script%ENDCOLOR% refers to the same, but with the first character capitalized, e.g `View`
102 > - %RED%skin%ENDCOLOR% refers to a skin name, e.g `dragon`, `pattern`. All skins are checked at each stage, in the order they appear in the skin path.
103 > - %RED%Skin%ENDCOLOR% refers to the same, but with the first character capitalized, e.g `Dragon`
104 > - %RED%web%ENDCOLOR% refers to the current web
105
106 For example, the `example` template file will be searched for in the following places, when the current web is `Thisweb` and the skin path is `print,pattern`:
107
108 1. `templates/Thisweb/example.print.tmpl` _deprecated; don't rely on it_
109 2. `templates/Thisweb/example.pattern.tmpl` _deprecated; don't rely on it_
110 3. `templates/example.print.tmpl`
111 4. `templates/example.pattern.tmpl`
112 5. `templates/Thisweb/example.tmpl` _deprecated; don't rely on it_
113 6. `templates/example.tmpl`
114 7. `Thisweb.PrintSkinExampleTemplate`
115 8. `Thisweb.PatternSkinExampleTemplate`
116 9. `Thisweb.ExampleTemplate`
117 10. `TWiki.PrintSkinExampleTemplate`
118 11. `TWiki.PatternSkinExampleTemplate`
119 12. `TWiki.ExampleTemplate`
120
121 Template names are usually derived from the name of the currently executing script; however it is also possible to override these settings in the `view` and `edit` scripts, for example when a topic-specific template is required. Two preference variables can be user to override the templates used:
122
123 - `VIEW_TEMPLATE` sets the template to be used for viewing a topic
124 - `EDIT_TEMPLATE` sets the template for editing a topic.
125
126 If these preferences are set locally (using _Local_ instead of _Set_) for a topic, in [[WebPreferences]], in [[Main.TWikiPreferences|Main/TWikiPreferences]], or [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] (using _Set_), the indicated templates will be chosen for `view` and `edit` respectively. The template search order is as specified above.
127
128 ## <a name="Master Templates"></a> Master Templates
129
130 Master templates use the block definition directives (`%TMPL:DEF` and `%TMPL:END%`) to define common sections that appear in two or more other templates. <code>**twiki.tmpl**</code> is the default master template.
131
132 > <table border="1" cellpadding="0" cellspacing="0">
133 >   <tr>
134 >     <th bgcolor="#99CCCC"><strong> Template variable: </strong></th>
135 >     <th bgcolor="#99CCCC"><strong> Defines: </strong></th>
136 >   </tr>
137 >   <tr>
138 >     <td> %TMPL:DEF{"sep"}% </td>
139 >     <td> "|" separator </td>
140 >   </tr>
141 >   <tr>
142 >     <td> %TMPL:DEF{"htmldoctype"}% </td>
143 >     <td> Start of all HTML pages </td>
144 >   </tr>
145 >   <tr>
146 >     <td> %TMPL:DEF{"standardheader"}% </td>
147 >     <td> Standard header (ex: view, index, search) </td>
148 >   </tr>
149 >   <tr>
150 >     <td> %TMPL:DEF{"simpleheader"}% </td>
151 >     <td> Simple header with reduced links (ex: edit, attach, oops) </td>
152 >   </tr>
153 >   <tr>
154 >     <td> %TMPL:DEF{"standardfooter"}% </td>
155 >     <td> Footer, excluding revision and copyright parts </td>
156 >   </tr>
157 >   <tr>
158 >     <td> %TMPL:DEF{"oops"}% </td>
159 >     <td> Skeleton of oops dialog </td>
160 >   </tr>
161 > </table>
162
163 <a name="HtmlTemplates"></a>
164
165 ## <a name="HTML Page Templates"></a> HTML Page Templates
166
167 HTML page templates are files of HTML mixed with template directives that tell TWiki how to build up an HTML page. As described above, the template system supports the use of 'include' directives that let you re-use the same sections of HTML - such as headers and footers - in several different places.
168
169 TWiki uses HTML page templates when composing the output from all actions, like topic view, edit, and preview. This allows you to change the look and feel of all pages by editing just a few template files.
170
171 HTML page templates are also used in the definition of [[TWikiSkins]].
172
173 <a name="TemplateTopics"></a>
174
175 ## <a name="Template Topics"></a> Template Topics
176
177 Template topics define the default text for new topics. There are three types of template topic:
178
179 > <table border="1" cellpadding="0" cellspacing="0">
180 >   <tr>
181 >     <th bgcolor="#99CCCC"><strong> Topic Name: </strong></th>
182 >     <th bgcolor="#99CCCC"><strong> What it is: </strong></th>
183 >   </tr>
184 >   <tr>
185 >     <td>[[Main/WebTopicViewTemplate]]</td>
186 >     <td> Error page shown when you try to view a nonexistent topic </td>
187 >   </tr>
188 >   <tr>
189 >     <td>[[Main/WebTopicNonWikiTemplate]]</td>
190 >     <td> Alert page shown when you try to view a nonexistent topic with a non-WikiName </td>
191 >   </tr>
192 >   <tr>
193 >     <td>[[Main/WebTopicEditTemplate]]</td>
194 >     <td> Default text shown when you create a new topic. </td>
195 >   </tr>
196 > </table>
197
198 When you create a new topic, TWiki locates a topic to use as a content template according to the following search order:
199
200 1. A topic name specified by the `templatetopic` CGI parameter
201   - if no web is specified, the current web is searched first and then the TWiki web
202 2. WebTopicEditTemplate in the current web
203 3. WebTopicEditTemplate in the TWiki web
204
205 <a name="TemplateTopicsVars"></a>
206
207 ### <a name="Edit Template Topics and Variabl"></a> Edit Template Topics and Variable Expansion
208
209 The following variables get expanded when a user creates a new topic based on a template topic:
210
211 > <table border="1" cellpadding="0" cellspacing="0">
212 >   <tr>
213 >     <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
214 >     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
215 >   </tr>
216 >   <tr>
217 >     <td><code>%DATE%</code></td>
218 >     <td> Signature format date. See [[Main/TWikiVariables#VarDATE]]</td>
219 >   </tr>
220 >   <tr>
221 >     <td><code>%GMTIME%</code></td>
222 >     <td> Date/time. See [[Main/TWikiVariables#VarGMTIME]]</td>
223 >   </tr>
224 >   <tr>
225 >     <td><code>%GMTIME{...}%</code></td>
226 >     <td> Formatted date/time. See [[Main/TWikiVariables#VarGMTIME2]]</td>
227 >   </tr>
228 >   <tr>
229 >     <td><code>%NOP%</code></td>
230 >     <td> A no-operation variable that gets removed. Useful to prevent a SEARCH from hitting an edit template topic; also useful to escape a variable like <code>%URLPARAM%NOP%{...}%</code></td>
231 >   </tr>
232 >   <tr>
233 >     <td><code>%STARTSECTION{type="templateonly"}%%BR%...%BR%%ENDSECTION{type="templateonly"}%</code></td>
234 >     <td> Text that gets removed when a new topic based on the template is created. See notes below. </td>
235 >   </tr>
236 >   <tr>
237 >     <td><code>%SERVERTIME%</code></td>
238 >     <td> Date/time. See [[Main/TWikiVariables#VarSERVERTIME]]</td>
239 >   </tr>
240 >   <tr>
241 >     <td><code>%SERVERTIME{...}%</code></td>
242 >     <td> Formatted date/time. See [[Main/TWikiVariables#VarSERVERTIME2]]</td>
243 >   </tr>
244 >   <tr>
245 >     <td><code>%USERNAME%</code></td>
246 >     <td> Login name of user who is instantiating the new topic, e.g. admin </td>
247 >   </tr>
248 >   <tr>
249 >     <td><code>%URLPARAM{"name"}%</code></td>
250 >     <td> Value of a named URL parameter </td>
251 >   </tr>
252 >   <tr>
253 >     <td><code>%WIKINAME%</code></td>
254 >     <td>[[Main/WikiName]] of user who is instantiating the new topic, e.g. admin </td>
255 >   </tr>
256 >   <tr>
257 >     <td><code>%WIKIUSERNAME%</code></td>
258 >     <td> User name of user who is instantiating the new tpoic, e.g. Main.admin </td>
259 >   </tr>
260 > </table>
261
262 `%STARTSECTION{type="templateonly"}%%BR%...%BR%%ENDSECTION{type="templateonly"}%` markers are used to embed text that you _do not_ want expanded when a new topic based on the template topic is created. For example, you might want to write in the template topic:
263
264     %STARTSECTION{type="templateonly"}%
265     This template can only be changed by:
266        * Set ALLOWTOPICCHANGE = %MAINWEB%.TWikiAdminGroup
267     %ENDSECTION{type="templateonly"}%
268
269 This will restrict who can edit the template topic, but will get removed when a new topic based on that template topic is created.
270
271 `%NOP%` can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g.i escape `%nop>SERVERTIME%` with `%SER%NOP%VERTIME%`.
272
273 All other variables are unchanged, e.g. are carried over "as is" into the new topic.
274
275 ### <a name="Template Topics in Action"></a> Template Topics in Action
276
277 Here is an example for creating new topics based on a specific template topic:
278
279 <form action="http://www.dementia.org/twiki/edit/%WEB%/" name="new">
280   <ul>
281     <li> New example topic: <input name="topic" size="26" type="text" value="ExampleTopic2010x06x29" /> <input type="submit" value="Create" /> <input name="templatetopic" type="hidden" value="ExampleTopicTemplate" /> <input name="topicparent" type="hidden" value="%TOPIC%" /> <input name="onlywikiname" type="hidden" value="on" /> <input name="onlynewtopic" type="hidden" value="on" /> (date format is YYYYxMMxDD) </li>
282   </ul>
283 </form>
284
285 The above form asks for a topic name. A hidden input tag named <code>**templatetopic**</code> specifies [[ExampleTopicTemplate]] as the template topic to use. Here is the HTML source of the form:
286
287     <form name="new" action="%SCRIPTURLPATH{edit}%/%WEB%/">
288         * New example topic:
289           <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="26" />
290           <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" />
291           <input type="hidden" name="topicparent" value="%TOPIC%" />
292           <input type="hidden" name="onlywikiname" value="on" />
293           <input type="hidden" name="onlynewtopic" value="on" />
294           <input type="submit"  value="Create" />
295           (date format is <nop>YYYYxMMxDD)
296     </form>
297
298 See [[TWikiScripts]] for details of the parameters that the `edit` script understands.
299
300 %T% **TIP:** You can use the `%WIKIUSERNAME%` and `%DATE%` variables in your topic templates to include the signature of the person creating a new topic. The variables are expanded into fixed text when a new topic is created. The standard signature is: <br /><code>**-- %WIKIUSERNAME% - %DATE%**</code>
301
302 <a name="AutomaticallyGeneratedTopicname"></a>
303
304 ### <a name="Automatically Generated Topicnam"></a> Automatically Generated Topicname
305
306 If you want to make a TWiki application where you need automatically generated unique topicnames, you can use 10 X's in the edit / save URL, and they will be replaced on topic save with a count value. For example, BugIDXXXXXXXXXX will result in topics named BugID0, BugID1, BugID2 etc.
307
308 Example link to create a new topic:%BR%
309
310     [[%SCRIPTURLPATH{"edit"}%/%WEB%/BugIDXXXXXXXXXX?templatetopic=BugTemplate&amp;topicparent=%TOPIC%&amp;t=%SERVERTIME{"$day$hour$min$sec"}%][Create new item]]=
311
312 ## <a name="Master Templates by Example"></a> Master Templates by Example
313
314 Attached is an example of an oops based template `oopsbase.tmpl` and an example oops dialog `oopstest.tmpl` based on the base template. %T% **NOTE:** This isn't the release version, just a quick, simple demo.
315
316 ### <a name="Base template oopsbase.tmpl"></a> Base template oopsbase.tmpl
317
318 The first line declares a delimiter variable called "sep", used to separate multiple link items. The variable can be called anywhere by writing `%TMPL:P{"sep"}%`
319
320 > <table bgcolor="#f5f5f5" border="1" cellpadding="1" cellspacing="0">
321 >   <tr>
322 >     <td><pre>
323 > %TMPL:DEF{"sep"}% | %TMPL:END%
324 > &lt;html&gt;
325 > &lt;head&gt;
326 >   &lt;title&gt; %WIKITOOLNAME% . %WEB% . %TOPIC% %.TMPL:P{"titleaction"}%&lt;/title&gt;
327 >   &lt;base href="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%"&gt;
328 >   &lt;meta name="robots" content="noindex"&gt;
329 > &lt;/head&gt;
330 > &lt;body bgcolor="#FFFFFF"&gt;
331 > &lt;table width="100%" border="0" cellpadding="3" cellspacing="0"&gt;
332 >   &lt;tr&gt;
333 >        &lt;td bgcolor="%WEBBGCOLOR%" rowspan="2" valign="top" width="1%"&gt;
334 >               &lt;a href="%WIKIHOMEURL%"&gt;
335 >               &lt;img src="%PUBURLPATH%/wikiHome.gif" border="0"&gt;&lt;/a&gt;
336 >        &lt;/td&gt;
337 >        &lt;td&gt;
338 >               &lt;b&gt;%WIKITOOLNAME% . %WEB% . &lt;/b&gt;&lt;font size="+2"&gt;
339 >               &lt;B&gt;%TOPIC%&lt;/b&gt; %TMPL:P{"titleaction"}%&lt;/font&gt;
340 >        &lt;/td&gt;
341 >   &lt;/tr&gt;
342 >   &lt;tr bgcolor="%WEBBGCOLOR%"&gt;
343 >        &lt;td colspan="2"&gt;
344 >               %TMPL:P{"webaction"}%
345 >        &lt;/td&gt;
346 >   &lt;/tr&gt;
347 > &lt;/table&gt;
348 > --- ++ %TMPL:P{"heading"}%
349 > %TMPL:P{"message"}%
350 > &lt;table width="100%" border="0" cellpadding="3" cellspacing="0"&gt;
351 >   &lt;tr bgcolor="%WEBBGCOLOR%"&gt;
352 >        &lt;td valign="top"&gt;
353 >               Topic &lt;b&gt;%TOPIC%&lt;/b&gt; . {
354 >                 %TMPL:P{"topicaction"}%
355 >               }
356 >        &lt;/td&gt;
357 >   &lt;/tr&gt;
358 > &lt;/table&gt;
359 > &lt;/body&gt;
360 > </pre></td>
361 >   </tr>
362 > </table>
363
364 ### <a name="Test template oopstest.tmpl"></a> Test template oopstest.tmpl
365
366 Each oops template basically just defines some variables and includes the base template that does the layout work.
367
368 > <table bgcolor="#f5f5f5" border="1" cellpadding="1" cellspacing="0">
369 >   <tr>
370 >     <td><pre>
371 > %TMPL:DEF{"titleaction"}% (test =titleaction=) %TMPL:END%
372 > %TMPL:DEF{"webaction"}% test =webaction= %TMPL:END%
373 > %TMPL:DEF{"heading"}%
374 > Test heading %TMPL:END%
375 > %TMPL:DEF{"message"}%
376 > Test =message=. Blah blah blah blah blah blah blah blah blah blah blah...
377 >
378 >       * Some more blah blah blah blah blah blah blah blah blah blah...
379 >       * Param1: %PARAM1%
380 >       * Param2: %PARAM2%
381 >       * Param3: %PARAM3%
382 >       * Param4: %PARAM4%
383 > %TMPL:END%
384 > %TMPL:DEF{"topicaction"}%
385 > Test =topicaction=:
386 > [[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}%
387 > [[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END%
388 > %TMPL:INCLUDE{"oopsbase"}%
389 > </pre></td>
390 >   </tr>
391 > </table>
392
393 ### <a name="Sample screen shot of oopstest.t"></a> Sample screen shot of oopstest.tmpl
394
395 With URL: <code>**.../bin/oops/Sandbox/TestTopic2?template=oopstest&amp;param1=WebHome&amp;param2=WebNotify**</code>
396
397 > <table border="1" cellpadding="0" cellspacing="0">
398 >   <tr>
399 >     <td><img alt="testscreen.gif" height="304" src="http://www.dementia.org/twiki//view/testscreen.gif" width="589" /></td>
400 >   </tr>
401 > </table>
402
403 **_Related Topics:_** [[TWikiSkins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]]