summaryrefslogtreecommitdiff
path: root/doc/preprocessordirective.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-02-13 23:10:45 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-02-13 23:10:45 +0000
commit88e8f08c8ffe61fbb3aa8d0fbf78a86c30c65543 (patch)
tree9ebd278a370af31a6591f176e774ee46a89a27e1 /doc/preprocessordirective.mdwn
parent309c689b6b139e67459c41a5132c9afec0504d84 (diff)
* Make the basewiki be full of symlinks to pages that should be the same
in the doc wiki. This will allow direct edits to alter the base wiki without manual munging.
Diffstat (limited to 'doc/preprocessordirective.mdwn')
-rw-r--r--doc/preprocessordirective.mdwn33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/preprocessordirective.mdwn b/doc/preprocessordirective.mdwn
new file mode 100644
index 000000000..1e2332c09
--- /dev/null
+++ b/doc/preprocessordirective.mdwn
@@ -0,0 +1,33 @@
+Preprocessor directives are similar to a [[WikiLink]] in form, except they
+contain spaces and parameters. The general form is:
+
+ \[[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.
+
+The quotes around values can be omitted if the value is a simple word.
+Also, some directives may use parameters without values, for example:
+
+ \[[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"
+ """]]