From b1fadc6eacaacb4d892b495e15ff82e9ba36c638 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Wed, 22 Oct 2008 20:31:53 +0200 Subject: Sync with ikiwiki 2.67. --- directive.mdwn | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 directive.mdwn (limited to 'directive.mdwn') diff --git a/directive.mdwn b/directive.mdwn new file mode 100644 index 0000000..c4342de --- /dev/null +++ b/directive.mdwn @@ -0,0 +1,45 @@ +[[!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-quotes: + + \[[!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|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 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. + +[[!if test="enabled(listdirectives)" then=""" +Here is a list of currently available directives in this wiki: + +[[!listdirectives ]] +"""]] -- cgit v1.2.3