X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a7e119767ce0b042075fd8955599e30df13e290b..509370d91ddc4871a60d48dc1dbd95e9a2eaff48:/doc/plugins/shortcut/discussion.mdwn

diff --git a/doc/plugins/shortcut/discussion.mdwn b/doc/plugins/shortcut/discussion.mdwn
index d11639856..7f0d58dbe 100644
--- a/doc/plugins/shortcut/discussion.mdwn
+++ b/doc/plugins/shortcut/discussion.mdwn
@@ -1,16 +1,49 @@
-The plugin somehow depends on [[mdwn]].  If you have
+The plugin depends on [[mdwn]].  If you have
 disabled [[mdwn]], to get [[shortcut]] work, you need
-commit in a shortcuts.ext (ext is rcs|creole|html|txt|etc).
+commit in a shortcuts.ext (ext is `rcs|creole|html|txt|etc`),
+and edit/patch [[shortcut]].
 
-Then edit the following lines in[[shortcut]] plugin source:
+Maybe use the `default_pageext` is better than hardcode .mdwn?
 
-    my $srcfile=srcfile("shortcuts.mdwn", 1);
+--[[weakish]]
 
-and
+> done, it will use `default_pageext` now --[[Joey]] 
 
-    error(gettext("shortcut plugin will not work without a shortcuts.mdwn"));
+---
 
+Instead of modifying the [[basewiki]]'s [[shortcuts]] file for local needs --
+thus copying it at some point and losing continuity with upstream enhancements --
+what about handling a `shortcuts-local.mdwn` or `shortcuts/local.mdwn` (if such
+a file exists in the wiki), and additionally process that one.  Possibily a
+conditional `\[[!inline]]` could be used.  --[[tschwinge]]
 
-(It is better to edit a local copy of shortcut.pm in, say, ~/.ikiwiki/IkiWiki/Plugin
-and add ~/.ikiwiki to libdir in your ikiwiki.setup then edit the shortcut.pm installed
-in system directly.)
+----
+
+The page says
+
+> Additionally, %W is replaced with the text encoded just right for Wikipedia
+
+with the implication that this is odd. However, it appears the escapes
+actually mean:
+
+=%s=
+    If every character in the string is in the Latin-1 range, encode each
+    character as a http %xx escape: ö -> %F6. If not,
+    mangle the string: ☃ (U+2603 SNOWMAN) -> %2603 which
+    actually means "&03".
+=%S=
+    Leave the string as-is.
+=%W=
+    Encode the string as UTF-8, then encode each byte of the UTF-8
+    individually as a http %xx escape: ö -> %C3%B6, ☃ (U+2603 SNOWMAN) ->
+    %E2%98%83.
+
+http %xx encoding is defined in terms of input bytes, not input characters,
+so you can't encode arbitrary Unicode into URLs without knowing which
+encoding the destination server is going to use. UTF-8 is what's
+recommended by the [[!wikipedia Internationalized resource identifier]]
+specification, so I suspect %W is right more often than it's wrong...
+
+I wonder whether %s should mean what %W does now, with a new format
+character - maybe %L for Latin-1? - for the version that only works
+for strings that can be encoded losslessly in Latin-1? --[[smcv]]