Changes between Initial Version and Version 1 of InterTrac


Ignore:
Timestamp:
Jun 19, 2006, 2:44:21 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • InterTrac

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