X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/5b927f38fad39d6605ed0a5bd4324a43b07daeb0..306d67c78633457b0047bd7f25cef4a909b2d4f6:/doc/shortcuts.mdwn diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn index 788408459..fd27544a3 100644 --- a/doc/shortcuts.mdwn +++ b/doc/shortcuts.mdwn @@ -57,13 +57,15 @@ This page controls what shortcut links the wiki supports. * [[shortcut name=zooomr url="http://www.zooomr.com/photos/%s"]] * Note: You have to include the username and number in here, such as `bob/123455`. -To add a new shortcut, use the `shortcut` [[PreprocessorDirective]]. "%s" is -replaced with the text passed to the named shortcut. The optional `desc` -parameter controls the description of the link. +To add a new shortcut, use the `shortcut` +[[ikiwiki/PreprocessorDirective]]. In the url, "%s" is replaced with the +text passed to the named shortcut, after url-encoding it, and '%S' is +replaced with the raw, non-encoded text. The optional `desc` parameter +controls the description of the link. Remember that the `name` you give the shortcut will become a new -[[PreprocessorDirective]]. Avoid using a `name` that conflicts with an -existing directive. +[[ikiwiki/PreprocessorDirective]]. Avoid using a `name` that conflicts +with an existing directive. If you come up with a shortcut that you think others might find useful, consider contributing it to the [[iki shortcuts]] page on the ikiwiki