Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
2012/06/16 22:07:38 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v2 v3  
    1717その他、 WikiFormatting を利用可能なことが明示されているすべてのテキストフィールド。 
    1818 
    19 例: 
    20  * チケット: '''!#1''', '''!ticket:1''' 
    21  * チケットのコメント: '''!comment:1:ticket:2''' 
    22  * レポート: '''!{1}''', '''!report:1''' 
    23  * チェンジセット: '''!r1''', '''![1]''', '''!changeset:1''', (ディレクトリを限定) '''![1/trunk]''', '''!changeset:1/trunk''' 
    24  * リビジョンログ: '''!r1:3''', '''![1:3]''', '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]''' 
    25  * Diff ([http://trac.edgewall.org/milestone/0.10 0.10] 以降): '''!diff:@1:3''', '''!diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default''', '''!diff:trunk/trac@3538//sandbox/vc-refactoring@3539''' 
    26  * Wiki ページ: '''!CamelCase''', '''!wiki:CamelCase''' 
    27  * 親ページ: '''![..]''' 
    28  * マイルストーン: '''!milestone:1.0''' 
    29  * 添付ファイル: '''!attachment:example.tgz''' (現在のページへの添付ファイル), '''!attachment:attachment.1073.diff:ticket:944''' (絶対パス) 
    30  * ファイル: '''!source:trunk/COPYING''' 
    31  * あるリビジョンのファイル: '''!source:/trunk/COPYING#200''' 
    32  * あるリビジョンのファイルのある行数: '''!source:/trunk/COPYING@200#L25''' 
    33 表示: 
    34  * チケット: #1, ticket:1 
    35  * チケットのコメント: comment:1:ticket:2  
    36  * レポート: {1} or report:1 
    37  * チェンジセット: r1, [1], changeset:1, (ディレクトリを限定) [1/trunk], changeset:1/trunk 
    38  * リビジョンログ: r1:3, [1:3], log:@1:3, log:trunk@1:3, [2:5/trunk] 
    39  * Diff ([http://trac.edgewall.org/milestone/0.10 0.10] 以降): diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default, diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539 
    40  * Wiki ページ: CamelCase, wiki:CamelCase 
    41  * 親ページ: [..] 
    42  * マイルストーン: milestone:1.0 
    43  * 添付ファイル: attachment:example.tgz(現在のページへの添付ファイル), attachment:attachment.1073.diff:ticket:944 (絶対パス) 
    44  * ファイル: source:trunk/COPYING 
    45  * あるリビジョンのファイル: source:/trunk/COPYING#200 
    46  * あるリビジョンのファイルのある行数: source:/trunk/COPYING@200#L25 
     19== 概要 == #Overview 
     20 
     21||= Wiki マークアップ =||= 表示 =|| 
     22{{{#!td 
     23 Wiki ページ :: `CamelCase`, `wiki:CamelCase` 
     24 親ページ :: `[..]` 
     25 チケット :: `#1`, `ticket:1` 
     26 チケットのコメント :: `comment:1:ticket:2` 
     27 レポート :: `{1}`, `report:1` 
     28 マイルストーン :: `milestone:1.0` 
     29 添付ファイル :: `attachment:example.tgz` (現在のページの添付ファイル), `attachment:attachment.1073.diff:ticket:944` (絶対パス) 
     30 チェンジセット :: `r1`, `[1]`, `changeset:1`, (特定パス配下) `[1/trunk]`, `changeset:1/trunk` 
     31 リビジョンログ :: `r1:3`, `[1:3]`, `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` 
     32 diff :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`, 
     33         `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`  
     34          または `diff:trunk/trac@3538//sandbox/vc-refactoring@3539` 
     35 ファイル :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (バージョン 200 における), `source:/trunk/COPYING@200#L25` (バージョン 200 における, 25 行目) 
     36}}} 
     37{{{#!td 
     38 Wiki ページ :: CamelCase, wiki:CamelCase 
     39 親ページ :: [..] 
     40 チケット :: #1, ticket:1 
     41 チケットのコメント :: comment:1:ticket:2 
     42 レポート :: {1}, report:1 
     43 マイルストーン :: `milestone:1.0` 
     44 添付ファイル :: `attachment:example.tgz` (現在のページの添付ファイル), `attachment:attachment.1073.diff:ticket:944` (絶対パス) 
     45 チェンジセット :: `r1`, `[1]`, `changeset:1`, (特定パス配下) `[1/trunk]`, `changeset:1/trunk` 
     46 リビジョンログ :: r1:3, [1:3], log:@1:3, log:trunk@1:3, [2:5/trunk] 
     47 diff :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953, 
     48         diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default  
     49          または diff:trunk/trac@3538//sandbox/vc-refactoring@3539 
     50 ファイル :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (バージョン 200 における), `source:/trunk/COPYING@200#L25` (バージョン 200 における, 25 行目) 
     51}}} 
    4752 
    4853'''Note:''' wiki:CamelCase の書式が使われることはほとんどありませんが、 
    4954ページ名が WikiPageNames のルールに従っていないページ (一文字、 
    50 アルファベット以外の文字、etc.) をリンクしたい場合には便利です。  
     55アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 
    5156WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。 
    5257 
    53 フル表記の (簡略形でない) Trac リンクでは、次のようにしてリンクタイトルを 
    54 カスタマイズすることもできます: 
    55  
    56 {{{ 
    57 [ticket:1 これは1番目のチケットへのリンクです]。 
    58 }}} 
    59  
    60 表示: [ticket:1 これは1番目のチケットへのリンクです]。 
    61  
    62 タイトルが省略された場合、 ID のみ (コロンの後ろ側) が表示されます。 
    63  
    64 {{{ 
    65 [ticket:1] 
    66 }}} 
    67  
    68 表示: [ticket:1] 
    69  
    70 もし名前空間の一部が省略されていたら、 `wiki` がデフォルトの値です。(''バージョン 0.10 以降''): 
    71  
    72 {{{ 
    73 [SandBox the sandbox] 
    74 }}} 
    75  
    76 表示: [SandBox the sandbox] 
     58 
     59{{{#!table class="" 
     60|||| 完全表記の (簡略形でない) Trac リンクでは、次のようにしてリンクタイトルをカスタマイズすることもできます: || 
     61{{{#!td 
     62{{{ 
     63[ticket:1 これは1番目のチケットへのリンクです] または 
     64[[ticket:1|これは1番目のチケットへのリンクです]]。 
     65}}} 
     66}}} 
     67{{{#!td 
     68[ticket:1 これは1番目のチケットへのリンクです] または 
     69[[ticket:1|これは1番目のチケットへのリンクです]]。 
     70}}} 
     71|-------------------------------------------------------------------------------------- 
     72|||| タイトルが省略された場合、 ID のみ (コロンの後ろ側) が表示されます: || 
     73{{{#!td 
     74{{{ 
     75[ticket:1] または [[ticket:2]] 
     76}}} 
     77}}} 
     78{{{#!td 
     79[ticket:1] または [[ticket:2]] 
     80}}} 
     81|-------------------------------------------------------------------------------------- 
     82|||| 完全表記から名前空間が省略されている場合、デフォルト値として `wiki` が使用されます: ||  
     83{{{#!td 
     84{{{ 
     85[SandBox サンドボックス] または 
     86[[SandBox|サンドボックス]] 
     87}}} 
     88}}} 
     89{{{#!td 
     90[SandBox サンドボックス] または 
     91[[SandBox|サンドボックス]] 
     92}}} 
     93|-------------------------------------------------------------------------------------- 
     94|||| ''realm:target'' 形式のリンクで特殊な文字を使用したい場合は、 <...> で囲んでください。 [[br]] (ただし > は使用できません) [[br]] 訳注: target 該当箇所を "" で囲む形式との違いは、バージョンに展開される `@` などのような特殊文字も解釈されずに、そのまま target として使用されることにあります。 || 
     95{{{#!td 
     96{{{ 
     97<wiki:Strange(page@!)> 
     98}}} 
     99}}} 
     100{{{#!td 
     101<wiki:Strange(page@!)> 
     102}}} 
     103}}} 
    77104 
    78105TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクを追跡する" ことによってプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。 
     
    85112ページ内の特定アンカーにリンクするには '#' を使用します: 
    86113{{{ 
    87  [#Relativelinks 相対リンク] 
     114 [#Relativelinks 相対リンク] または [[#Relativelinks|相対リンク]] 
    88115}}} 
    89116表示: 
    90   [#Relativelinks 相対リンク] 
     117  [#Relativelinks 相対リンク] または [[#Relativelinks|相対リンク]] 
    91118 
    92119Hint: セクションのタイトルにマウスオーバしたときに、文字 '¶' が表示されます。これはそのセクションへのリンクですので、 `#...` の部分をコピーすれば、相対リンクのアンカーとして使用できます。 
     
    94121[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページにリンクするには '/' を使用します: 
    95122{{{ 
    96  WikiPage/SubWikiPage or ./SubWikiPage 
    97 }}} 
    98  
    99 [http://trac.edgewall.org/wiki/SubWiki SubWiki] ページから親ページにリンクするには、単に '..' を使用します: 
    100 {{{ 
    101   [..] 
    102 }}} 
    103  
    104 [http://trac.edgewall.org/wiki/SubWiki SubWiki] ページから兄弟の位置にあるページにリンクするには '../' を使用します: 
    105 {{{ 
    106   [../Sibling see next sibling] 
    107 }}} 
    108  
    109 ''(0.11 で変更された箇所です)'' Trac 0.10 では `[../newticket]` のように書くと、トップレベル URL の /newticket にリンクする動作でした。しかし 0.11 では Wiki の名前空間にとどまり、兄弟の位置にあるページにリンクします。新しいシンタックスについては [#Server-relativelinks サーバ相対リンク] を参照してください。 
     123 WikiPage/SubWikiPage または ./SubWikiPage 
     124}}} 
     125 
     126[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページから親ページにリンクするには、 '..' を使用します: 
     127{{{ 
     128  [..] または [[..]] 
     129}}} 
     130  [..] または [[..]] 
     131 
     132[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページから [=#sibling 兄弟の位置にある] ページにリンクするには、 '../' を使用します: 
     133{{{ 
     134  [../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]] 
     135}}} 
     136  [../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]] 
     137 
     138しかし、兄弟の位置にあるページにリンクするために `../` プレフィックスを使用しない方がいい場合もあります。 
     139Wiki リンクのロケーションを解決するとき、相対リンクではリンクを記述するページから階層内での近い位置にあるページが選択されます。 
     140つまり、階層化されているページの場合、トップレベルにあるページよりも、兄弟の位置にあるページが優先されます。 
     141プレフィックスを使用しない場合は [[WikiNewPage#renaming|ページ名変更]] による下位の階層へのページのコピーや移動の際に、 
     142リンクを書き換える必要がなくなるので、簡単にできるようになります。 
     143 
     144明示的に [=#toplevel トップレベル] の Wiki ページへのリンクを記述する場合は、 
     145`wiki:/` プレフィックスを使用してください。 
     146ただし、 `/` プレフィックスを単独で使う場合 **Wiki ページへのリンクになりません**。 
     147`/` で始まるリンクは [#Server-relativelinks サーバ相対リンク] のシンタックスとして解釈されるため、 
     148`/wiki/` が付与されない、不完全な URL になってしまいます。 
     149 
     150''(0.11 で変更された箇所です)'' Trac 0.10 では `[../newticket]` のように書くと、トップレベル URL の `/newticket` にリンクする動作でした。しかし 0.11 では Wiki の名前空間にとどまり、兄弟の位置にあるページにリンクします。 
     151新しいシンタックスについては [#Server-relativelinks サーバ相対リンク] を参照してください。 
    110152 
    111153=== InterWiki リンク === #InterWikilinks 
    112154 
    113 他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページ、 InterMapTxt ページで定義されます。 他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。 
     155他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページである InterMapTxt ページで定義されます。他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。 
    114156 
    115157=== InterTrac リンク === #InterTraclinks 
     
    117159InterWiki リンクと同じ要領で使用できますが、リンクする対象を他の Trac プロジェクトに特化した機能です。 
    118160 
    119 プレフィックスとして定義した他の Trac Environment の名前とコロンに続けて、あらゆる種類の Trac リンクを記述することで、一つの Trac Enviroment から他の Trac Environment のリソースを参照することができます。このリモートの Trac Environment は、名前そのものかエイリアスとして、あらかじめ登録しておく必要があります。詳しくは InterTrac を参照してください。 
    120  
    121 InterWiki リンクに対する InterTrac リンクの利点は、 InterTrac リンクが Trac リンクの短縮書式を解釈できることにあります。例えば、チケットへのリンクは `#T234` (T は Trac Project へのエイリアスに設定されているとします) と書くことができ、チェンジセットへのリンクは `[trac 1508]` と書くことができます。 
     161ある Trac Environment に記述される、どんな形式の Trac リンクであっても、他の Trac Environment のリソースを参照することができます。他の Trac Environment のリソースを指すためには、 Trac リンクのプレフィックスとして、リンク先の Trac Environment の名前とコロンを付与してください。このリンク先の Trac Environment は、名前そのものかエイリアスを、あらかじめ InterTrac に登録しておく必要があります。 
     162 
     163InterWiki リンクに対する InterTrac リンクの利点は、 Trac リンクの短縮書式 (`{}`, `r`, `#` など) を使えることにあります。例えば、 Trac プロジェクトへのエイリアスとして T が設定されている場合、 Trac プロジェクトへのチケットへのリンクは `#T234` と書くことができ、 Trac プロジェクトへのチェンジセットへのリンクは `[trac 1508]` と書くことができます。 
     164完全な詳細は InterTrac を参照してください。 
    122165 
    123166=== サーバ相対リンク === #Server-relativelinks 
     
    131174 
    132175{{{ 
    133 [/newticket Create a new ticket] 
    134 [/ home] 
    135 }}} 
    136  
    137 表示: [/newticket newticket] [/ home] 
    138  
    139 サーバ上の他のロケーション (Project の外部) にリンクするためには、 '//location' リンクシンタックスを使用します (''0.11 で変更された箇所です''): 
    140  
    141 {{{ 
    142 [//register Register Here] 
    143 }}} 
    144  
    145 表示: [//register Register Here] 
     176[/newticket 新規チケット作成] または [[//newticket|新規チケット作成]] 
     177[/ home] または [[/|home]] 
     178}}} 
     179 
     180表示: [/newticket 新規チケット作成] または [[//newticket|新規チケット作成]] 
     181[/ home] または [[/|home]] 
     182 
     183サーバ上の他のロケーション (Project の外部だが同じ FQDN にホストされているリソース) にリンクするためには、 '//' リンクシンタックスを使用します (''0.11 で変更された箇所です''): 
     184 
     185{{{ 
     186[//register ここで登録します] または [[//register|ここで登録します]] 
     187}}} 
     188 
     189表示: [//register ここで登録します] または [[//register|ここで登録します]] 
    146190 
    147191=== Trac リンクで空白文字をエスケープする === #QuotingspaceinTracLinks 
     
    155199 * !attachment:"the file.txt:ticket:123"  
    156200 
     201[http://trac.edgewall.org/wiki/WikiCreole WikiCreole] 形式のリンクを使用する場合、空白文字はそのまま解釈されます (訳注: WikiMacros の書式と重複しているので、マクロ名と同じページ名では使用できません): 
     202 * ![[The whitespace convention]] 
     203 * ![[attachment:the file.txt]] 
     204 
    157205=== リンクの無効化 === #EscapingLinks 
    158206 
     
    170218=== パラメータつきの Trac リンク === #ParameterizedTraclinks 
    171219 
    172 Trac リンクの対象となる Trac リソースは通常、パラメータで制御される複数の表示形式を持っています。例えば、 Wiki ページでは `version` や `format` パラメータを使用でき、レポートでは動的変数の使用ができます。 
    173  
    174 あらゆる種類の Trac リンクは、 URL のクエリパラメータに相当する方法で記述できる。任意の組み合わせのパラメータを持っています。例えば: 
     220Trac リンクの対象となる Trac リソースの多くは複数の表示形式を持ち、パラメータで制御することができます。例えば、 Wiki ページでは `version` や `format` パラメータを使用でき、レポートでは動的変数の使用ができます。 
     221 
     222Trac リンクは、 URL のクエリパラメータに相当する方法で記述できる。任意の組み合わせのパラメータを持っています。例えば: 
    175223 - `wiki:WikiStart?format=txt` 
    176224 - `ticket:1?version=1` 
    177  - `[/newticket?component=module1 create a ticket for module1]` 
     225 - `[/newticket?component=module1 module1 についてのチケットを新規登録]` 
     226 - `[/newticket?summary=Add+short+description+here 空白文字を含む場合]` 
    178227 
    179228 
     
    200249該当するチケットの内部では、 !comment:3 と書くと 3 番目の更新のコメントにリンクします。 
    201250それ以外の場所であっても、チケットを特定することで、どこからでもコメントへのリンクが可能です: 
    202  - !comment:3:ticket:123  
    203  - !ticket:123#comment:3 (Note: !#123#!comment:3! という書き方は間違っています) 
     251 - `comment:3:ticket:123`  
     252 - `ticket:123#comment:3` (Note: `#123#!comment:3` という書き方は間違っています!) 
     253チケットの説明 (英語版では description) にリンクしたい場合、以下のように記述してください: 
     254 - `comment:description` (該当するチケットの内部) 
     255 - `comment:description:ticket:123` 
     256 - `ticket:123#comment:description` 
    204257 
    205258=== query: リンク === #query:links 
     
    212265 
    213266=== ticket: リンク === #ticket:links 
     267 ''エイリアス:'' `bug:` 
    214268 
    215269通常使用される `ticket:id` 形式のほか、 `id` の代わりにチケットのリストやチケットの範囲を指定できます。これはカスタムクエリの検索結果ビューへのリンクを生成します。検索結果は指定したチケット固定です。 
     
    228282 - `timeline:2008-01-29` 
    229283 - `timeline:2008-01-29T15:48` 
    230  - `timeline:2008-01-29T16:48Z+01` 
     284 - `timeline:2008-01-29T15:48Z` 
     285 - `timeline:2008-01-29T16:48+01` 
    231286 
    232287''(Trac 0.11 以降)'' 
     
    237292 
    238293=== バージョン管理に関連するリンク === #VersionControlrelatedlinks 
     294 
     295複数リポジトリのサポートは、リポジトリ名称に対応したトップレベルのフォルダ配下のバージョン管理されたファイルへの仮想の名前空間を作ることによって動作します。それゆえ、下記に詳細を示しますが、複数リポジトリが存在する中での Trac リンクのシンタックス、 ''/path'' の指定では、リポジトリの名前から始める必要があります。省略された場合は、デフォルトリポジトリが使用されます。デフォルトリポジトリのトップレベルのフォルダにリポジトリと同じ名前のものが存在する場合は、フォルダ名称が使用されます。これらのフォルダには、完全修飾名でいつでもアクセスすることができます。( デフォルトリポジトリは、名前付きのリポジトリのエイリアスの一つなので、逆に言えばデフォルトリポジトリのエイリアスはいつでも作成することができます。 Trac の管理者に尋ねて下さい ) 
     296 
     297例として、 `source:/trunk/COPYING` はデフォルトリポジトリの `/trunk/COPYING` へのパスを指します。一方で、 `source:/projectA/trunk/COPYING` は `projectA` という名前のリポジトリの `/trunk/COPYING` へのパスを示します。もし、 `'projectA'` がデフォルトリポジトリへのエイリアスであるか、 `''` (デフォルトリポジトリ) が `'projectA'` リポジトリへのエイリアスであるならば、同じファイルを指していることになります。 
     298 
    239299==== source: リンク ==== #source:links 
    240  
    241 source:/some/path 形式のリンクは、パスがディレクトリを示しているならば 
    242 ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。 
     300 ''aliases:'' `browser:`, `repos:` 
     301 
     302source:/some/path 形式のリンクは、パスがディレクトリを指している場合は、そのディレクトリを開き、 
     303それ以外の場合は最新のリビジョンのファイルの内容を表示します。 
    243304 
    244305特定のリビジョンを指定してリンクすることもできます : 
    245306 - `source:/some/file@123` - file のリビジョン 123 にリンクします。 
    246  - `source:/some/file@head` - file の最新リビジョンにリンクします。 
    247 ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。 
     307 - `source:/some/file@head` - 明示的に file の最新リビジョンにリンクします。 
    248308 
    249309リビジョンを指定した場合はさらに特定の行番号にリンクすることさえできます : 
     
    253313さらに、特定の行をハイライト表示することもできます : 
    254314 - `source:/some/file@123:10-20,100,103#L99` - 10 行目から 20 行目、 100 行目、 103 行目をハイライトします。 
    255 ''(0.11 以降)'' 
     315   ''(0.11 以降)'' 
     316 
     317マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `source:reponame/trunk/README` のように記述するとリンクします。 ''(0.12 以降)'' 
    256318 
    257319==== export: リンク ==== #export:links 
     
    282344最後に、上記のすべてについて、リビジョン範囲の書式は `x:y` と `x-y` のどちらでも使用することができます。 
    283345 
     346マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `log:repos/branches` や `[20-40/repos]` のように記述するとリンクします。 
     347 
    284348---- 
    285349See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki