86e19ea2e64d9eb05af56f98a4d83e23b7a4b16a
[openafs-wiki.git] / TWiki / TWikiTemplates.mdwn
1 # <a name="new topic for the final doc"></a> new topic for the final doc
2
3 Slightly edited down, but waiting for new docs, hopefully.
4
5 see also for ref: orig [[TWikiTemplatingSystem]]
6
7 <div>
8   <ul>
9     <li><a href="#new topic for the final doc"> new topic for the final doc</a><ul>
10         <li><a href="#TWiki Template System"> TWiki Template System</a><ul>
11             <li><a href="#Overview"> Overview</a></li>
12             <li><a href="#Needs of the TWiki templating sy"> Needs of the TWiki templating system</a></li>
13             <li><a href="#Functional Spec"> Functional Spec</a></li>
14             <li><a href="#Examples"> Examples</a><ul>
15                 <li>
16                   <ul>
17                     <li><a href="#Base template oopsbase.tmpl"> Base template oopsbase.tmpl</a></li>
18                     <li><a href="#Test template oopstest.tmpl"> Test template oopstest.tmpl</a></li>
19                     <li><a href="#Sample screen shot of oopstest.t"> Sample screen shot of oopstest.tmpl</a></li>
20                   </ul>
21                 </li>
22               </ul>
23             </li>
24             <li><a href="#Comments and feedback"> Comments and feedback</a></li>
25           </ul>
26         </li>
27       </ul>
28     </li>
29   </ul>
30 </div>
31
32 ## <a name="TWiki Template System"></a> TWiki Template System
33
34 _Define the templates used to render all HTML pages displayed in TWiki_
35
36 ### <a name="Overview"></a> Overview
37
38 We have a need for more advanced template handling. As [[JohnTalintyre]] pointed out in [[CommonHeaderFooterTemplate]] it makes sense to separate the header and footer into one file so that it can be easily altered (or even overloaded by a skin). Also the oops dialog messages are all identical except for a few variables like heading, and so on.
39
40 Using external modules like the [[TemplateToolkit]] would be one way to go, but this will add a lot of baggage to TWiki.
41
42 ### <a name="Needs of the TWiki templating sy"></a> Needs of the TWiki templating system
43
44 - Separate common parts into one (or more) base template file(s) and include that from other template files like `view.tmpl`.
45 - Define common variables like a "|" separator in the base template and use them in other template files
46 - Define variable text in templates (i.e. `view.tmpl`) and pass them to the base template
47
48 ### <a name="Functional Spec"></a> Functional Spec
49
50 I tried to define a simple but powerful solution that can be extended over time. Here we go:
51
52 - Special template directives (or preprocessor commands) are embedded in normal templates.
53 - Use of template directives is optional, templates work without them.
54 - All template preprocessing is done in `&TWiki::Store::readTemplate()` so that the caller simply gets an expanded template file (the same as before)
55 - Directives are of form `%TMPL:<key>%` and `%TMPL:<key>{"attr"}%`.
56 - Initial set of directives:
57   - `%TMPL:INCLUDE{"file"}%`: Includes a template file. The usual search path is applied.
58   - `%TMPL:DEF{"var"}%`: Define a variable. Text between this and the END directive is not returned, but put into a hash for later use.
59   - `%TMPL:END%`: Ends variable definition.
60   - `%TMPL:P{"var"}%`: Prints a previously defined variable.
61 - New directives can be added over time when needed, i.e. IF-THEN-ELSE.
62 - Variables live in a global name space, there is no parameter passing.
63 - Two pass processing, so that you can use a variable before declaring it or after.
64 - Templates and skins work transparently and interchangeably. You could for example define a new skin just for the header &amp; footer and keep the other template files unchanged.
65 - **_Note:_** The template directive work only for templates, they do not get processed in topic text.
66
67 ### <a name="Examples"></a> Examples
68
69 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. This is not the version that will go into the release, it is just a quick hack.
70
71 ##### <a name="Base template oopsbase.tmpl"></a> Base template oopsbase.tmpl
72
73 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"}%`
74
75 **_Note:_** Added a dot to escape rendering of variables, i.e. read <code>**%.WEB%**</code> as <code>**%WEB%**</code>.
76
77     <table border="1" cellspacing="0" cellpadding="1">
78     <tr><td>
79     <verbatim>
80     %.TMPL:DEF{"sep"}% | %.TMPL:END%
81     <html>
82     <head>
83       <title> %.WIKITOOLNAME% . %.WEB% . %.TOPIC% %.TMPL:P{"titleaction"}%</title>
84       <base href="%.SCRIPTURL%/view%.SCRIPTSUFFIX%/%.WEB%/%.TOPIC%">
85       <meta name="robots" content="noindex">
86     </head>
87     <body bgcolor="#FFFFFF">
88     <table width="100%" border="0" cellpadding="3" cellspacing="0">
89       <tr>
90          <td bgcolor="%.WEBBGCOLOR%" rowspan="2" valign="top" width="1%">
91                 <a href="%.WIKIHOMEURL%">
92                 <img src="%.PUBURLPATH%/wikiHome.gif" border="0"></a>
93          </td>
94          <td>
95                 <b>%.WIKITOOLNAME% . %.WEB% . </b><font size="+2">
96                 <B>%.TOPIC%</b> %.TMPL:P{"titleaction"}%</font>
97          </td>
98       </tr>
99       <tr bgcolor="%.WEBBGCOLOR%">
100          <td colspan="2">
101                 %.TMPL:P{"webaction"}%
102          </td>
103       </tr>
104     </table>
105     --- ++ %.TMPL:P{"heading"}%
106     %.TMPL:P{"message"}%
107     <table width="100%" border="0" cellpadding="3" cellspacing="0">
108       <tr bgcolor="%.WEBBGCOLOR%">
109          <td valign="top">
110                 Topic <b>%TOPIC%</b> . {
111                   %.TMPL:P{"topicaction"}%
112                 }
113          </td>
114       </tr>
115     </table>
116     </body>
117     </verbatim>
118     </td></tr>
119     </table >
120
121 ##### <a name="Test template oopstest.tmpl"></a> Test template oopstest.tmpl
122
123 Each oops template basically just defines some variables and includes the base template that does the layout work.
124
125 <table border="1" cellpadding="1" cellspacing="0">
126   <tr>
127     <td><pre>
128 %.TMPL:DEF{"titleaction"}% (test =titleaction=) %.TMPL:END%
129 %.TMPL:DEF{"webaction"}% test =webaction= %.TMPL:END%
130 %.TMPL:DEF{"heading"}%
131 Test heading %.TMPL:END%
132 %.TMPL:DEF{"message"}%
133 Test =message=. Blah blah blah blah blah blah blah blah blah blah blah...
134
135    * Some more blah blah blah blah blah blah blah blah blah blah...
136    * Param1: %PARAM1%
137    * Param2: %PARAM2%
138    * Param3: %PARAM3%
139    * Param4: %PARAM4%
140 %.TMPL:END%
141 %.TMPL:DEF{"topicaction"}%
142 Test =topicaction=:
143 [[%.WEB%.%TOPIC%][OK]] %.TMPL:P{"sep"}%
144 [[%.TWIKIWEB%.TWikiRegistration][Register]] %.TMPL:END%
145 %.TMPL:INCLUDE{"oopsbase"}%
146 </pre></td>
147   </tr>
148   <tr>
149     <td> &lt;/table &gt; <p>
150       </p>
151       <h5><a name="Sample screen shot of oopstest.t"></a> Sample screen shot of oopstest.tmpl </h5>
152       <p> With URL: <code><b>.../bin/oops/Test/TestTopic2?template=oopstest&amp;param1=WebHome&amp;param2=WebNotify</b></code></p>
153       <p>
154       </p>
155       <table border="1" cellpadding="0" cellspacing="0">
156         <tr>
157           <td><img alt="testscreen.gif" height="304" src="http://www.dementia.org/twiki//view/testscreen.gif" width="554" /></td>
158         </tr>
159       </table>
160       <p>
161       </p>
162       <h3><a name="Comments and feedback"></a> Comments and feedback </h3>
163       <p>
164       </p>
165       <ul>
166         <li> The itching factor to put this into the upcoming release is to easy the pending converstion of the templates into XHTML format and to have a more flexible solution for templates and skins. </li>
167         <li> Is the terminology OK? </li>
168         <li> Is the spec OK? </li>
169         <li> Are there any other directives that are needed urgently? </li>
170         <li> One drawback by using the directives is that you can only test a template from within TWiki. This is because you don't have a text that has a linear flow when you use TMPL:DEF, TMPL:P and TMPL:INCLUDE. </li>
171       </ul>
172       <p> -- [[Main/PeterThoeny]] - 21 Jul 2001 <br />
173       </p>
174       <p>
175       </p>
176       <ul>
177         <li> It's probably more readable to enforce variables being defined before use, which would avoid need for slower two-pass processing. <ul>
178             <li> [ [[Main/PeterThoeny]] ] You need two-pass processing because you need to define the "|" separator in the included template onone side, and on the other side define variables for the included template. The processing happens as regex in memory, so there is no mesurable speed penalty. </li>
179           </ul>
180         </li>
181         <li> It would be nice to simplify the syntax a bit, e.g. not using "" around variable names (they don't really need it, unlike filenames), and not using braces - however, this is not a big deal and there is some merit in keeping consistent with the current TWiki syntax. <ul>
182             <li> [ [[Main/PeterThoeny]] ] The templating system uses the standard internal TWiki function to parse variable attributes. The "" can be skipped (is possible but is not documented). </li>
183           </ul>
184         </li>
185       </ul>
186       <p>
187       </p>
188       <p> Please have a look at the latest templates in the [[Main/TWikiAlphaRelease]]. There is now one master template called <code>twiki.tmpl</code> that all other templates include (well, will include when all done). The idea is to define all common parts of the templates in <code>twiki.tmpl</code> and simply use that from all other templates. </p>
189       <p>
190       </p>
191       <table border="1" cellpadding="0" cellspacing="0">
192         <tr>
193           <th bgcolor="#99CCCC"><strong> Template variable: </strong></th>
194           <th bgcolor="#99CCCC"><strong> Defines: </strong></th>
195         </tr>
196         <tr>
197           <td> %TMPL:DEF{"sep"}% </td>
198           <td> %TMPL:END% </td>
199           <td> "|" separator </td>
200         </tr>
201         <tr>
202           <td> %TMPL:DEF{"htmldoctype"}% </td>
203           <td> Start of all HTML pages </td>
204         </tr>
205         <tr>
206           <td> %TMPL:DEF{"standardheader"}% </td>
207           <td> Standard header (for view, rdiff, ... </td>
208         </tr>
209         <tr>
210           <td> %TMPL:DEF{"simpleheader"}% </td>
211           <td> Simple header with reduced links (for edit, attach, oops,...) </td>
212         </tr>
213         <tr>
214           <td> %TMPL:DEF{"standardfooter"}% </td>
215           <td> Footer, excluding revision part and copyright part </td>
216         </tr>
217         <tr>
218           <td> %TMPL:DEF{"oops"}% </td>
219           <td> Skeleton of oops dialog </td>
220         </tr>
221       </table>
222       <p> I.e. the <code>preview.tmpl</code> template is now simply: </p><pre>
223 %TMPL:INCLUDE{"twiki"}%
224 %TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
225 %TMPL:DEF{"webaction"}% *Attention* %TMPL:END%
226 %TMPL:DEF{"heading"}% Topic is not saved yet %TMPL:END%
227 %TMPL:DEF{"message"}%
228   Please go back in your browser and save the topic. %TMPL:END%
229 %TMPL:DEF{"topicaction"}% %TMPL:END%
230 %TMPL:P{"oops"}%
231 </pre><p> With this it should be possible to create a skin that overloads just the <code>twiki.tmpl</code>, i.e. a <code>twiki.print.tmpl</code> that redefines the header and footer. </p>
232       <p> -- [[Main/PeterThoeny]] - 23 Jul 2001 <br /> -- [[Main/MikeMannix]] - 30 Aug 2001 </p>
233       <p>
234       </p>
235     </td>
236   </tr>
237 </table>