Edgewall Software

Version 3 (modified by Christian Boos, 19 years ago) ( diff )

Updated InterWiki documentation to match the current development status

This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.

Support for InterWiki links

This is a proposal for implementing #40 and #1414 It's candidate for integration in the trunk, after the 0.9 release (see #2041)

Definition

An InterWiki link can be used for referring to a Wiki page located in another Wiki system, and by extension, to any object located in any other Web application, provided a simple URL mapping can be done.

Link Syntax

<target_wiki>(:<identifier>)+

The link is composed by the targeted Wiki (or system) name, followed by a column (e.g. MeatBall:), followed by a page specification in the target. Note that, as for InterTrac prefixes, InterWiki prefixes are case insensitive.

The target Wiki URL is looked up in a the InterMapTxt wiki page, modelled after MeatBall:InterMapTxt.

An addition to traditional InterWiki links, where the target is simply appended to the URL, Trac supports parametric InterWiki URLs: identifiers $1, $2, … in the URL will be replaced by corresponding arguments from a list made up from the page specification split by the ":" token.

Examples

If the following is an excerpt of the InterMapTxt page:

= InterMapTxt =
== This is the place for defining InterWiki prefixes ==

Currently active prefixes: [[InterWiki]]

This page is modelled after the MeatBall:InterMapTxt page.
In addition, an optional comment is allowed after the mapping.
----
{{{
PEP     http://www.python.org/peps/pep-$1.html                                       # Python Enhancement Proposal 
TracML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/  # Trac Mailing List

...
MeatBall http://www.usemod.com/cgi-bin/mb.pl?
MetaWiki http://sunir.org/apps/meta.pl?
MetaWikiPedia http://meta.wikipedia.org/wiki/
MoinMoin http://moinmoin.wikiwikiweb.de/
...
}}}

Then,

  • MoinMoin:InterWikiMap should be rendered as MoinMoin:InterWikiMap and the title for that link would be "InterWikiMap in MoinMoin"
  • TracML:4346 should be rendered as TracML:4346 and the title for that link would be "4346 in Trac Mailing List" (idea: I should allow positional parameters in the comment as well)
Note: See TracWiki for help on using the wiki.