Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Oct 12, 2010, 8:57:27 PM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    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 チェンジセット :: `r1`, `[1]`, `changeset:1`, (特定パス配下) `[1/trunk]`, `changeset:1/trunk`
     29 リビジョンログ :: `r1:3`, `[1:3]`, `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
     30 diff :: `diff:@1:3`, `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
     31          または `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
     32 マイルストーン :: `milestone:1.0`
     33 添付ファイル :: `attachment:example.tgz` (現在のページへの添付ファイル), `attachment:attachment.1073.diff:ticket:944` (他のリソースへの添付ファイル)
     34 リポジトリのファイル :: `source:trunk/COPYING`
     35 特定リビジョンのリポジトリのファイル :: `source:/trunk/COPYING@200`
     36 リポジトリのファイルの特定行 :: `source:/trunk/COPYING@200#L25`
     37}}}
     38{{{#!td
     39 Wiki ページ :: CamelCase, wiki:CamelCase
     40 親ページ :: [..]
     41 チケット :: #1, ticket:1
     42 チケットのコメント :: comment:1:ticket:2
     43 レポート :: {1}, report:1
     44 チェンジセット :: r1, [1], changeset:1, (特定パス配下) [1/trunk], changeset:1/trunk
     45 リビジョンログ :: r1:3, [1:3], log:@1:3, log:trunk@1:3, [2:5/trunk]
     46 diff :: diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
     47          または diff:trunk/trac@3538//sandbox/vc-refactoring@3539
     48 マイルストーン :: milestone:1.0
     49 添付ファイル :: attachment:example.tgz (現在のページへの添付ファイル), attachment:attachment.1073.diff:ticket:944 (他のリソースへの添付ファイル)
     50 リポジトリのファイル :: source:trunk/COPYING
     51 特定リビジョンのリポジトリのファイル :: source:/trunk/COPYING@200
     52 リポジトリのファイルの特定行 :: source:/trunk/COPYING@200#L25
     53}}}
    4754
    4855'''Note:''' wiki:CamelCase の書式が使われることはほとんどありませんが、
    4956ページ名が WikiPageNames のルールに従っていないページ (一文字、
    50 アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 
     57アルファベット以外の文字、etc.) をリンクしたい場合には便利です。
    5158WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。
    5259
    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]
     60
     61{{{#!table class=""
     62|||| 完全表記の (簡略形でない) Trac リンクでは、次のようにしてリンクタイトルをカスタマイズすることもできます: ||
     63{{{#!td
     64{{{
     65[ticket:1 これは1番目のチケットへのリンクです] または
     66[[ticket:1|これは1番目のチケットへのリンクです]]。
     67}}}
     68}}}
     69{{{#!td
     70[ticket:1 これは1番目のチケットへのリンクです] または
     71[[ticket:1|これは1番目のチケットへのリンクです]]。
     72}}}
     73|--------------------------------------------------------------------------------------
     74|||| タイトルが省略された場合、 ID のみ (コロンの後ろ側) が表示されます: ||
     75{{{#!td
     76{{{
     77[ticket:1] または [[ticket:2]]
     78}}}
     79}}}
     80{{{#!td
     81[ticket:1] または [[ticket:2]]
     82}}}
     83|--------------------------------------------------------------------------------------
     84|||| 完全表記から名前空間が省略されている場合、デフォルト値として `wiki` が使用されます: ||
     85{{{#!td
     86{{{
     87[SandBox サンドボックス] または
     88[[SandBox|サンドボックス]]
     89}}}
     90}}}
     91{{{#!td
     92[SandBox サンドボックス] または
     93[[SandBox|サンドボックス]]
     94}}}
     95|--------------------------------------------------------------------------------------
     96|||| ''realm:target'' 形式のリンクで特殊な文字を使用したい場合は、 <...> で囲んでください。 [[br]] (ただし > は使用できません) [[br]] 訳注: target 該当箇所を "" で囲む形式との違いは、バージョンに展開される `@` などのような特殊文字も解釈されずに、そのまま target として使用されることにあります。 ||
     97{{{#!td
     98{{{
     99<wiki:Strange(page@!)>
     100}}}
     101}}}
     102{{{#!td
     103<wiki:Strange(page@!)>
     104}}}
     105}}}
    77106
    78107TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクを追跡する" ことによってプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。
     
    85114ページ内の特定アンカーにリンクするには '#' を使用します:
    86115{{{
    87  [#Relativelinks 相対リンク]
     116 [#Relativelinks 相対リンク] または [[#Relativelinks|相対リンク]]
    88117}}}
    89118表示:
    90   [#Relativelinks 相対リンク]
     119  [#Relativelinks 相対リンク] または [[#Relativelinks|相対リンク]]
    91120
    92121Hint: セクションのタイトルにマウスオーバしたときに、文字 '¶' が表示されます。これはそのセクションへのリンクですので、 `#...` の部分をコピーすれば、相対リンクのアンカーとして使用できます。
     
    94123[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページにリンクするには '/' を使用します:
    95124{{{
    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 サーバ相対リンク] を参照してください。
     125 WikiPage/SubWikiPage または ./SubWikiPage
     126}}}
     127
     128[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページから親ページにリンクするには、 '..' を使用します:
     129{{{
     130  [..] または [[..]]
     131}}}
     132  [..] または [[..]]
     133
     134[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページから [=#sibling 兄弟の位置にある] ページにリンクするには、 '../' を使用します:
     135{{{
     136  [../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]]
     137}}}
     138  [../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]]
     139
     140しかし、兄弟の位置にあるページにリンクするために `../` プレフィックスを使用しない方がいい場合もあります。
     141Wiki リンクのロケーションを解決するとき、相対リンクではリンクを記述するページから階層内での近い位置にあるページが選択されます。
     142つまり、階層化されているページの場合、トップレベルにあるページよりも、兄弟の位置にあるページが優先されます。
     143プレフィックスを使用しない場合は [[WikiNewPage#renaming|ページ名変更]] による下位の階層へのページのコピーや移動の際に、
     144リンクを書き換える必要がなくなるので、簡単にできるようになります。
     145
     146明示的に [=#toplevel トップレベル] の Wiki ページへのリンクを記述する場合は、
     147`wiki:/` プレフィックスを使用してください。
     148ただし、 `/` プレフィックスを単独で使う場合 **Wiki ページへのリンクになりません**。
     149`/` で始まるリンクは [#Server-relativelinks サーバ相対リンク] のシンタックスとして解釈されるため、
     150`/wiki/` が付与されない、不完全な URL になってしまいます。
     151
     152''(0.11 で変更された箇所です)'' Trac 0.10 では `[../newticket]` のように書くと、トップレベル URL の `/newticket` にリンクする動作でした。しかし 0.11 では Wiki の名前空間にとどまり、兄弟の位置にあるページにリンクします。
     153新しいシンタックスについては [#Server-relativelinks サーバ相対リンク] を参照してください。
    110154
    111155=== InterWiki リンク === #InterWikilinks
    112156
    113 他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページ、 InterMapTxt ページで定義されます。 他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。
     157他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページである InterMapTxt ページで定義されます。他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。
    114158
    115159=== InterTrac リンク === #InterTraclinks
     
    117161InterWiki リンクと同じ要領で使用できますが、リンクする対象を他の Trac プロジェクトに特化した機能です。
    118162
    119 プレフィックスとして定義した他の Trac Environment の名前とコロンに続けて、あらゆる種類の Trac リンクを記述することで、一つの Trac Enviroment から他の Trac Environment のリソースを参照することができます。このリモートの Trac Environment は、名前そのものかエイリアスとして、あらかじめ登録しておく必要があります。詳しくは InterTrac を参照してください。
    120 
    121 InterWiki リンクに対する InterTrac リンクの利点は、 InterTrac リンクが Trac リンクの短縮書式を解釈できることにあります。例えば、チケットへのリンクは `#T234` (T は Trac Project へのエイリアスに設定されているとします) と書くことができ、チェンジセットへのリンクは `[trac 1508]` と書くことができます。
     163ある Trac Environment に記述される、どんな形式の Trac リンクであっても、他の Trac Environment のリソースを参照することができます。他の Trac Environment のリソースを指すためには、 Trac リンクのプレフィックスとして、リンク先の Trac Environment の名前とコロンを付与してください。このリンク先の Trac Environment は、名前そのものかエイリアスを、あらかじめ InterTrac に登録しておく必要があります。
     164
     165InterWiki リンクに対する InterTrac リンクの利点は、 Trac リンクの短縮書式 (`{}`, `r`, `#` など) を使えることにあります。例えば、 Trac プロジェクトへのエイリアスとして T が設定されている場合、 Trac プロジェクトへのチケットへのリンクは `#T234` と書くことができ、 Trac プロジェクトへのチェンジセットへのリンクは `[trac 1508]` と書くことができます。
     166完全な詳細は InterTrac を参照してください。
    122167
    123168=== サーバ相対リンク === #Server-relativelinks
     
    131176
    132177{{{
    133 [/newticket Create a new ticket]
    134 [/ home]
    135 }}}
    136 
    137 表示: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]]  [/ home]
    138 
    139 サーバ上の他のロケーション (Project の外部) にリンクするためには、 '//location' リンクシンタックスを使用します (''0.11 で変更された箇所です''):
    140 
    141 {{{
    142 [//register Register Here]
    143 }}}
    144 
    145 表示: [//register Register Here]
     178[/newticket 新規チケット作成] または [[//newticket|新規チケット作成]]
     179[/ home] または [[/|home]]
     180}}}
     181
     182表示: [/newticket 新規チケット作成] または [[//newticket|新規チケット作成]]
     183[/ home] または [[/|home]]
     184
     185サーバ上の他のロケーション (Project の外部だが同じ FQDN にホストされているリソース) にリンクするためには、 '//' リンクシンタックスを使用します (''0.11 で変更された箇所です''):
     186
     187{{{
     188[//register ここで登録します] または [[//register|ここで登録します]]
     189}}}
     190
     191表示: [//register ここで登録します] または [[//register|ここで登録します]]
    146192
    147193=== Trac リンクで空白文字をエスケープする === #QuotingspaceinTracLinks
     
    155201 * !attachment:"the file.txt:ticket:123"
    156202
     203[http://trac.edgewall.org/wiki/WikiCreole WikiCreole] 形式のリンクを使用する場合、空白文字はそのまま解釈されます (訳注: WikiMacros の書式と重複しているので、マクロ名と同じページ名では使用できません):
     204 * ![[The whitespace convention]]
     205 * ![[attachment:the file.txt]]
     206
    157207=== リンクの無効化 === #EscapingLinks
    158208
     
    170220=== パラメータつきの Trac リンク === #ParameterizedTraclinks
    171221
    172 Trac リンクの対象となる Trac リソースは通常、パラメータで制御される複数の表示形式を持っています。例えば、 Wiki ページでは `version` や `format` パラメータを使用でき、レポートでは動的変数の使用ができます。
    173 
    174 あらゆる種類の Trac リンクは、 URL のクエリパラメータに相当する方法で記述できる。任意の組み合わせのパラメータを持っています。例えば:
     222Trac リンクの対象となる Trac リソースの多くは複数の表示形式を持ち、パラメータで制御することができます。例えば、 Wiki ページでは `version` や `format` パラメータを使用でき、レポートでは動的変数の使用ができます。
     223
     224Trac リンクは、 URL のクエリパラメータに相当する方法で記述できる。任意の組み合わせのパラメータを持っています。例えば:
    175225 - `wiki:WikiStart?format=txt`
    176226 - `ticket:1?version=1`
    177  - `[/newticket?component=module1 create a ticket for module1]`
     227 - `[/newticket?component=module1 module1 についてのチケットを新規登録]`
     228 - `[/newticket?summary=Add+short+description+here 空白文字を含む場合]`
    178229
    179230
     
    200251該当するチケットの内部では、 !comment:3 と書くと 3 番目の更新のコメントにリンクします。
    201252それ以外の場所であっても、チケットを特定することで、どこからでもコメントへのリンクが可能です:
    202  - !comment:3:ticket:123
    203  - !ticket:123#comment:3 (Note: !#123#!comment:3! という書き方は間違っています)
     253 - `comment:3:ticket:123`
     254 - `ticket:123#comment:3` (Note: `#123#!comment:3` という書き方は間違っています!)
     255チケットの説明 (英語版では description) にリンクしたい場合、以下のように記述してください:
     256 - `comment:description` (該当するチケットの内部)
     257 - `comment:description:ticket:123`
     258 - `ticket:123#comment:description`
    204259
    205260=== query: リンク === #query:links
     
    212267
    213268=== ticket: リンク === #ticket:links
     269 ''エイリアス:'' `bug:`
    214270
    215271通常使用される `ticket:id` 形式のほか、 `id` の代わりにチケットのリストやチケットの範囲を指定できます。これはカスタムクエリの検索結果ビューへのリンクを生成します。検索結果は指定したチケット固定です。
     
    228284 - `timeline:2008-01-29`
    229285 - `timeline:2008-01-29T15:48`
    230  - `timeline:2008-01-29T16:48Z+01`
     286 - `timeline:2008-01-29T15:48Z`
     287 - `timeline:2008-01-29T16:48+01`
    231288
    232289''(Trac 0.11 以降)''
     
    238295=== バージョン管理に関連するリンク === #VersionControlrelatedlinks
    239296==== source: リンク ==== #source:links
    240 
    241 source:/some/path 形式のリンクは、パスがディレクトリを示しているならば
    242 ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。
     297 ''エイリアス:'' `browser:`, `repos:`
     298
     299source:/some/path 形式のリンクは、パスがディレクトリを指している場合は、そのディレクトリを開き、
     300それ以外の場合は最新のリビジョンのファイルの内容を表示します。
    243301
    244302特定のリビジョンを指定してリンクすることもできます :
     
    253311さらに、特定の行をハイライト表示することもできます :
    254312 - `source:/some/file@123:10-20,100,103#L99` - 10 行目から 20 行目、 100 行目、 103 行目をハイライトします。
    255 ''(0.11 以降)''
     313   ''(0.11 以降)''
     314
     315マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `source:reponame/trunk/README` のように記述するとリンクします。 ''(0.12 以降)''
    256316
    257317==== export: リンク ==== #export:links
     
    282342最後に、上記のすべてについて、リビジョン範囲の書式は `x:y` と `x-y` のどちらでも使用することができます。
    283343
     344マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `log:repos/branches` や `[20-40/repos]` のように記述するとリンクします。
     345
    284346----
    285347See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki