releasing version 2.31.1

[git.ikiwiki.info.git] / doc / shortcuts.mdwn

diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn
index 788408459a4ab4daf7ecc81673f612f374180977..62e06614b7195b617a60fef8c125fb4211357647 100644 (file)
--- a/doc/shortcuts.mdwn
+++ b/doc/shortcuts.mdwn
@@ -11,7 +11,7 @@ Some examples of using shortcuts include:
 This page controls what shortcut links the wiki supports.
 
 * [[shortcut name=google url="http://www.google.com/search?q=%s"]]
 This page controls what shortcut links the wiki supports.
 
 * [[shortcut name=google url="http://www.google.com/search?q=%s"]]

-* [[shortcut name=archive url="http://web.archive.org/*/%s"]]
+* [[shortcut name=archive url="http://web.archive.org/*/%S"]]

 * [[shortcut name=gmap url="http://maps.google.com/maps?q=%s"]]
 * [[shortcut name=gmsg url="http://groups.google.com/groups?selm=%s"]]
 * [[shortcut name=wikipedia url="http://en.wikipedia.org/wiki/%s"]]
 * [[shortcut name=gmap url="http://maps.google.com/maps?q=%s"]]
 * [[shortcut name=gmsg url="http://groups.google.com/groups?selm=%s"]]
 * [[shortcut name=wikipedia url="http://en.wikipedia.org/wiki/%s"]]


@@ -37,8 +37,7 @@ This page controls what shortcut links the wiki supports.
 * [[shortcut name=cpan url="http://search.cpan.org/search?mode=dist&query=%s"]]
 * [[shortcut name=ctan url="http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=%s"]]
 * [[shortcut name=hoogle url="http://haskell.org/hoogle/?q=%s"]]
 * [[shortcut name=cpan url="http://search.cpan.org/search?mode=dist&query=%s"]]
 * [[shortcut name=ctan url="http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=%s"]]
 * [[shortcut name=hoogle url="http://haskell.org/hoogle/?q=%s"]]

-* [[shortcut name=iki url="http://ikiwiki.info/%s/"]]
-* [[shortcut name=ikirev url="http://ikiwiki.info/cgi-bin/viewvc.cgi?view=rev&root=ikiwiki&revision=%s"]]
+* [[shortcut name=iki url="http://ikiwiki.info/%S/"]]

 * [[shortcut name=ljuser url="http://%s.livejournal.com/"]]
 * [[shortcut name=rfc url="http://www.ietf.org/rfc/rfc%s.txt" desc="RFC %s"]]
 * [[shortcut name=c2 url="http://c2.com/cgi/wiki?%s"]]
 * [[shortcut name=ljuser url="http://%s.livejournal.com/"]]
 * [[shortcut name=rfc url="http://www.ietf.org/rfc/rfc%s.txt" desc="RFC %s"]]
 * [[shortcut name=c2 url="http://c2.com/cgi/wiki?%s"]]


@@ -54,18 +53,18 @@ This page controls what shortcut links the wiki supports.
 * [[shortcut name=cia url="http://cia.vc/stats/project/%s"]]
 * [[shortcut name=ciauser url="http://cia.vc/stats/user/%s"]]
 * [[shortcut name=flickr url="http://www.flickr.com/photos/%s"]]
 * [[shortcut name=cia url="http://cia.vc/stats/project/%s"]]
 * [[shortcut name=ciauser url="http://cia.vc/stats/user/%s"]]
 * [[shortcut name=flickr url="http://www.flickr.com/photos/%s"]]

-* [[shortcut name=zooomr url="http://www.zooomr.com/photos/%s"]]
-  * Note: You have to include the username and number in here, such as `bob/123455`.

 
 

-To add a new shortcut, use the `shortcut` [[PreprocessorDirective]]. "%s" is
-replaced with the text passed to the named shortcut. The optional `desc`
-parameter controls the description of the link.
+To add a new shortcut, use the `shortcut`
+[[ikiwiki/PreprocessorDirective]]. In the url, "%s" is replaced with the
+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
 
 Remember that the `name` you give the shortcut will become a new

-[[PreprocessorDirective]].  Avoid using a `name` that conflicts with an
-existing directive.
+[[ikiwiki/PreprocessorDirective]].  Avoid using a `name` that conflicts
+with an existing directive.

 
 If you come up with a shortcut that you think others might find useful,
 
 If you come up with a shortcut that you think others might find useful,

-consider contributing it to the [[iki shortcuts]] page on the ikiwiki
-ikiwiki, so that future versions of ikiwiki will include your shortcut
-in the standard underlay.
+consider contributing it to the [shortcuts page on the ikiwiki
+ikiwiki](http://ikiwiki.info/shortcuts/), so that future versions of
+ikiwiki will include your shortcut in the standard underlay.