Changes between Version 2 and Version 3 of InterTrac


Ignore:
Timestamp:
Jun 28, 2019, 2:20:16 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • InterTrac

    v2 v3  
    1 = InterTrac リンク = #InterTracLinks
     1= InterTrac Links
    22
    3 バージョン 0.10 以降で、 Trac は Wiki マークアップの中から、他の Trac サーバのリソースを簡単に参照できるようになりました。
     3Trac supports a convenient way to refer to resources of other Trac servers using Wiki markup. An !InterTrac link can be seen as a scoped [TracLinks TracLink]. It is used for referring to a Trac resource located in another Trac environment.
    44
    5 == 定義 == #Definitions
     5== Link Syntax
    66
    7 InterTrac リンクはスコープ付きの TracLinks とみなすことができます。
    8 他の Trac Environment で管理されている Trac のリソース
    9 (Wiki ページ, チェンジセット, チケット, ...) を指定し、
    10 参照するために使用します。
     7Simply use the name of the other Trac environment as a prefix, followed by a colon, ending with the resource located in the other environment:
    118
    12 == InterTrac プレフィックスのリスト == #ListofActiveInterTracPrefixes
     9{{{
     10<target_environment>:<TracLinks>
     11}}}
     12
     13The other resource is specified using a regular !TracLink, of any flavor.
     14
     15That target environment name is either the real name of the environment or an alias.
     16The aliases are defined in the `trac.ini` file, see below.
     17The prefix is case insensitive.
     18
     19If the InterTrac link is enclosed in square brackets, like `[th:WikiExtrasPlugin]`, the InterTrac prefix is removed in the displayed link like a normal link resolver would be. For example, the above would be displayed as `WikiExtrasPlugin`.
     20
     21For convenience, there is also an alternate short-hand form, where an alias can be used as an immediate prefix for the identifier of a ticket, changeset or report, eg `#T234`, `[T1508]`, `[trac 1508]`.
     22
     23== Examples
     24
     25The only prefix defined by default is `trac`, which points to trac.edgewall.org. Additional prefixes can be specified in the [TracIni#intertrac-section intertrac] section of TracIni. For example:
     26
     27{{{#!ini
     28[intertrac]
     29# -- Example of setting up an alias:
     30t = trac
     31
     32# -- Link to an external Trac:
     33genshi.title = Edgewall's Trac for Genshi
     34genshi.url = http://genshi.edgewall.org
     35}}}
     36
     37The `.url` is mandatory and is used for locating the other Trac.
     38It can be a relative URL when the Trac environment is located on the same server.
     39
     40The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link.
     41
     42Now, given the above configuration, one could create the following links:
     43 * to this InterTrac page:
     44   * `trac:wiki:InterTrac` trac:wiki:InterTrac
     45   * `t:wiki:InterTrac` t:wiki:InterTrac
     46   * `genshi:InterTrac` genshi:InterTrac
     47   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac
     48 * to the ticket #234:
     49   * `trac:ticket:234` trac:ticket:234
     50   * `trac:#234` trac:#234
     51   * `genshi:#234` genshi:#234
     52   * `#T234` #T234
     53 * to the changeset [1912]:
     54   * `trac:changeset:1912` trac:changeset:1912
     55   * `[T1912]` [T1912]
     56 * to the log range [3300:3330]:
     57   * `trac:log:@3300:3330` trac:log:@3300:3330 
     58   * `[trac 3300:3330]` [trac 3300:3330]
     59   * finally, to link to the start page of a remote trac, simply use its prefix followed by ':', inside an explicit link. Example: `[th: Trac Hacks]` (note that the ''remote'' Trac has to run Trac >= 0.11 for this to work'')
     60
     61The generic form `intertrac_prefix:module:id` is translated to the corresponding URL `<remote>/module/id`. Shorthand links are specific to some modules (e.g. !#T234 is processed by the ticket module). For the rest (`intertrac_prefix:something`), we rely on the [TracSearch#quickjump quick jump] facility of the remote Trac.
     62
     63== List of Active InterTrac Prefixes
     64
     65The following InterTrac prefixes are available on this site:
    1366
    1467[[InterTrac]]
    1568
    16 == リンクのシンタックス == #LinkSyntax
    17 
    18 他の Trac Environment の名前をプレフィックスとして使用し、
    19 コロンに続けて他の Environment にあるリソースを記述します。
    20 
    21 {{{
    22 <対象の Environment>:<TracLinks>
    23 }}}
    24 
    25 リソースは通常の TracLinks で使用できるどのようなものでも指定できます。
    26 
    27 <対象の Environment> には、 Environment の本当の名前か、
    28 エイリアスを指定します。
    29 エイリアスは `trac.ini` に定義します (下記参照)。
    30 プレフィックスでは大文字 / 小文字は区別されません。
    31 
    32 もし InterTrac リンクがスクウェアブラケットで括られている場合(`[trac:SpamFilter]` のように), リンクとして表示する際に、 InterTrac のプレフィックスは取り除かれ、普通のリンクリソルバであるかのように扱います (例: 上記の例では `SpamFilter` と表示されます)。
    33 
    34 簡易な方法として、他にも省略形があります。
    35 チケット、チェンジセット、レポートの識別子に直接プレフィックスとして、
    36 エイリアスを使うことができます。
    37 (例 `#T234`, `[T1508]`, `[trac 1508]`, ...)
    38 
    39 == 例 == #Examples
    40 
    41 InterTrac を使用するためには、設定をする必要があります。
    42 この設定は、 TracIni ファイルの `[intertrac]` セクションに行います。
    43 
    44 設定の例:
    45 {{{
    46 ...
    47 [intertrac]
    48 # -- エイリアスの設定例:
    49 t = trac
    50 
    51 # -- 外部の Trac へのリンク:
    52 trac.title = Edgewall's Trac for Trac
    53 trac.url = http://trac.edgewall.org
    54 }}}
    55 
    56 `.url` は必須項目で、他の Trac の場所を指定するのに使用されます。
    57 同じサーバ上の Trac Environment であれば、相対 URL でも
    58 かまいません。
    59 
    60 `.title` に設定した内容は InterTrac リンクをマウスオーバしたときに、
    61 ツールティップとして表示されます。
    62 
    63 `.compat` オプションには ''互換性'' モードの
    64 有効無効を設定します:
    65  * リンク先の Trac が [http://trac.edgewall.org/milestone/0.10 milesotne:0.10]
    66    (正確には [http://trac.edgewall.org/changeset/3526 r3526]) より前のバージョンで稼働している場合、 InterTrac リンクをどのようにディスパッチしていいのか解釈できませんので、
    67    ローカルの Trac で正しいリンクを生成します。
    68    通常使用するほとんどのリンクを生成できますが、すべてのリンクが動作するわけではありません。
    69    これを互換モード (compatibility mode) と言い、デフォルトで `true` になっています
    70  * リモートの Trac が InterTrac リンクをディスパッチできると分かっている (訳註: リモートの Trac のバージョンが 0.10 以降である) 場合、
    71    互換モードを明示的に無効化することで、 TracLinks の ''すべての''
    72    機能を InterTrac リンクで使用できるようになります
    73 
    74 上記の例を設定すると、以下のようなリンクを使用することができます:
    75  * この (訳注: 本家サイトの) InterTrac ページ:
    76    * `trac:wiki:InterTrac` trac:wiki:InterTrac
    77    * `t:wiki:InterTrac` t:wiki:InterTrac
    78    * キーでは大文字/小文字は区別されません: `T:wiki:InterTrac` T:wiki:InterTrac
    79  * チケット #234 へのリンク:
    80    * `trac:ticket:234` trac:ticket:234
    81    * `trac:#234` trac:#234
    82    * `#T234` #T234
    83  * チェンジセット [1912] へのリンク:
    84    * `trac:changeset:1912` trac:changeset:1912
    85    * `[T1912]` [T1912]
    86  * リビジョンログの範囲指定 [3300:3330]: '''(Note: `trac.compat=false` を設定する必要があります)'''
    87    * `trac:log:@3300:3330` trac:log:@3300:3330
    88    * `[trac 3300:3330]` [trac 3300:3330]
    89  * リモートの Trac のスタートページにリンクするためには、明示的なリンクの内部にプレフィックスに続いて ':' を記述します。例: `[th: Trac Hacks]` (''0.11 以降は注意してください。 ''リモート'' の Trac も 0.11 以降で動いている必要があります'')
    90 
    91 通常の形式 `<InterTrac のプレフィックス>:モジュール:識別子` は
    92 正しい URL `<リンク先の Environment>/モジュール/識別子` と解釈されます。省略形のリンクは
    93 モジュールごとに固有となっています (例 !#T234 は
    94 チケットモジュールによって解釈されます)。残りの形 (`<InterTrac のプレフィックス>:任意の文字列`)
    95 については、 リモートの Trac の TracSearch#quickjump に沿った動作をします。
    96 
    9769----
    9870See also: TracLinks, InterWiki