Trac リンク
Table of Contents
TracLinks は Trac の基礎となる機能です。というのも、 TracLinks によってシステムのエントリ間 - チケット、レポート、チェンジセット、Wikiページ、マイルストーン、ソースファイルなど - で簡単にハイパーリンクすることができるからです。
TracLinks は通常、 type:id (id はアイテムの 番号や名前、パス) の形式で記述しますが、よく使われるコンポーネントについては、 下の例のように表記を省略することもできます。
TracLinks が使えるところ
TracLinks が使えるのは:
- ソースコード (Subverison) のコミットメッセージ
- Wikiページ
- チケット、レポート、マイルストーンでの説明記述箇所
その他、 WikiFormatting を利用可能なことが明示されているすべてのテキストフィールド。
概要
| Wiki マークアップ | 表示 |
|---|---|
|
|
Note: wiki:CamelCase の書式が使われることはほとんどありませんが、 ページ名が WikiPageNames のルールに従っていないページ (一文字、 アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。
| 完全表記の (簡略形でない) Trac リンクでは、次のようにしてリンクタイトルをカスタマイズすることもできます: | |
[ticket:1 これは1番目のチケットへのリンクです] または [[ticket:1|これは1番目のチケットへのリンクです]]。 | |
| タイトルが省略された場合、 ID のみ (コロンの後ろ側) が表示されます: | |
[ticket:1] または [[ticket:2]] | |
| 完全表記から名前空間が省略されている場合、デフォルト値として wiki が使用されます: | |
[SandBox サンドボックス] または [[SandBox|サンドボックス]] | |
| realm:target 形式のリンクで特殊な文字を使用したい場合は、 <...> で囲んでください。 (ただし > は使用できません) 訳注: target 該当箇所を "" で囲む形式との違いは、バージョンに展開される @ などのような特殊文字も解釈されずに、そのまま target として使用されることにあります。 | |
<wiki:Strange(page@!)> | |
TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクを追跡する" ことによってプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。
TracLinks の高度な利用
相対リンク
SubWiki ページにリンクするには '/' を使用します:
WikiPage/SubWikiPage または ./SubWikiPage
SubWiki ページから親ページにリンクするには、 '..' を使用します:
[..] または [[..]]
SubWiki ページから 兄弟の位置にある ページにリンクするには、 '../' を使用します:
[../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]]
しかし、兄弟の位置にあるページにリンクするために ../ プレフィックスを使用しない方がいい場合もあります。 Wiki リンクのロケーションを解決するとき、相対リンクではリンクを記述するページから階層内での近い位置にあるページが選択されます。 つまり、階層化されているページの場合、トップレベルにあるページよりも、兄弟の位置にあるページが優先されます。 プレフィックスを使用しない場合は ページ名変更 による下位の階層へのページのコピーや移動の際に、 リンクを書き換える必要がなくなるので、簡単にできるようになります。
明示的に トップレベル の Wiki ページへのリンクを記述する場合は、 wiki:/ プレフィックスを使用してください。 ただし、 / プレフィックスを単独で使う場合 Wiki ページへのリンクになりません。 / で始まるリンクは サーバ相対リンク のシンタックスとして解釈されるため、 /wiki/ が付与されない、不完全な URL になってしまいます。
(0.11 で変更された箇所です) Trac 0.10 では [../newticket] のように書くと、トップレベル URL の /newticket にリンクする動作でした。しかし 0.11 では Wiki の名前空間にとどまり、兄弟の位置にあるページにリンクします。 新しいシンタックスについては サーバ相対リンク を参照してください。
リンクアンカー
ページ内の特定アンカーにリンクするには、'#'を使用してください:
[#Linkanchors リンクアンカー] または [[#Linkanchors|リンクアンカー]]
Hint: セクションのタイトルにマウスオーバしたときに、文字 '¶' が表示されます。これはそのセクションへのリンクですので、 #... の部分をコピーすれば、相対リンクのアンカーとして使用できます。
ページ上に最初と最後に記載されている用語にリンクを作成するためには、'#/' または '#?'で始まる pseudo anchor を使用してください:
[#/Milestone first occurrence of Milestone] または [#?Milestone last occurrence of Milestone]
first occurrence of Milestone または last occurrence of Milestone
リンクしたページで一致したらすべてがハイライト表示されます。 デフォルト値のみ、大文字と小文字が区別されます。 大文字と小文字を区別しない場合には、 '/i' 追加してください:
[#/Milestone/i first occurrence of Milestone or milestone] または [#?Milestone/i last occurrence of Milestone or milestone]
first occurrence of Milestone or milestone または last occurrence of Milestone or milestone
(Trac 1.0 以降)
このようなアンカーは、ソースブラウザでファイルの特定の行にリンクするのに非常に役立ちます:
[trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] または [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
(Hint: ソースブラウザに表示される行番号は、それぞれのライン上でアンカーへリンクします。)
ファイルが変更されるとリンクが古くなるので, 代わりに疑似アンカー '#/' を使用するとリンクする時に便利です:
[trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] または [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
InterWiki リンク
他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページである InterMapTxt ページで定義されます。他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。
InterTrac リンク
InterWiki リンクと同じ要領で使用できますが、リンクする対象を他の Trac プロジェクトに特化した機能です。
ある Trac Environment に記述される、どんな形式の Trac リンクであっても、他の Trac Environment のリソースを参照することができます。他の Trac Environment のリソースを指すためには、 Trac リンクのプレフィックスとして、リンク先の Trac Environment の名前とコロンを付与してください。このリンク先の Trac Environment は、名前そのものかエイリアスを、あらかじめ InterTrac に登録しておく必要があります。
InterWiki リンクに対する InterTrac リンクの利点は、 Trac リンクの短縮書式 ({}, r, # など) を使えることにあります。例えば、 Trac プロジェクトへのエイリアスとして T が設定されている場合、 Trac プロジェクトへのチケットへのリンクは #T234 と書くことができ、 Trac プロジェクトへのチェンジセットへのリンクは [trac 1508] と書くことができます。 完全な詳細は InterTrac を参照してください。
サーバ相対リンク
静的リソースや newticket のような固定リンク、 /register ページのような サーバ内で共有するリソースなど、 Trac のリンク機構にビルトインされていない リソースに対して Project 内でリンクする機能は時折、有用になります。
Project 内のリソースにリンクするためには、 Project root からの絶対パスか、 現在のページの URL からの相対リンクを使用します (0.11 で変更された箇所です):
[/newticket 新規チケット作成] または [[//newticket|新規チケット作成]] [/ home] または [[/|home]]
表示: 新規チケット作成 または 新規チケット作成 home または home
サーバ上の他のロケーション (Project の外部だが同じ FQDN にホストされているリソース) にリンクするためには、 '' リンクシンタックスを使用します (0.11 で変更された箇所です):
[//register ここで登録します] または [[//register|ここで登録します]]
Trac リンクで空白文字をエスケープする
TracLinks のプレフィックスの後ろにスペースを含んだターゲットがある場合、 シングルクォーテーションかダブルクォーテーションで囲みます。 例:
- wiki:"The whitespace convention"
- attachment:'the file.txt' もしくは
- attachment:"the file.txt"
- attachment:"the file.txt:ticket:123"
WikiCreole 形式のリンクを使用する場合、空白文字はそのまま解釈されます (訳注: WikiMacros の書式と重複しているので、マクロ名と同じページ名では使用できません):
- [[The whitespace convention]]
- [[attachment:the file.txt]]
リンクの無効化
TracLinks を無効化するには、先頭に '!' (エクスクラメーションマーク) を付けます。
!NoLinkHere. ![42] is not a link either.
表示:
NoLinkHere. [42] is not a link either.
パラメータつきの Trac リンク
Trac リンクの対象となる Trac リソースの多くは複数の表示形式を持ち、パラメータで制御することができます。例えば、 Wiki ページでは version や format パラメータを使用でき、レポートでは動的変数の使用ができます。
Trac リンクは、 URL のクエリパラメータに相当する方法で記述できる。任意の組み合わせのパラメータを持っています。例えば:
- wiki:WikiStart?format=txt
- ticket:1?version=1
- [/newticket?component=module1 module1 についてのチケットを新規登録]
- [/newticket?summary=Add+short+description+here 空白文字を含む場合]
TracLinks リファレンス
以下に示すセクションは特定のリンクの種類の詳細について記述しています。 TracLinks の上級者向けの使用方法も同時に記述します。
attachment: リンク
添付ファイルへのリンクのシンタックスは次に示すとおりです:
- attachment:the_file.txt は、現在のオブジェクトに添付されたファイル the_file.txt へのリンクを生成します
- attachment:the_file.txt:wiki:MyPage は、 Wiki ページ MyPage に添付されたファイル the_file.txt へのリンクを生成します
- attachment:the_file.txt:ticket:753 は、チケット 753 に添付されたファイル the_file.txt へのリンクを生成します
Note: 古い記法ではファイル名を最後に書いていました。この記法はまだ使うことができます: attachment:ticket:753:the_file.txt
添付ファイルページではなく、添付ファイルの内容に直接リンクしたい場合は attachment: の代わりに raw-attachment: を使用してください。
このリンクは HTML ドキュメントなどを直接指す目的では使いやすいですが、この方法を使うためには [attachment] render_unsafe_content = yes (See TracIni#attachment-section) を設定し、 Web ブラウザに内容を表示できるように設定しなければなりません。注意: この設定を行うのはファイルを添付するユーザのことを 100% 信頼できる場合だけにしてください。そうでない場合、サイトが クロスサイトスクリプティング 攻撃に晒されることになります。
#export:links を参照してください。
comment: リンク
該当するチケットの内部では、 comment:3 と書くと 3 番目の更新のコメントにリンクします。 それ以外の場所であっても、チケットを特定することで、どこからでもコメントへのリンクが可能です:
- comment:3:ticket:123
- ticket:123#comment:3 (Note: #123#!comment:3 という書き方は間違っています!)
チケットの説明 (英語版では description) にリンクしたい場合、以下のように記述してください:
- comment:description (該当するチケットの内部)
- comment:description:ticket:123
- ticket:123#comment:description
htdocs: リンク
Trac Environment の htdocs ディレクトリ内のファイルを参照したい場合、 htdocs:path/to/file と記述してください。 (リソースディレクトリについて)
query: リンク
TracQuery#UsingTracLinks と #ticket:links を参照してください。
search: リンク
TracSearch#SearchLinks を参照してください。
ticket: リンク
エイリアス: bug:
通常使用される ticket:id 形式のほか、 id の代わりにチケットのリストやチケットの範囲を指定できます。これはカスタムクエリの検索結果ビューへのリンクを生成します。検索結果は指定したチケット固定です。
例:
- ticket:5000-6000
- ticket:1,150
(Trac 0.11 以降)
timeline: リンク
タイムラインへのリンクは ISO:8601 形式で日付を指定して生成できます。日付の指定には、任意で時刻の指定を続けることもできます。この時刻は UTC 時刻で解釈されますが、 UTC 時刻を使用したくない場合はタイムゾーンを続けて指定することで、ローカルタイムを使用できます。
例:
- timeline:2008-01-29
- timeline:2008-01-29T15:48
- timeline:2008-01-29T15:48Z
- timeline:2008-01-29T16:48+01
(Trac 0.11 以降)
wiki: リンク
WikiPageNames と、このページの Trac リンクで空白文字をエスケープする を参照してください。WikiStart@1 といった構文を使用することで、リビジョンを指定してページへのリンクを生成することが可能です。
バージョン管理に関連するリンク
複数リポジトリのサポートは、リポジトリ名称に対応したトップレベルのフォルダ配下のバージョン管理されたファイルへの仮想の名前空間を作ることによって動作します。それゆえ、下記に詳細を示しますが、複数リポジトリが存在する中での Trac リンクのシンタックス、 /path の指定では、リポジトリの名前から始める必要があります。省略された場合は、デフォルトリポジトリが使用されます。デフォルトリポジトリのトップレベルのフォルダにリポジトリと同じ名前のものが存在する場合は、フォルダ名称が使用されます。これらのフォルダには、完全修飾名でいつでもアクセスすることができます。( デフォルトリポジトリは、名前付きのリポジトリのエイリアスの一つなので、逆に言えばデフォルトリポジトリのエイリアスはいつでも作成することができます。 Trac の管理者に尋ねて下さい )
例として、 source:/trunk/COPYING はデフォルトリポジトリの /trunk/COPYING へのパスを指します。一方で、 source:/projectA/trunk/COPYING は projectA という名前のリポジトリの /trunk/COPYING へのパスを示します。もし、 'projectA' がデフォルトリポジトリへのエイリアスであるか、 '' (デフォルトリポジトリ) が 'projectA' リポジトリへのエイリアスであるならば、同じファイルを指していることになります。
source: リンク
aliases: browser:, repos:
source:/some/path 形式のリンクは、パスがディレクトリを指している場合は、そのディレクトリを開き、 それ以外の場合は最新のリビジョンのファイルの内容を表示します。
特定のリビジョンを指定してリンクすることもできます :
- source:/some/file@123 - file のリビジョン 123 にリンクします
- source:/some/file@head - 明示的に file の最新リビジョンにリンクします
リビジョンを指定した場合はさらに特定の行番号にリンクすることさえできます :
- source:/some/file@123#L10
- source:/tag/0.10@head#L10
さらに、特定の行をハイライト表示することもできます :
- source:/some/file@123:10-20,100,103#L99 - 10 行目から 20 行目、 100 行目、 103 行目をハイライトします (0.11 以降)
マルチリポジトリ使用時は、リポジトリの名前が source: 以降のパスに統合されるので、 source:reponame/trunk/README のように記述するとリンクします。 (0.12 以降)
export: リンク
ブラウザでリンクをクリックしたときに、リポジトリ内をブラウザに表示するのではなく、ダウンロードを強制するためには export リンクを使用します。いくつかの形式が使用できます :
- export:/some/file - file の最新リビジョンをダウンロードします
- export:123:/some/file - file の リビジョン 123 をダウンロードします
- export:/some/file@123 - file の リビジョン 123 をダウンロードします
リポジトリにチェックインされている XML や HTML 文書を、正しいスタイルシートと画像で表示する場合などには非常に使いやすいですが、この方法を使うためには [browser] render_unsafe_content = yes (See TracIni#browser-section) を設定し、 Web ブラウザに内容を表示できるように設定しなければなりません。設定されていない場合、セキュリティを確保するため、そのファイルを Web ブラウザ上で表示せず、添付ファイルと同じようにダウンロードさせます。
特定のファイルの代わりにリポジトリのディレクトリのパスが指定されると、ソースブラウザはディレクトリを表示します (source:/some/dir と同じ) 。
log: リンク
log: リンクはリビジョンの範囲を表示するために使用します。最も単純な形式では、特定パスの最新のリビジョン群へのリンクを生成します。リビジョンを指定することで、最新以外の任意のリビジョンを表示することもできます。
- log:/ - リポジトリのルートディレクトリでの最新のリビジョン群
- log:/trunk/tools - trunk/tools での最新のリビジョン群
- log:/trunk/tools@10000 - trunk/tools での 10000 から始まるリビジョン群 (訳注: 10000 以前のリビジョン)
- log:@20788,20791:20795 - リビジョン 20788 と 20791 から 20795 までの範囲のリビジョンを表示する
- log:/trunk/tools@20788,20791:20795 - リビジョン 20788 と 20791 から 20795 までの範囲のリビジョンのうち、 /trunk/tools に影響したものを表示する
リビジョン範囲の短縮形式は以下の通りです:
- [20788,20791:20795]
- [20788,20791:20795/trunk/tools]
- r20791:20795 (ただし r20788,20791:20795 や r20791:20795/trunk は使用できません)
最後に、上記のすべてについて、リビジョン範囲の書式は x:y と x-y のどちらでも使用することができます。
マルチリポジトリ使用時は、リポジトリの名前が source: 以降のパスに統合されるので、 log:repos/branches や [20-40/repos] のように記述するとリンクします。
See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
