doc/shortcuts.mdwn



[[!if test="enabled(shortcut)"
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]]
Check the \[[!cia ikiwiki desc="CIA page for %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=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=debpkgsid url="http://packages.debian.org/sid/%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/"]]
[[!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=meatballwiki url="http://www.usemod.com/cgi-bin/mb.pl?%s"]]
[[!shortcut name=emacswiki url="http://www.emacswiki.org/cgi-bin/wiki/%s"]]
[[!shortcut name=haskellwiki url="http://haskell.org/haskellwiki/%s"]]
[[!shortcut name=dict url="http://www.dict.org/bin/Dict?Form=Dict1&Strategy=&Database=&Query=%s"]]
[[!shortcut name=imdb url="http://imdb.com/find?q=%s"]]
[[!shortcut name=gpg url="http://pgpkeys.mit.edu:11371/pks/lookup?op=vindex&exact=on&search=0x%s"]]
[[!shortcut name=perldoc url="http://perldoc.perl.org/search.html?q=%s"]]
[[!shortcut name=whois url="http://reports.internic.net/cgi/whois?whois_nic=%s&type=domain"]]
[[!shortcut name=cve url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=%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=man url="http://linux.die.net/man/%s"]]

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
[[ikiwiki/PreprocessorDirective]].  Avoid using a name that conflicts
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
ikiwiki, so that future versions of
ikiwiki will include your shortcut in the standard underlay.