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
|