summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/bugs/shortcut_encoding.mdwn2
-rw-r--r--doc/shortcuts.mdwn5
2 files changed, 5 insertions, 2 deletions
diff --git a/doc/bugs/shortcut_encoding.mdwn b/doc/bugs/shortcut_encoding.mdwn
index b4a159004..bb335906a 100644
--- a/doc/bugs/shortcut_encoding.mdwn
+++ b/doc/bugs/shortcut_encoding.mdwn
@@ -24,3 +24,5 @@ That also doesn't work, but this is an already-reported issue, as far as I know.
> doesn't decode the escaped characters in the path string.
>
> I could add a %S that is not escaped, and leave %s escaped.. --[[Joey]]
+>
+> [[done]]
diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn
index 38215b627..fd27544a3 100644
--- a/doc/shortcuts.mdwn
+++ b/doc/shortcuts.mdwn
@@ -59,8 +59,9 @@ This page controls what shortcut links the wiki supports.
To add a new shortcut, use the `shortcut`
[[ikiwiki/PreprocessorDirective]]. In the url, "%s" is replaced with the
-text passed to the named shortcut. The optional `desc` parameter controls
-the description of the link.
+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
[[ikiwiki/PreprocessorDirective]]. Avoid using a `name` that conflicts