X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/18e776f4c16b643e08c524890c2a1af866dab433..58ef55c79893190021a441b2ba618178fce13bc5:/doc/shortcuts.mdwn diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn index c21d9d070..62e06614b 100644 --- a/doc/shortcuts.mdwn +++ b/doc/shortcuts.mdwn @@ -2,26 +2,44 @@ then="This wiki has shortcuts **enabled**." else="This wiki has shortcuts **disabled**."]] +Some examples of using shortcuts include: + + \[[google foo]] + \[[wikipedia War_of_1812]] + \[[debbug 12345]] + 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=wikitravel url="http://wikitravel.org/en/%s"]] * [[shortcut name=debbug url="http://bugs.debian.org/%s" desc="bug #%s"]] * [[shortcut name=deblist url="http://lists.debian.org/debian-%s" desc="debian-%s@lists.debian.org"]] * [[shortcut name=debpkg url="http://packages.debian.org/%s"]] * [[shortcut name=debpts url="http://packages.qa.debian.org/%s"]] +* [[shortcut name=debmsg url="http://lists.debian.org/msgid-search/%s"]] +* [[shortcut name=debrt url="https://rt.debian.org/Ticket/Display.html?id=%s"]] +* [[shortcut name=debss url="http://snapshot.debian.net/package/%s"]] + * Usage: `\[[debss package]]`, `\[[debss package#version]]`, or `\[[debss package/version]]`. See http://snapshot.debian.net for details. * [[shortcut name=fdobug url="https://bugs.freedesktop.org/show_bug.cgi?id=%s" desc="freedesktop.org bug #%s"]] * [[shortcut name=fdolist url="http://lists.freedesktop.org/mailman/listinfo/%s" desc="%s@lists.freedesktop.org"]] * [[shortcut name=gnomebug url="http://bugzilla.gnome.org/show_bug.cgi?id=%s" desc="GNOME bug #%s"]] +* [[shortcut name=linuxbug url="http://bugzilla.kernel.org/show_bug.cgi?id=%s" desc="Linux bug #%s"]] +* [[shortcut name=mozbug url="https://bugzilla.mozilla.org/show_bug.cgi?id=%s" desc="Mozilla bug #%s"]] +* [[shortcut name=gnulist url="http://lists.gnu.org/mailman/listinfo/%s" desc="%s@gnu.org"]] +* [[shortcut name=marcmsg url="http://marc.info/?i=%s"]] +* [[shortcut name=marclist url="http://marc.info/?l=%s"]] +* [[shortcut name=gmane url="http://dir.gmane.org/gmane.%s" desc="gmane.%s"]] +* [[shortcut name=gmanemsg url="http://mid.gmane.org/%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.html"]] +* [[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"]] +* [[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=meatballwiki url="http://www.usemod.com/cgi-bin/mb.pl?%s"]] * [[shortcut name=emacswiki url="http://www.emacswiki.org/cgi-bin/wiki/%s"]] @@ -35,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=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 -[[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, -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.