19 | | Some examples: |
20 | | * Tickets: '''!#1''' or '''!ticket:1''' |
21 | | * Ticket comments: '''!comment:1:ticket:2''' |
22 | | * Reports: '''!{1}''' or '''!report:1''' |
23 | | * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' |
24 | | * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]''' |
25 | | * Diffs (requires [trac: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:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944''' |
30 | | (absolute path) |
31 | | * Files: '''!source:trunk/COPYING''' |
32 | | * A specific file revision: '''!source:/trunk/COPYING@200''' |
33 | | * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' |
34 | | Display: |
35 | | * Tickets: #1 or ticket:1 |
36 | | * Ticket comments: comment:1:ticket:2 |
37 | | * Reports: {1} or report:1 |
38 | | * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk |
39 | | * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] |
40 | | * 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 |
41 | | * Wiki pages: CamelCase or wiki:CamelCase |
42 | | * Parent page: [..] |
43 | | * Milestones: milestone:1.0 |
44 | | * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 |
45 | | (absolute path) |
46 | | * Files: source:trunk/COPYING |
47 | | * A specific file revision: source:/trunk/COPYING@200 |
48 | | * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 |
49 | | |
50 | | '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to |
51 | | pages whose names do not follow WikiPageNames rules, i.e., single words, |
52 | | non-alphabetic characters, etc. See WikiPageNames for more about features specific |
53 | | to links to Wiki page names. |
54 | | |
55 | | Trac links using the full (non-shorthand) notation can also be given a custom |
56 | | link title like this: |
57 | | |
58 | | {{{ |
59 | | [ticket:1 This is a link to ticket number one]. |
60 | | }}} |
61 | | |
62 | | Display: [ticket:1 This is a link to ticket number one]. |
63 | | |
64 | | If the title is omitted, only the id (the part after the colon) is displayed: |
65 | | |
66 | | {{{ |
67 | | [ticket:1] |
68 | | }}} |
69 | | |
70 | | Display: [ticket:1] |
71 | | |
72 | | `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''): |
73 | | |
74 | | {{{ |
75 | | [SandBox the sandbox] |
76 | | }}} |
77 | | |
78 | | Display: [SandBox the sandbox] |
| 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. |
| 55 | |
| 56 | |
| 57 | {{{#!table class="" |
| 58 | |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: || |
| 59 | {{{#!td |
| 60 | {{{ |
| 61 | [ticket:1 This is a link to ticket number one] or |
| 62 | [[ticket:1|This is another link to ticket number one]]. |
| 63 | }}} |
| 64 | }}} |
| 65 | {{{#!td |
| 66 | [ticket:1 This is a link to ticket number one] or |
| 67 | [[ticket:1|This is another link to ticket number one]]. |
| 68 | }}} |
| 69 | |-------------------------------------------------------------------------------------- |
| 70 | |||| If the title is omitted, only the id (the part after the colon) is displayed: || |
| 71 | {{{#!td |
| 72 | {{{ |
| 73 | [ticket:1] or [[ticket:2]] |
| 74 | }}} |
| 75 | }}} |
| 76 | {{{#!td |
| 77 | [ticket:1] or [[ticket:2]] |
| 78 | }}} |
| 79 | |-------------------------------------------------------------------------------------- |
| 80 | |||| `wiki` is the default if the namespace part of a full link is omitted: || |
| 81 | {{{#!td |
| 82 | {{{ |
| 83 | [SandBox the sandbox] or |
| 84 | [[SandBox|the sandbox]] |
| 85 | }}} |
| 86 | }}} |
| 87 | {{{#!td |
| 88 | [SandBox the sandbox] or |
| 89 | [[SandBox|the sandbox]] |
| 90 | }}} |
| 91 | |-------------------------------------------------------------------------------------- |
| 92 | |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >) || |
| 93 | {{{#!td |
| 94 | {{{ |
| 95 | <wiki:Strange(page@!)> |
| 96 | }}} |
| 97 | }}} |
| 98 | {{{#!td |
| 99 | <wiki:Strange(page@!)> |
| 100 | }}} |
| 101 | }}} |
96 | | To create a link to a [trac:SubWiki SubWiki]-page just use a '/': |
97 | | {{{ |
98 | | WikiPage/SubWikiPage or ./SubWikiPage |
99 | | }}} |
100 | | |
101 | | To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': |
102 | | {{{ |
103 | | [..] |
104 | | }}} |
105 | | |
106 | | To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../': |
107 | | {{{ |
108 | | [../Sibling see next sibling] |
109 | | }}} |
110 | | |
111 | | ''(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. |
112 | | |
113 | | === InterWiki links === |
114 | | |
115 | | 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. |
116 | | |
117 | | === InterTrac links === |
| 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 |
| 145 | [#?Milestone last occurrence of Milestone] |
| 146 | }}} |
| 147 | [#/Milestone first occurrence of Milestone] or |
| 148 | [#?Milestone last occurrence of Milestone] |
| 149 | This will also highlight all other matches on the linked page. By default only case sensitive matches are considered. To include case insensitive matches append '/i': |
| 150 | {{{ |
| 151 | [#/Milestone/i first occurrence of Milestone or milestone] or |
| 152 | [#?Milestone/i last occurrence of Milestone or milestone] |
| 153 | }}} |
| 154 | [#/Milestone/i first occurrence of Milestone or milestone] or |
| 155 | [#?Milestone/i last occurrence of Milestone or milestone] |
| 156 | |
| 157 | ''(since Trac 1.0)'' |
| 158 | |
| 159 | Such anchors can be very useful for linking to specific lines in a file in the source browser: |
| 160 | {{{ |
| 161 | [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or |
| 162 | [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47] |
| 163 | }}} |
| 164 | [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or |
| 165 | [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47] |
| 166 | (Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.) |
| 167 | |
| 168 | Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead: |
| 169 | {{{ |
| 170 | [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or |
| 171 | [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] |
| 172 | }}} |
| 173 | [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or |
| 174 | [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider] |
| 175 | |
| 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 |
121 | | 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. |
122 | | |
123 | | 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]. |
124 | | |
125 | | === Server-relative links === |
126 | | |
127 | | It is often useful to be able to link to objects in your project that |
128 | | have no built-in Trac linking mechanism, such as static resources, `newticket`, |
129 | | a shared `/register` page on the server, etc. |
130 | | |
131 | | To link to resources inside the project, use either an absolute path from the project root, |
132 | | or a relative link from the URL of the current page (''Changed in 0.11''): |
133 | | |
134 | | {{{ |
135 | | [/newticket Create a new ticket] |
136 | | [/ home] |
137 | | }}} |
138 | | |
139 | | Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]] [/ home] |
140 | | |
141 | | To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): |
142 | | |
143 | | {{{ |
144 | | [//register Register Here] |
145 | | }}} |
146 | | |
147 | | Display: [//register Register Here] |
148 | | |
149 | | === Quoting space in TracLinks === |
150 | | |
151 | | Immediately after a TracLinks prefix, targets containing space characters should |
152 | | be enclosed in a pair of quotes or double quotes. |
| 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. |
232 | | - `timeline:2008-01-29T16:48Z+01` |
233 | | |
234 | | ''(since Trac 0.11)'' |
235 | | |
236 | | === wiki: links === |
237 | | |
238 | | See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. |
239 | | |
240 | | === Version Control related links === |
241 | | ==== source: links ==== |
242 | | |
243 | | The default behavior for a source:/some/path link is to open the directory browser |
244 | | if the path points to a directory and otherwise open the log view. |
| 305 | - `timeline:2008-01-29T15:48Z` |
| 306 | - `timeline:2008-01-29T16:48+01` |
| 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 | |
| 322 | ''aliases:'' `browser:`, `repos:` |
| 323 | |
| 324 | The default behavior for a `source:/some/path link` is to open the browser in that directory directory if the path points to a directory or to show the latest content of the file. |