Changes between Version 1 and Version 2 of InterTrac

Timestamp:

Jul 30, 2013, 8:39:06 PM (11 years ago)

Author:

trac

Comment:

--

InterTrac

@@ -1 @@
-= InterTrac リンク = #InterTracLinks
+= InterTrac Links  =
 
-バージョン 0.10 以降で、 Trac は Wiki マークアップの中から、他の Trac サーバのリソースを簡単に参照できるようになりました。
+Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.
 
-== 定義 == #Definitions
+== Definitions ==
 
-InterTrac リンクはスコープ付きの TracLinks とみなすことができます。
-他の Trac Environment で管理されている Trac のリソース
-(Wiki ページ, チェンジセット, チケット, ...) を指定し、
-参照するために使用します。
+An InterTrac link can be seen as a scoped TracLinks.
+It is used for referring to a Trac resource 
+(Wiki page, changeset, ticket, ...) located in another
+Trac environment.
 
-== InterTrac プレフィックスのリスト == #ListofActiveInterTracPrefixes
+== List of Active InterTrac Prefixes ==
 
 [[InterTrac]]
 
-== リンクのシンタックス == #LinkSyntax
+== Link Syntax ==
 
-他の Trac Environment の名前をプレフィックスとして使用し、
-コロンに続けて他の Environment にあるリソースを記述します。
+Simply use the name of the other Trac environment as a prefix, 
+followed by a colon, ending with the resource located in the other environment.
 
 {{{
-<対象の Environment>:<TracLinks>
+<target_environment>:<TracLinks>
 }}}
 
-リソースは通常の TracLinks で使用できるどのようなものでも指定できます。
+The other resource is specified using a regular TracLinks, of any flavor.
 
-<対象の Environment> には、 Environment の本当の名前か、
-エイリアスを指定します。
-エイリアスは `trac.ini` に定義します (下記参照)。
-プレフィックスでは大文字 / 小文字は区別されません。
+That target environment name is either the real name of the 
+environment, or an alias for it. 
+The aliases are defined in `trac.ini` (see below).
+The prefix is case insensitive.
 
-簡易な方法として、他にも省略形があります。
-チケット、チェンジセット、レポートの識別子に直接プレフィックスとして、
-エイリアスを使うことができます。
-(例 `#T234`, `[T1508]`, `[trac 1508]`, ...)
+If 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 (i.e. the above would be displayed as `WikiExtrasPlugin`).
 
-== 例 == #Examples
+For convenience, there's also some alternative short-hand form, 
+where one can use an alias as an immediate prefix 
+for the identifier of a ticket, changeset or report:
+(e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)
 
-InterTrac を使用するためには、設定をする必要があります。
-この設定は、 TracIni ファイルの `[intertrac]` セクションに行います。
+== Examples ==
 
-設定の例:
+It is necessary to setup a configuration for the InterTrac facility.
+This configuration has to be done in the TracIni file, `[intertrac]` section.
+
+Example configuration:
 {{{
 ...
 [intertrac]
-# -- エイリアスの設定例:
+# -- Example of setting up an alias:
 t = trac
 
-# -- 外部の Trac へのリンク:
+# -- Link to an external Trac:
 trac.title = Edgewall's Trac for Trac
 trac.url = http://trac.edgewall.org
 }}}
 
-`.url` は必須項目で、他の Trac の場所を指定するのに使用されます。
-同じサーバ上の Trac Environment であれば、相対 URL でも
-かまいません。
+The `.url` is mandatory and is used for locating the other Trac.
+This can be a relative URL in case that Trac environment is located 
+on the same server.
 
-`.title` に設定した内容は InterTrac リンクをマウスオーバしたときに、
-ツールティップとして表示されます。
+The `.title` information will be used for providing an useful tooltip
+when moving the cursor over an InterTrac links.
 
-`.compat` オプションには ''互換性'' モードの
-有効無効を設定します:
- * リンク先の Trac が [http://trac.edgewall.org/milestone/0.10 milesotne:0.10]
-   (正確には [http://trac.edgewall.org/changeset/3526 r3526]) より前のバージョンで稼働している場合、 InterTrac リンクをどのようにディスパッチしていいのか解釈できませんので、
-   ローカルの Trac で正しいリンクを生成します。
-   通常使用するほとんどのリンクを生成できますが、すべてのリンクが動作するわけではありません。
-   これを互換モード (compatibility mode) と言い、デフォルトで `true` になっています。
- * リモートの Trac が InterTrac リンクをディスパッチできると分かっている (訳註: リモートの Trac のバージョンが 0.10 以降である) 場合、
-   互換モードを明示的に無効化することで、 TracLinks の ''すべての''
-   機能を InterTrac リンクで使用できるようになります。
+Finally, the `.compat` option can be used to activate or disable
+a ''compatibility'' mode:
+ * If the targeted Trac is running a version below [trac:milestone:0.10 0.10] 
+   ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac 
+   link, and it's up to the local Trac to prepare the correct link. 
+   Not all links will work that way, but the most common do. 
+   This is called the compatibility mode, and is `true` by default. 
+ * If you know that the remote Trac knows how to dispatch InterTrac links, 
+   you can explicitly disable this compatibility mode and then ''any'' 
+   TracLinks can become an InterTrac link.
 
-上記の例を設定すると、以下のようなリンクを使用することができます:
- * この (訳注: 本家サイトの) InterTrac ページ:
+Now, given the above configuration, one could create the following links:
+ * to this InterTrac page:
    * `trac:wiki:InterTrac` trac:wiki:InterTrac
    * `t:wiki:InterTrac` t:wiki:InterTrac
-   * キーでは大文字/小文字は区別されません: `T:wiki:InterTrac` T:wiki:InterTrac
- * チケット #234 へのリンク:
+   * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac
+ * to the ticket #234:
    * `trac:ticket:234` trac:ticket:234
    * `trac:#234` trac:#234 
    * `#T234` #T234
- * チェンジセット [1912] へのリンク:
+ * to the changeset [1912]:
    * `trac:changeset:1912` trac:changeset:1912
    * `[T1912]` [T1912]
- * リビジョンログの範囲指定 [3300:3330]: '''(Note: `trac.compat=false` を設定する必要があります。)'''
+ * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
    * `trac:log:@3300:3330` trac:log:@3300:3330  
    * `[trac 3300:3330]` [trac 3300:3330] 
- * リモートの Trac のスタートページにリンクするためには、明示的なリンクの内部にプレフィックスに続いて ':' を記述します。例: `[th: Trac Hacks]` (''0.11 以降; ''リモート'' の Trac も 0.11 で動いている必要があります'')
+ * 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]` (''since 0.11; note that the ''remote'' Trac has to run 0.11 for this to work'')
 
-通常の形式 `<InterTrac のプレフィックス>:モジュール:識別子` は
-正しい URL `<リンク先の Environment>/モジュール/識別子` と解釈されます。省略形のリンクは
-モジュールごとに固有となっています (例 !#T234 は
-チケットモジュールによって解釈されます)。残りの形 (`<InterTrac のプレフィックス>:任意の文字列`)
-については、 リモートの Trac の TracSearch#quickjump に沿った動作をします。
+The 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) and for the rest (`intertrac_prefix:something`),
+we rely on the TracSearch#quickjump facility of the remote Trac.
 
 ----