web commit by http://joey.kitenet.net/

[ikiwiki.git] / basewiki / preprocessordirective.mdwn

diff --git a/basewiki/preprocessordirective.mdwn b/basewiki/preprocessordirective.mdwn
index a7d1be8c848a14519cb6c00df6121e924eb66eb6..1e2332c091b48386c2f164b2de2c2bfc5f5106cc 100644 (file)
--- a/basewiki/preprocessordirective.mdwn
+++ b/basewiki/preprocessordirective.mdwn
@@ -1,11 +1,33 @@
 Preprocessor directives are similar to a [[WikiLink]] in form, except they
 contain spaces and parameters. The general form is:
 
 Preprocessor directives are similar to a [[WikiLink]] in form, except they
 contain spaces and parameters. The general form is:
 

-\\[[directive param="value" param="value"]]
+       \[[directive param="value" param="value"]]

 
 This gets expanded before the rest of the page is processed, and can be used
 to transform the page in various ways.
 
 
 This gets expanded before the rest of the page is processed, and can be used
 to transform the page in various ways.
 

-Currently, these preprocessor directives are available:
+The quotes around values can be omitted if the value is a simple word.
+Also, some directives may use parameters without values, for example:

 
 

-* "inline" to make a [[blog]]
+       \[[tag foo]]
+
+Note that if a preprocessor directive has no parameters, a space still must
+be put after its name, to avoid confusion with a [[WikiLink]]. For example:
+
+       \[[pagecount ]]
+
+A preprocessor directive does not need to all be on one line, it can be
+wrapped to multiple lines if you like:
+       
+       \[[directive foo="baldersnatch"
+       bar="supercalifragalisticexpealadocious" baz=11]]
+
+Also, multiple lines of *quoted* text can be used for a value.
+To allow quote marks inside the quoted text, delimit the block
+of text with triple-quotes:
+
+       \[[directive text="""
+       1. "foo"
+       2. "bar"
+       3. "baz"
+       """]]