diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ikiwiki/directive.mdwn | 14 | ||||
| -rw-r--r-- | doc/templates.mdwn | 7 |
2 files changed, 11 insertions, 10 deletions
diff --git a/doc/ikiwiki/directive.mdwn b/doc/ikiwiki/directive.mdwn index dafbd7271..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,12 +29,12 @@ 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. diff --git a/doc/templates.mdwn b/doc/templates.mdwn index 6b237bd9e..eff0e15e9 100644 --- a/doc/templates.mdwn +++ b/doc/templates.mdwn @@ -81,6 +81,7 @@ that contains it, so you can include WikiLinks and all other forms of wiki markup in the template. Note though that such WikiLinks will not show up as backlinks to the page that uses the template. -Note the use of "raw_name" inside the [[WikiLink]] generator. This ensures -that if the name contains something that might be mistaken for wiki markup, -it's not converted to html before being processed as a [[WikiLink]]. +Note the use of "raw_name" inside the [[ikiwiki/WikiLink]] generator. This +ensures that if the name contains something that might be mistaken for wiki +markup, it's not converted to html before being processed as a +[[ikiwiki/WikiLink]]. |