Changes between Initial Version and Version 1 of InterTrac


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