Changes between Version 2 and Version 3 of InterWiki


Ignore:
Timestamp:
2023-04-20T18:31:29Z (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterWiki

    v2 v3  
    1 = Support for InterWiki links =
     1= Support for InterWiki links
     2[[PageOutline(2-5,Contents,pullout)]]
    23
    3 ''(since [milestone:0.10])''
     4== Definition
    45
    5 == Definition ==
     6An 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.
    67
    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.
     8InterWiki prefixes can even be used to introduce links to new protocols, such as `tsvn:` used by [trac:TortoiseSvn TortoiseSvn].
    119
    12 At the extreme, InterWiki prefixes can even be used to simply introduce
    13 links to new protocols, such as `tsvn:` used by TortoiseSvn.
    14 
    15 == Link Syntax ==
     10== Link Syntax
    1611
    1712{{{
    … …  
    1914}}}
    2015
    21 The link is composed by the targeted Wiki (or system) name,
    22 followed by a colon (e.g. `MeatBall:`),
    23 followed by a page specification in the target.
     16The link is composed by the targeted Wiki (or system) name, followed by a colon, eg `MeatBall:`, followed by a page specification in the target.
    2417Note that, as for InterTrac prefixes, '''InterWiki prefixes are case insensitive'''.
    2518
    26 The target Wiki URL is looked up in the InterMapTxt wiki page,
    27 modelled after MeatBall:InterMapTxt.
     19The target Wiki URL is looked up in the [TracIni#interwiki-section "[interwiki]"] section of TracIni and 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.
    2820
    29 In addition to traditional InterWiki links, where the target
    30 is simply ''appended'' to the URL,
    31 Trac supports parametric InterWiki URLs:
    32 identifiers `$1`, `$2`, ... in the URL
    33 will be replaced by corresponding arguments.
    34 The argument list is formed by splitting the page identifier
    35 using the ":" separator.
     21In addition to traditional !InterWiki links, where the target is simply ''appended'' to the URL, Trac supports parametric !InterWiki URLs:
     22identifiers `$1`, `$2`, ... in the URL will be replaced by corresponding arguments.
     23The argument list is formed by splitting the page identifier using the ":" separator.
    3624
    37 == Examples ==
     25== [TracIni#interwiki-section "[interwiki]"]
    3826
    39 If the following is an excerpt of the InterMapTxt page:
     27Every 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.
     28
     29'''Example:'''
     30{{{#!ini
     31[interwiki]
     32MeatBall = http://www.usemod.com/cgi-bin/mb.pl?
     33PEP = http://www.python.org/peps/pep-$1.html Python Enhancement Proposal $1
     34tsvn = tsvn: Interact with TortoiseSvn
     35}}}
     36
     37== Examples
     38
     39For the following excerpt of the InterMapTxt page:
    4040
    4141{{{
    … …  
    4949----
    5050{{{
    51 PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1 
     51PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1
    5252Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
    5353
    … …  
    6262}}}
    6363
    64 Then,
    65  * `MoinMoin:InterWikiMap` should be rendered as MoinMoin:InterWikiMap
    66    and the ''title'' for that link would be "!InterWikiMap in !MoinMoin"
    67  * `Trac-ML:4346` should be rendered as Trac-ML:4346
    68    and the ''title'' for that link would be "Message 4346 in Trac Mailing List"
     64Then,
     65 * `MoinMoin:InterWikiMap` will be rendered as MoinMoin:InterWikiMap and the ''title'' for that link will be "!InterWikiMap in !MoinMoin".
     66 * `Trac-ML:4346` will be rendered as Trac-ML:4346 and the ''title'' for that link will be "Message 4346 in Trac Mailing List".
     67
     68== List of Active Prefixes
     69
     70[[InterWiki]]
    6971
    7072----