Changes between Version 2 and Version 3 of InterWiki

Timestamp:

Jun 2, 2023 10:32:55 AM (18 months ago)

Author:

trac

Comment:

--

InterWiki

@@ -1 @@
-= Support for InterWiki links =
+= Support for InterWiki links
+[[PageOutline(2-5,Contents,pullout)]]
 
-''(since [trac:milestone:0.10 0.10])''
+== Definition
 
-== 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.
 
-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.
+InterWiki prefixes can even be used to introduce links to new protocols, such as `tsvn:` used by [trac:TortoiseSvn TortoiseSvn].
 
-At the extreme, InterWiki prefixes can even be used to simply introduce
-links to new protocols, such as `tsvn:` used by [trac:TortoiseSvn TortoiseSvn].
-
-== Link Syntax ==
+== Link Syntax
 
 {{{
@@ -19 +14 @@
 }}}
 
-The link is composed by the targeted Wiki (or system) name,
-followed by a colon (e.g. `MeatBall:`),
-followed by a page specification in the target.
+The link is composed by the targeted Wiki (or system) name, followed by a colon, eg `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 the InterMapTxt wiki page, 
-modelled after MeatBall:InterMapTxt.
+The 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.
 
-In 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.
-The argument list is formed by splitting the page identifier
-using the ":" separator.
+In 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.
+The argument list is formed by splitting the page identifier using the ":" separator.
 
-== Examples ==
+== [TracIni#interwiki-section "[interwiki]"]
 
-If the following is an excerpt of the InterMapTxt page:
+Every 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.
+
+'''Example:'''
+{{{#!ini
+[interwiki]
+MeatBall = http://www.usemod.com/cgi-bin/mb.pl?
+PEP = http://www.python.org/peps/pep-$1.html Python Enhancement Proposal $1
+tsvn = tsvn: Interact with TortoiseSvn
+}}}
+
+== Examples
+
+For the following excerpt of the InterMapTxt page:
 
 {{{
@@ -49 +49 @@
 ----
 {{{
-PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1 
+PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1
 Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
 
@@ -62 +62 @@
 }}}
 
-Then, 
- * `MoinMoin:InterWikiMap` should be rendered as MoinMoin:InterWikiMap
-   and the ''title'' for that link would be "!InterWikiMap in !MoinMoin"
- * `Trac-ML:4346` should be rendered as Trac-ML:4346
-   and the ''title'' for that link would be "Message 4346 in Trac Mailing List"
+Then,
+ * `MoinMoin:InterWikiMap` will be rendered as MoinMoin:InterWikiMap and the ''title'' for that link will be "!InterWikiMap in !MoinMoin".
+ * `Trac-ML:4346` will be rendered as Trac-ML:4346 and the ''title'' for that link will be "Message 4346 in Trac Mailing List".
+
+== List of Active Prefixes
+
+[[InterWiki]]
 
 ----