Changes between Initial Version and Version 1 of InterWiki

03/14/15 20:29:38 (7 months ago)



  • InterWiki

    v1 v1  
     1= Support for InterWiki links =
     3''(since [trac:milestone:0.10 0.10])''
     5== Definition ==
     7An InterWiki link can be used for referring to a Wiki page
     8located in another Wiki system, and by extension, to any object
     9located in any other Web application, provided a simple URL
     10mapping can be done.
     12At the extreme, InterWiki prefixes can even be used to simply introduce
     13links to new protocols, such as `tsvn:` used by [trac:TortoiseSvn TortoiseSvn].
     15== Link Syntax ==
     21The link is composed by the targeted Wiki (or system) name,
     22followed by a colon (e.g. `MeatBall:`),
     23followed by a page specification in the target.
     24Note that, as for InterTrac prefixes, '''InterWiki prefixes are case insensitive'''.
     26The target Wiki URL is looked up in the `[interwiki]` section of TracIni or in the InterMapTxt wiki page, modeled after MeatBall:InterMapTxt. If a prefix is defined in both the `[interwiki]` section and InterMapTxt, the `[interwiki]` section takes precedence.
     28In addition to traditional InterWiki links, where the target
     29is simply ''appended'' to the URL,
     30Trac supports parametric InterWiki URLs:
     31identifiers `$1`, `$2`, ... in the URL
     32will be replaced by corresponding arguments.
     33The argument list is formed by splitting the page identifier
     34using the ":" separator.
     36=== [interwiki] ===
     37Every option in the `[interwiki]` section in TracIni defines one InterWiki prefix. The option name defines the prefix. The option value defines the URL, optionally followed by a description separated from the URL by whitespace. Parametric URLs are supported as well.
     42MeatBall =
     43PEP =$1.html Python Enhancement Proposal $1
     44tsvn = tsvn: Interact with TortoiseSvn
     47== Examples ==
     49If the following is an excerpt of the InterMapTxt page:
     52= InterMapTxt =
     53== This is the place for defining InterWiki prefixes ==
     55Currently active prefixes: [[InterWiki]]
     57This page is modelled after the MeatBall:InterMapTxt page.
     58In addition, an optional comment is allowed after the mapping.
     61PEP$1.html           # Python Enhancement Proposal $1
     62Trac-ML$1  # Message $1 in Trac Mailing List
     64tsvn     tsvn:                                            # Interact with TortoiseSvn
     75 * `MoinMoin:InterWikiMap` should be rendered as MoinMoin:InterWikiMap
     76   and the ''title'' for that link would be "!InterWikiMap in !MoinMoin"
     77 * `Trac-ML:4346` should be rendered as Trac-ML:4346
     78   and the ''title'' for that link would be "Message 4346 in Trac Mailing List"
     81See also: InterTrac, InterMapTxt