root/projects/WinDictator/trunk/doc/InterWiki

Revision 19, 2.3 kB (checked in by edsuom, 1 year ago)

Importing windictator into the global FOSS repo

Line 
1 = Support for InterWiki links =
2
3 ''(since [milestone:0.10])''
4
5 == Definition ==
6
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.
11
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 ==
16
17 {{{
18 <target_wiki>(:<identifier>)+
19 }}}
20
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.
24 Note that, as for InterTrac prefixes, '''InterWiki prefixes are case insensitive'''.
25
26 The target Wiki URL is looked up in the InterMapTxt wiki page,
27 modelled after MeatBall:InterMapTxt.
28
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.
36
37 == Examples ==
38
39 If the following is an excerpt of the InterMapTxt page:
40
41 {{{
42 = InterMapTxt =
43 == This is the place for defining InterWiki prefixes ==
44
45 Currently active prefixes: [[InterWiki]]
46
47 This page is modelled after the MeatBall:InterMapTxt page.
48 In addition, an optional comment is allowed after the mapping.
49 ----
50 {{{
51 PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1
52 Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List
53
54 tsvn     tsvn:                                            # Interact with TortoiseSvn
55 ...
56 MeatBall http://www.usemod.com/cgi-bin/mb.pl?
57 MetaWiki http://sunir.org/apps/meta.pl?
58 MetaWikiPedia http://meta.wikipedia.org/wiki/
59 MoinMoin http://moinmoin.wikiwikiweb.de/
60 ...
61 }}}
62 }}}
63
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"
69
70 ----
71 See also: InterTrac, InterMapTxt
Note: See TracBrowser for help on using the browser.