| 3 | | |
| 4 | | TracLinks は Trac の基礎となる機能です。というのも、 TracLinks によってシステムのエントリ間 - チケット、レポート、チェンジセット、Wikiページ、マイルストーン、ソースファイルなど - で簡単にハイパーリンクすることができるからです。 |
| 5 | | |
| 6 | | TracLinks は通常、 '''type:id''' (''id'' はアイテムの |
| 7 | | 番号や名前、パス) の形式で記述しますが、よく使われるコンポーネントについては、 |
| 8 | | 下の例のように表記を省略することもできます。 |
| 9 | | |
| 10 | | == TracLinks が使えるところ == #WheretouseTracLinks |
| 11 | | TracLinks が使えるのは: |
| 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 | | マイルストーン :: `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 or (特定パス配下) [1/trunk], changeset:1/trunk |
| 46 | | リビジョンログ :: r1:3, [1:3] or 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 | | }}} |
| 52 | | |
| 53 | | '''Note:''' wiki:CamelCase の書式が使われることはほとんどありませんが、 |
| 54 | | ページ名が WikiPageNames のルールに従っていないページ (一文字、 |
| 55 | | アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 |
| 56 | | WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。 |
| | 4 | [[PageOutline(2-5,Contents,pullout)]] |
| | 5 | |
| | 6 | TracLinks are a fundamental feature of Trac, because they allow easy hyperlinking between the various entities in the system — such as tickets, reports, changesets, Wiki pages, milestones, and source files — from anywhere where WikiFormatting is used. |
| | 7 | |
| | 8 | TracLinks are generally of the form '''type:id''' (where ''id'' represents the number, name or path of the item) though some frequently used kinds of items also have short-hand notations. |
| | 9 | |
| | 10 | == Where to use TracLinks |
| | 11 | |
| | 12 | You can use TracLinks in: |
| | 13 | |
| | 14 | * Source code (Subversion) commit messages |
| | 15 | * Wiki pages |
| | 16 | * Full descriptions for tickets, reports and milestones |
| | 17 | |
| | 18 | and any other text fields explicitly marked as supporting WikiFormatting. |
| | 19 | |
| | 20 | == Overview |
| | 21 | |
| | 22 | ||= Wiki Markup =||= Display =|| |
| | 23 | {{{#!td |
| | 24 | Wiki pages :: `CamelCase` or `wiki:CamelCase` |
| | 25 | Parent page :: `[..]` |
| | 26 | Tickets :: `#1` or `ticket:1` |
| | 27 | Ticket comments :: `comment:1:ticket:2` |
| | 28 | Reports :: `{1}` or `report:1` |
| | 29 | Milestones :: `milestone:1.0` |
| | 30 | Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path) |
| | 31 | Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`, `[1/repository]` |
| | 32 | Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]` |
| | 33 | Diffs :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`, |
| | 34 | `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` |
| | 35 | or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539` |
| | 36 | Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25) |
| | 37 | }}} |
| | 38 | {{{#!td |
| | 39 | Wiki pages :: CamelCase or wiki:CamelCase |
| | 40 | Parent page :: [..] |
| | 41 | Tickets :: #1 or ticket:1 |
| | 42 | Ticket comments :: comment:1:ticket:2 |
| | 43 | Reports :: {1} or report:1 |
| | 44 | Milestones :: milestone:1.0 |
| | 45 | Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) |
| | 46 | Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk, [1/repository] |
| | 47 | Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] |
| | 48 | Diffs :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953, |
| | 49 | diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default |
| | 50 | or diff:trunk/trac@3538//sandbox/vc-refactoring@3539 |
| | 51 | Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25) |
| | 52 | }}} |
| | 53 | |
| | 54 | '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to pages whose names do not follow WikiPageNames rules, ie single words, non-alphabetic characters, etc. See WikiPageNames for more about features specific to links to Wiki page names. |
| 105 | | TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクを追跡する" ことによってプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。 |
| 106 | | |
| 107 | | |
| 108 | | == TracLinks の高度な利用 == #AdvanceduseofTracLinks |
| 109 | | |
| 110 | | === 相対リンク === #Relativelinks |
| 111 | | |
| 112 | | [trac:/SubWiki SubWiki] ページにリンクするには '/' を使用します: |
| 113 | | {{{ |
| 114 | | WikiPage/SubWikiPage または ./SubWikiPage |
| 115 | | }}} |
| 116 | | |
| 117 | | [trac:SubWiki SubWiki] ページから親ページにリンクするには、 '..' を使用します: |
| 118 | | {{{ |
| 119 | | [..] または [[..]] |
| 120 | | }}} |
| 121 | | [..] または [[..]] |
| 122 | | |
| 123 | | [trac:SubWiki SubWiki] ページから [=#sibling 兄弟の位置にある] ページにリンクするには、 '../' を使用します: |
| 124 | | {{{ |
| 125 | | [../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]] |
| 126 | | }}} |
| 127 | | [../Sibling 次の兄弟ページ] または [[../Sibling|次の兄弟ページ]] |
| 128 | | |
| 129 | | しかし、兄弟の位置にあるページにリンクするために `../` プレフィックスを使用しない方がいい場合もあります。 |
| 130 | | Wiki リンクのロケーションを解決するとき、相対リンクではリンクを記述するページから階層内での近い位置にあるページが選択されます。 |
| 131 | | つまり、階層化されているページの場合、トップレベルにあるページよりも、兄弟の位置にあるページが優先されます。 |
| 132 | | プレフィックスを使用しない場合は [[WikiNewPage#renaming|ページ名変更]] による下位の階層へのページのコピーや移動の際に、 |
| 133 | | リンクを書き換える必要がなくなるので、簡単にできるようになります。 |
| 134 | | |
| 135 | | 明示的に [=#toplevel トップレベル] の Wiki ページへのリンクを記述する場合は、 |
| 136 | | `wiki:/` プレフィックスを使用してください。 |
| 137 | | ただし、 `/` プレフィックスを単独で使う場合 **Wiki ページへのリンクになりません**。 |
| 138 | | `/` で始まるリンクは [#Server-relativelinks サーバ相対リンク] のシンタックスとして解釈されるため、 |
| 139 | | `/wiki/` が付与されない、不完全な URL になってしまいます。 |
| 140 | | |
| 141 | | ''(0.11 で変更された箇所です)'' Trac 0.10 では `[../newticket]` のように書くと、トップレベル URL の `/newticket` にリンクする動作でした。しかし 0.11 では Wiki の名前空間にとどまり、兄弟の位置にあるページにリンクします。 |
| 142 | | 新しいシンタックスについては [#Server-relativelinks サーバ相対リンク] を参照してください。 |
| 143 | | |
| 144 | | === リンクアンカー === #Linkanchors |
| 145 | | |
| 146 | | ページ内の特定アンカーにリンクするには、'#'を使用してください: |
| 147 | | {{{ |
| 148 | | [#Linkanchors リンクアンカー] または [[#Linkanchors|リンクアンカー]] |
| 149 | | }}} |
| 150 | | [#Linkanchors リンクアンカー] または [[#Linkanchors|リンクアンカー]] |
| 151 | | |
| 152 | | Hint: セクションのタイトルにマウスオーバしたときに、文字 '¶' が表示されます。これはそのセクションへのリンクですので、 `#...` の部分をコピーすれば、相対リンクのアンカーとして使用できます。 |
| 153 | | |
| 154 | | ページ上に最初と最後に記載されている用語にリンクを作成するためには、'#/' または '#?'で始まる ''pseudo anchor'' を使用してください: |
| 155 | | {{{ |
| 156 | | [#/Milestone first occurrence of Milestone] または |
| | 103 | TracLinks are a very simple idea, but actually allow quite a complex network of information. In practice, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's happening in a project or why a particular change was made. |
| | 104 | |
| | 105 | == Advanced use of TracLinks |
| | 106 | |
| | 107 | === Relative links |
| | 108 | |
| | 109 | To create a link to a [trac:SubWiki SubWiki]-page just use a '/': |
| | 110 | {{{ |
| | 111 | WikiPage/SubWikiPage or ./SubWikiPage |
| | 112 | }}} |
| | 113 | |
| | 114 | To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': |
| | 115 | {{{ |
| | 116 | [..] or [[..]] |
| | 117 | }}} |
| | 118 | [..] or [[..]] |
| | 119 | |
| | 120 | To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': |
| | 121 | {{{ |
| | 122 | [../Sibling see next sibling] or [[../Sibling|see next sibling]] |
| | 123 | }}} |
| | 124 | [../Sibling see next sibling] or [[../Sibling|see next sibling]] |
| | 125 | |
| | 126 | But in practice you often won't need to add the `../` prefix to link to a sibling page. |
| | 127 | For resolving the location of a wiki link, it's the target page closest in the hierarchy to the page where the link is written which will be selected. So for example, within a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page. |
| | 128 | This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. |
| | 129 | |
| | 130 | To link explicitly to a [=#toplevel toplevel] Wiki page, use the `wiki:/` prefix. Be careful **not** to use the `/` prefix alone, as this corresponds to the [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/` part in the resulting URL. A link such as `[../newticket]` will stay in the wiki namespace and therefore link to a sibling page. |
| | 131 | |
| | 132 | === Link anchors |
| | 133 | |
| | 134 | To create a link to a specific anchor in a page, use '#': |
| | 135 | {{{ |
| | 136 | [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] |
| | 137 | }}} |
| | 138 | [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]] |
| | 139 | |
| | 140 | Hint: when you move your mouse over the title of a section, a '¶' character will be displayed. This is a link to that specific section and you can use this to copy the `#...` part inside a relative link to an anchor. |
| | 141 | |
| | 142 | To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?': |
| | 143 | {{{ |
| | 144 | [#/Milestone first occurrence of Milestone] or |
| 188 | | === InterWiki リンク === #InterWikilinks |
| 189 | | |
| 190 | | 他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページである InterMapTxt ページで定義されます。他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。 |
| 191 | | |
| 192 | | === InterTrac リンク === #InterTraclinks |
| 193 | | |
| 194 | | InterWiki リンクと同じ要領で使用できますが、リンクする対象を他の Trac プロジェクトに特化した機能です。 |
| 195 | | |
| 196 | | ある Trac Environment に記述される、どんな形式の Trac リンクであっても、他の Trac Environment のリソースを参照することができます。他の Trac Environment のリソースを指すためには、 Trac リンクのプレフィックスとして、リンク先の Trac Environment の名前とコロンを付与してください。このリンク先の Trac Environment は、名前そのものかエイリアスを、あらかじめ InterTrac に登録しておく必要があります。 |
| 197 | | |
| 198 | | InterWiki リンクに対する InterTrac リンクの利点は、 Trac リンクの短縮書式 (`{}`, `r`, `#` など) を使えることにあります。例えば、 Trac プロジェクトへのエイリアスとして T が設定されている場合、 Trac プロジェクトへのチケットへのリンクは `#T234` と書くことができ、 Trac プロジェクトへのチェンジセットへのリンクは `[trac 1508]` と書くことができます。 |
| 199 | | 完全な詳細は InterTrac を参照してください。 |
| 200 | | |
| 201 | | === サーバ相対リンク === #Server-relativelinks |
| 202 | | |
| 203 | | 静的リソースや `newticket` のような固定リンク、 `/register` ページのような |
| 204 | | サーバ内で共有するリソースなど、 Trac のリンク機構にビルトインされていない |
| 205 | | リソースに対して Project 内でリンクする機能は時折、有用になります。 |
| 206 | | |
| 207 | | Project 内のリソースにリンクするためには、 Project root からの絶対パスか、 |
| 208 | | 現在のページの URL からの相対リンクを使用します (''0.11 で変更された箇所です''): |
| 209 | | |
| 210 | | {{{ |
| 211 | | [/newticket 新規チケット作成] または [[//newticket|新規チケット作成]] |
| 212 | | [/ home] または [[/|home]] |
| 213 | | }}} |
| 214 | | |
| 215 | | 表示: [/newticket 新規チケット作成] または [[//newticket|新規チケット作成]] |
| 216 | | [/ home] または [[/|home]] |
| 217 | | |
| 218 | | サーバ上の他のロケーション (Project の外部だが同じ FQDN にホストされているリソース) にリンクするためには、 '//' リンクシンタックスを使用します (''0.11 で変更された箇所です''): |
| 219 | | |
| 220 | | {{{ |
| 221 | | [//register ここで登録します] または [[//register|ここで登録します]] |
| 222 | | }}} |
| 223 | | |
| 224 | | 表示: [//register ここで登録します] または [[//register|ここで登録します]] |
| 225 | | |
| 226 | | === Trac リンクで空白文字をエスケープする === #QuotingspaceinTracLinks |
| 227 | | |
| 228 | | TracLinks のプレフィックスの後ろにスペースを含んだターゲットがある場合、 |
| 229 | | シングルクォーテーションかダブルクォーテーションで囲みます。 |
| 230 | | 例: |
| | 176 | === InterWiki links |
| | 177 | |
| | 178 | Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there is a more specialized way to register other Trac environments which offers greater flexibility. |
| | 179 | |
| | 180 | === InterTrac links |
| | 181 | |
| | 182 | This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. |
| | 183 | |
| | 184 | Any type of Trac link can be written in one Trac environment and actually refer to resources in another Trac environment. All that is required is to prefix the Trac link with the name of the other Trac environment followed by a colon. The other Trac environment must be registered on the InterTrac page. |
| | 185 | |
| | 186 | A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links (e.g. `{}`, `r`, `#`) can also be used. For example if T was set as an alias for Trac, links to Trac tickets can be written #T234, links to Trac changesets can be written [trac 1508]. |
| | 187 | See InterTrac for the complete details. |
| | 188 | |
| | 189 | === Server-relative links |
| | 190 | |
| | 191 | It is often useful to be able to link to objects in your project that have no built-in Trac linking mechanism, such as static resources, `newticket`, a shared `/register` page on the server, etc. |
| | 192 | |
| | 193 | To link to resources inside the project, use either an absolute path from the project root, or a relative link from the URL of the current page (''Changed in 0.11''): |
| | 194 | |
| | 195 | {{{ |
| | 196 | [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] |
| | 197 | [/ home] or [[/|home]] |
| | 198 | }}} |
| | 199 | |
| | 200 | Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] |
| | 201 | [/ home] or [[/|home]] |
| | 202 | |
| | 203 | To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''): |
| | 204 | |
| | 205 | {{{ |
| | 206 | [//register Register Here] or [[//register|Register Here]] |
| | 207 | }}} |
| | 208 | |
| | 209 | Display: [//register Register Here] or [[//register|Register Here]] |
| | 210 | |
| | 211 | === Quoting space in TracLinks |
| | 212 | |
| | 213 | Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes. |
| | 214 | Examples: |
| 260 | | - `[/newticket?component=module1 module1 についてのチケットを新規登録]` |
| 261 | | - `[/newticket?summary=Add+short+description+here 空白文字を含む場合]` |
| 262 | | |
| 263 | | |
| 264 | | == TracLinks リファレンス == #TracLinksReference |
| 265 | | 以下に示すセクションは特定のリンクの種類の詳細について記述しています。 TracLinks の上級者向けの使用方法も同時に記述します。 |
| 266 | | |
| 267 | | === attachment: リンク === #attachment:links |
| 268 | | |
| 269 | | 添付ファイルへのリンクのシンタックスは次に示すとおりです: |
| 270 | | * !attachment:the_file.txt は、現在のオブジェクトに添付されたファイル the_file.txt へのリンクを生成します |
| 271 | | * !attachment:the_file.txt:wiki:MyPage は、 Wiki ページ !MyPage に添付されたファイル the_file.txt へのリンクを生成します |
| 272 | | * !attachment:the_file.txt:ticket:753 は、チケット 753 に添付されたファイル the_file.txt へのリンクを生成します |
| 273 | | |
| 274 | | Note: 古い記法ではファイル名を最後に書いていました。この記法はまだ使うことができます: !attachment:ticket:753:the_file.txt |
| 275 | | |
| 276 | | 添付ファイルページではなく、添付ファイルの内容に直接リンクしたい場合は `attachment:` の代わりに `raw-attachment:` を使用してください。 |
| 277 | | |
| 278 | | このリンクは HTML ドキュメントなどを直接指す目的では使いやすいですが、この方法を使うためには `[attachment] render_unsafe_content = yes` (See TracIni#attachment-section) を設定し、 Web ブラウザに内容を表示できるように設定しなければなりません。注意: この設定を行うのはファイルを添付するユーザのことを 100% 信頼できる場合だけにしてください。そうでない場合、サイトが [http://ja.wikipedia.org/wiki/クロスサイトスクリプティング クロスサイトスクリプティング] 攻撃に晒されることになります。 |
| 279 | | |
| 280 | | [#export:links] を参照してください。 |
| 281 | | |
| 282 | | === comment: リンク === #comment:links |
| 283 | | |
| 284 | | 該当するチケットの内部では、 !comment:3 と書くと 3 番目の更新のコメントにリンクします。 |
| 285 | | それ以外の場所であっても、チケットを特定することで、どこからでもコメントへのリンクが可能です: |
| 286 | | - `comment:3:ticket:123` |
| 287 | | - `ticket:123#comment:3` (Note: `#123#!comment:3` という書き方は間違っています!) |
| 288 | | チケットの説明 (英語版では description) にリンクしたい場合、以下のように記述してください: |
| 289 | | - `comment:description` (該当するチケットの内部) |
| | 243 | - `[/newticket?component=module1 create a ticket for module1]` |
| | 244 | - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]` |
| | 245 | |
| | 246 | == TracLinks Reference |
| | 247 | |
| | 248 | The following sections describe the individual link types in detail, as well as notes on advanced usage of links. |
| | 249 | |
| | 250 | === attachment: links |
| | 251 | |
| | 252 | The link syntax for attachments is as follows: |
| | 253 | * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object |
| | 254 | * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page |
| | 255 | * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753 |
| | 256 | |
| | 257 | Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt. |
| | 258 | |
| | 259 | If you'd like to create a direct link to the content of the attached file instead of a link to the attachment page, simply use `raw-attachment:` instead of `attachment:`. |
| | 260 | |
| | 261 | This can be useful for pointing directly to an HTML document, for example. Note that for this use case, you'd have to allow the web browser to render the content by setting `[attachment] render_unsafe_content = yes` (see TracIni#attachment-section). Caveat: only do that in environments for which you're 100% confident you can trust the people who are able to attach files, as otherwise this would open up your site to [wikipedia:Cross-site_scripting cross-site scripting] attacks. |
| | 262 | |
| | 263 | See also [#export:links]. |
| | 264 | |
| | 265 | === comment: links |
| | 266 | |
| | 267 | When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. |
| | 268 | It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: |
| | 269 | - `comment:3:ticket:123` |
| | 270 | - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!) |
| | 271 | It is also possible to link to the ticket's description using one of the following syntax: |
| | 272 | - `comment:description` (within the ticket) |
| 325 | | |
| 326 | | ''(Trac 0.11 以降)'' |
| 327 | | |
| 328 | | === wiki: リンク === #wiki:links |
| 329 | | |
| 330 | | WikiPageNames と、このページの [#QuotingspaceinTracLinks Trac リンクで空白文字をエスケープする] を参照してください。WikiStart@1 といった構文を使用することで、リビジョンを指定してページへのリンクを生成することが可能です。 |
| 331 | | |
| 332 | | === バージョン管理に関連するリンク === #VersionControlrelatedlinks |
| 333 | | |
| 334 | | 複数リポジトリのサポートは、リポジトリ名称に対応したトップレベルのフォルダ配下のバージョン管理されたファイルへの仮想の名前空間を作ることによって動作します。それゆえ、下記に詳細を示しますが、複数リポジトリが存在する中での Trac リンクのシンタックス、 ''/path'' の指定では、リポジトリの名前から始める必要があります。省略された場合は、デフォルトリポジトリが使用されます。デフォルトリポジトリのトップレベルのフォルダにリポジトリと同じ名前のものが存在する場合は、フォルダ名称が使用されます。これらのフォルダには、完全修飾名でいつでもアクセスすることができます。( デフォルトリポジトリは、名前付きのリポジトリのエイリアスの一つなので、逆に言えばデフォルトリポジトリのエイリアスはいつでも作成することができます。 Trac の管理者に尋ねて下さい ) |
| 335 | | |
| 336 | | 例として、 `source:/trunk/COPYING` はデフォルトリポジトリの `/trunk/COPYING` へのパスを指します。一方で、 `source:/projectA/trunk/COPYING` は `projectA` という名前のリポジトリの `/trunk/COPYING` へのパスを示します。もし、 `'projectA'` がデフォルトリポジトリへのエイリアスであるか、 `''` (デフォルトリポジトリ) が `'projectA'` リポジトリへのエイリアスであるならば、同じファイルを指していることになります。 |
| 337 | | |
| 338 | | ==== source: リンク ==== #source:links |
| | 307 | - `timeline:2008-01-29T16:48+0100` |
| | 308 | - `timeline:2008-01-29T16:48+01:00` |
| | 309 | |
| | 310 | === wiki: links |
| | 311 | |
| | 312 | See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. It is possible to create a link to a specific page revision using the syntax WikiStart@1. |
| | 313 | |
| | 314 | === Version Control related links |
| | 315 | |
| | 316 | It should be noted that multiple repository support works by creating a kind of virtual namespace for versioned files in which the toplevel folders correspond to the repository names. Therefore, in presence of multiple repositories, a ''/path'' specification in the syntax of links detailed below should start with the name of the repository. If omitted, the default repository is used. In case a toplevel folder of the default repository has the same name as a repository, the latter "wins". One can always access such folder by fully qualifying it. The default repository can be an alias of a named repository, or conversely, it is always possible to create an alias for the default repository, ask your Trac administrator. |
| | 317 | |
| | 318 | For example, `source:/trunk/COPYING` targets the path `/trunk/COPYING` in the default repository, whereas `source:/projectA/trunk/COPYING` targets the path `/trunk/COPYING` in the repository named `projectA`. This can be the same file if `'projectA'` is an alias to the default repository or if `''` (the default repository) is an alias to `'projectA'`. |
| | 319 | |
| | 320 | ==== source: links |
| | 321 | |
| 351 | | |
| 352 | | さらに、特定の行をハイライト表示することもできます : |
| 353 | | - `source:/some/file@123:10-20,100,103#L99` - 10 行目から 20 行目、 100 行目、 103 行目をハイライトします |
| 354 | | ''(0.11 以降)'' |
| 355 | | |
| 356 | | マルチリポジトリ使用時は、リポジトリの名前が `source:` 以降のパスに統合されるので、 `source:reponame/trunk/README` のように記述するとリンクします。 ''(0.12 以降)'' |
| 357 | | |
| 358 | | ==== export: リンク ==== #export:links |
| 359 | | |
| 360 | | ブラウザでリンクをクリックしたときに、リポジトリ内をブラウザに表示するのではなく、ダウンロードを強制するためには `export` リンクを使用します。いくつかの形式が使用できます : |
| 361 | | * `export:/some/file` - file の最新リビジョンをダウンロードします |
| 362 | | * `export:123:/some/file` - file の リビジョン 123 をダウンロードします |
| 363 | | * `export:/some/file@123` - file の リビジョン 123 をダウンロードします |
| 364 | | |
| 365 | | リポジトリにチェックインされている XML や HTML 文書を、正しいスタイルシートと画像で表示する場合などには非常に使いやすいですが、この方法を使うためには `[browser] render_unsafe_content = yes` (See TracIni#browser-section) を設定し、 Web ブラウザに内容を表示できるように設定しなければなりません。設定されていない場合、セキュリティを確保するため、そのファイルを Web ブラウザ上で表示せず、添付ファイルと同じようにダウンロードさせます。 |
| 366 | | |
| 367 | | 特定のファイルの代わりにリポジトリのディレクトリのパスが指定されると、ソースブラウザはディレクトリを表示します (`source:/some/dir` と同じ) 。 |
| 368 | | |
| 369 | | ==== log: リンク ==== #log:links |
| 370 | | |
| 371 | | `log:` リンクはリビジョンの範囲を表示するために使用します。最も単純な形式では、特定パスの最新のリビジョン群へのリンクを生成します。リビジョンを指定することで、最新以外の任意のリビジョンを表示することもできます。 |
| 372 | | - `log:/` - リポジトリのルートディレクトリでの最新のリビジョン群 |
| 373 | | - `log:/trunk/tools` - `trunk/tools` での最新のリビジョン群 |
| 374 | | - `log:/trunk/tools@10000` - `trunk/tools` での 10000 から始まるリビジョン群 (訳注: 10000 以前のリビジョン) |
| 375 | | - `log:@20788,20791:20795` - リビジョン 20788 と 20791 から 20795 までの範囲のリビジョンを表示する |
| 376 | | - `log:/trunk/tools@20788,20791:20795` - リビジョン 20788 と 20791 から 20795 までの範囲のリビジョンのうち、 `/trunk/tools` に影響したものを表示する |
| 377 | | |
| 378 | | リビジョン範囲の短縮形式は以下の通りです: |
| | 334 | - `source:/some/file@named-branch#L10` |
| | 335 | |
| | 336 | Finally, one can also highlight an arbitrary set of lines: |
| | 337 | - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99 |
| | 338 | - or without version number (the `@` is still needed): `source:/some/file@:10-20,100,103#L99`. Version can be omitted when the path is pointing to a source file that will no longer change (like `source:/tags/...`), otherwise it's better to specify which lines of //which version// of the file you're talking about. |
| | 339 | |
| | 340 | Note that in presence of multiple repositories, the name of the repository is simply integrated in the path you specify for `source:` (e.g. `source:reponame/trunk/README`). ''(since 0.12)'' |
| | 341 | |
| | 342 | ==== export: links |
| | 343 | |
| | 344 | To force the download of a file in the repository, as opposed to displaying it in the browser, use the `export` link. Several forms are available: |
| | 345 | * `export:/some/file` - get the HEAD revision of the specified file |
| | 346 | * `export:123:/some/file` - get revision 123 of the specified file |
| | 347 | * `export:/some/file@123` - get revision 123 of the specified file |
| | 348 | * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial). |
| | 349 | |
| | 350 | This can be very useful for displaying XML or HTML documentation with correct stylesheets and images, in case that has been checked in into the repository. Note that for this use case, you'd have to allow the web browser to render the content by setting `[browser] render_unsafe_content = yes` (see TracIni#browser-section), otherwise Trac will force the files to be downloaded as attachments for security concerns. |
| | 351 | |
| | 352 | If the path is to a directory in the repository instead of a specific file, the source browser will be used to display the directory (identical to the result of `source:/some/dir`). |
| | 353 | |
| | 354 | ==== log: links |
| | 355 | |
| | 356 | The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions of the specified path, but it can also support displaying an arbitrary set of revisions. |
| | 357 | - `log:/` - the latest revisions starting at the root of the repository |
| | 358 | - `log:/trunk/tools` - the latest revisions in `trunk/tools` |
| | 359 | - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000 |
| | 360 | - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 |
| | 361 | - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path |
| | 362 | - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial) |
| | 363 | |
| | 364 | There are short forms for revision ranges as well: |
