aboutsummaryrefslogtreecommitdiff
path: root/doc/shortcuts.mdwn
diff options
context:
space:
mode:
authorAdeodato Simó <dato@net.com.org.es>2008-03-02 17:29:02 +0100
committerJoey Hess <joey@kodama.kitenet.net>2008-03-02 18:04:09 -0500
commita8f08ab8e18877dd023430fc8926530244c74771 (patch)
tree86a5fd67b7d047a43d94c4781d47e5d3802957ab /doc/shortcuts.mdwn
parentbdb57e58334afb9ac1fab45f9f9653da4e5af98f (diff)
downloadikiwiki-a8f08ab8e18877dd023430fc8926530244c74771.tar
ikiwiki-a8f08ab8e18877dd023430fc8926530244c74771.tar.gz
Make directives generated by shortcuts accept a `desc` parameter.
(cherry picked from commit 252da396bfa728b99af7c9bb304a7b5f3f6d94e6)
Diffstat (limited to 'doc/shortcuts.mdwn')
-rw-r--r--doc/shortcuts.mdwn4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn
index e4e740897..8c0700165 100644
--- a/doc/shortcuts.mdwn
+++ b/doc/shortcuts.mdwn
@@ -7,6 +7,7 @@ Some examples of using shortcuts include:
\[[!google foo]]
\[[!wikipedia War_of_1812]]
\[[!debbug 12345]]
+ Check the \[[!cia ikiwiki desc="CIA page for %s"]].
This page controls what shortcut links the wiki supports.
@@ -62,7 +63,8 @@ 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
-with an existing directive.
+with an existing directive. These directives also accept a `desc`
+parameter that will override the one provided at definition time.
If you come up with a shortcut that you think others might find useful,
consider contributing it to the [shortcuts page on the ikiwiki