Edit Template Topics and Variable Expansion

The following variables get expanded when a user creates a new topic based on a template topic:

Variable:	Description:
%DATE%	Current date, e.g. 02 Feb 2025
%WIKIUSERNAME%	User name, e.g. Main.TWikiGuest
%URLPARAM{"name"}%	Value of a named URL parameter
%NOP%	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 %URLPARAM%NOP%{...}%
%NOP{ ... }%	A no-operation text that gets removed. Useful to write-protect an edit template topic, but not the topics based this template topic. See notes below. Example: %NOP{    * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup }%

Notes:

• Unlike other variables, %NOP{ ... }% can span multiple lines.
• The scan for the closing }% pattern is "non-greedy", that is, it stops at the first occurance. That means, you need to escape variables with parameters located inside %NOP{ ... }%: Insert a %NOP% between } and %. Silly example: %NOP{ %GMTIME{"$year"}%NOP%% }%.

All other variables are unchanged, e.g. are carried over "as is" into the new topic.

-- PeterThoeny - 23 Jul 2001

-- PeterThoeny - 01 Feb 2003

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%URLENCODE{"%WEB%"}%/">

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%INTURLENCODE{"%WEB%"}%/">

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEBURLENCODED%/">

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%URLENCODE{"%WEB%"}%/">

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/">

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEBURLENCODED%/">

The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML mark-up for template-specific content. Templates are used to define page layout, and also to supplydefault content for new pages.

The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML markup for template-specific content. Templates are used to define page layout, and also to supply default content for new pages.

Functional Specifications

How Template Variables Work

• Use of template directives is optional, templates work without them.

• Directives are of the form %TMPL:<key>% and %TMPL:<key>{"attr"}%.

• Directives are of the form %TMPL:<key>% and %TMPL:<key>{"attr"}%.

• • %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.

• • %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 live in a global name space: there is no parameter passing.
• Two-pass processing lets you use a variable before or after declaring it.
• 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.
• Use of template directives is optional: templates work without them.
• NOTE: Template directives work only for templates: they do not get processed in topic text.

TWiki Master Template

Types of Template

There are three types of template:

• Master Template: Stores common parts; included by other templates
• HTML Page Templates: Defines the layout of TWiki pages
• Template Topics: Defines default text when you create a new topic

Master Templates

All common parts are defined in a master template, twiki.tmpl, that all other templates use.

Common parts, appearing in two or more templates, can be defined in a master template and then shared by others: twiki.tmpl is the default master template.

Types of Template

There are two types of templates:

• HTML Page Templates: Defines layout of TWiki pages
• Template Topics: Defines default text when you create a new topic

TWiki uses HTML template files for all actions like topic view, edit, preview and so on. This allows you to change the look and feel of all pages by editing just some template files.

TWiki uses HTML template files for 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.

The template files are in the 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:

Templates are in the twiki/templates directory. As an example, twiki/templates/view.tmpl is the template file for the twiki/bin/view script. Templates can be overloaded by individual webs. The following search order applies:

• • $webName is the name of the web (ex: Main)
  • $scriptName is the script (ex: view).

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.

NOTE: TWikiSkins can be defined to overload the standard templates.

Template topics define the default text for new topics. There are three types of template topics:

Template topics define the default text for new topics. There are three types of template topic:

All template topics are located in the TWiki web. The WebTopicEditTemplate can be overloaded. The following search order applies when you create a new topic:

All template topics are located in the TWiki web. The WebTopicEditTemplate can be overloaded. When you create a new topic, TWiki locates a topic to use as a content template according to the following search order:

1. The topic name specified by the templatetopic CGI parameter.
2. WebTopicEditTemplate in the current web.
3. WebTopicEditTemplate in the TWiki web.

1. A topic name specified by the templatetopic CGI parameter.
2. WebTopicEditTemplate in the current web
3. WebTopicEditTemplate in the TWiki web

Above form asks for a topic name. A hidden input tag of name "templatetopic" specifies the ExampleTopicTemplate as the template topic. Here is the HTML source of the form:

The above form asks for a topic name. A hidden input tag named templatetopic specifies ExampleTopicTemplate as the template topic to use. Here is the HTML source of the form:

The "onlywikiname" parameter enforces WikiWords for topic names.

The onlywikiname parameter enforces WikiWords for topic names.

Note: Use can use the %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%

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:
-- %WIKIUSERNAME% - %DATE%

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.

Attached is an example of an oops based template oopsbase.tmpl and an example oops dialog oopstest.tmpl based on the base template. %A% NOTE: This isn't the release version, just a quick, simple demo.

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"}%

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"}%

• 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.

• 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 was a structurally complete HTML document with a .tmpl filename extension - it contained unresolved %VARIABLES%, but could still be previewed directly in a browser.

-- TWiki:Main/DavidLeBlanc - 11 Mar 2002

With URL: .../bin/oops/Test/TestTopic2?template=oopstest&param1=WebHome&param2=WebNotify

With URL: .../bin/oops/Sandbox/TestTopic2?template=oopstest&param1=WebHome&param2=WebNotify

%META:FILEATTACHMENT{name="testscreen.gif" attr="h" comment="Example of oopstest.tmpl rendered" date="999598142" path="C:\02_TWikiDocs\testscreen.gif" size="9460" user="MikeMannix" version="1.1"}%

%META:FILEATTACHMENT{name="testscreen.gif" attr="h" comment="Example of oopstest.tmpl rendered" date="1026977240" path="C:\Data\Temp\testscreen.gif" size="9566" user="PeterThoeny" version="1.2"}%

The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML mark-up for template-specific content.

The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML mark-up for template-specific content. Templates are used to define page layout, and also to supplydefault content for new pages.

TWiki Template System

TWiki Templates

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.

The new modular template system offers flexible, easy control over the layout of all TWiki pages. The master template approach groups parts that are shared by several templates - like headers and footers - in a common file. Special variables allow individual layouts to include parts from a master template - variables are mixed with regular HTML mark-up for template-specific content.

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:

Where the old templates were each complete HTML documents, the new templates are defined using variables to include template parts from a master file. You can now change one instance of a common element to update all occurrences; previously, every affected template had to be updated. This simplifies the conversion of templates into XHTML format, and provides a more versatile solution for templates and for TWikiSkins. The new system:

• Note: The template directives work only for templates, they do not get processed in topic text.

• NOTE: The template directives work only for templates, they do not get processed in topic text.

1. The topic name specified by the templatetopic parameter.

1. The topic name specified by the templatetopic CGI parameter.

(date format is YYYYMMDD)

(date format is YYYYxMMxDD)

<input type="text" name="topic" value="ExampleTopic%SERVERTIME{$year$mo$day}%" size="22"> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate"> <input type="hidden" name="onlywikiname" value="on"> <input type="submit" value="Create"> (date format is YYYYMMDD)

<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)

Note: $webName is the name of the web ( i.e. Main ), and $scriptName is the script ( i.e. view ).

Note: $webName is the name of the web (ex: Main), and $scriptName is the script (ex: view).

Some special variables are used in templates ( especially view ) to show meta data - see Meta Data Rendering

Special variables are used in templates, especially in view, to display meta data.

New Template System by Example

TWiki Master Template

All common parts are defined in a master template, twiki.tmpl, that all other templates use.

Template variable:	Defines:
%TMPL:DEF{"sep"}%	"|" separator
%TMPL:DEF{"htmldoctype"}%	Start of all HTML pages
%TMPL:DEF{"standardheader"}%	Standard header (ex: view, index, seach)
%TMPL:DEF{"simpleheader"}%	Simple header with reduced links (ex: edit, attach, oops)
%TMPL:DEF{"standardfooter"}%	Footer, excluding revision and copyright parts
%TMPL:DEF{"oops"}%	Skeleton of oops dialog

Types of Template

• HTML Page Templates: Defines layout of TWiki pages
• Template Topics: Defines default text when you create a new topic

HTML Page Templates

TWiki uses HTML template files for all actions like topic view, edit, preview and so on. This allows you to change the look and feel of all pages by editing just some template files.

The template files are in the 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 ( i.e. Main ), and $scriptName is the script ( i.e. view ).

Note: TWikiSkins can be defined to overload the standard templates.

Some special variables are used in templates ( especially view ) to show meta data - see Meta Data Rendering

Template Topics

Template topics define the default text for new topics. There are three types of template topics:

Topic Name:	What it is:
WebTopicViewTemplate	Help text shown when you view a non existing topic.
WebTopicNonWikiTemplate	Help text shown when you view a non existing topic that has not a WikiName.
WebTopicEditTemplate	Default text shown when you create a new topic.

1. The topic name specified by the templatetopic parameter.
2. WebTopicEditTemplate in the current web.
3. WebTopicEditTemplate in the TWiki web.

Template Topics in Action

Here is an example for creating new topics based on a specific template topic:

• New example topic: (date format is YYYYMMDD)

Above form asks for a topic name. A hidden input tag of name "templatetopic" specifies the ExampleTopicTemplate as the template topic. Here is the HTML source of the form:

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/">
   * New example topic: 
     <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$year$mo$day}%" size="22">
     <input type="hidden" name="templatetopic" value="ExampleTopicTemplate">
     <input type="hidden" name="onlywikiname" value="on">
     <input type="submit" value="Create"> (date format is YYYYMMDD)
</form>

The "onlywikiname" parameter enforces WikiWords for topic names.

Note: Use can use the %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

TWiki master template

All common template parts are defined in one master template, twiki.tmpl, that all other templates include.

Example: oopspreview.tmpl template

%TMPL:INCLUDE{"twiki"}%
%TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
%TMPL:DEF{"webaction"}% *Attention* %TMPL:END%
%TMPL:DEF{"heading"}% Topic is not saved yet %TMPL:END%
%TMPL:DEF{"message"}% Please go back in your browser and save the topic. %TMPL:END%
%TMPL:DEF{"topicaction"}%
%TMPL:END%
%TMPL:P{"oops"}%

-- PeterThoeny - 23 Jul 2001
-- MikeMannix - 30 Aug 2001

-- PeterThoeny - 23 Jul 2001
-- MikeMannix - 14 Sep 2001

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.

• 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).

• New directives can be added over time when needed, ex: IF-THEN-ELSE.

• 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: 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%

<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%">

<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>

<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>

<tr bgcolor="%.WEBBGCOLOR%">

<tr bgcolor="%WEBBGCOLOR%">

%.TMPL:P{"webaction"}%

%TMPL:P{"webaction"}%

<tr bgcolor="%.WEBBGCOLOR%">

<tr bgcolor="%WEBBGCOLOR%">

Topic <b>TWikiTemplates</b> . { %.TMPL:P{"topicaction"}%

Topic <b>%TOPIC%</b> . { %TMPL:P{"topicaction"}%

</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"}%

• Param1: %PARAM1%
• Param2: %PARAM2%
• Param3: %PARAM3%
• Param4: %PARAM4%

• Param1: %PARAM1%
• Param2: %PARAM2%
• Param3: %PARAM3%
• Param4: %PARAM4%

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

Example: preview.tmpl template

Example: oopspreview.tmpl template

-- PeterThoeny - 23 Jul 2001

-- PeterThoeny - 23 Jul 2001

%META:TOPICMOVED{by="MikeMannix" date="1000277381" from="TWiki.TWikiTemplateSystem" to="TWiki.TWikiTemplates"}%

new topic for the final doc

Slightly edited down, but waiting for new docs, hopefully.

see also for ref: orig TWikiTemplatingSystem?

Define the templates used to render all HTML pages displayed in TWiki

Definition of the templates used to render all HTML pages displayed in TWiki

Overview

Overview

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.

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.

Using external modules like the TemplateToolkit? would be one way to go, but this will add a lot of baggage to TWiki.

Major changes from the previous template system

Needs of the TWiki templating system

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:

• Separate common parts into one (or more) base template file(s) and include that from other template files like view.tmpl.
• Define common variables like a "|" separator in the base template and use them in other template files
• Define variable text in templates (i.e. view.tmpl) and pass them to the base template

• separates a set of common template parts into a base template that is included by all of the related templates;

Functional Spec

• defines common variables, like a standard separator (ex: "|"), in the base template;

I tried to define a simple but powerful solution that can be extended over time. Here we go:

• defines variable text in the individual templates and passes it back to the base template.

Functional Specifications

• 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 form %TMPL:<key>% and %TMPL:<key>{"attr"}%.

• 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"}%.

• New directives can be added over time when needed, i.e. IF-THEN-ELSE.
• Variables 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. You could for example define a new skin just for the header & footer and keep the other template files unchanged.
• Note: The template directive work only for templates, they do not get processed in topic text.

• 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.
• Note: The template directives work only for templates, they do not get processed in topic text.

Examples

New Template System 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. This is not the version that will go into the release, it is just a quick hack.

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

Base template oopsbase.tmpl

Note: Added a dot to escape rendering of variables, i.e. read %.WEB% as %WEB%.

NOTE: Added a dot to escape rendering of variables, i.e. read %.WEB% as %WEB%.

Test template oopstest.tmpl

Test template oopstest.tmpl

Sample screen shot of oopstest.tmpl

Sample screen shot of oopstest.tmpl

Comments and feedback

• 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.
• Is the terminology OK?
• Is the spec OK?
• Are there any other directives that are needed urgently?
• 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.

-- PeterThoeny - 21 Jul 2001

• It's probably more readable to enforce variables being defined before use, which would avoid need for slower two-pass processing.
  • [ 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.
• 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.
  • [ PeterThoeny ] The templating system uses the standard internal TWiki function to parse variable attributes. The "" can be skipped (is possible but is not documented).

Please have a look at the latest templates in the TWikiAlphaRelease?. There is now one master template called twiki.tmpl that all other templates include (well, will include when all done). The idea is to define all common parts of the templates in twiki.tmpl and simply use that from all other templates.

All common template parts are defined in one master template, twiki.tmpl, that all other templates include.

I.e. the preview.tmpl template is now simply:

Example: preview.tmpl template

%TMPL:DEF{"message"}% Please go back in your browser and save the topic. %TMPL:END% %TMPL:DEF{"topicaction"}% %TMPL:END%

%TMPL:DEF{"message"}% Please go back in your browser and save the topic. %TMPL:END% %TMPL:DEF{"topicaction"}% %TMPL:END%

Known Issues

With this it should be possible to create a skin that overloads just the twiki.tmpl, i.e. a twiki.print.tmpl that redefines the header and footer.

• 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.

TWiki Template System

TWiki Template System

Overview

Overview

Needs of the TWiki templating system

Needs of the TWiki templating system

Functional Spec

Functional Spec

Examples

Examples

Base template oopsbase.tmpl

Base template oopsbase.tmpl

Test template oopstest.tmpl

Test template oopstest.tmpl

Sample screen shot of oopstest.tmpl

Sample screen shot of oopstest.tmpl

Comments and feedback

Comments and feedback

%META:TOPICINFO{author="MikeMannix" date="999598350" format="1.0" version="1.1"}% %META:TOPICPARENT{name="WebHome"}%

new topic for the final doc

Slightly edited down, but waiting for new docs, hopefully.

see also for ref: orig TWikiTemplatingSystem?

• new topic for the final doc
  • TWiki Template System
    • Overview
    • Needs of the TWiki templating system
    • Functional Spec
    • Examples
      • • Base template oopsbase.tmpl
        • Test template oopstest.tmpl
        • Sample screen shot of oopstest.tmpl
    • Comments and feedback

TWiki Template System

Define the templates used to render all HTML pages displayed in TWiki

Overview

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.

Using external modules like the TemplateToolkit? would be one way to go, but this will add a lot of baggage to TWiki.

Needs of the TWiki templating system

• Separate common parts into one (or more) base template file(s) and include that from other template files like view.tmpl.
• Define common variables like a "|" separator in the base template and use them in other template files
• Define variable text in templates (i.e. view.tmpl) and pass them to the base template

Functional Spec

I tried to define a simple but powerful solution that can be extended over time. Here we go:

• Special template directives (or preprocessor commands) are embedded in normal templates.
• 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 form %TMPL:<key>% and %TMPL:<key>{"attr"}%.
• Initial set of directives:
  • %TMPL:INCLUDE{"file"}%: Includes a template file. The usual search path is applied.
  • %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, i.e. IF-THEN-ELSE.
• Variables 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. You could for example define a new skin just for the header & footer and keep the other template files unchanged.
• Note: The template directive work only for templates, they do not get processed in topic text.

Examples

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.

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"}%

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%
<html>
<head>
  <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>
    <td>
      <b>%.WIKITOOLNAME% . %.WEB% . </b><font size="+2">
      <B>%.TOPIC%</b> %.TMPL:P{"titleaction"}%</font>
    </td>
  </tr>
  <tr bgcolor="%.WEBBGCOLOR%">
    <td colspan="2">
      %.TMPL:P{"webaction"}%
    </td>
  </tr>
</table>
--- ++ %.TMPL:P{"heading"}%
%.TMPL:P{"message"}%
<table width="100%" border="0" cellpadding="3" cellspacing="0">
  <tr bgcolor="%.WEBBGCOLOR%">
    <td valign="top">
      Topic <b>TWikiTemplates</b> . {
        %.TMPL:P{"topicaction"}%
      }
    </td>
  </tr>
</table>
</body>
</verbatim>
</td></tr>
</table >

Test template oopstest.tmpl

Each oops template basically just defines some variables and includes the base template that does the layout work.

%.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"}%
Test =topicaction=:
[[%.WEB%.%TOPIC%][OK]] %.TMPL:P{"sep"}%
[[%.TWIKIWEB%.TWikiRegistration][Register]] %.TMPL:END%
%.TMPL:INCLUDE{"oopsbase"}%

Sample screen shot of oopstest.tmpl

With URL: .../bin/oops/Test/TestTopic2?template=oopstest&param1=WebHome&param2=WebNotify

Comments and feedback

• 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.
• Is the terminology OK?
• Is the spec OK?
• Are there any other directives that are needed urgently?
• 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.

-- PeterThoeny - 21 Jul 2001

• It's probably more readable to enforce variables being defined before use, which would avoid need for slower two-pass processing.
  • [ 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.
• 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.
  • [ PeterThoeny ] The templating system uses the standard internal TWiki function to parse variable attributes. The "" can be skipped (is possible but is not documented).

Please have a look at the latest templates in the TWikiAlphaRelease?. There is now one master template called twiki.tmpl that all other templates include (well, will include when all done). The idea is to define all common parts of the templates in twiki.tmpl and simply use that from all other templates.

I.e. the preview.tmpl template is now simply:

%TMPL:INCLUDE{"twiki"}%
%TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
%TMPL:DEF{"webaction"}% *Attention* %TMPL:END%
%TMPL:DEF{"heading"}% Topic is not saved yet %TMPL:END%
%TMPL:DEF{"message"}%
  Please go back in your browser and save the topic. %TMPL:END%
%TMPL:DEF{"topicaction"}% %TMPL:END%
%TMPL:P{"oops"}%

With this it should be possible to create a skin that overloads just the twiki.tmpl, i.e. a twiki.print.tmpl that redefines the header and footer.

-- PeterThoeny - 23 Jul 2001
-- MikeMannix - 30 Aug 2001

%META:FILEATTACHMENT{name="testscreen.gif" attr="h" comment="Example of oopstest.tmpl rendered" date="999598142" path="C:\02_TWikiDocs\testscreen.gif" size="9460" user="MikeMannix" version="1.1"}%