| |
| META TOPICPARENT | name="WebHome" |
|---|
|
| | Overview |
|
<
< | 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. |
>
> | 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 TWikiSkins. |
| | Major changes from the previous template system |
| |
- Use of template directives is optional, templates work without them.
- All template preprocessing is done in
&TWiki::Store::readTemplate() so that the caller simply gets an expanded template file (the same as before).
- Directives are of the form
%TMPL:<key>% and %TMPL:<key>{"attr"}%.
|
|
<
< |
- Initial set of directives:
-
%TMPL:INCLUDE{"file"}%: Includes a template file. The usual search path is applied.
|
>
> |
- Directives:
-
%TMPL:INCLUDE{"file"}%: Includes a template file. The template directory of the current web is searched first, then the templates root (twiki/templates).
|
| |
-
-
%TMPL:DEF{"var"}%: Define a variable. Text between this and the END directive is not returned, but put into a hash for later use.
-
%TMPL:END%: Ends variable definition.
-
%TMPL:P{"var"}%: Prints a previously defined variable.
|
|
<
< |
- New directives can be added over time when needed, ex: IF-THEN-ELSE.
|
| |
- Variables are live in a global name space, there is no parameter passing.
- Two-pass processing, so that you can use a variable before declaring it or after.
|
|
<
< |
- Templates and 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.
|
>
> |
- Templates and TWikiSkins 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.
|
| |
- Note: The template directives work only for templates, they do not get processed in topic text.
New Template System by Example |
| | 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"}% |
|
<
< | NOTE: Added a dot to escape rendering of variables, i.e. read %.WEB% as %WEB%. |
| | |
|
>
> | |
| |
|
|
<
< | <table border="1" cellspacing="0" cellpadding="1">
<tr><td>
<verbatim>
%.TMPL:DEF{"sep"}% | %.TMPL:END% |
>
> | %TMPL:DEF{"sep"}% | %TMPL:END% |
| | <html>
<head> |
|
<
< | <title> %.WIKITOOLNAME% . %.WEB% . %.TOPIC% %.TMPL:P{"titleaction"}%</title>
<base href="%.SCRIPTURL%/view%.SCRIPTSUFFIX%/%.WEB%/%.TOPIC%"> |
>
> | <title> %WIKITOOLNAME% . %WEB% . %TOPIC% %.TMPL:P{"titleaction"}%</title>
<base href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%"> |
| | <meta name="robots" content="noindex">
</head>
<body bgcolor="#FFFFFF">
<table width="100%" border="0" cellpadding="3" cellspacing="0">
<tr> |
|
<
< | <td bgcolor="%.WEBBGCOLOR%" rowspan="2" valign="top" width="1%">
<a href="%.WIKIHOMEURL%">
<img src="%.PUBURLPATH%/wikiHome.gif" border="0"></a> |
>
> | <td bgcolor="%WEBBGCOLOR%" rowspan="2" valign="top" width="1%">
<a href="%WIKIHOMEURL%">
<img src="%PUBURLPATH%/wikiHome.gif" border="0"></a> |
| | </td>
<td> |
|
<
< | <b>%.WIKITOOLNAME% . %.WEB% . </b><font size="+2">
<B>%.TOPIC%</b> %.TMPL:P{"titleaction"}%</font> |
>
> | <b>%WIKITOOLNAME% . %WEB% . </b><font size="+2">
<B>%TOPIC%</b> %TMPL:P{"titleaction"}%</font> |
| | </td>
</tr> |
|
<
< | <tr bgcolor="%.WEBBGCOLOR%"> |
>
> | <tr bgcolor="%WEBBGCOLOR%"> |
| | <td colspan="2"> |
|
<
< | %.TMPL:P{"webaction"}% |
>
> | %TMPL:P{"webaction"}% |
| | </td>
</tr>
</table> |
|
<
< |
++ %.TMPL:P{"heading"}%
%.TMPL:P{"message"}% |
>
> |
++ %TMPL:P{"heading"}%
%TMPL:P{"message"}% |
| | <table width="100%" border="0" cellpadding="3" cellspacing="0"> |
|
<
< | <tr bgcolor="%.WEBBGCOLOR%"> |
>
> | <tr bgcolor="%WEBBGCOLOR%"> |
| | <td valign="top"> |
|
<
< | Topic <b>TWikiTemplates</b> . {
%.TMPL:P{"topicaction"}% |
>
> | Topic <b>%TOPIC%</b> . {
%TMPL:P{"topicaction"}% |
| | }
</td>
</tr>
</table>
</body> |
|
<
< | </verbatim>
</td></tr>
</table > |
| | |
|
>
> | |
| | |
| |
|
|
<
< |
%.TMPL:DEF{"titleaction"}% (test =titleaction=) %.TMPL:END%
%.TMPL:DEF{"webaction"}% test =webaction= %.TMPL:END%
%.TMPL:DEF{"heading"}%
Test heading %.TMPL:END%
%.TMPL:DEF{"message"}% |
>
> |
%TMPL:DEF{"titleaction"}% (test =titleaction=) %TMPL:END%
%TMPL:DEF{"webaction"}% test =webaction= %TMPL:END%
%TMPL:DEF{"heading"}%
Test heading %TMPL:END%
%TMPL:DEF{"message"}%
|
| | Test message. Blah blah blah blah blah blah blah blah blah blah blah...
- Some more blah blah blah blah blah blah blah blah blah blah...
|
|
<
< |
- Param1: %PARAM1%
- Param2: %PARAM2%
- Param3: %PARAM3%
- Param4: %PARAM4%
%.TMPL:END%
%.TMPL:DEF{"topicaction"}% |
>
> |
- Param1: %PARAM1%
- Param2: %PARAM2%
- Param3: %PARAM3%
- Param4: %PARAM4%
%TMPL:END%
%TMPL:DEF{"topicaction"}% |
| | Test topicaction: |
|
<
< | OK? %.TMPL:P{"sep"}%
Register? %.TMPL:END%
%.TMPL:INCLUDE{"oopsbase"}%
|
>
> | [[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}%
[[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END%
%TMPL:INCLUDE{"oopsbase"}%
|
| | |
| |
|
|
>
> | TWiki master template |
| | All common template parts are defined in one master template, twiki.tmpl, that all other templates include.
|
| |
| %TMPL:DEF{"oops"}% | Skeleton of oops dialog |
|
|
<
< | Example: preview.tmpl template |
>
> | Example: oopspreview.tmpl template |
| |
%TMPL:INCLUDE{"twiki"}%
%TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
|
| |
- 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.
|
|
<
< | -- PeterThoeny? - 23 Jul 2001
|
>
> | -- PeterThoeny - 23 Jul 2001
|
| | -- MikeMannix? - 30 Aug 2001
| META FILEATTACHMENT | attr="h" comment="Example of oopstest.tmpl rendered" date="999598142" name="testscreen.gif" path="C:\02_TWikiDocs\testscreen.gif" size="9460" user="MikeMannix" version="1.1" |
|---|
| META TOPICMOVED | by="MikeMannix" date="1000277381" from="TWiki.TWikiTemplateSystem" to="TWiki.TWikiTemplates" |
|---|
|
