annotate examples/trac/wiki-default/InterTrac @ 39:71ecbe90aafc

Copy Trac to main branch.
author cmlenz
date Mon, 03 Jul 2006 18:53:27 +0000
parents
children
rev   line source
39
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
1 = InterTrac Extension for TracLinks =
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
2
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
3 ''(since [milestone:0.10])''
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
4
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
5 == Definitions ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
6
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
7 An InterTrac link is used for referring to a Trac object
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
8 (Wiki page, changeset, ticket, ...) located in another
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
9 Trac environment.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
10
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
11 == List of Active InterTrac Prefixes ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
12
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
13 [[InterTrac]]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
14
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
15 == Link Syntax ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
16
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
17 {{{
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
18 <target_environment>:<TracLinks>
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
19 }}}
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
20
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
21 The link is composed by the target environment name,
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
22 followed by a colon (e.g. `trac:`),
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
23 followed by a regular TracLinks, of any flavor.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
24
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
25 That target environment name is either the real name of the
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
26 environment, or an alias for it.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
27 The aliases are defined in `trac.ini` (see below).
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
28 The prefix is case insensitive.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
29
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
30 For convenience, there's also an alternative short-hand form,
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
31 where one can use an alias as an immediate prefix
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
32 for the identifier of a ticket, changeset or report:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
33 (e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
34
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
35 == Configuration ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
36
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
37 It is necessary to setup a specific `[intertrac]` section in the TracIni for the InterTrac facility, in order to associate a prefix to other Trac sites, and for defining environment aliases.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
38
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
39 Example configuration:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
40 {{{
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
41 ...
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
42 [intertrac]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
43 ## -- Example of setting up an alias:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
44 t = trac
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
45
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
46 ## -- Link to an external Trac:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
47 trac.title = Edgewall's Trac for Trac
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
48 trac.url = http://projects.edgewall.com/trac
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
49
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
50 #trac.svn = http://repos.edgewall.com/projects/trac
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
51 # Hint: .svn information could be used in the future to support svn:externals...
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
52 }}}
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
53
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
54 Now, given this configuration, one could create the following links:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
55 * to the current InterTrac page:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
56 * `trac:wiki:InterTrac` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
57 [http://projects.edgewall.com/trac/wiki/InterTrac trac:wiki:InterTrac]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
58 * `t:wiki:InterTrac` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
59 [http://projects.edgewall.com/trac/wiki/InterTrac t:wiki:InterTrac]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
60 * Keys are case insensitive: `T:wiki:InterTrac` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
61 [http://projects.edgewall.com/trac/wiki/InterTrac T:wiki:InterTrac]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
62 * to the ticket #234:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
63 * `trac:ticket:234` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
64 [http://projects.edgewall.com/trac/ticket/234 trac:ticket:234]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
65 * `trac:#234` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
66 [http://projects.edgewall.com/trac/ticket/234 trac:#234]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
67 * `#T234` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
68 [http://projects.edgewall.com/trac/search?q=#234 #T234]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
69 * to the changeset [1912]:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
70 * `trac:changeset:1912` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
71 [http://projects.edgewall.com/trac/changeset/1912 trac:changeset:1912]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
72 * `trac:[1912]` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
73 [http:"//projects.edgewall.com/trac/search?q=[1912]" "trac:[1912]"]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
74 * `[T1912]` ->
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
75 [http://projects.edgewall.com/trac/changeset/1912 "[T1912]"]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
76
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
77 Anything not given as explicit links (intertrac_prefix:module:id)
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
78 is interpreted by the remote Trac, relying on its quickjump
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
79 facility.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
80
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
81 ----
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
82 See also: TracLinks, InterWiki
Copyright (C) 2012-2017 Edgewall Software