summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/preprocessordirective.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-08-25 14:19:39 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-08-25 14:19:39 -0400
commitd6fd1f1cc878b5dffdfae30f6dfee77c235c438e (patch)
treeae0e8d689bec3a0471385864056d68b6629427f7 /doc/ikiwiki/preprocessordirective.mdwn
parent9867806c13b97c0f4ce1850ee4d43c6fe3a926e7 (diff)
rename preprocessordirective to directive
Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-)
Diffstat (limited to 'doc/ikiwiki/preprocessordirective.mdwn')
-rw-r--r--doc/ikiwiki/preprocessordirective.mdwn39
1 files changed, 0 insertions, 39 deletions
diff --git a/doc/ikiwiki/preprocessordirective.mdwn b/doc/ikiwiki/preprocessordirective.mdwn
deleted file mode 100644
index 743c0d9f5..000000000
--- a/doc/ikiwiki/preprocessordirective.mdwn
+++ /dev/null
@@ -1,39 +0,0 @@
-[[!meta robots="noindex, follow"]]
-Preprocessor directives are similar to a [[WikiLink]] in form, except they
-begin with `!` and may contain 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]]
-
-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"
- """]]
-
-ikiwiki also has an older syntax for preprocessor directives, which requires a
-space in directives to distinguish them from [[wikilinks|wikilink]]. This
-syntax has several disadvantages: it requires a space after directives with no
-parameters (such as `\[[pagecount ]]`), and it prohibits spaces in
-[[wikilinks|wikilink]]. ikiwiki now provides the `!`-prefixed syntax shown
-above as the preferred alternative. However, ikiwiki still supports wikis
-using the older syntax, if the `prefix_directives` option is not enabled.
-For backward compatibility with existing wikis, this option currently
-defaults to off, so ikiwiki supports the old syntax.