1 | | = Trac リンク = |
2 | | TracLinks は Trac の基礎となる機能です。というのも、 TracLinks によってシステムのエントリ間 - チケット、レポート、チェンジセット、Wikiページ、マイルストーン、ソースファイルなど - で簡単にハイパーリンクすることができるからです。 |
3 | | |
4 | | TracLinks は通常、 '''type:id''' (''id'' はコンポーネントの |
5 | | 番号や名前、パス) の形式で記述しますが、よく使われるコンポーネントについては、 |
6 | | 下の例のように表記を省略することもできます。 |
7 | | |
8 | | 例: |
9 | | * チケット: '''!#1''' or '''!ticket:1''' |
10 | | * チケットのコメント: '''!comment:ticket:1:2''' |
11 | | * レポート: '''!{1}''' or '''!report:1''' |
12 | | * チェンジセット: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' |
13 | | * リビジョンログ: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' |
14 | | * Diffs ([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''' or '''!diff:trunk/trac@3538//sandbox/vc-refactoring@3539''' |
15 | | * Wiki ページ: '''CamelCase''' or '''!wiki:CamelCase''' |
16 | | * マイルストーン: '''!milestone:1.0''' |
17 | | * 添付ファイル: '''!attachment:ticket:944:attachment.1073.diff''' |
18 | | * ファイル: '''!source:trunk/COPYING''' |
19 | | * あるリビジョンのファイル: '''!source:/trunk/COPYING#200''' |
20 | | * あるリビジョンのファイルのある行数: '''!source:/trunk/COPYING@200#L25''' |
21 | | 表示: |
22 | | * チケット: #1 or ticket:1 |
23 | | * チケットのコメント: comment:ticket:1:2 |
24 | | * レポート: {1} or report:1 |
25 | | * チェンジセット: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk |
26 | | * リビジョンログ: r1:3, [1:3] or log:@1:3, log:trunk@1:3 |
27 | | * Diffs ([http://trac.edgewall.org/milestone/0.10 0.10] 以降): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539 |
28 | | * Wiki ページ: CamelCase or wiki:CamelCase |
29 | | * マイルストーン: milestone:1.0 |
30 | | * 添付ファイル: attachment:ticket:944:attachment.1073.diff |
31 | | * ファイル: source:trunk/COPYING |
32 | | * あるリビジョンのファイル: source:/trunk/COPYING#200 |
33 | | * あるリビジョンのファイルのある行数: source:/trunk/COPYING@200#L25 |
34 | | |
35 | | '''Note:''' wiki:CamelCase の書式が使われることはほとんどありませんが、 |
36 | | ページ名が WikiPageNames のルールに従っていないページ (一文字、 |
37 | | アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 |
38 | | WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。 |
39 | | |
40 | | フル表記の (簡略形でない) Trac リンクでは、次のようにしてリンクタイトルを |
41 | | カスタマイズすることもできます: |
42 | | |
43 | | {{{ |
44 | | [ticket:1 これは1番目のチケットへのリンクです]. |
45 | | }}} |
46 | | |
47 | | 表示: [ticket:1 これは1番目のチケットへのリンクです]. |
48 | | |
49 | | タイトルが省略された場合、 ID のみ(コロンの後ろ側)が表示されます。 |
| 1 | = Trac Links = |
| 2 | [[TracGuideToc]] |
| 3 | |
| 4 | 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 WikiFormatting is used. |
| 5 | |
| 6 | TracLinks are generally of the form '''type:id''' (where ''id'' represents the |
| 7 | number, name or path of the item) though some frequently used kinds of items |
| 8 | also have short-hand notations. |
| 9 | |
| 10 | == Where to use TracLinks == |
| 11 | You can use TracLinks in: |
| 12 | |
| 13 | * Source code (Subversion) commit messages |
| 14 | * Wiki pages |
| 15 | * Full descriptions for tickets, reports and milestones |
| 16 | |
| 17 | and any other text fields explicitly marked as supporting WikiFormatting. |
| 18 | |
| 19 | Some examples: |
| 20 | * Tickets: '''!#1''' or '''!ticket:1''' |
| 21 | * Ticket comments: '''!comment:ticket:1:2''' |
| 22 | * Reports: '''!{1}''' or '''!report:1''' |
| 23 | * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''', '''![2:5/trunk]''' |
| 24 | * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' |
| 25 | * Diffs (requires [milestone:0.10 0.10]): '''!diff:@1:3''', '''!diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default''' or '''!diff:trunk/trac@3538//sandbox/vc-refactoring@3539''' |
| 26 | * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' |
| 27 | * Parent page: '''![..]''' |
| 28 | * Milestones: '''!milestone:1.0''' |
| 29 | * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' |
| 30 | * Files: '''!source:trunk/COPYING''' |
| 31 | * A specific file revision: '''!source:/trunk/COPYING@200''' |
| 32 | * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' |
| 33 | Display: |
| 34 | * Tickets: #1 or ticket:1 |
| 35 | * Ticket comments: comment:ticket:1:2 |
| 36 | * Reports: {1} or report:1 |
| 37 | * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk, [2:5/trunk] |
| 38 | * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 |
| 39 | * Diffs (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539 |
| 40 | * Wiki pages: CamelCase or wiki:CamelCase |
| 41 | * Parent page: '''[..]''' |
| 42 | * Milestones: milestone:1.0 |
| 43 | * Attachment: attachment:ticket:944:attachment.1073.diff |
| 44 | * Files: source:trunk/COPYING |
| 45 | * A specific file revision: source:/trunk/COPYING@200 |
| 46 | * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 |
| 47 | |
| 48 | '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to |
| 49 | pages whose names do not follow WikiPageNames rules, i.e., single words, |
| 50 | non-alphabetic characters, etc. See WikiPageNames for more about features specific |
| 51 | to links to Wiki page names. |
| 52 | |
| 53 | Trac links using the full (non-shorthand) notation can also be given a custom |
| 54 | link title like this: |
| 55 | |
| 56 | {{{ |
| 57 | [ticket:1 This is a link to ticket number one]. |
| 58 | }}} |
| 59 | |
| 60 | Display: [ticket:1 This is a link to ticket number one]. |
| 61 | |
| 62 | If the title is omitted, only the id (the part after the colon) is displayed: |
63 | | 表示: [SandBox the sandbox] |
64 | | |
65 | | TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクの追跡" がプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。 |
66 | | |
67 | | 以下に示すセクションは特定のリンクの種類の詳細について記述しています。 TracLinks の上級者向けの使用方法も同時に記述します。 |
68 | | |
69 | | == attachment: リンク == |
70 | | |
71 | | 添付ファイルへのリンクのシンタックスは次に示すとおりです: |
72 | | * !attachment:the_file.txt は、現在のオブジェクトに添付されたファイル the_file.txt へのリンクを生成します。 |
73 | | * !attachment:wiki:MyPage:the_file.txt は、 Wiki ページ !MyPage に添付されたファイル the_file.txt へのリンクを生成します。 |
74 | | * !attachment:ticket:753:the_file.txt は、チケット 753 に添付されたファイル the_file.txt へのリンクを生成します。 |
75 | | |
76 | | == ソースファイルへのリンク == |
77 | | |
78 | | source:/some/path 形式のリンクは、パスがディレクトリを示しているならば |
79 | | ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。 |
80 | | また、source:/some/file@123 のように表記することで、特定のリビジョンにリンクしたり、 |
81 | | source:/some/file@latest で、最新のリビジョンにリンクすることもできます。 |
82 | | リビジョンを特定している場合、 !source:/some/file@123#L10 の書式で特定の行にリンクすることができます。 |
83 | | |
84 | | == search: リンクと query: リンク == |
85 | | |
86 | | [wiki:TracSearch#リンク検索 "TracSearch#リンク検索"] と [wiki:TracQuery#TracLinksを使用する "TracQuery#TracLinks を使用する"] 参照。 |
87 | | |
88 | | == !SubWiki リンク == |
89 | | !SubWiki ページへ !SubWiki リンクするには '/' を使います。: |
90 | | {{{ |
91 | | [wiki:WikiPage/SubWikiPage]. |
92 | | }}} |
93 | | |
94 | | == InterWiki リンク == |
95 | | |
96 | | 他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページ、 InterMapTxt ページで定義されます。 他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。 |
97 | | |
98 | | == InterTrac リンク == |
99 | | |
100 | | 上記の TracLinks はすべて一つの TracEnvironment におけるものでした。他の TracEnvironment をあらわすプレフィックスにコロンを付けたものを TracLinks につけると、実際に他の TracEnvironment に存在するリソースを参照します。他の TracEnvironment は登録しなければなりません。詳しくは InterTrac を参照して下さい。 |
101 | | |
102 | | |
103 | | == サーバ上の相対リンク == |
104 | | |
105 | | サーバ上の静的コンテンツや、 `/register` ページ(訳注:一般的なアカウント登録用ページをあらわしています) |
106 | | など、 Trac リンク機能自体ではリンクを生成できないような同じサーバ上のオブジェクトにリンクすることが出来たら便利なこともあるでしょう。 |
107 | | サーバのルートからの絶対パスか |
108 | | 現在のページの URL からの相対リンクを指定するだけで、そのようなことを実現出来るようになりました: |
109 | | |
110 | | {{{ |
111 | | [../newticket newticket] |
| 76 | Display: [SandBox the sandbox] |
| 77 | |
| 78 | 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. |
| 79 | |
| 80 | |
| 81 | == Advanced use of TracLinks == |
| 82 | |
| 83 | === Relative links === |
| 84 | |
| 85 | To create a link to a specific anchor in a page, use '#': |
| 86 | {{{ |
| 87 | [#Relativelinks relative links] |
| 88 | }}} |
| 89 | Displays: |
| 90 | [#Relativelinks relative links] |
| 91 | |
| 92 | 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. |
| 93 | |
| 94 | To create a link to a SubWiki-page just use a '/': |
| 95 | {{{ |
| 96 | WikiPage/SubWikiPage or ./SubWikiPage |
| 97 | }}} |
| 98 | |
| 99 | To link from a SubWiki page to a parent, simply use a '..': |
| 100 | {{{ |
| 101 | [..] |
| 102 | }}} |
| 103 | |
| 104 | To link from a SubWiki page to a sibling page, use a '../': |
| 105 | {{{ |
| 106 | [../Sibling see next sibling] |
| 107 | }}} |
| 108 | |
| 109 | ''(Changed in 0.11)'' Note that in Trac 0.10, using e.g. `[../newticket]` may have worked for linking to the /newticket top-level URL, but now in 0.11 it will stay in the wiki namespace and link to a sibling page. See [#Server-relativelinks] for the new syntax. |
| 110 | |
| 111 | === InterWiki links === |
| 112 | |
| 113 | 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's a more specialized way to register other Trac environments which offers greater flexibility. |
| 114 | |
| 115 | === InterTrac links === |
| 116 | |
| 117 | This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. |
| 118 | |
| 119 | Any type of Trac links could be written in one Trac environment and actually refer to resources present in another Trac environment, provided the Trac link is prefixed by the name of that other Trac environment followed by a colon. That other Trac environment must be registered, under its name or an alias. See InterTrac for details. |
| 120 | |
| 121 | A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links usually have a way to understand the InterTrac prefixes. For example, links to Trac tickets can be written #T234 (if T was set as an alias for Trac), links to Trac changesets can be written [trac 1508]. |
| 122 | |
| 123 | === Server-relative links === |
| 124 | |
| 125 | It is often useful to be able to link to objects in your project that |
| 126 | have no built-in Trac linking mechanism, such as static resources, `newticket`, |
| 127 | a shared `/register` page on the server, etc. |
| 128 | |
| 129 | To link to resources inside the project, use either an absolute path from the project root, |
| 130 | or a relative link from the URL of the current page (''Changed in 0.11''): |
| 131 | |
| 132 | {{{ |
| 133 | [/newticket Create a new ticket] |
| 168 | |
| 169 | |
| 170 | === Parameterized Trac links === |
| 171 | |
| 172 | The Trac links target Trac resources which have generally more than one way to be rendered, according to some extra parameters. For example, a Wiki page can accept a `version` or a `format` parameter, a report can make use of dynamic variables, etc. |
| 173 | |
| 174 | Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: |
| 175 | - `wiki:WikiStart?format=txt` |
| 176 | - `ticket:1?version=1` |
| 177 | - `[/newticket?component=module1 create a ticket for module1]` |
| 178 | |
| 179 | |
| 180 | == TracLinks Reference == |
| 181 | The following sections describe the individual link types in detail, as well as several notes advanced usage of links. |
| 182 | |
| 183 | === attachment: links === |
| 184 | |
| 185 | The link syntax for attachments is as follows: |
| 186 | * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object |
| 187 | * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page |
| 188 | * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 |
| 189 | |
| 190 | === query: links === |
| 191 | |
| 192 | See TracQuery#UsingTracLinks and [#ticket:links]. |
| 193 | |
| 194 | === search: links === |
| 195 | |
| 196 | See TracSearch#SearchLinks |
| 197 | |
| 198 | === ticket: links === |
| 199 | |
| 200 | Besides the obvious `ticket:id` form, it is also possible to specify a list of tickets or even a range of tickets instead of the `id`. This generates a link to a custom query view containing this fixed set of tickets. |
| 201 | |
| 202 | Example: |
| 203 | - `ticket:5000-6000` |
| 204 | - `ticket:1,150` |
| 205 | |
| 206 | ''(since Trac 0.11)'' |
| 207 | |
| 208 | === timeline: links === |
| 209 | |
| 210 | Links to the timeline can be created by specifying a date in the ISO:8601 format. The date can be optionally followed by a time specification. The time is interpreted as being UTC time, but alternatively you can specify your local time, followed by your timezone if you don't want to compute the UTC time. |
| 211 | |
| 212 | Examples: |
| 213 | - `timeline:2008-01-29` |
| 214 | - `timeline:2008-01-29T15:48` |
| 215 | - `timeline:2008-01-29T16:48Z+01` |
| 216 | |
| 217 | ''(since Trac 0.11)'' |
| 218 | |
| 219 | === wiki: links === |
| 220 | |
| 221 | See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. |
| 222 | |
| 223 | === Version Control related links === |
| 224 | ==== source: links ==== |
| 225 | |
| 226 | The default behavior for a source:/some/path link is to open the directory browser |
| 227 | if the path points to a directory and otherwise open the log view. |
| 228 | |
| 229 | It's also possible to link directly to a specific revision of a file like this: |
| 230 | - `source:/some/file@123` - link to the file's revision 123 |
| 231 | - `source:/some/file@head` - link explicitly to the latest revision of the file |
| 232 | |
| 233 | If the revision is specified, one can even link to a specific line number: |
| 234 | - `source:/some/file@123#L10` |
| 235 | - `source:/tag/0.10@head#L10` |
| 236 | |
| 237 | Finally, one can also highlight an arbitrary set of lines: |
| 238 | - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103. |
| 239 | ''(since 0.11)'' |
| 240 | |
| 241 | ==== export: links ==== |
| 242 | |
| 243 | 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: |
| 244 | * `export:/some/file` - get the HEAD revision of the specified file |
| 245 | * `export:123:/some/file` - get revision 123 of the specified file |
| 246 | * `export:/some/file@123` - get revision 123 of the specified file |
| 247 | |
| 248 | This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository. |
| 249 | |
| 250 | 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`. |
| 251 | |
| 252 | ==== log: links ==== |
| 253 | |
| 254 | The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions from the specified path, but it can also support displaying an arbitrary set of revisions. |
| 255 | - `log:/` - the latest revisions starting at the root of the repository |
| 256 | - `log:/trunk/tools` - the latest revisions in `trunk/tools` |
| 257 | - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from revision 10000 |
| 258 | - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range |
| 259 | - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path |
| 260 | |
| 261 | There are short forms for revision ranges as well: |
| 262 | - `[20788,20791:20795]` |
| 263 | - `[20788,20791:20795/trunk/tools]` |
| 264 | - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`) |
| 265 | |
| 266 | Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`. |