.{
#a comment
use "filename";
$name "value";
$name qq(
valuelineone
valuelinetwo
);
print $name;
}%
- HTML -
and
- HTML - %{print $name}% - HTML -
This example maps fairly closely to the original suggestion:
| This... |
becomes... |
%TMPL:DEF{"name"}%value%TMPL:END% |
%.{$name value}% |
%TMPL:DEF{"name"}% |
%{$name qq( |
%TMPL:END% |
)}% |
%TMPL:INCLUDE{"filename"}% |
%.{use "filename"}% |
This then lead me to think that doing some kind of pre-parsed `eval{}` of the code inside the toggles may be a very powerful way to quickly extend the reach of the TWiki template system to do things like if/then and regexps. For example, what if we allowed template code to (just) call the functions in Func.pm? [Of course, this would make TWiki templates more locked to perl compared to building a new (XHTML) set of intepreted template tags...]
-- [[Main/SteveRoe]] - 23 Jul 2001
It's worth noting that Peter's suggested syntax is %TMPL:foo%, i.e. no `'.'` after the `'%'` - the use of `'.'` is purely due to [[VerbatimExpandsVariables]] - please comment there, as I'd like to see this aspect of <VERBATIM> fixed. Hence, your attached example doesn't need to use `'%.'`.
However, in your suggested new syntax, it might be useful to use `'%.'` as the intro sequence, as you have done.
-- [[Main/RichardDonkin]] - 23 Jul 2001
Thanks - fixed!
-- [[Main/SteveRoe]] - 23 Jul 2001
Please have a look at the latest templates in the [[TWikiAlphaRelease]]. There is now one master template called `twiki.tmpl` that all other templates include (well, will include when all done). The idea is to define all common parts of the templates in `twiki.tmpl` and simply use that from all other templates.
| Template variable: |
Defines: |
| %TMPL:DEF{"sep"}% |
%TMPL:END% |
"|" separator |
| %TMPL:DEF{"htmldoctype"}% |
Start of all HTML pages |
| %TMPL:DEF{"standardheader"}% |
Standard header (for view, rdiff, ... |
| %TMPL:DEF{"simpleheader"}% |
Simple header with reduced links (for edit, attach, oops,...) |
| %TMPL:DEF{"standardfooter"}% |
Footer, excluding revision part and copyright part |
| %TMPL:DEF{"oops"}% |
Skeleton of oops dialog |
I.e. the `preview.tmpl` template is now simply:
%TMPL:INCLUDE{"twiki"}%
%TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
%TMPL:DEF{"webaction"}% *Attention* %TMPL:END%
%TMPL:DEF{"heading"}% Topic is not saved yet %TMPL:END%
%TMPL:DEF{"message"}%
Please go back in your browser and save the topic. %TMPL:END%
%TMPL:DEF{"topicaction"}% %TMPL:END%
%TMPL:P{"oops"}%
With this it should be possible to create a skin that overloads just the `twiki.tmpl`, i.e. a `twiki.print.tmpl` that redefines the header and footer.
In regards to Steve's idea of toggling between "code" and "data", this is certainly powerful. This is what ASP, JSP and [[TemplateToolkit]] is all about. I do not favor this approach for these reasons:
* Mixing code and presentation is not so good because designers are not programmers and vice versa. I.e. a `$name qq( valuelineone valuelinetwo );` command is harder to grasp for a designer then some simple directives. Better let programmers write plugins and designers write templates.
* Security. It is challenging to ensure that no loop holes are in the system when you eval user specified Perl code.
-- [[Main/PeterThoeny]] - 23 Jul 2001
I suppose given the recent cvs posts on the mailing list, that this is a bit late, but isn't the whole template mechanism distinct from storing and managing revisions? I kind of see it as:
* TWiki:Store gets the latest revision. (Current file store.pm.)
* TWiki:Tmpl does all variable substition. (New file Template.pm?)
* TWiki:Render converts structured text to (x)html. (Currently subs in TWiki.pm.)
I don't know the TWiki code body well enough to know if this is feasible at this point. Sorry if this is noise at this point.
Just my $.02 worth...
-- [[Main/DavidLeBlanc]] - 23 Jul 2001
Good feedback David. TWiki currently has a different internal structure for historical reasons, not as simple as you point out. We will change the internal structure of TWiki over time.
-- [[Main/PeterThoeny]] - 24 Jul 2001
Re Steve's suggested new syntax - I tend to agree with Peter for both usability (by designers, who may not know Perl) and security. I'd particularly like to avoid introducing new security issues - TWiki has some security problems already (see [[SecureSetup]] - it's quite hard to avoid open permissions on all files if you are not the webmaster and don't have root access, because it's hard to manipulate files owned by 'nobody').
-- [[Main/RichardDonkin]] - 24 Jul 2001
I've been playing with this new templating system. Certainly powerful, but a bit confusing. A few thoughts:
* Change the name of `webaction`
* [ [[Main/PeterThoeny]] - 24 Jul 2001 ] This might be a confusing term for the oops dialogs, but is the correct term for all other templates, e.g. the acions you can do on the current web.
* Move oops template definition from `twiki.tmpl` i.e. try and keep definition of snippets of html separate from whole pages
* [ [[Main/PeterThoeny]] ] I was considering this. Technically it is possible to have two level includes, the first one an %TMPL:INCLUDE\{"oops"\}%, and from `oops.tmpl` an %TMPL:INCLUDE\{"twiki"\}%. I decided to put all in one `twiki.tmpl` file for performance reasons.
* Consider an additional syntax for definition inline with print statement - see example below.
* [ [[Main/PeterThoeny]] ] Your proposed %TMPL:P\{"oops" titleaction="(oops)"\}% syntax is a shorter version of saying %TMPL:DEF\{"titleaction"\}% (oops) %TMPL:END% %TMPL:P\{"oops"\}%. This could be a useful addition.
* Slightly different form for DEF e.g. %TMPL:DEF:xxx\{% ... %\}TMPL:DEF%, as block nature of current form is somewhat hidden, some editors will even help point out missing braces. Could make it even shorted e.g. %xxx\{% ... %\}xxx%
* [ [[Main/PeterThoeny]] ] Questions if we should do it. With the current spec you can indent the text so that you can see the structure visually. Also, there is no nesting possible, so the braces are of questionable value. I opt for the current spec.
* Move copyright information into a footer (might be alternative footers without it)
* [ [[Main/PeterThoeny]] ] This is not so simple with the current layout because there are many differences. View and diff have rev info + copyright info; preview has a colored bar + check boxes + copyright info; edit and other scripts have copyright info only.
`ooptauth.tmpl` currently:
%TMPL:INCLUDE{"twiki"}%
%TMPL:DEF{"titleaction"}% (oops) %TMPL:END%
%TMPL:DEF{"webaction"}% *Attention* %TMPL:END%
%TMPL:DEF{"heading"}% Either you need to register or the authentication failed %TMPL:END%
%TMPL:DEF{"message"}%
To edit topics on this %WIKITOOLNAME% collaborative web, you must be registered as a user.
---+++++ If you expected to be logged in at this point:
* Did you type in your login name and password correctly? Remeber, both are case sensitive.
* If you want to try again, back arrow and hit edit again.
* If you have forgotton your password, please contact %WIKIWEBMASTER% who will reset it for you.
* __Note:__ You can also login anonymously as user *TWikiGuest* with password *guest*.
---+++++ To register as a new user:
* Simply fill out the *[[%TWIKIWEB%.TWikiRegistration][TWikiRegistration]]* form.
It only takes a minute.%TMPL:END%
%TMPL:DEF{"topicaction"}%
[[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}%
[[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END%
%TMPL:P{"oops"}%
Suggest changing to:
%TMPL:INCLUDE{"oopsbase"}%
%TMPL:DEF{"message"}%
To edit topics on this %WIKITOOLNAME% collaborative web, you must be registered as a user.
---+++++ If you expected to be logged in at this point:
* Did you type in your login name and password correctly? Remeber, both are case sensitive.
* If you want to try again, back arrow and hit edit again.
* If you have forgotton your password, please contact %WIKIWEBMASTER% who will reset it for you.
* __Note:__ You can also login anonymously as user *TWikiGuest* with password *guest*.
---+++++ To register as a new user:
* Simply fill out the *[[%TWIKIWEB%.TWikiRegistration][TWikiRegistration]]* form.
It only takes a minute.%TMPL:END%
%TMPL:DEF{"topicaction"}%
[[%WEB%.%TOPIC%][OK]] %TMPL:P{"sep"}%
[[%TWIKIWEB%.TWikiRegistration][Register]] %TMPL:END%
%TMPL:P{"oops" titleaction="(oops)" action="*Attention*"
heading="Either you need to register or the authentication failed"}%
-- [[Main/JohnTalintyre]] - 24 Jul 2001
I guess that the concerns about security and complexity in the templates are valid etc. And I have a lot of respect for the caution not to overengineer this kind of thing. Certainly the controls seem to be very powerful as they are...
...I have now modified all of the templates on Codev to use the new TMPL facility. Hopefully this will save someone else the pain. This uses the standardheader, standardfooter and oops declarations as per the first rev of twiki.tmpl - the results are zipped and [attached](%ATTACHURLPATH%/tmpltemplates.zip) and hopefully can be put into CVS (?) to get everyone jump started on this.
* [ [[Main/PeterThoeny]] - 03 Aug 2001 ] Thanks Steve for the modified template files, saved time! All template files are now updated and in [[TWikiAlphaRelease]].
-- [[Main/SteveRoe]] - 25 Jul 2001
I'd like to suggest a new template print to be used within the header section of pages e.g. "INHEAD". `twiki.skin.tmpl` could define this to include scripts and style that should not be rendered, and in any case head is the standard place, not body (although this usually seems to work).
-- [[Main/JohnTalintyre]] - 31 Jul 2001
If I understand you correctly, you would like to have this change (in red) in `twiki.tmpl`:
%TMPL:DEF{"htmldoctype"}%
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
%TMPL:P{"inhead"}% %TMPL:END%
Is that correct? Where would you define "inhead"?
-- [[Main/PeterThoeny]] - 03 Aug 2001
Every template that was printing out an html heading would use this. Alternatively, being able to fully escape twiki processing (outside of the <head> section could have a similar effect).
-- [[Main/JohnTalintyre]] - 07 Aug 2001
-- [[TWiki/MikeMannix]] - 30 Aug 2001
