"safe" and "unsafe" too simplistic, I suspect

[ikiwiki.git] / doc / plugins / shortcut / discussion.mdwn

diff --git a/doc/plugins/shortcut/discussion.mdwn b/doc/plugins/shortcut/discussion.mdwn
index d11639856202947d51445f1c9a255a43355e7d58..2e2b1b281b5ff5d8009ec841243192371c5778a6 100644 (file)
--- a/doc/plugins/shortcut/discussion.mdwn
+++ b/doc/plugins/shortcut/discussion.mdwn
@@ -1,16 +1,18 @@
-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"));
+---
 
-
-(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.)
+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]]