wiki:TracLinks

Version 1 (modified by trac, 18 years ago) (diff)

--

Trac リンク

Trac リンク は Trac にとって根幹となる機能です。

Trac リンク は WikiFormatting を使用しているすべてのコンポーネントで、Tracコンポーネント(チケット、レポート、チェンジセット、 Wikiページ、マイルストーン、ソースファイル)間のハイパーリンクを可能にします。

Trac リンク は通常、 type:id( id はコンポーネントの 番号や名前、パス)の形式で記述しますが、よく使われるコンポーネントについては、 下の例のように表記を省略することもできます。

例:

  • チケット: #1 or ticket:1
  • レポート: {1} or report:1
  • チェンジセット: r1, [1] or changeset:1
  • コミットログ: r1:3, [1:3] or log:#1:3
  • Wiki ページ: CamelCase or wiki:CamelCase
  • マイルストーン: milestone:1.0
  • 添付ファイル: attachment:ticket:944:attachment.1073.diff
  • ファイル: source:trunk/COPYING
  • あるリビジョンのファイル: source:/trunk/COPYING#200

表示:

Note: wiki:CamelCase の書式が使われることはほとんどありませんが、 ページ名が WikiPageNames のルールに従っていないページ(一文字、 アルファベット以外の文字、etc.)をリンクしたい場合には便利です。

フル表記の(簡略形でない) Trac リンクでは、次のようにしてリンクタイトルを カスタマイズすることもできます: 

[ticket:1 これは1番目のチケットへのリンクです].

表示: これは1番目のチケットへのリンクです.

タイトルが省略された場合、 ID のみ（コロンの後ろ側）が表示されます。 

[ticket:1]

表示: 1

これは一見、全くシンプルな概念に見えるかもしれませんが、複雑に入り組んだ情報を横断することができるようになります。実用面でも、使い方はとても直感的で簡単です。そして、この "リンクの軌跡" が、プロジェクトで起きていることや、特定の変更が行われた経緯について理解を深めるのに非常に役に立つでしょう。

添付ファイルへのリンク

添付ファイルへのリンクのシンタックスは次に示すとおりです:

  • attachment:the_file.txt は、現在のオブジェクトに添付されたファイル the_file.txt へのリンクを生成します。
  • attachment:wiki:MyPage:the_file.txt は、 Wiki ページ MyPage に添付されたファイル the_file.txt へのリンクを生成します。
  • attachment:ticket:753:the_file.txt は、チケット 753 に添付されたファイル the_file.txt へのリンクを生成します。

ソースファイルへのリンク

source:/some/path 形式のリンクは、パスがディレクトリを示しているならば ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。 また、source:/some/file@123 のように表記することで、特定のリビジョンにリンクしたり、 source:/some/file@latest で、最新のリビジョンにリンクすることもできます。 リビジョンを特定している場合、 source:/some/file@123#L10 の書式で特定の行にリンクすることができます。

Trac リンクで空白文字をエスケープする

空白文字をエスケープする場合のシンタックスは次の通りです:

  • attachment:'the file.txt' もしくは
  • attachment:"the file.txt"

TracLinks が使えるところ

TracLinks が使えるのは:

  • ソースコード (Subverison) のコミットログ
  • Wikiページ
  • チケット、レポート、マイルストーンでの説明記述箇所

その他、WikiFormatting をサポートしていることが明示されているすべてのテキストフィールド。

リンクの無効化

TracLinks を無効化するには、先頭に'!' (エクスクラメーションマーク)を付けます。 

 !NoLinkHere.
 ![42] is not a link either.

表示:

NoLinkHere. [42] is not a link either.

See also: WikiFormatting, TracWiki