%TMPL:<key>% and %TMPL:<key>\{"attr"\}%.
* 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.
* 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 [[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.
## TWiki Master Template
All common parts are defined in a master template, **twiki.tmpl**, that all other templates use.
> | Template variable: | >Defines: | >
|---|---|
| % |
> "|" separator | >
| % |
> Start of all HTML pages | >
| % |
> Standard header (ex: view, index, seach) | >
| % |
> Simple header with reduced links (ex: edit, attach, oops) | >
| % |
> Footer, excluding revision and copyright parts | >
| % |
> Skeleton of oops dialog | >
**twiki/templates** directory. As an example, **twiki/templates/view.tmpl** is the template file for the **twiki/bin/view** script. Templates can be overloaded per web. The following search order applies:
1. **twiki/templates/$webName/$scriptName.tmpl**
2. **twiki/templates/$scriptName.tmpl**
**_Note:_** `$webName` is the name of the web (ex: `Main`), and **$scriptName** is the script (ex: `view`).
**_Note:_** [[TWikiSkins]] can be defined to overload the standard templates.
Special variables are used in templates, especially in `view`, to display [[TWikiMetaData]].
### Template Topics
Template topics define the default text for new topics. There are three types of template topics:
> | Topic Name: | >What it is: | >
|---|---|
| Web Topic View Template? | >Help text shown when you view a non existing topic. | >
| Web Topic Non Wiki Template? | >Help text shown when you view a non existing topic that has not a Wiki Name?. | >
| Web Topic Edit Template? | >Default text shown when you create a new topic. | >
<form name="new" action="%The "onlywikiname" parameter enforces [[WikiWords]] for topic names. **_Note:_** Use can use theSCRIPTURLPATH%/edit% SCRIPTSUFFIX%/% WEB%/"> * New example topic: <input type="text" name="topic" value="ExampleTopic% SERVERTIME{$yearx$mox$day}%" size="23" /> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" /> <input type="hidden" name="onlywikiname" value="on" /> <input type="submit" value="Create" /> (date format is <nop>YYYYxMMxDD) </form>
%WIKIUSERNAME% and %DATE% variables in your topic templates as the signature; those variables are expanded when a new topic is created. The standard topic signature is: -- %WIKIUSERNAME% - %DATE%
## Templates by Example
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.
### Base template oopsbase.tmpl
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"\}%
> > % |
>
> % |
>
**.../bin/oops/Test/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify**
> |
>