diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/template.mdwn | 15 | ||||
| -rw-r--r-- | doc/todo/linkify_and_preprocessor_ordering.mdwn | 24 |
2 files changed, 34 insertions, 5 deletions
diff --git a/doc/plugins/template.mdwn b/doc/plugins/template.mdwn index 9e2ab0891..6f38e554e 100644 --- a/doc/plugins/template.mdwn +++ b/doc/plugins/template.mdwn @@ -9,15 +9,18 @@ and inserted into pages in the wiki. Using a template works like this: This fills out the template `templates/foo`, filling in the `color` and `age` fields on it with the specified values, and inserts the result into the page. -If a value is triple-quoted, it can include any markup that would be -allowed in the wiki page outside the template. Combined with multi-line -quoted values, this allows for large chunks of marked up text to be -embedded into a template: +(Note that if the template doesn't exist, the page will provide a link that +can be used to create it.) + +A value can include any markup that would be allowed in the wiki page +outside the template. Triple-quoting the value even allows quotes to be +included in it. Combined with multi-line quoted values, this allows for +large chunks of marked up text to be embedded into a template: \[[template id=foo name="Sally" color="green" age=8 notes=""" * \[[Charley]]'s sister. + * "I want to be an astronaut when I grow up." * Really 8 and a half. - * Wants to be an astronaut when she grows up. """]] To create a template, make a page in the wiki named `template/foo`. Note @@ -31,6 +34,8 @@ for the full syntax, but all you really need to know are a few things: * To insert the value of a variable, use `<TMPL_VAR variable>`. * To make a block of text conditional on a variable being set use `<TMPL_IF NAME="variable">text</TMPL_IF>`. +* To use one block of text if a variable is set and a second if it's not, + use `<TMPL_IF NAME="variable">text<TMPL_ELSE>other text</TMPL_IF>` Here's a sample template: diff --git a/doc/todo/linkify_and_preprocessor_ordering.mdwn b/doc/todo/linkify_and_preprocessor_ordering.mdwn new file mode 100644 index 000000000..2936d74f0 --- /dev/null +++ b/doc/todo/linkify_and_preprocessor_ordering.mdwn @@ -0,0 +1,24 @@ +Currently ikiwiki linkifies text, then runs preprocessor directives. This +allows a directive to contain a wikilink inside a parameter, but since the +wikilink expands to some arbitrary html, the parameter needs to be +triple-quoted to avoid quotes in the expanded text from leaking out. This +is rather non-obvious. + +One fix would be to switch the order, since linkification and preprocessing +are relatively independant. Some directives, like inline, would need to keep +on linkifiying the inlined pages, to make the links be resolved correctly, +but that's ok. Any directives that outputed stuff that looked like a +wikilink, but wasn't, would need to be changed. + +> This solution has been implemented and _seems_ ok. + +An alternative would be to change the wikilink regexp so it doesn't apply +to wikilinks that are embedded inside preprocessor directives. I haven't +found a way to do that yet, since perl doesn't allow variable-width +negative lookbehind. + +Maybe processing wikilinks and preprocessor directives +as part of the same loop would work, but that probably has its own +issues. + +[[todo/done]] |