urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/doc/shortcuts.mdwn

80 lines
5.0 KiB
Plaintext
Raw Normal View History

Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
[[!if test="enabled(shortcut)"
Add enabled/disabled indicator at the top of the shortcuts page.
2007-04-09 23:03:24 +02:00
then="This wiki has shortcuts **enabled**."
else="This wiki has shortcuts **disabled**."]]
move examples of how to use shortcuts into the shortcuts page so it's available in basewiki
2007-05-20 01:45:43 +02:00
Some examples of using shortcuts include:
Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
\[[!google foo]]
\[[!wikipedia War_of_1812]]
\[[!debbug 12345]]
Make directives generated by shortcuts accept a `desc` parameter. (cherry picked from commit 252da396bfa728b99af7c9bb304a7b5f3f6d94e6)
2008-03-02 17:29:02 +01:00
Check the \[[!cia ikiwiki desc="CIA page for %s"]].
move examples of how to use shortcuts into the shortcuts page so it's available in basewiki
2007-05-20 01:45:43 +02:00
* Make the basewiki be full of symlinks to pages that should be the same in the doc wiki. This will allow direct edits to alter the base wiki without manual munging.
2007-02-14 00:10:45 +01:00
This page controls what shortcut links the wiki supports.
Use HTTPS version for [Wikimedia](https://secure.wikimedia.org/) and Google (noted by using DuckDuckGo.com which is directing there)
2010-09-02 16:09:55 +02:00
* [[!shortcut name=google url="https://encrypted.google.com/search?q=%s"]]
Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
* [[!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"]]
Use HTTPS version for [Wikimedia](https://secure.wikimedia.org/) and Google (noted by using DuckDuckGo.com which is directing there)
2010-09-02 16:09:55 +02:00
* [[!shortcut name=wikipedia url="https://secure.wikimedia.org/wikipedia/en/wiki/%s"]]
* [[!shortcut name=wikitravel url="https://wikitravel.org/en/%s"]]
* [[!shortcut name=wiktionary url="https://secure.wikimedia.org/wiktionary/en/wiki/%s"]]
Make it obvious for the reader of the rendered page that the debbug shortcut links to Debian bug reports.
2009-10-07 19:54:46 +02:00
* [[!shortcut name=debbug url="http://bugs.debian.org/%S" desc="Debian bug #%s"]]
Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
* [[!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"]]
web commit by http://madduck.net/: add debpkgsid to link to packages.d.o/sid directly
2008-03-06 14:11:41 +01:00
* [[!shortcut name=debpkgsid url="http://packages.debian.org/sid/%s"]]
Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
* [[!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.
fix entry
2008-10-11 16:29:52 +02:00
* [[!shortcut name=debwiki url="http://wiki.debian.org/%s"]]
Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
* [[!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"]]
Despam, again. Someone ban adrianna please?
2010-04-02 19:28:34 +02:00
* [[!shortcut name=imdb url="http://imdb.com/find?q=%s"]]
Add new preprocessor directive syntax¸ using a '!' prefix. Add a prefix_directives option to the setup file to turn this syntax on; currently defaults to false, for backward compatibility. Support optional '!' prefix even with prefix_directives off, and use that in the underlay to support either setting of prefix_directives. Add NEWS entry with migration information.
2008-01-28 01:13:54 +01:00
* [[!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"]]
web commit by http://mmassonnet.myopenid.com/: Added linux.die.net/man/%s (not sure this is the right place)
2008-03-05 14:26:27 +01:00
* [[!shortcut name=man url="http://linux.die.net/man/%s"]]
Add shortcut for ohloh projects.
2008-03-27 02:06:25 +01:00
* [[!shortcut name=ohloh url="http://www.ohloh.net/projects/%s"]]
add cpanrt
2009-10-08 17:38:34 +02:00
* [[!shortcut name=cpanrt url="https://rt.cpan.org/Ticket/Display.html?id=%s" desc="CPAN RT#%s"]]
add shortcut for novell bugzilla
2009-10-13 11:09:37 +02:00
* [[!shortcut name=novellbug url="https://bugzilla.novell.com/show_bug.cgi?id=%s" desc="bug %s"]]
* Make the basewiki be full of symlinks to pages that should be the same in the doc wiki. This will allow direct edits to alter the base wiki without manual munging.
2007-02-14 00:10:45 +01:00
remove wikilink to ikiwiki/directive/shortcut This is a broken link if ikiwiki is configured w/o the listdirectives plugin. Since the value of the link to the directive docs is fairly low (there are a bunch of examples of it right on the page you put it on), it seems simplest to just remove the link.
2009-05-22 19:35:47 +02:00
To add a new shortcut, use the `shortcut`
rename preprocessordirective to directive Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-)
2008-08-25 20:19:39 +02:00
[[ikiwiki/directive]]. In the url, "%s" is replaced with the
fix link
2009-08-24 20:09:58 +02:00
text passed to the named shortcut, after [[!wikipedia url_encoding]]
Despam, again. Someone ban adrianna please?
2010-04-02 19:28:34 +02:00
it, and '%S' is replaced with the raw, non-encoded text. The optional
clarify and add link
2009-08-24 20:08:20 +02:00
`desc` parameter controls the description of the link.
web commit by JoshTriplett: Add a note about not conflicting with existing [[PreprocessorDirective]]s. Add a note about contributing shortcuts upstream to ikiwiki.
2007-02-15 21:08:20 +01:00
Remember that the `name` you give the shortcut will become a new
rename preprocessordirective to directive Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-)
2008-08-25 20:19:39 +02:00
[[ikiwiki/directive]]. Avoid using a `name` that conflicts
Make directives generated by shortcuts accept a `desc` parameter. (cherry picked from commit 252da396bfa728b99af7c9bb304a7b5f3f6d94e6)
2008-03-02 17:29:02 +01:00
with an existing directive. These directives also accept a `desc`
Despam, again. Someone ban adrianna please?
2010-04-02 19:28:34 +02:00
parameter that will override the one provided at definition time.
web commit by JoshTriplett: Add a note about not conflicting with existing [[PreprocessorDirective]]s. Add a note about contributing shortcuts upstream to ikiwiki.
2007-02-15 21:08:20 +01:00
If you come up with a shortcut that you think others might find useful,
shortcuts: use a markdown link to link back to the ikiwiki page, not a shortcut Since the wiki might not have shortcuts turned on, don't use the "iki" shortcut to link back to the ikiwiki ikiwiki; use a markdown link instead.
2008-01-27 01:15:07 +01:00
consider contributing it to the [shortcuts page on the ikiwiki
clarify and add link
2009-08-24 20:08:20 +02:00
wiki](http://ikiwiki.info/shortcuts/), so that future versions of
shortcuts: use a markdown link to link back to the ikiwiki page, not a shortcut Since the wiki might not have shortcuts turned on, don't use the "iki" shortcut to link back to the ikiwiki ikiwiki; use a markdown link instead.
2008-01-27 01:15:07 +01:00
ikiwiki will include your shortcut in the standard underlay.