Changes between Initial Version and Version 1 of InterWiki


Ignore:
Timestamp:
Sep 9, 2006, 9:15:00 AM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • InterWiki

    v1 v1  
     1= Support for InterWiki links =
     2
     3''(since [milestone:0.10])''
     4
     5== Definition ==
     6
     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.
     11
     12== Link Syntax ==
     13
     14{{{
     15<target_wiki>(:<identifier>)+
     16}}}
     17
     18The link is composed by the targeted Wiki (or system) name,
     19followed by a colon (e.g. {{{MeatBall:}}}),
     20followed by a page specification in the target.
     21Note that, as for InterTrac prefixes, InterWiki prefixes are case insensitive.
     22
     23The target Wiki URL is looked up in a the InterMapTxt wiki page,
     24modelled after
     25[http://www.usemod.com/cgi-bin/mb.pl?InterMapTxt MeatBall:InterMapTxt].
     26
     27In addition to traditional InterWiki links, where the target
     28is simply ''appended'' to the URL,
     29Trac supports parametric InterWiki URLs:
     30identifiers `$1`, `$2`, ... in the URL
     31will be replaced by corresponding arguments.
     32The argument list is formed by splitting the page identifier
     33using the ":" separator.
     34
     35== Examples ==
     36
     37If the following is an excerpt of the InterMapTxt page:
     38
     39{{{
     40= InterMapTxt =
     41== This is the place for defining InterWiki prefixes ==
     42
     43Currently active prefixes: [[InterWiki]]
     44
     45This page is modelled after the MeatBall:InterMapTxt page.
     46In addition, an optional comment is allowed after the mapping.
     47----
     48{{{
     49PEP     http://www.python.org/peps/pep-$1.html                                       # Python Enhancement Proposal $1
     50Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
     51
     52...
     53MeatBall http://www.usemod.com/cgi-bin/mb.pl?
     54MetaWiki http://sunir.org/apps/meta.pl?
     55MetaWikiPedia http://meta.wikipedia.org/wiki/
     56MoinMoin http://moinmoin.wikiwikiweb.de/
     57...
     58}}}
     59}}}
     60
     61Then,
     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 * {{{Trac-ML:4346}}} should be rendered as
     66   [http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/4346 Trac-ML:4346]
     67   and the ''title'' for that link would be "Message 4346 in Trac Mailing List"
     68
     69----
     70=== Temporary notice (delete this when we sync) ===
     71About full links vs. having the InterWiki link itself.
     72
     73Well, I'm not sure about that, since those InterWiki prefixes ''are'' (or will be when we sync) present in the default InterMapTxt, so those examples will work until the InterMapTxt gets locally edited, at which point it won't be a surprise that this links don't work anymore... OTOH, if those examples ''still'' work after the prefixes have been removed, this can also be a bit surprising ;)
     74----