X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/c69a7f758590c91bd137a8d1cfa99f37bf28045a..17bab92c31f171ff0b88d55330c039e6c5204a84:/doc/ikiwiki/directive.mdwn diff --git a/doc/ikiwiki/directive.mdwn b/doc/ikiwiki/directive.mdwn index 4ab9a2076..c4342dee8 100644 --- a/doc/ikiwiki/directive.mdwn +++ b/doc/ikiwiki/directive.mdwn @@ -1,5 +1,5 @@ [[!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"]] @@ -29,23 +29,17 @@ of text with triple-quotes: """]] 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. +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(shortcut)" then=""" -The [[/ikiwiki/directive/shortcut]] directive allows defining simple wikilinks to -remote wikis. See the [[shortcuts]] page for a list of these shortcuts. -"""]] - [[!if test="enabled(listdirectives)" then=""" -Here is a list of available (non-[[shortcut|shortcuts]]) directives: +Here is a list of currently available directives in this wiki: -[[!listdirectives]] +[[!listdirectives ]] """]] -