Changes between Version 2 and Version 3 of InterWiki


Ignore:
Timestamp:
Sep 24, 2024, 10:52:05 AM (7 weeks 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 [trac:milestone:0.10 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 [trac:TortoiseSvn 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 `[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.
     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.
    2720
    28 In addition to traditional InterWiki links, where the target
    29 is simply ''appended'' to the URL,
    30 Trac supports parametric InterWiki URLs:
    31 identifiers `$1`, `$2`, ... in the URL
    32 will be replaced by corresponding arguments.
    33 The argument list is formed by splitting the page identifier
    34 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.
    3524
    36 === [interwiki] ===
     25== [TracIni#interwiki-section "[interwiki]"]
     26
    3727Every 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.
    3828
    3929'''Example:'''
    40 {{{
     30{{{#!ini
    4131[interwiki]
    4232MeatBall = http://www.usemod.com/cgi-bin/mb.pl?
    … …  
    4535}}}
    4636
    47 == Examples ==
     37== Examples
    4838
    49 If the following is an excerpt of the InterMapTxt page:
     39For the following excerpt of the InterMapTxt page:
    5040
    5141{{{
    … …  
    5949----
    6050{{{
    61 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
    6252Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
    6353
    … …  
    7262}}}
    7363
    74 Then,
    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"
     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]]
    7971
    8072----