summaryrefslogtreecommitdiff
path: root/backend/ikistrap/basewiki/ikiwiki/directive.mdwn
diff options
context:
space:
mode:
authorKarl Semich <0xloem@gmail.com>2016-08-27 04:31:52 -0400
committerKarl Semich <0xloem@gmail.com>2016-08-27 04:31:52 -0400
commit6945074c2c496a89665f559d431cf22602199937 (patch)
treedd76fa29e557aaaaf11a40d5595a22a996533f41 /backend/ikistrap/basewiki/ikiwiki/directive.mdwn
parent227d6118cf72cf9333ac2488b76633f346e59425 (diff)
downloadstandingwithresilience-6945074c2c496a89665f559d431cf22602199937.tar.gz
standingwithresilience-6945074c2c496a89665f559d431cf22602199937.zip
Added ikistrap template
Diffstat (limited to 'backend/ikistrap/basewiki/ikiwiki/directive.mdwn')
-rw-r--r--backend/ikistrap/basewiki/ikiwiki/directive.mdwn56
1 files changed, 56 insertions, 0 deletions
diff --git a/backend/ikistrap/basewiki/ikiwiki/directive.mdwn b/backend/ikistrap/basewiki/ikiwiki/directive.mdwn
new file mode 100644
index 0000000..1dc1e51
--- /dev/null
+++ b/backend/ikistrap/basewiki/ikiwiki/directive.mdwn
@@ -0,0 +1,56 @@
+[[!meta robots="noindex, follow"]]
+Directives are similar to a [[ikiwiki/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 directive does not need to all be on one line, it can be
+wrapped to multiple lines if you like:
+
+ \[[!directive foo="baldersnatch"
+ bar="supercalifragilisticexpialidocious" 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-double-quotes or triple-single-quotes:
+
+ \[[!directive text="""
+ 1. "foo"
+ 2. "bar"
+ 3. "baz"
+ """ othertext='''
+ 1. 'quux'
+ 2. "foo"
+ ''']]
+
+If you want to put text with triple quotes into a parameter value, you can
+use perl-style here-doc syntax, even nesting it like this:
+
+ \[[!directive text=<<OUTER
+ [[!otherdirective <<INNER
+ inner text
+ INNER]]
+ outer text
+ OUTER]]
+
+ikiwiki also has an older syntax for directives, which requires a space in
+directives to distinguish them from [[wikilinks|ikiwiki/wikilink]]. This
+syntax has several disadvantages: it requires a space after directives with
+no parameters (such as `\[[pagecount ]]`), and it prohibits spaces in
+[[wikilinks|ikiwiki/wikilink]]. ikiwiki now provides the `!`-prefixed
+syntax shown above as default. However, ikiwiki still supports wikis using
+the older syntax, if the `prefix_directives` option is disabled.
+
+[[!if test="enabled(listdirectives)" then="""
+Here is a list of currently available directives in this wiki:
+
+[[!listdirectives ]]
+"""]]