typo

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

diff --git a/doc/plugins/shortcut/discussion.mdwn b/doc/plugins/shortcut/discussion.mdwn
index 0ecf29537787c4adc634227926d393db441c0528..8fa3f7acfb734c1eada461eec57392024bb958a3 100644 (file)
--- a/doc/plugins/shortcut/discussion.mdwn
+++ b/doc/plugins/shortcut/discussion.mdwn
@@ -1,16 +1,16 @@
-I'd like to use a shortcut like \[[gnumach-1-branch ddb/db_expr.h]] to link to
-<http://cvs.savannah.gnu.org/viewvc/gnumach/ddb/db_expr.h?view=log&root=hurd&pathrev=gnumach-1-branch>.
+The plugin somehow 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`).
 
-* Dashes are not allowed in shortcut identifiers.  Why?
+Then edit the following lines in [[shortcut]] plugin source:
 
-* The URL is rewritten to
-    <http://cvs.savannah.gnu.org/viewvc/gnumach/ddb%2Fdb%5Fexpr%2Eh?view=log&root=hurd&pathrev=gnumach-1-branch>,
-    which the remove server doesn't like.  Mind the esacping of [^A-Za-z0-9].
-    Might this be a problem of the web server?
+    my $srcfile=srcfile("shortcuts.mdwn", 1);
 
-Also, I'd like to put the shortcut usages into backticks
--- `[[iki shortcuts]]` --
-to have them displayed in the usual backtick-formatting.
-That also doesn't work, but this is an already-reported issue, as far as I know.
+and
 
---[[tschwinge]]
+    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 than edit the shortcut.pm installed
+in system directly.)