Changes between Initial Version and Version 1 of TracLinks


Ignore:
Timestamp:
2010/10/12 00:14:07 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v1  
     1= Trac リンク = #TracLinks 
     2[[TracGuideToc]] 
     3 
     4TracLinks は Trac の基礎となる機能です。というのも、 TracLinks によってシステムのエントリ間 - チケット、レポート、チェンジセット、Wikiページ、マイルストーン、ソースファイルなど - で簡単にハイパーリンクすることができるからです。 
     5 
     6TracLinks は通常、 '''type:id''' (''id'' はアイテムの 
     7番号や名前、パス) の形式で記述しますが、よく使われるコンポーネントについては、 
     8下の例のように表記を省略することもできます。 
     9 
     10== TracLinks が使えるところ == #WheretouseTracLinks 
     11TracLinks が使えるのは: 
     12 
     13 * ソースコード (Subverison) のコミットメッセージ 
     14 * Wikiページ 
     15 * チケット、レポート、マイルストーンでの説明記述箇所 
     16 
     17その他、 WikiFormatting を利用可能なことが明示されているすべてのテキストフィールド。 
     18 
     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}}} 
     54 
     55'''Note:''' wiki:CamelCase の書式が使われることはほとんどありませんが、 
     56ページ名が WikiPageNames のルールに従っていないページ (一文字、 
     57アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 
     58WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。 
     59 
     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}}} 
     106 
     107TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクを追跡する" ことによってプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。 
     108 
     109 
     110== TracLinks の高度な利用 == #AdvanceduseofTracLinks 
     111 
     112=== 相対リンク === #Relativelinks 
     113 
     114ページ内の特定アンカーにリンクするには '#' を使用します: 
     115{{{ 
     116 [#Relativelinks 相対リンク] または [[#Relativelinks|相対リンク]] 
     117}}} 
     118表示: 
     119  [#Relativelinks 相対リンク] または [[#Relativelinks|相対リンク]] 
     120 
     121Hint: セクションのタイトルにマウスオーバしたときに、文字 '¶' が表示されます。これはそのセクションへのリンクですので、 `#...` の部分をコピーすれば、相対リンクのアンカーとして使用できます。 
     122 
     123[http://trac.edgewall.org/wiki/SubWiki SubWiki] ページにリンクするには '/' を使用します: 
     124{{{ 
     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 サーバ相対リンク] を参照してください。 
     154 
     155=== InterWiki リンク === #InterWikilinks 
     156 
     157他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページである InterMapTxt ページで定義されます。他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。 
     158 
     159=== InterTrac リンク === #InterTraclinks 
     160 
     161InterWiki リンクと同じ要領で使用できますが、リンクする対象を他の Trac プロジェクトに特化した機能です。 
     162 
     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 を参照してください。 
     167 
     168=== サーバ相対リンク === #Server-relativelinks 
     169 
     170静的リソースや `newticket` のような固定リンク、 `/register` ページのような 
     171サーバ内で共有するリソースなど、 Trac のリンク機構にビルトインされていない 
     172リソースに対して Project 内でリンクする機能は時折、有用になります。 
     173 
     174Project 内のリソースにリンクするためには、 Project root からの絶対パスか、 
     175現在のページの URL からの相対リンクを使用します (''0.11 で変更された箇所です''): 
     176 
     177{{{ 
     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|ここで登録します]] 
     192 
     193=== Trac リンクで空白文字をエスケープする === #QuotingspaceinTracLinks 
     194 
     195TracLinks のプレフィックスの後ろにスペースを含んだターゲットがある場合、 
     196シングルクォーテーションかダブルクォーテーションで囲みます。 
     197例: 
     198 * !wiki:"The whitespace convention" 
     199 * !attachment:'the file.txt' もしくは 
     200 * !attachment:"the file.txt"  
     201 * !attachment:"the file.txt:ticket:123"  
     202 
     203[http://trac.edgewall.org/wiki/WikiCreole WikiCreole] 形式のリンクを使用する場合、空白文字はそのまま解釈されます (訳注: WikiMacros の書式と重複しているので、マクロ名と同じページ名では使用できません): 
     204 * ![[The whitespace convention]] 
     205 * ![[attachment:the file.txt]] 
     206 
     207=== リンクの無効化 === #EscapingLinks 
     208 
     209!TracLinks を無効化するには、先頭に '!' (エクスクラメーションマーク) を付けます。 
     210{{{ 
     211 !NoLinkHere. 
     212 ![42] is not a link either. 
     213}}} 
     214 
     215表示: 
     216 !NoLinkHere. 
     217 ![42] is not a link either. 
     218 
     219 
     220=== パラメータつきの Trac リンク === #ParameterizedTraclinks 
     221 
     222Trac リンクの対象となる Trac リソースの多くは複数の表示形式を持ち、パラメータで制御することができます。例えば、 Wiki ページでは `version` や `format` パラメータを使用でき、レポートでは動的変数の使用ができます。 
     223 
     224Trac リンクは、 URL のクエリパラメータに相当する方法で記述できる。任意の組み合わせのパラメータを持っています。例えば: 
     225 - `wiki:WikiStart?format=txt` 
     226 - `ticket:1?version=1` 
     227 - `[/newticket?component=module1 module1 についてのチケットを新規登録]` 
     228 - `[/newticket?summary=Add+short+description+here 空白文字を含む場合]` 
     229 
     230 
     231== TracLinks リファレンス == #TracLinksReference 
     232以下に示すセクションは特定のリンクの種類の詳細について記述しています。 TracLinks の上級者向けの使用方法も同時に記述します。 
     233 
     234=== attachment: リンク === #attachment:links 
     235 
     236添付ファイルへのリンクのシンタックスは次に示すとおりです: 
     237 * !attachment:the_file.txt は、現在のオブジェクトに添付されたファイル the_file.txt へのリンクを生成します。 
     238 * !attachment:the_file.txt:wiki:MyPage は、 Wiki ページ !MyPage に添付されたファイル the_file.txt へのリンクを生成します。 
     239 * !attachment:the_file.txt:ticket:753 は、チケット 753 に添付されたファイル the_file.txt へのリンクを生成します。 
     240 
     241Note: 古い記法ではファイル名を最後に書いていました。この記法はまだ使うことができます: !attachment:ticket:753:the_file.txt 
     242 
     243添付ファイルページではなく、添付ファイルの内容に直接リンクしたい場合は `attachment:` の代わりに `raw-attachment:` を使用してください。 
     244 
     245このリンクは HTML ドキュメントなどを直接指す目的では使いやすいですが、この方法を使うためには `[attachment] render_unsafe_content = yes` (See TracIni#attachment-section) を設定し、 Web ブラウザに内容を表示できるように設定しなければなりません。注意: この設定を行うのはファイルを添付するユーザのことを 100% 信頼できる場合だけにしてください。そうでない場合、サイトが [http://ja.wikipedia.org/wiki/クロスサイトスクリプティング クロスサイトスクリプティング] 攻撃に晒されることになります。 
     246 
     247See also [#export:links]. 
     248 
     249=== comment: リンク === #comment:links 
     250 
     251該当するチケットの内部では、 !comment:3 と書くと 3 番目の更新のコメントにリンクします。 
     252それ以外の場所であっても、チケットを特定することで、どこからでもコメントへのリンクが可能です: 
     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` 
     259 
     260=== query: リンク === #query:links 
     261 
     262TracQuery#UsingTracLinks と [#ticket:links] を参照してください。 
     263 
     264=== search: リンク === #search:links 
     265 
     266TracSearch#SearchLinks を参照してください。 
     267 
     268=== ticket: リンク === #ticket:links 
     269 ''エイリアス:'' `bug:` 
     270 
     271通常使用される `ticket:id` 形式のほか、 `id` の代わりにチケットのリストやチケットの範囲を指定できます。これはカスタムクエリの検索結果ビューへのリンクを生成します。検索結果は指定したチケット固定です。 
     272 
     273例:  
     274 - `ticket:5000-6000` 
     275 - `ticket:1,150` 
     276 
     277''(Trac 0.11 以降)'' 
     278 
     279=== timeline: リンク === #timeline:links 
     280 
     281タイムラインへのリンクは ISO:8601 形式で日付を指定して生成できます。日付の指定には、任意で時刻の指定を続けることもできます。この時刻は UTC 時刻で解釈されますが、 UTC 時刻を使用したくない場合はタイムゾーンを続けて指定することで、ローカルタイムを使用できます。 
     282 
     283例: 
     284 - `timeline:2008-01-29` 
     285 - `timeline:2008-01-29T15:48` 
     286 - `timeline:2008-01-29T15:48Z` 
     287 - `timeline:2008-01-29T16:48+01` 
     288 
     289''(Trac 0.11 以降)'' 
     290 
     291=== wiki: リンク === #wiki:links 
     292 
     293WikiPageNames と、このページの [#QuotingspaceinTracLinks Trac リンクで空白文字をエスケープする] を参照してください。 
     294 
     295=== バージョン管理に関連するリンク === #VersionControlrelatedlinks 
     296==== source: リンク ==== #source:links 
     297 ''エイリアス:'' `browser:`, `repos:` 
     298 
     299source:/some/path 形式のリンクは、パスがディレクトリを指している場合は、そのディレクトリを開き、 
     300それ以外の場合は最新のリビジョンのファイルの内容を表示します。 
     301 
     302特定のリビジョンを指定してリンクすることもできます : 
     303 - `source:/some/file@123` - file のリビジョン 123 にリンクします。 
     304 - `source:/some/file@head` - file の最新リビジョンにリンクします。 
     305ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。 
     306 
     307リビジョンを指定した場合はさらに特定の行番号にリンクすることさえできます : 
     308 - `source:/some/file@123#L10` 
     309 - `source:/tag/0.10@head#L10` 
     310 
     311さらに、特定の行をハイライト表示することもできます : 
     312 - `source:/some/file@123:10-20,100,103#L99` - 10 行目から 20 行目、 100 行目、 103 行目をハイライトします。 
     313   ''(0.11 以降)'' 
     314 
     315マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `source:reponame/trunk/README` のように記述するとリンクします。 ''(0.12 以降)'' 
     316 
     317==== export: リンク ==== #export:links 
     318 
     319ブラウザでリンクをクリックしたときに、リポジトリ内をブラウザに表示するのではなく、ダウンロードを強制するためには `export` リンクを使用します。いくつかの形式が使用できます : 
     320 * `export:/some/file` - file の最新リビジョンをダウンロードします。 
     321 * `export:123:/some/file` - file の リビジョン 123 をダウンロードします。 
     322 * `export:/some/file@123` - file の リビジョン 123 をダウンロードします。 
     323 
     324リポジトリにチェックインされている XML や HTML 文書を、正しいスタイルシートと画像で表示する場合などには非常に使いやすいですが、この方法を使うためには `[browser] render_unsafe_content = yes` (See TracIni#browser-section) を設定し、 Web ブラウザに内容を表示できるように設定しなければなりません。設定されていない場合、セキュリティを確保するため、そのファイルを Web ブラウザ上で表示せず、添付ファイルと同じようにダウンロードさせます。 
     325 
     326特定のファイルの代わりにリポジトリのディレクトリのパスが指定されると、ソースブラウザはディレクトリを表示します (`source:/some/dir` と同じ) 。 
     327 
     328==== log: リンク ==== #log:links 
     329 
     330`log:` リンクはリビジョンの範囲を表示するために使用します。最も単純な形式では、特定パスの最新のリビジョン群へのリンクを生成します。リビジョンを指定することで、最新以外の任意のリビジョンを表示することもできます。 
     331 - `log:/` - リポジトリのルートディレクトリでの最新のリビジョン群 
     332 - `log:/trunk/tools` - `trunk/tools` での最新のリビジョン群 
     333 - `log:/trunk/tools@10000` - `trunk/tools` での 10000 から始まるリビジョン群 (訳注: 10000 以前のリビジョン) 
     334 - `log:@20788,20791:20795` - リビジョン 20788 と 20791 から 20795 までの範囲のリビジョンを表示する 
     335 - `log:/trunk/tools@20788,20791:20795` - リビジョン 20788 と 20791 から 20795 までの範囲のリビジョンのうち、 `/trunk/tools` に影響したものを表示する 
     336 
     337リビジョン範囲の短縮形式は以下の通りです: 
     338 - `[20788,20791:20795]` 
     339 - `[20788,20791:20795/trunk/tools]` 
     340 - `r20791:20795` (ただし `r20788,20791:20795` や `r20791:20795/trunk` は使用できません) 
     341 
     342最後に、上記のすべてについて、リビジョン範囲の書式は `x:y` と `x-y` のどちらでも使用することができます。 
     343 
     344マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `log:repos/branches` や `[20-40/repos]` のように記述するとリンクします。 
     345 
     346---- 
     347See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 
     348