diff options
author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2007-03-31 06:55:12 +0000 |
---|---|---|
committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2007-03-31 06:55:12 +0000 |
commit | d73eb7d9b2569ebb44fc79480b6ec2d8c1faea5d (patch) | |
tree | a7a268140d43e358dd8e1cb3d5c29deef5ab1251 /doc/templates | |
parent | 08d6f422a7848a2462418be58fcb186f5f2cec03 (diff) |
* Add a templates page to the basewiki. It will automatically list all
available templates. Rename the old templates page to wikitemplates.
* Include the note template in the basewiki.
* Add a popup template in the basewiki. CSS based on some by Martin Krafft.
* Make the note, popup, and plugin templates detect missing variables and be
self-documenting, listing the available variables.
Diffstat (limited to 'doc/templates')
-rw-r--r-- | doc/templates/note.mdwn | 8 | ||||
-rw-r--r-- | doc/templates/plugin.mdwn | 9 | ||||
-rw-r--r-- | doc/templates/popup.mdwn | 16 |
3 files changed, 33 insertions, 0 deletions
diff --git a/doc/templates/note.mdwn b/doc/templates/note.mdwn index 2cbc230b3..d992e0236 100644 --- a/doc/templates/note.mdwn +++ b/doc/templates/note.mdwn @@ -1,3 +1,11 @@ <span class="notebox"> <TMPL_VAR text> </span> +<TMPL_UNLESS NAME="text"> +Use this template to insert a note into a page. The note will be styled to +float to the right of other text on the page. This template has one +parameter: +<ul> +<li>`text` - the text to display in the note +</ul> +</TMPL_UNLESS> diff --git a/doc/templates/plugin.mdwn b/doc/templates/plugin.mdwn index 5ce05b231..b4dabc341 100644 --- a/doc/templates/plugin.mdwn +++ b/doc/templates/plugin.mdwn @@ -7,3 +7,12 @@ Currently enabled: [[if test="enabled(<TMPL_VAR name>)" then="yes" else="no"]]<b </span> [[if test="sourcepage(plugins/contrib/*)" then="""[[meta title="<TMPL_VAR name> (third party plugin)"]]"""]] <TMPL_IF core>[[tag type/core]]</TMPL_IF> +<TMPL_UNLESS NAME="name"> +This template is used to create an infobox for an ikiwiki plugin. It uses +these parameters: +<ul> +<li>name - the name of the plugin +<li>author - the author of the plugin +<li>core - set to a true value if the plugin is enabled by default +</ul> +</TMPL_UNLESS> diff --git a/doc/templates/popup.mdwn b/doc/templates/popup.mdwn new file mode 100644 index 000000000..244c1d4dd --- /dev/null +++ b/doc/templates/popup.mdwn @@ -0,0 +1,16 @@ +<TMPL_UNLESS NAME="mouseover"> +Use this template to create a popup window that is displayed when the mouse +is over part of the page. This template has two parameters: +<ul> +<li>`mouseover` - This is the text or other content that triggers the +popup. +<li>`popup` - This should be the content of the popup window. It can be +anything, even images or a whole little wiki page, but should not be too +large for good usability. +</ul> +Note that browsers that do not support the CSS will display the popup +inline in the page, inside parens. +</TMPL_UNLESS> +<span class="popup"><TMPL_VAR mouseover> +<span class="paren">[</span><span class="balloon"><TMPL_VAR popup></span><span class="paren">]</span> +</span> |