Line: 1 to 1 | |||||||||
---|---|---|---|---|---|---|---|---|---|
TWiki Templates | |||||||||
Line: 130 to 130 | |||||||||
Template Topics | |||||||||
Changed: | |||||||||
< < | The second type of template in TWiki are template topics. Template topics define the default text for new topics. There are three types of template topic: | ||||||||
> > | The second type of template in TWiki are template topics. Template topics define the default text for new topics. There are four types of template topic: | ||||||||
| |||||||||
Added: | |||||||||
> > |
| ||||||||
When you create a new topic using the edit script, TWiki locates a topic to use as a content template according to the following search order:
|
Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deleted: | |||||||||||||
< < | |||||||||||||
Changed: | |||||||||||||
< < | TWiki Templates | ||||||||||||
> > | TWiki Templates | ||||||||||||
Definition of the templates used to render all HTML pages displayed in TWiki | |||||||||||||
Added: | |||||||||||||
> > | |||||||||||||
Overview | |||||||||||||
Changed: | |||||||||||||
< < | There are three types of template:
| ||||||||||||
> > | Templates are plain text with embedded template directives that tell TWiki how to compose blocks of text together, to create something new. | ||||||||||||
Changed: | |||||||||||||
< < | All three types of template use the TWiki template system. | ||||||||||||
> > | There are two types of template:
| ||||||||||||
Tip: TWiki:TWiki.TWikiTemplatesSupplement on TWiki.org has supplemental documentation on TWiki templates. | |||||||||||||
Changed: | |||||||||||||
< < | The TWiki Template System | ||||||||||||
> > |
Master TemplatesTWiki uses master templates when composing the output from 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 plain text with embedded template directives that tell TWiki how to compose blocks of text together to create something new. | ||||||||||||
> > | Master templates are also used in the definition of TWikiSkins.
Master templates are stored as text files with the extension .tmpl . They are usually HTML with embedded template directives. The directives are expanded when TWiki wants to generate a user interface screen. | ||||||||||||
How Template Directives Work | |||||||||||||
Deleted: | |||||||||||||
< < |
| ||||||||||||
| |||||||||||||
Line: 38 to 41 | |||||||||||||
TMPL:P also supports simple parameters. For example, given the definition
%TMPL:DEF{"x"}% x%P%z%TMPL:END% then %TMPL:P{"x" P="y"}% will expand to xyz . | |||||||||||||
Changed: | |||||||||||||
< < | Note that parameters can simply be ignored; for example=%TMPL:P{"x"}%= will expand to x%P%z. | ||||||||||||
> > | Note that parameters can simply be ignored; for example, %TMPL:P{"x"}% will expand to x%P%z. | ||||||||||||
Any alphanumeric characters can be used in parameter names. You are highly recommended to use parameter names that cannot be confused with TWikiVariables. | |||||||||||||
Line: 53 to 56 | |||||||||||||
Finding Templates | |||||||||||||
Changed: | |||||||||||||
< < | Templates are stored either in the twiki/templates directory, or can also be read from user topics. As an example, twiki/templates/view.tmpl is the default template file for the twiki/bin/view script. | ||||||||||||
> > | The master templates shipped with a twiki release are stored in the twiki/templates directory. As an example, twiki/templates/view.tmpl is the default template file for the twiki/bin/view script.
You can save templates in other directories as long as they are listed in the {TemplatePath} configuration setting. The {TemplatePath} is defined in the Miscellaneous section of the configure page. | ||||||||||||
Changed: | |||||||||||||
< < | Templates that are included using %TMPL:INCLUDE% are also found using the same search algorithm, unless you explicitly put '.tmpl' at the end of the template name. In this case, the string is assumed to be the full name of a template in the templates directory, and the algorithm isn't used. | ||||||||||||
> > | You can also save templates in user topics. The {TemplatePath} configuration setting defines which topics will be accepted as templates. | ||||||||||||
Changed: | |||||||||||||
< < | TWiki uses the following search order to determine which template file or topic to use for a particular script. The skin path is set as described in TWikiSkins. | ||||||||||||
> > | Templates that are included with an explicit '.tmpl' extension are looked for only in the templates/ directory. For instance %TMPL:INCLUDE{"example.tmpl"}% will only return templates/example.tmpl , regardless of {TemplatePath} and SKIN settings.
The out-of-the-box setting of {TemplatePath} supports the following search order to determine which template file or topic to use for a particular script or %TMPL:INCLUDE{"script"}% statement. The skin path is set as described in TWikiSkins. | ||||||||||||
Deleted: | |||||||||||||
< < | |||||||||||||
| |||||||||||||
Line: 69 to 75 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Legend:
| |||||||||||||
Changed: | |||||||||||||
< < | |||||||||||||
> > | |||||||||||||
For example, the example template file will be searched for in the following places, when the current web is Thisweb and the skin path is print,pattern : | |||||||||||||
Added: | |||||||||||||
> > | |||||||||||||
| |||||||||||||
Line: 88 to 95 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Changed: | |||||||||||||
< < | Template names are usually derived from the name of the currently executing script; however it is also possible to override these settings in the view and edit scripts, for example when a topic-specific template is required. Two preference variables can be user to override the templates used: | ||||||||||||
> > | Template names are usually derived from the name of the currently executing script; however it is also possible to override these settings in the view and edit scripts, for example when a topic-specific template is required. Two preference variables can be used to override the templates used: | ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | If these preferences are set locally (using Local instead of Set) for a topic, in WebPreferences, in Main.TWikiPreferences, or TWiki.TWikiPreferences (using Set), the indicated templates will be chosen for view and edit respectively. The template search order is as specified above. | ||||||||||||
> > | If these preferences are set locally (using Local instead of Set) for a topic, in WebPreferences, in Main.TWikiPreferences, or TWiki.TWikiPreferences (using Set), the indicated templates will be chosen for view and edit respectively. The template search order is as specified above. | ||||||||||||
Changed: | |||||||||||||
< < | TMPL:INCLUDE recusion for piecewise customisation, or mixing in new features | ||||||||||||
> > | TMPL:INCLUDE recursion for piecewise customisation, or mixing in new features | ||||||||||||
Changed: | |||||||||||||
< < | If there is recusion in the TMPL:INCLUDE chain (eg twiki.classic.tmpl contains %TMPL:INCLUDE{"twiki"}% , the templating system will include the next twiki.SKIN in the skin path. | ||||||||||||
> > | If there is recursion in the TMPL:INCLUDE chain (eg twiki.classic.tmpl contains %TMPL:INCLUDE{"twiki"}% , the templating system will include the next twiki.SKIN in the skin path. | ||||||||||||
For example, to create a customisation of pattern skin, where you only want to over-ride the breadcrumbs for the view script, you can create only a view.yourlocal.tmpl:
%TMPL:INCLUDE{"view"}% | |||||||||||||
Line: 107 to 114 | |||||||||||||
and then set SKIN=yourlocal,pattern | |||||||||||||
Changed: | |||||||||||||
< < | Master TemplatesMaster templates use the block definition directives (%TMPL:DEF and %TMPL:END% ) to define common sections that appear in two or more other templates. twiki.tmpl is the default master template.
| ||||||||||||
> > | The default {TemplatePath} will not give you the desired result if you put these statements in the topic Thisweb.YourlocalSkinViewTemplate . The default {TemplatePath} will resolve the request to the template/view.pattern.tmpl , before it gets to the Thisweb.YourlocalSkinViewTemplate resolution. You can make it work by prefixing the {TemplatePath} with: $web.YourlocalSkin$nameTemplate .
Default master templatetwiki.tmpl is the default master template. It defines the following sections. | ||||||||||||
| |||||||||||||
Deleted: | |||||||||||||
< < |
HTML Page TemplatesHTML page templates are files of HTML mixed with template directives that tell TWiki how to build up an HTML page. As described above, the template system supports the use of 'include' directives that let you re-use the same sections of HTML - such as headers and footers - in several different places. TWiki uses HTML page templates when composing the output from 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. HTML page templates are also used in the definition of TWikiSkins. | ||||||||||||
Template Topics | |||||||||||||
Changed: | |||||||||||||
< < | Template topics define the default text for new topics. There are three types of template topic: | ||||||||||||
> > | The second type of template in TWiki are template topics. Template topics define the default text for new topics. There are three types of template topic: | ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
edit script, TWiki locates a topic to use as a content template according to the following search order:
| ||||||||||||
Changed: | |||||||||||||
< < | Edit Template Topics and Variable Expansion | ||||||||||||
> > | Variable Expansion | ||||||||||||
Changed: | |||||||||||||
< < | The following variables get expanded when a user creates a new topic based on a template topic: | ||||||||||||
> > | When the following variables are used in a template topic, they automatically get expanded when new topic is created based on it: | ||||||||||||
Deleted: | |||||||||||||
< < | |||||||||||||
| |||||||||||||
Line: 163 to 160 | |||||||||||||
| |||||||||||||
Deleted: | |||||||||||||
< < | |||||||||||||
%STARTSECTION{type="templateonly"}% markers are used to embed text that you do not want expanded when a new topic based on the template topic is created. For example, you might want to write in the template topic: | |||||||||||||
Changed: | |||||||||||||
< < | %STARTSECTION{type="templateonly"}% | ||||||||||||
> > | %STARTSECTION{type="templateonly"}% | ||||||||||||
This template can only be changed by: | |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
This will restrict who can edit the template topic, but will get removed when a new topic based on that template topic is created. | |||||||||||||
Changed: | |||||||||||||
< < | %NOP% can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g.i escape %nop>SERVERTIME% with %SER%NOP%VERTIME% . | ||||||||||||
> > | %NOP% can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g.i escape %SERVERTIME% with %SER%NOP%VERTIME% . | ||||||||||||
All other variables are unchanged, e.g. are carried over "as is" into the new topic. | |||||||||||||
Added: | |||||||||||||
> > | Specifying a FormWhen you create a new topic based on a template, you often want the new topic to have a form attached to it. You can attach a form to the template topic, in which case it will be copied into the new topic. Sometimes this isn't quite what you want, as it copies all the existing data from the template topic into the new topic. To avoid this and use the default values specified in the form definition instead, you can use theformtemplate CGI parameter to the edit script to specify the name of a form to attach.
See TWikiScripts for information about all the other parameters to edit .
Automatically Generated Topic NamesFor TWiki applications it is useful to be able to automatically generate unique topicnames, such as BugID0001, BugID0002, etc. You can addAUTOINC<n> to the topic name in the edit and save scripts, and it will be replaced with an auto-incremented number on topic save. <n> is a number starting from 0, and may include leading zeros. Leading zeros are used to zero-pad numbers so that auto-incremented topic names can sort properly. Deleted topics are not re-used to ensure uniqueness of topic names. That is, the auto-incremented number is always higher than the existing ones, even if there are gaps in the number sequence.
Examples:
[[%SCRIPTURLPATH{edit}%/%WEB%/BugIDAUTOINC00001?templatetopic=BugTemplate;topicparent=%TOPIC%;t=%SERVERTIME{"$day$hour$min$sec"}%][Create new item]] | ||||||||||||
Template Topics in Action | |||||||||||||
Changed: | |||||||||||||
< < | Here is an example for creating new topics based on a specific template topic: | ||||||||||||
> > | Here is an example for creating new topics (in the Sandbox web) based on a specific template topic and form: | ||||||||||||
Changed: | |||||||||||||
< < | |||||||||||||
> > | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | |||||||||||||
> > | |||||||||||||
Deleted: | |||||||||||||
< < | (date format is YYYYxMMxDD) | ||||||||||||
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}%/%WEB%/"> | ||||||||||||
> > | <form name="new" action="%SCRIPTURLPATH{edit}%/Sandbox/"> | ||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="26" /> | ||||||||||||
> > | <input type="text" name="topic" value="ExampleTopicAUTOINC0001" size="30" /> | ||||||||||||
<input type="hidden" name="templatetopic" value="ExampleTopicTemplate" /> <input type="hidden" name="topicparent" value="%TOPIC%" /> <input type="hidden" name="onlywikiname" value="on" /> <input type="hidden" name="onlynewtopic" value="on" /> <input type="submit" class="twikiSubmit" value="Create" /> | |||||||||||||
Deleted: | |||||||||||||
< < | (date format is <nop>YYYYxMMxDD) | ||||||||||||
</form> | |||||||||||||
Line: 212 to 228 | |||||||||||||
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% | |||||||||||||
Changed: | |||||||||||||
< < |
Automatically Generated TopicnameFor TWiki application it is useful to automatically generate unique topicnames, such as BugID0001, BugID0002, etc. You can addAUTOINC<n> to the topic name in the edit and save scripts, it gets replaced with an auto-incremented number on topic save. <n> is a number starting from 0, and may include leading zeros. Leading zeros are used to zero-pad numbers so that auto-incremented topic names can sort properly. Deleted topics are not re-used to ensure uniqueness of topic names. That is, the auto-incremented number is always higher than the existing ones, even if there are gaps in the number sequence. | ||||||||||||
> > | Using Absolute vs Relative URLs in Templates | ||||||||||||
Changed: | |||||||||||||
< < | Examples:
[[%SCRIPTURLPATH{"edit"}%/%WEB%/BugIDAUTOINC00000?templatetopic=BugTemplate&topicparent=%TOPIC%&t=%SERVERTIME{"$day$hour$min$sec"}%][Create new item]]= Master Templates by ExampleAttached is an example of an oops based templateoopsbase.tmpl and an example oops dialog oopstest.tmpl based on the base template. NOTE: This isn't the release version, just a quick, simple demo.
Base template oopsbase.tmplThe 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"}%
%TMPL:DEF{"sep"}% | %TMPL:END% <html> <head> <title> %WIKITOOLNAME% . %WEB% . %TOPIC% %.TMPL:P{"titleaction"}%</title> <base href="%SCRIPTURLPATH{"view"}%/%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>%TOPIC%</b> . { %TMPL:P{"topicaction"}% } </td> </tr> </table> </body> Test template oopstest.tmplEach 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.tmplWith URL:.../bin/oops/Sandbox/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify
| ||||||||||||
> > | When you use TWikiVariables such as %PUBURL% and %PUBURLPATH% in templates you should be aware that using %PUBURL% instead of %PUBURLPATH% puts absolute URLs in the produced HTML. This means that when a user saves a TWiki page in HTML and emails the file to someone outside a company firewall, the receiver has a severe problem viewing it. It is therefore recommended always to use the %PUBURLPATH% to refer to images, CSS, Javascript files etc so links become relative. This way browsers just give up right away and show a usable html file. | ||||||||||||
Related Topics: TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory | |||||||||||||
Changed: | |||||||||||||
< < | -- Contributors: TWiki:Main.CrawfordCurrie, TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.DavidLeBlanc
| ||||||||||||
> > | -- Contributors: TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.DavidLeBlanc, TWiki:Main.CrawfordCurrie |
Line: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TWiki Templates | |||||||||||||
Line: 111 to 111 | |||||||||||||
Master templates use the block definition directives (%TMPL:DEF and %TMPL:END% ) to define common sections that appear in two or more other templates. twiki.tmpl is the default master template.
| |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Line: 207 to 207 | |||||||||||||
</form> | |||||||||||||
Changed: | |||||||||||||
< < | See TWikiScripts for details of the parameters that the edit script understands. | ||||||||||||
> > | See TWikiScripts#edit for details of the parameters that the edit script understands. | ||||||||||||
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: 312 to 312 | |||||||||||||
Related Topics: TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory | |||||||||||||
Added: | |||||||||||||
> > | -- Contributors: TWiki:Main.CrawfordCurrie, TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.DavidLeBlanc | ||||||||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
TWiki Templates | ||||||||
Line: 14 to 14 | ||||||||
All three types of template use the TWiki template system. | ||||||||
Added: | ||||||||
> > | Tip: TWiki:TWiki.TWikiTemplatesSupplement on TWiki.org has supplemental documentation on TWiki templates. | |||||||
The TWiki Template SystemTemplates are plain text with embedded template directives that tell TWiki how to compose blocks of text together to create something new. | ||||||||
Line: 24 to 26 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 64 to 66 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Legend:
| ||||||||
Line: 95 to 97 | ||||||||
view and edit respectively. The template search order is as specified above. | ||||||||
Added: | ||||||||
> > | TMPL:INCLUDE recusion for piecewise customisation, or mixing in new featuresIf there is recusion in the TMPL:INCLUDE chain (eg twiki.classic.tmpl contains%TMPL:INCLUDE{"twiki"}% , the templating system will include the next twiki.SKIN in the skin path.
For example, to create a customisation of pattern skin, where you only want to over-ride the breadcrumbs for the view script, you can create only a view.yourlocal.tmpl:
%TMPL:INCLUDE{"view"}% %TMPL:DEF{"breadcrumb"}% We don't want any crumbs %TMPL:END%and then set SKIN=yourlocal,pattern | |||||||
Master TemplatesMaster templates use the block definition directives (%TMPL:DEF and %TMPL:END% ) to define common sections that appear in two or more other templates. twiki.tmpl is the default master template.
| ||||||||
Line: 143 to 155 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 203 to 215 | ||||||||
Automatically Generated Topicname | ||||||||
Changed: | ||||||||
< < | If you want to make a TWiki application where you need automatically generated unique topicnames, you can use 10 X's in the edit / save URL, and they will be replaced on topic save with a count value. For example, BugIDXXXXXXXXXX will result in topics named BugID0, BugID1, BugID2 etc. | |||||||
> > | For TWiki application it is useful to automatically generate unique topicnames, such as BugID0001, BugID0002, etc. You can add AUTOINC<n> to the topic name in the edit and save scripts, it gets replaced with an auto-incremented number on topic save. <n> is a number starting from 0, and may include leading zeros. Leading zeros are used to zero-pad numbers so that auto-incremented topic names can sort properly. Deleted topics are not re-used to ensure uniqueness of topic names. That is, the auto-incremented number is always higher than the existing ones, even if there are gaps in the number sequence.
Examples:
| |||||||
Example link to create a new topic: | ||||||||
Changed: | ||||||||
< < | Create new item= | |||||||
> > | Create new item= | |||||||
Master Templates by Example | ||||||||
Line: 219 to 236 | ||||||||
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"}%
| ||||||||
Deleted: | ||||||||
< < | ||||||||
%TMPL:DEF{"sep"}% | %TMPL:END% <html> | ||||||||
Line: 260 to 275 | ||||||||
</table> </body> | ||||||||
Deleted: | ||||||||
< < | ||||||||
Test template oopstest.tmpl | ||||||||
Line: 269 to 282 | ||||||||
Each oops template basically just defines some variables and includes the base template that does the layout work. | ||||||||
Deleted: | ||||||||
< < | ||||||||
%TMPL:DEF{"titleaction"}% (test =titleaction=) %TMPL:END% %TMPL:DEF{"webaction"}% test =webaction= %TMPL:END% | ||||||||
Line: 291 to 302 | ||||||||
[[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END% %TMPL:INCLUDE{"oopsbase"}% | ||||||||
Deleted: | ||||||||
< < | ||||||||
Sample screen shot of oopstest.tmplWith URL:.../bin/oops/Sandbox/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify | ||||||||
Changed: | ||||||||
< < | ||||||||
> > | ||||||||
Related Topics: TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
TWiki Templates | ||||||||
Line: 140 to 140 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
|
Line: 1 to 1 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deleted: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
TWiki Templates | |||||||||||||||||||||
Line: 8 to 7 | |||||||||||||||||||||
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 markup for template-specific content. Templates are used to define page layout, and also to supply default content for new pages. | ||||||||||||||||||||
> > | There are three types of template:
| ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Major changes from the previous template system | ||||||||||||||||||||
> > | All three types of template use the TWiki template system. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | 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: | ||||||||||||||||||||
> > | The TWiki Template System | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > | Templates are plain text with embedded template directives that tell TWiki how to compose blocks of text together to create something new. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | How Template Variables Work
| ||||||||||||||||||||
> > | How Template Directives Work
| ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Types of Template | ||||||||||||||||||||
> > | TMPL:P also supports simple parameters. For example, given the definition
%TMPL:DEF{"x"}% x%P%z%TMPL:END% then %TMPL:P{"x" P="y"}% will expand to xyz . | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | There are three types of template: | ||||||||||||||||||||
> > | Note that parameters can simply be ignored; for example=%TMPL:P{"x"}%= will expand to x%P%z. Any alphanumeric characters can be used in parameter names. You are highly recommended to use parameter names that cannot be confused with TWikiVariables. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > | Note that three parameter names, context , then and else are reserved. They are used to support a limited form of "if" condition that you can use to select which of two templates to use, based on a context identifier:
%TMPL:DEF{"link_inactive"}%<input type="button" disabled value="Link>%TMPL:END% %TMPL:DEF{"link_active"}%<input type="button" onclick="link()" value="Link" />%TMPL:END% %TMPL:P{context="inactive" then="inactive_link" else="active_link"}% for %CONTEXT%When the "inactive" context is set, then this will expand the "link_inactive" template; otherwise it will expand the "link_active" template. See IfStatements for details of supported context identifiers. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Master Templates | ||||||||||||||||||||
> > | Finding TemplatesTemplates are stored either in thetwiki/templates directory, or can also be read from user topics. As an example, twiki/templates/view.tmpl is the default template file for the twiki/bin/view script.
Templates that are included using %TMPL:INCLUDE% are also found using the same search algorithm, unless you explicitly put '.tmpl' at the end of the template name. In this case, the string is assumed to be the full name of a template in the templates directory, and the algorithm isn't used.
TWiki uses the following search order to determine which template file or topic to use for a particular script. The skin path is set as described in TWikiSkins. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | 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. | ||||||||||||||||||||
> > | For example, the example template file will be searched for in the following places, when the current web is Thisweb and the skin path is print,pattern :
view and edit scripts, for example when a topic-specific template is required. Two preference variables can be user to override the templates used:
view and edit respectively. The template search order is as specified above.
Master TemplatesMaster templates use the block definition directives (%TMPL:DEF and %TMPL:END% ) to define common sections that appear in two or more other templates. twiki.tmpl is the default master template. | ||||||||||||||||||||
| |||||||||||||||||||||
Line: 57 to 108 | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | HTML Page TemplatesTWiki 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. Templates are stored either in thetwiki/templates directory or in user topics. As an example, twiki/templates/view.tmpl is the template file for the twiki/bin/view script. | ||||||||||||||||||||
> > | HTML Page Templates | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Templates can be overloaded by individual webs. | ||||||||||||||||||||
> > | HTML page templates are files of HTML mixed with template directives that tell TWiki how to build up an HTML page. As described above, the template system supports the use of 'include' directives that let you re-use the same sections of HTML - such as headers and footers - in several different places. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | TWikiSkins can overload the standard templates. | ||||||||||||||||||||
> > | TWiki uses HTML page templates when composing the output from 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: | |||||||||||||||||||||
< < | TWiki uses the following search order to determine which template to use:
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 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. | ||||||||||||||||||||
> > | HTML page templates are also used in the definition of TWikiSkins. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Template Topics | ||||||||||||||||||||
> > | Template Topics | ||||||||||||||||||||
Template topics define the default text for new topics. There are three types of template topic: | |||||||||||||||||||||
Line: 99 to 126 | |||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | 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: | ||||||||||||||||||||
> > | When you create a new topic, TWiki locates a topic to use as a content template according to the following search order: | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Edit Template Topics and Variable Expansion | ||||||||||||||||||||
> > |
Edit Template Topics and Variable Expansion | ||||||||||||||||||||
The following variables get expanded when a user creates a new topic based on a template topic:
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Notes:
| ||||||||||||||||||||
> > | %STARTSECTION{type="templateonly"}% markers are used to embed text that you do not want expanded when a new topic based on the template topic is created. For example, you might want to write in the template topic:
%STARTSECTION{type="templateonly"}% This template can only be changed by: * Set ALLOWTOPICCHANGE = %MAINWEB%.TWikiAdminGroup %ENDSECTION{type="templateonly"}%This will restrict who can edit the template topic, but will get removed when a new topic based on that template topic is created. %NOP% can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g.i escape %nop>SERVERTIME% with %SER%NOP%VERTIME% . | ||||||||||||||||||||
All other variables are unchanged, e.g. are carried over "as is" into the new topic. | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Template Topics in Action | ||||||||||||||||||||
> > | Template Topics in Action | ||||||||||||||||||||
Here is an example for creating new topics based on a specific template topic: | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | |||||||||||||||||||||
> > | |||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | |||||||||||||||||||||
> > | |||||||||||||||||||||
Deleted: | |||||||||||||||||||||
< < | |||||||||||||||||||||
(date format is YYYYxMMxDD)
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%/%INTURLENCODE{"%WEB%"}%/"> | ||||||||||||||||||||
> > | <form name="new" action="%SCRIPTURLPATH{edit}%/%WEB%/"> | ||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="23" /> | ||||||||||||||||||||
> > | <input type="text" name="topic" value="ExampleTopic%SERVERTIME{$yearx$mox$day}%" size="26" /> | ||||||||||||||||||||
<input type="hidden" name="templatetopic" value="ExampleTopicTemplate" /> <input type="hidden" name="topicparent" value="%TOPIC%" /> <input type="hidden" name="onlywikiname" value="on" /> <input type="hidden" name="onlynewtopic" value="on" /> | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | <input type="submit" value="Create" /> | ||||||||||||||||||||
> > | <input type="submit" class="twikiSubmit" value="Create" /> | ||||||||||||||||||||
(date format is <nop>YYYYxMMxDD) </form> | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | The edit scipt understands the following parameters, typically supplied by HTML input fields:
| ||||||||||||||||||||
> > | See TWikiScripts for details of the parameters that the edit script understands. | ||||||||||||||||||||
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% | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Templates by Example | ||||||||||||||||||||
> > |
Automatically Generated TopicnameIf you want to make a TWiki application where you need automatically generated unique topicnames, you can use 10 X's in the edit / save URL, and they will be replaced on topic save with a count value. For example, BugIDXXXXXXXXXX will result in topics named BugID0, BugID1, BugID2 etc. | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | 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. | ||||||||||||||||||||
> > | Example link to create a new topic:[[%SCRIPTURLPATH{"edit"}%/%WEB%/BugIDXXXXXXXXXX?templatetopic=BugTemplate&topicparent=%TOPIC%&t=%SERVERTIME{"$day$hour$min$sec"}%][Create new item]]= Master Templates by ExampleAttached is an example of an oops based templateoopsbase.tmpl and an example oops dialog oopstest.tmpl based on the base template. NOTE: This isn't the release version, just a quick, simple demo. | ||||||||||||||||||||
Base template oopsbase.tmpl | |||||||||||||||||||||
Line: 189 to 226 | |||||||||||||||||||||
<html> <head> <title> %WIKITOOLNAME% . %WEB% . %TOPIC% %.TMPL:P{"titleaction"}%</title> | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | <base href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%"> | ||||||||||||||||||||
> > | <base href="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%"> | ||||||||||||||||||||
<meta name="robots" content="noindex"> </head> <body bgcolor="#FFFFFF"> | |||||||||||||||||||||
Line: 266 to 303 | |||||||||||||||||||||
| |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | Known Issues
| ||||||||||||||||||||
> > | Related Topics: TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory | ||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | -- TWiki:Main.CrawfordCurrie - 30 Jun 2004 -- TWiki:Main.PeterThoeny - 15 Aug 2004 -- TWiki:Main.MikeMannix - 14 Sep 2001 -- TWiki:Main.DavidLeBlanc - 11 Mar 2002 | ||||||||||||||||||||
> > |
| ||||||||||||||||||||
Deleted: | |||||||||||||||||||||
< < |
|
Line: 1 to 1 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
Line: 59 to 59 | |||||||||||||||||||||
HTML Page Templates | |||||||||||||||||||||
Changed: | |||||||||||||||||||||
< < | 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. | ||||||||||||||||||||
> > | 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: | |||||||||||||||||||||
< < |
| ||||||||||||||||||||
> > | 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:
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 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 | |||||||||||||||||||||
| |||||||||||||||||||||
Added: | |||||||||||||||||||||
> > |
| ||||||||||||||||||||
| |||||||||||||||||||||
Line: 252 to 270 | |||||||||||||||||||||
| |||||||||||||||||||||
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 |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 95 to 95 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 250 to 252 | ||||||||
| ||||||||
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: | ||||||||
> > | ||||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 117 to 117 | ||||||||
Added: | ||||||||
> > | ||||||||
(date format is YYYYxMMxDD) | ||||||||
Line: 130 to 131 | ||||||||
<input type="hidden" name="templatetopic" value="ExampleTopicTemplate" /> <input type="hidden" name="topicparent" value="%TOPIC%" /> <input type="hidden" name="onlywikiname" value="on" /> | ||||||||
Added: | ||||||||
> > | <input type="hidden" name="onlynewtopic" value="on" /> | |||||||
<input type="submit" value="Create" /> (date format is <nop>YYYYxMMxDD) </form> | ||||||||
Line: 141 to 143 | ||||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
| ||||||||
Line: 247 to 250 | ||||||||
| ||||||||
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
|
Line: 1 to 1 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
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:
| ||||||||||||||
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 | |||||||||||||||
| |||||||||||||||
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 | ||||||||||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 115 to 115 | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
(date format is YYYYxMMxDD) | ||||||||
Line: 126 to 128 | ||||||||
| ||||||||
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. | |||||||
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: 1 to 1 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
Line: 88 to 88 | |||||||||||||
| |||||||||||||
Added: | |||||||||||||
> > | Edit Template Topics and Variable ExpansionThe following variables get expanded when a user creates a new topic based on a template topic:Notes:
| ||||||||||||
Template Topics in ActionHere is an example for creating new topics based on a specific template topic: | |||||||||||||
Line: 215 to 234 | |||||||||||||
| |||||||||||||
Changed: | |||||||||||||
< < | -- PeterThoeny - 23 Jul 2001 | ||||||||||||
> > | -- PeterThoeny - 01 Feb 2003 | ||||||||||||
-- MikeMannix? - 14 Sep 2001 -- TWiki:Main/DavidLeBlanc - 11 Mar 2002
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 92 to 92 | ||||||||
Here is an example for creating new topics based on a specific template topic: | ||||||||
Changed: | ||||||||
< < | ||||||||
> > | ||||||||
| ||||||||
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%"}%/"> | |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 92 to 92 | ||||||||
Here is an example for creating new topics based on a specific template topic: | ||||||||
Changed: | ||||||||
< < | ||||||||
> > | ||||||||
| ||||||||
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%"}%/"> | |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 92 to 92 | ||||||||
Here is an example for creating new topics based on a specific template topic: | ||||||||
Changed: | ||||||||
< < | ||||||||
> > | ||||||||
| ||||||||
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%/"> | |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Functional Specifications | |||||||
> > | How Template Variables Work | |||||||
| ||||||||
Deleted: | ||||||||
< < |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < | TWiki Master Template | |||||||
> > | Types of TemplateThere are three types of template:
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. | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Deleted: | ||||||||
< < | Types of TemplateThere are two types of templates:
| |||||||
HTML Page Templates | ||||||||
Changed: | ||||||||
< < | 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. | |||||||
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: | |||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
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: | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
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: | ||||||||
< < |
| |||||||
> > |
| |||||||
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¶m1=WebHome¶m2=WebNotify
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Known Issues | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
-- PeterThoeny - 23 Jul 2001 -- MikeMannix? - 14 Sep 2001 | ||||||||
Added: | ||||||||
> > | -- TWiki:Main/DavidLeBlanc - 11 Mar 2002 | |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 202 to 202 | ||||||||
Sample screen shot of oopstest.tmpl | ||||||||
Changed: | ||||||||
< < | With URL: .../bin/oops/Test/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify | |||||||
> > | With URL: .../bin/oops/Sandbox/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify | |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Known Issues | ||||||||
Line: 214 to 214 | ||||||||
-- PeterThoeny - 23 Jul 2001 -- MikeMannix? - 14 Sep 2001 | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 205 to 205 | ||||||||
With URL: .../bin/oops/Test/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Known Issues |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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. | |||||||
> > | 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 | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
HTML Page TemplatesTWiki 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 TopicsTemplate topics define the default text for new topics. There are three types of template topics: |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Changed: | ||||||||
< < | TWiki Template System | |||||||
> > | TWiki Templates | |||||||
Definition of the templates used to render all HTML pages displayed in TWiki
Overview | ||||||||
Changed: | ||||||||
< < | 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 | ||||||||
Changed: | ||||||||
< < | 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: | |||||||
| ||||||||
Deleted: | ||||||||
< < | ||||||||
| ||||||||
Deleted: | ||||||||
< < | ||||||||
Functional Specifications | ||||||||
Line: 34 to 32 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
TWiki Master Template |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 48 to 48 | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
Types of Template | ||||||||
Added: | ||||||||
> > | ||||||||
There are two types of templates:
| ||||||||
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: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
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> |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 63 to 63 | ||||||||
| ||||||||
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 |
Line: 1 to 1 | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Line: 36 to 36 | |||||||||||||||||||||||
| |||||||||||||||||||||||
Changed: | |||||||||||||||||||||||
< < | New Template System by Example | ||||||||||||||||||||||
> > | TWiki Master TemplateAll common parts are defined in a master template,twiki.tmpl , that all other templates use.
Types of TemplateThere are two types of templates:
HTML Page TemplatesTWiki 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 thetwiki/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:
$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 TopicsTemplate topics define the default text for new topics. There are three types of template topics: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:
Template Topics in ActionHere is an example for creating new topics based on a specific template topic: 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 | ||||||||||||||||||||||
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. | |||||||||||||||||||||||
Line: 44 to 119 | |||||||||||||||||||||||
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"}% | |||||||||||||||||||||||
Changed: | |||||||||||||||||||||||
< < | |||||||||||||||||||||||
> > | |||||||||||||||||||||||
| |||||||||||||||||||||||
Line: 90 to 165 | |||||||||||||||||||||||
Deleted: | |||||||||||||||||||||||
< < | |||||||||||||||||||||||
Test template oopstest.tmplEach oops template basically just defines some variables and includes the base template that does the layout work. | |||||||||||||||||||||||
Changed: | |||||||||||||||||||||||
< < | |||||||||||||||||||||||
> > | |||||||||||||||||||||||
| |||||||||||||||||||||||
Line: 126 to 200 | |||||||||||||||||||||||
With URL: .../bin/oops/Test/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify | |||||||||||||||||||||||
Changed: | |||||||||||||||||||||||
< < | |||||||||||||||||||||||
> > | |||||||||||||||||||||||
| |||||||||||||||||||||||
Deleted: | |||||||||||||||||||||||
< < | TWiki master templateAll common template parts are defined in one master template,twiki.tmpl , that all other templates include.
Example: | ||||||||||||||||||||||
Known Issues
| |||||||||||||||||||||||
Changed: | |||||||||||||||||||||||
< < | -- PeterThoeny - 23 Jul 2001 -- MikeMannix? - 30 Aug 2001 | ||||||||||||||||||||||
> > | -- PeterThoeny - 23 Jul 2001 -- MikeMannix? - 14 Sep 2001 | ||||||||||||||||||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 8 to 8 | ||||||||
Overview | ||||||||
Changed: | ||||||||
< < | 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 | ||||||||
Line: 26 to 26 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Deleted: | ||||||||
< < |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
New Template System by Example | ||||||||
Line: 45 to 44 | ||||||||
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"}% | ||||||||
Deleted: | ||||||||
< < | NOTE: Added a dot to escape rendering of variables, i.e. read %.WEB% as %WEB% . | |||||||
Added: | ||||||||
> > | ||||||||
Changed: | ||||||||
< < | <table border="1" cellspacing="0" cellpadding="1"> <tr><td> <verbatim> %.TMPL:DEF{"sep"}% | %.TMPL:END% | |||||||
> > | %TMPL:DEF{"sep"}% | %TMPL:END% | |||||||
<html> <head> | ||||||||
Changed: | ||||||||
< < | <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> | ||||||||
Changed: | ||||||||
< < | <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> | ||||||||
Changed: | ||||||||
< < | <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> | ||||||||
Changed: | ||||||||
< < | <tr bgcolor="%.WEBBGCOLOR%"> | |||||||
> > | <tr bgcolor="%WEBBGCOLOR%"> | |||||||
<td colspan="2"> | ||||||||
Changed: | ||||||||
< < | %.TMPL:P{"webaction"}% | |||||||
> > | %TMPL:P{"webaction"}% | |||||||
</td> </tr> </table> | ||||||||
Changed: | ||||||||
< < | ++ %.TMPL:P{"heading"}% %.TMPL:P{"message"}% | |||||||
> > | ++ %TMPL:P{"heading"}% %TMPL:P{"message"}% | |||||||
<table width="100%" border="0" cellpadding="3" cellspacing="0"> | ||||||||
Changed: | ||||||||
< < | <tr bgcolor="%.WEBBGCOLOR%"> | |||||||
> > | <tr bgcolor="%WEBBGCOLOR%"> | |||||||
<td valign="top"> | ||||||||
Changed: | ||||||||
< < | Topic <b>TWikiTemplates</b> . { %.TMPL:P{"topicaction"}% | |||||||
> > | Topic <b>%TOPIC%</b> . { %TMPL:P{"topicaction"}% | |||||||
} </td> </tr> </table> </body> | ||||||||
Deleted: | ||||||||
< < | </verbatim> </td></tr> </table > | |||||||
Added: | ||||||||
> > | ||||||||
Line: 103 to 98 | ||||||||
Changed: | ||||||||
< < | %.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...
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Test topicaction : | ||||||||
Changed: | ||||||||
< < | OK? %.TMPL:P{"sep"}% Register? %.TMPL:END% %.TMPL:INCLUDE{"oopsbase"}% | |||||||
> > | [[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}% [[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END% %TMPL:INCLUDE{"oopsbase"}% | |||||||
Line: 135 to 130 | ||||||||
| ||||||||
Added: | ||||||||
> > | TWiki master template | |||||||
All common template parts are defined in one master template, twiki.tmpl , that all other templates include.
| ||||||||
Line: 146 to 143 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Example: preview.tmpl template | |||||||
> > | Example: oopspreview.tmpl template | |||||||
%TMPL:INCLUDE{"twiki"}% %TMPL:DEF{"titleaction"}% (oops) %TMPL:END% | ||||||||
Line: 163 to 160 | ||||||||
| ||||||||
Changed: | ||||||||
< < | -- PeterThoeny - 23 Jul 2001 | |||||||
> > | -- PeterThoeny - 23 Jul 2001 | |||||||
-- MikeMannix? - 30 Aug 2001
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Line: 166 to 166 | ||||||||
-- PeterThoeny - 23 Jul 2001 -- MikeMannix? - 30 Aug 2001
| ||||||||
Added: | ||||||||
> > |
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Deleted: | ||||||||
< < | new topic for the final docSlightly edited down, but waiting for new docs, hopefully. see also for ref: orig TWikiTemplatingSystem? | |||||||
Deleted: | ||||||||
< < | ||||||||
TWiki Template System | ||||||||
Changed: | ||||||||
< < | 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 | |||||||
Changed: | ||||||||
< < | Overview | |||||||
> > | Overview | |||||||
Changed: | ||||||||
< < | 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. | |||||||
Changed: | ||||||||
< < | 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 | |||||||
Changed: | ||||||||
< < | 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: | |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < | Functional Spec | |||||||
> > |
| |||||||
Changed: | ||||||||
< < | I tried to define a simple but powerful solution that can be extended over time. Here we go: | |||||||
> > |
Functional Specifications | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < | Examples | |||||||
> > | New Template System 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. 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. | |||||||
Changed: | ||||||||
< < | Base template oopsbase.tmpl | |||||||
> > | 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"}% | ||||||||
Changed: | ||||||||
< < | 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% . | |||||||
Added: | ||||||||
> > | ||||||||
<table border="1" cellspacing="0" cellpadding="1"> <tr><td> | ||||||||
Line: 99 to 93 | ||||||||
</td></tr> </table > | ||||||||
Added: | ||||||||
> > | ||||||||
Changed: | ||||||||
< < | Test template oopstest.tmpl | |||||||
> > | Test template oopstest.tmpl | |||||||
Each oops template basically just defines some variables and includes the base template that does the layout work. | ||||||||
Added: | ||||||||
> > | ||||||||
Line: 129 to 125 | ||||||||
Added: | ||||||||
> > | ||||||||
Changed: | ||||||||
< < | Sample screen shot of oopstest.tmpl | |||||||
> > | Sample screen shot of oopstest.tmpl | |||||||
With URL: .../bin/oops/Test/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify | ||||||||
Added: | ||||||||
> > | ||||||||
| ||||||||
Added: | ||||||||
> > | ||||||||
Changed: | ||||||||
< < | Comments and feedback
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. | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < | I.e. the preview.tmpl template is now simply: | |||||||
> > |
Example: | |||||||
%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% | ||||||||
Changed: | ||||||||
< < | %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% | |||||||
%TMPL:P{"oops"}% | ||||||||
Added: | ||||||||
> > |
Known Issues | |||||||
Changed: | ||||||||
< < | 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 | ||||||||
Deleted: | ||||||||
< < | ||||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
new topic for the final doc | ||||||||
Line: 8 to 8 | ||||||||
Changed: | ||||||||
< < | TWiki Template System | |||||||
> > | TWiki Template System | |||||||
Define the templates used to render all HTML pages displayed in TWiki | ||||||||
Changed: | ||||||||
< < | 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. Using external modules like the TemplateToolkit? would be one way to go, but this will add a lot of baggage to TWiki. | ||||||||
Changed: | ||||||||
< < | Needs of the TWiki templating system | |||||||
> > | Needs of the TWiki templating system | |||||||
| ||||||||
Changed: | ||||||||
< < | Functional Spec | |||||||
> > | Functional Spec | |||||||
I tried to define a simple but powerful solution that can be extended over time. Here we go: | ||||||||
Line: 44 to 44 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Examples | |||||||
> > | 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. | ||||||||
Changed: | ||||||||
< < | Base template oopsbase.tmpl | |||||||
> > | 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"}% | ||||||||
Line: 101 to 101 | ||||||||
Changed: | ||||||||
< < | Test template oopstest.tmpl | |||||||
> > | Test template oopstest.tmpl | |||||||
Each oops template basically just defines some variables and includes the base template that does the layout work. | ||||||||
Line: 130 to 130 | ||||||||
Changed: | ||||||||
< < | Sample screen shot of oopstest.tmpl | |||||||
> > | Sample screen shot of oopstest.tmpl | |||||||
With URL: .../bin/oops/Test/TestTopic2?template=oopstest¶m1=WebHome¶m2=WebNotify
| ||||||||
Changed: | ||||||||
< < | Comments and feedback | |||||||
> > | Comments and feedback | |||||||
|
Line: 1 to 1 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Added: | ||||||||||||||||||||||
> > |
new topic for the final docSlightly edited down, but waiting for new docs, hopefully. see also for ref: orig TWikiTemplatingSystem?On this page:
TWiki Template SystemDefine the templates used to render all HTML pages displayed in TWikiOverviewWe 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
Functional SpecI tried to define a simple but powerful solution that can be extended over time. Here we go:
ExamplesAttached is an example of an oops base templateoopsbase.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.tmplThe 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.tmplEach oops template basically just defines some variables and includes the base template that does the layout work.
Comments and feedback
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.
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
|