why a directive?

[git.ikiwiki.info.git] / doc / ikiwiki / directive.mdwn

diff --git a/doc/ikiwiki/directive.mdwn b/doc/ikiwiki/directive.mdwn
index 775adaa0f0960ed4edc2f6ad468cf8ea874fb747..1dc1e517d3b0f0890b65af4ead0e469a5ed5ad9f 100644 (file)
--- a/doc/ikiwiki/directive.mdwn
+++ b/doc/ikiwiki/directive.mdwn
@@ -1,5 +1,5 @@
 [[!meta robots="noindex, follow"]]
 [[!meta robots="noindex, follow"]]

-Directives are similar to a [[WikiLink]] in form, except they
+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"]]
 begin with `!` and may contain parameters. The general form is:
 
        \[[!directive param="value" param="value"]]


@@ -20,26 +20,37 @@ wrapped to multiple lines if you like:
 
 Also, multiple lines of *quoted* text can be used for a value.
 To allow quote marks inside the quoted text, delimit the block
 
 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:
+of text with triple-double-quotes or triple-single-quotes:

 
        \[[!directive text="""
        1. "foo"
        2. "bar"
        3. "baz"
 
        \[[!directive text="""
        1. "foo"
        2. "bar"
        3. "baz"

-       """]]
-
-ikiwiki also has an older syntax for 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.
+       """ 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="""
 
 [[!if test="enabled(listdirectives)" then="""

-Here is a list of available directives:
+Here is a list of currently available directives in this wiki:

 
 [[!listdirectives ]]
 """]]
 
 [[!listdirectives ]]
 """]]