(r1.1 vs. r1.23) TWikiTemplates < TWiki

<<O>> Difference Topic TWikiTemplates (r1.23 - 15 Aug 2004 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 59 to 59

HTML Page Templates

Changed:

<
< VRJ Wiki 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.

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

Changed:

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

>
> Templates are stored either in the twiki/templates directory or in user topics. As an example, twiki/templates/view.tmpl is the template file for the twiki/bin/view script.

Changed:

<
<

twiki/templates/$webName/$scriptName.tmpl
twiki/templates/$scriptName.tmpl
- $webName is the name of the web (ex: Main)
- $scriptName is the script (ex: view).

>
> Templates can be overloaded by individual webs.

Changed:

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

>
>

TWikiSkins can overload the standard templates.

TWiki uses the following search order to determine which template to use:

If a skin is specified If no skin is specified

templates/%WEB%/script.skin.tmpl templates/%WEB%/script.tmpl

templates/script.skin.tmpl templates/script.tmpl

data/%WEB%/SkinSkinScriptTemplate.txt data/%WEB%/ScriptTemplate.txt

data/TWiki/SkinSkinScriptTemplate.txt data/TWiki/ScriptTemplate.txt

Legend:
• script refers to the script name, e.g view, edit
• Script refers to the same, but with the first character capitalized, e.g View
• skin refers to the skin name, e.g dragon, pattern
• Skin refers to the same, but with the first character capitalized, e.g Dragon
• %WEB% refers to the current web

Additionally (and primarily for use in %TMPL:INCLUDE{}%) the template name may be a wiki topic name, specified as Web.Topic, in which case the search is:

If a skin is specified If no skin is specified

templates/web/Web.Topic.skin.tmpl templates/web/Web.Topic.tmpl

templates/Web.Topic.skin.tmpl templates/Web.Topic.tmpl

data/Web/Topic.txt

If Web is not specified in the INCLUDE, it defaults to TWiki, and the search to the first type.

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

Line: 149 to 166

`templatetopic`	The name of the template topic, e.g. topic used to copy the initial content
`topicparent`	Sets the parent topic
`TopicClassification`	Assuming the template topic has a form with a field called "TopicClassification", it will set the value of the field

Added:

>
>

contenttype Optional parameter that defines the application type to write into the CGI header. Defaults to text/html. May be used to invoke alternative client applications

anyname Any parameter can passed to the new topic; if the template topic contains %URLPARAM{"anyname"}%, it will be replaced by its value

Line: 252 to 270

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.

Changed:

<
< -- TWiki:Main.PeterThoeny - 25 Apr 2004

>
> -- TWiki:Main.CrawfordCurrie - 30 Jun 2004
-- TWiki:Main.PeterThoeny - 15 Aug 2004

-- TWiki:Main.MikeMannix - 14 Sep 2001
-- TWiki:Main.DavidLeBlanc - 11 Mar 2002

<<O>> Difference Topic TWikiTemplates (r1.22 - 25 Apr 2004 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 95 to 95

Variable: Description:

%DATE% Current date, e.g. 08 Aug 2008

Changed:

<
<

%WIKIUSERNAME% User name, e.g. Main.TWikiGuest

>
>

`%USERNAME%`	Login name, e.g. `jsmith`
`%WIKINAME%`	WikiName of user, e.g. `JohnSmith`
`%WIKIUSERNAME%`	User name, e.g. `Main.JohnSmith`

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

Line: 250 to 252

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.

Changed:

<
< -- TWiki:Main.PeterThoeny - 30 Dec 2004

>
> -- TWiki:Main.PeterThoeny - 25 Apr 2004

-- TWiki:Main.MikeMannix - 14 Sep 2001
-- TWiki:Main.DavidLeBlanc - 11 Mar 2002

Added:

>
>

META FILEATTACHMENT	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"
META TOPICMOVED	MikeMannix^?	date="1000277381" from="TWiki.TWikiTemplateSystem" to="TWiki.TWikiTemplates"

<<O>> Difference Topic TWikiTemplates (r1.21 - 31 Dec 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 117 to 117

Added:

>
>

(date format is YYYYxMMxDD)

Line: 130 to 131

Added:

>
> <input type="hidden" name="onlynewtopic" value="on" />

<input type="submit" value="Create" /> (date format is <nop>YYYYxMMxDD) </form>

Line: 141 to 143

Parameter:	Description:
`topic`	Name of topic to create. Can be set in a text field, or is set programmatically (e.g. with a sequential number)
`onlywikiname`	If set, TWiki will complain if the topic name is not a WikiWord

Added:

>
>

onlynewtopic If set, TWiki will complain if a topic of the same name already exists

`templatetopic`	The name of the template topic, e.g. topic used to copy the initial content
`topicparent`	Sets the parent topic
`TopicClassification`	Assuming the template topic has a form with a field called "TopicClassification", it will set the value of the field

Line: 247 to 250

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.

Changed:

<
< -- TWiki:Main.PeterThoeny - 16 Dec 2003

>
> -- TWiki:Main.PeterThoeny - 30 Dec 2004

-- TWiki:Main.MikeMannix - 14 Sep 2001
-- TWiki:Main.DavidLeBlanc - 11 Mar 2002

META FILEATTACHMENT	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"

<<O>> Difference Topic TWikiTemplates (r1.20 - 16 Dec 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 135 to 135

</form>

Changed:

<
< The onlywikiname parameter enforces WikiWords for topic names. The topicparent parameter sets the topic parent to the topic where the form is located.

>
>

The edit scipt understands the following parameters, typically supplied by HTML input fields:

Parameter: Description:

topic Name of topic to create. Can be set in a text field, or is set programmatically (e.g. with a sequential number)

onlywikiname If set, TWiki will complain if the topic name is not a WikiWord

templatetopic The name of the template topic, e.g. topic used to copy the initial content

topicparent Sets the parent topic

TopicClassification Assuming the template topic has a form with a field called "TopicClassification", it will set the value of the field

anyname Any parameter can passed to the new topic; if the template topic contains %URLPARAM{"anyname"}%, it will be replaced by its value

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%

Line: 237 to 247

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.

Changed:

<
< -- PeterThoeny - 01 Feb 2003
-- MikeMannix^? - 14 Sep 2001
-- TWiki:Main/DavidLeBlanc - 11 Mar 2002

>
> -- TWiki:Main.PeterThoeny - 16 Dec 2003
-- TWiki:Main.MikeMannix - 14 Sep 2001
-- TWiki:Main.DavidLeBlanc - 11 Mar 2002

META FILEATTACHMENT	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"
META TOPICMOVED	MikeMannix^?	date="1000277381" from="TWiki.TWikiTemplateSystem" to="TWiki.TWikiTemplates"

<<O>> Difference Topic TWikiTemplates (r1.19 - 02 Apr 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 115 to 115

New example topic:

Added:

>
>

(date format is YYYYxMMxDD)

Line: 126 to 128

New example topic: <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" /> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" />

Added:

>
> <input type="hidden" name="topicparent" value="%TOPIC%" />

<input type="hidden" name="onlywikiname" value="on" /> <input type="submit" value="Create" /> (date format is <nop>YYYYxMMxDD) </form>

Changed:

<
< The onlywikiname parameter enforces WikiWords for topic names.

>
> The onlywikiname parameter enforces WikiWords for topic names. The topicparent parameter sets the topic parent to the topic where the form is located.

<<O>> Difference Topic TWikiTemplates (r1.18 - 01 Feb 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 88 to 88

WebTopicEditTemplate in the current web
WebTopicEditTemplate in the TWiki web

Added:

>
>

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. 08 Aug 2008

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

Template Topics in Action

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

Line: 215 to 234

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.

Changed:

<
< -- PeterThoeny - 23 Jul 2001

>
> -- PeterThoeny - 01 Feb 2003

-- MikeMannix^? - 14 Sep 2001
-- TWiki:Main/DavidLeBlanc - 11 Mar 2002

META FILEATTACHMENT	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"

<<O>> Difference Topic TWikiTemplates (r1.17 - 08 Jan 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 92 to 92

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

Changed:

<
<

>
>

New example topic:

Line: 103 to 103

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:

Changed:

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

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

New example topic: <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" /> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" />

<<O>> Difference Topic TWikiTemplates (r1.16 - 05 Jan 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 92 to 92

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

Changed:

<
<

>
>

New example topic:

Line: 103 to 103

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:

Changed:

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

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

New example topic: <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" /> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" />

<<O>> Difference Topic TWikiTemplates (r1.15 - 05 Jan 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 92 to 92

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

Changed:

<
<

>
>

New example topic:

Line: 103 to 103

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:

Changed:

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

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

New example topic: <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" /> <input type="hidden" name="templatetopic" value="ExampleTopicTemplate" />

<<O>> Difference Topic TWikiTemplates (r1.14 - 04 Jan 2003 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 18 to 18

defines common variables, like a standard separator (ex: "|"), in the base template;
defines variable text in the individual templates and passes it back to the base template.

Added:

>
>

How Template Variables Work

Special template directives (or preprocessor commands) are embedded in normal templates.

<<O>> Difference Topic TWikiTemplates (r1.13 - 20 Dec 2002 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 8 to 8

Overview

Changed:

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

Major changes from the previous template system

Line: 18 to 18

defines common variables, like a standard separator (ex: "|"), in the base template;
defines variable text in the individual templates and passes it back to the base template.

Changed:

<
<

Functional Specifications

>
>

How Template Variables Work

Special template directives (or preprocessor commands) are embedded in normal templates.

Deleted:

<
<

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

Changed:

<
<

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

>
>

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

Directives:

Changed:

<
<

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

Changed:

<
<

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 VRJ Wiki pages
Template Topics: Defines default text when you create a new topic

Master Templates

Changed:

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

Template variable: Defines:

%TMPL:DEF{"sep"}% "|" separator

%TMPL:DEF{"htmldoctype"}% Start of all HTML pages

Changed:

<
<

%TMPL:DEF{"standardheader"}%

Standard header (ex: view, index, seach)

>
>

%TMPL:DEF{"standardheader"}%

Standard header (ex: view, index, search)

%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

Deleted:

<
<

Types of Template

There are two types of templates:

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

HTML Page Templates

Changed:

<
< VRJ Wiki 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.

>
> VRJ Wiki 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.

Changed:

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

twiki/templates/$webName/$scriptName.tmpl
twiki/templates/$scriptName.tmpl

Added:

>
>

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

Changed:

<
<

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.

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

Template Topics

Changed:

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

Topic Name: What it is:

Changed:

<
<

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.

>
>

WebTopicViewTemplate	Error page shown when you try to view a nonexistent topic
WebTopicNonWikiTemplate	Alert page shown when you try to view a nonexistent topic with a non-WikiName

WebTopicEditTemplate

Default text shown when you create a new topic.

Changed:

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

Changed:

<
<

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

>
>

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

Template Topics in Action

Line: 98 to 99

(date format is YYYYxMMxDD)

Changed:

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

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

Line: 111 to 112

</form>

Changed:

<
< The "onlywikiname" parameter enforces WikiWords for topic names.

>
> The onlywikiname parameter enforces WikiWords for topic names.

Changed:

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

Templates by Example

Changed:

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

Base template oopsbase.tmpl

Changed:

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

Line: 205 to 207

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

Changed:

<
<

>
>

Known Issues

Changed:

<
<

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.

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

Added:

>
> -- TWiki:Main/DavidLeBlanc - 11 Mar 2002

META FILEATTACHMENT	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"
META TOPICMOVED	MikeMannix^?	date="1000277381" from="TWiki.TWikiTemplateSystem" to="TWiki.TWikiTemplates"

<<O>> Difference Topic TWikiTemplates (r1.12 - 18 Jul 2002 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 202 to 202

Sample screen shot of oopstest.tmpl

Changed:

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

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

Changed:

<
<

>
>

Known Issues

Line: 214 to 214

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

Changed:

<
<

META FILEATTACHMENT	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	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"

META TOPICMOVED	MikeMannix^?	date="1000277381" from="TWiki.TWikiTemplateSystem" to="TWiki.TWikiTemplates"

<<O>> Difference Topic TWikiTemplates (r1.11 - 04 Dec 2001 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 205 to 205

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

Changed:

<
<

>
>

Known Issues

<<O>> Difference Topic TWikiTemplates (r1.10 - 18 Sep 2001 - MikeMannix)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 8 to 8

Overview

Changed:

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

Major changes from the previous template system

Line: 54 to 54

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

Added:

>
>

HTML Page Templates

VRJ Wiki 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.

Line: 69 to 70

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

Added:

>
>

Template Topics

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

<<O>> Difference Topic TWikiTemplates (r1.9 - 16 Sep 2001 - MikeMannix)

  META TOPICPARENT  WebHome 

TOC: No TOC in "TWiki.TWikiTemplates"
-<
<
+  TWiki Template System
->
>
+  TWiki Templates
 Definition of the templates used to render all HTML pages displayed in TWiki 

  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 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.
    Major changes from the previous template 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:
->
>
+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:
  separates a set of common template parts into a base template that is included by all of the related templates;
-<
<
  defines common variables, like a standard separator (ex: "|"), in the base template;
-<
<
  defines variable text in the individual templates and passes it back to the base template.



  Functional Specifications
  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.
->
>
+ NOTE: The template directives work only for templates, they do not get processed in topic text.
   TWiki Master Template

<<O>> Difference Topic TWikiTemplates (r1.8 - 15 Sep 2001 - PeterThoeny)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 48 to 48

%TMPL:DEF{"standardfooter"}%	Footer, excluding revision and copyright parts
%TMPL:DEF{"oops"}%	Skeleton of oops dialog

Added:

>
>

Types of Template

Added:

>
>

There are two types of templates:

HTML Page Templates: Defines layout of VRJ Wiki pages

Line: 80 to 82

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:

Changed:

<
<

The topic name specified by the templatetopic parameter.

>
>

The topic name specified by the templatetopic CGI parameter.

WebTopicEditTemplate in the current web.
WebTopicEditTemplate in the TWiki web.

Line: 90 to 92

Changed:

<
< (date format is YYYYMMDD)

>
> (date format is YYYYxMMxDD)

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:

Line: 100 to 103

<form name="new" action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/%WEB%/">
   * New example topic:

Changed:

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

</form>

<<O>> Difference Topic TWikiTemplates (r1.7 - 15 Sep 2001 - MikeMannix)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 63 to 63

twiki/templates/$webName/$scriptName.tmpl
twiki/templates/$scriptName.tmpl

Changed:

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

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

Changed:

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

Template Topics

<<O>> Difference Topic TWikiTemplates (r1.6 - 15 Sep 2001 - MikeMannix)

META TOPICPARENT	WebHome

TOC: No TOC in "TWiki.TWikiTemplates"

Line: 36 to 36

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.

Changed:

<
<

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

There are two types of templates:

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

HTML Page Templates

VRJ Wiki 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:

twiki/templates/$webName/$scriptName.tmpl
twiki/templates/$scriptName.tmpl

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

	VRJ Wiki > TWiki > TWikiTemplates (r1.1 vs. r1.23)	VRJ Wiki webs: Juggler \| VRJPlanning \| Main \| TWiki \| Test
	TWiki . { Welcome \| Register \| Changes \| Topics \| Index \| Search \| Go }