Edgewall Software

Changes between Version 2 and Version 3 of InterWiki


Ignore:
Timestamp:
Dec 10, 2015, 6:49:38 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterWiki

    v2 v3  
    1 = Support for InterWiki links =
     1= Support for InterWiki links
    22
    3 ''(since [milestone:0.10])''
     3== Definition
    44
    5 == Definition ==
     5An 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.
    66
    7 An InterWiki link can be used for referring to a Wiki page
    8 located in another Wiki system, and by extension, to any object
    9 located in any other Web application, provided a simple URL
    10 mapping can be done.
     7At the extreme, InterWiki prefixes can even be used to simply introduce links to new protocols, such as `tsvn:` used by [trac:TortoiseSvn TortoiseSvn].
    118
    12 == Link Syntax ==
     9== Link Syntax
    1310
    1411{{{
    … …  
    1613}}}
    1714
    18 The link is composed by the targeted Wiki (or system) name,
    19 followed by a column (e.g. {{{MeatBall:}}}),
    20 followed by a page specification in the target.
    21 Note that, as for InterTrac prefixes, InterWiki prefixes are case insensitive.
     15The link is composed by the targeted Wiki (or system) name, followed by a colon, eg `MeatBall:`, followed by a page specification in the target.
     16Note that, as for InterTrac prefixes, '''InterWiki prefixes are case insensitive'''.
    2217
    23 The target Wiki URL is looked up in a the InterMapTxt wiki page,
    24 modelled after
    25 [http://www.usemod.com/cgi-bin/mb.pl?InterMapTxt MeatBall:InterMapTxt].
     18The 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.
    2619
    27 In addition to traditional InterWiki links, where the target
    28 is simply ''appended'' to the URL,
    29 Trac supports parametric InterWiki URLs:
    30 identifiers `$1`, `$2`, ... in the URL
    31 will be replaced by corresponding arguments.
    32 The argument list is formed by splitting the page identifier
    33 using the ":" separator.
     20In addition to traditional InterWiki links, where the target is simply ''appended'' to the URL, Trac supports parametric InterWiki URLs:
     21identifiers `$1`, `$2`, ... in the URL will be replaced by corresponding arguments.
     22The argument list is formed by splitting the page identifier using the ":" separator.
    3423
    35 == Examples ==
     24=== [interwiki]
     25
     26Every 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.
     27
     28'''Example:'''
     29{{{
     30[interwiki]
     31MeatBall = http://www.usemod.com/cgi-bin/mb.pl?
     32PEP = http://www.python.org/peps/pep-$1.html Python Enhancement Proposal $1
     33tsvn = tsvn: Interact with TortoiseSvn
     34}}}
     35
     36== Examples
    3637
    3738If the following is an excerpt of the InterMapTxt page:
    … …  
    4748----
    4849{{{
    49 PEP     http://www.python.org/peps/pep-$1.html                                       # Python Enhancement Proposal $1
    50 TracML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
     50PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1
     51Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
    5152
     53tsvn     tsvn:                                            # Interact with TortoiseSvn
    5254...
    5355MeatBall http://www.usemod.com/cgi-bin/mb.pl?
    … …  
    6062
    6163Then,
    62  * `MoinMoin:InterWikiMap` should be rendered as
    63    [http://moinmoin.wikiwikiweb.de/InterWikiMap MoinMoin:InterWikiMap]
    64    and the ''title'' for that link would be "!InterWikiMap in !MoinMoin"
    65  * {{{TracML:4346}}} should be rendered as
    66    [http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/4346 TracML:4346]
    67    and the ''title'' for that link would be "Message 4346 in Trac Mailing List"
     64 * `MoinMoin:InterWikiMap` should be rendered as MoinMoin:InterWikiMap and the ''title'' for that link would be "!InterWikiMap in !MoinMoin"
     65 * `Trac-ML:4346` should be rendered as Trac-ML:4346 and the ''title'' for that link would be "Message 4346 in Trac Mailing List"
     66
     67----
     68See also: InterTrac, InterMapTxt