updated branch; this is ready for review for inclusion in IkIWiki

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

diff --git a/doc/ikiwiki/directive.mdwn b/doc/ikiwiki/directive.mdwn
index fb88aa72d494df0408baa77051abf729d7b83b12..1dc1e517d3b0f0890b65af4ead0e469a5ed5ad9f 100644 (file)
--- a/doc/ikiwiki/directive.mdwn
+++ b/doc/ikiwiki/directive.mdwn
@@ -20,13 +20,26 @@ 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"

-       """]]
+       """ 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
 
 ikiwiki also has an older syntax for directives, which requires a space in
 directives to distinguish them from [[wikilinks|ikiwiki/wikilink]]. This