Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
Jul 6, 2018 6:12:51 AM (16 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v2 v3  
    1 = Trac Links =
     1= Trac Links
     2
    23[[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 ==
     4[[PageOutline(2-5,Contents,pullout)]]
     5
     6TracLinks 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
     8TracLinks 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
    1112You can use TracLinks in:
    1213
     
    1718and any other text fields explicitly marked as supporting WikiFormatting.
    1819
    19 == Overview ==
     20== Overview
    2021
    2122||= Wiki Markup =||= Display =||
     
    2829 Milestones :: `milestone:1.0`
    2930 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
    30  Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`
     31 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`, `[1/repository]`
    3132 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
    3233 Diffs :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`,
     
    4344 Milestones :: milestone:1.0
    4445 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
    45  Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
     46 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk, [1/repository]
    4647 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    4748 Diffs :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953,
     
    5152}}}
    5253
    53 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    54 pages whose names do not follow WikiPageNames rules, i.e., single words,
    55 non-alphabetic characters, etc. See WikiPageNames for more about features specific
    56 to links to Wiki page names.
     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.
    5755
    5856
     
    105103TracLinks 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.
    106104
    107 
    108 == Advanced use of TracLinks ==
    109 
    110 === Relative links ===
     105== Advanced use of TracLinks
     106
     107=== Relative links
     108
     109To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     110{{{
     111 WikiPage/SubWikiPage or ./SubWikiPage
     112}}}
     113
     114To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     115{{{
     116  [..] or [[..]]
     117}}}
     118  [..] or [[..]]
     119
     120To 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
     126But in practice you often won't need to add the `../` prefix to link to a sibling page.
     127For 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.
     128This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
     129
     130To 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
    111133
    112134To create a link to a specific anchor in a page, use '#':
    113135{{{
    114  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
    115 }}}
    116 Displays:
    117   [#Relativelinks relative links] or [[#Relativelinks|relative links]]
     136 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
     137}}}
     138  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
    118139
    119140Hint: 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.
    120141
    121 To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
    122 {{{
    123  WikiPage/SubWikiPage or ./SubWikiPage
    124 }}}
    125 
    126 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
    127 {{{
    128   [..] or [[..]]
    129 }}}
    130   [..] or [[..]]
    131 
    132 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
    133 {{{
    134   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    135 }}}
    136   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    137 
    138 But in practice you often won't need to add the `../` prefix to link to a sibling page.
    139 For resolving the location of a wiki link, it's the target page closest in the hierarchy
    140 to the page where the link is written which will be selected. So for example, within
    141 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
    142 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    143 
    144 In order to link explicitly to a [=#toplevel toplevel] Wiki page,
    145 use the `wiki:/` prefix.
    146 Be careful **not** to use the `/` prefix alone, as this corresponds to the
    147 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
    148 part in the resulting URL.
    149 
    150 ''(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 since 0.11, such a link will stay in the wiki namespace and therefore link to a sibling page.
    151 See [#Server-relativelinks] for the new syntax.
    152 
    153 === InterWiki links ===
    154 
    155 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.
    156 
    157 === InterTrac links ===
     142To 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]
     149This 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
     159Such 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
     168Since 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
     178Other 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
    158181
    159182This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     
    164187See InterTrac for the complete details.
    165188
    166 === Server-relative links ===
    167 
    168 It is often useful to be able to link to objects in your project that
    169 have no built-in Trac linking mechanism, such as static resources, `newticket`,
    170 a shared `/register` page on the server, etc.
    171 
    172 To link to resources inside the project, use either an absolute path from the project root,
    173 or a relative link from the URL of the current page (''Changed in 0.11''):
     189=== Server-relative links
     190
     191It 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
     193To 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''):
    174194
    175195{{{
     
    189209Display: [//register Register Here] or [[//register|Register Here]]
    190210
    191 === Quoting space in TracLinks ===
    192 
    193 Immediately after a TracLinks prefix, targets containing space characters should
    194 be enclosed in a pair of quotes or double quotes.
     211=== Quoting space in TracLinks
     212
     213Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes.
    195214Examples:
    196215 * !wiki:"The whitespace convention"
     
    203222 * ![[attachment:the file.txt]]
    204223
    205 === Escaping Links ===
     224=== Escaping Links
    206225
    207226To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     
    215234 ![42] is not a link either.
    216235
    217 
    218 === Parameterized Trac links ===
     236=== Parameterized Trac links
    219237
    220238Many Trac resources have more than one way to be rendered, depending on 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.
     
    226244 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    227245
    228 
    229 == TracLinks Reference ==
     246== TracLinks Reference
     247
    230248The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    231249
    232 === attachment: links ===
     250=== attachment: links
    233251
    234252The link syntax for attachments is as follows:
     
    245263See also [#export:links].
    246264
    247 === comment: links ===
     265=== comment: links
    248266
    249267When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     
    256274 - `ticket:123#comment:description`
    257275
    258 === htdocs: links ===
     276=== htdocs: links
    259277
    260278Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
    261279
    262 === query: links ===
     280=== query: links
    263281
    264282See TracQuery#UsingTracLinks and [#ticket:links].
    265283
    266 === search: links ===
     284=== search: links
    267285
    268286See TracSearch#SearchLinks
    269287
    270 === ticket: links ===
     288=== ticket: links
     289
    271290 ''alias:'' `bug:`
    272291
     
    277296 - `ticket:1,150`
    278297
    279 ''(since Trac 0.11)''
    280 
    281 === timeline: links ===
    282 
    283 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.
     298=== timeline: links
     299
     300Links 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 if you don't want to compute the UTC time, you can specify a local time followed by your timezone offset relative to UTC.
    284301
    285302Examples:
     
    288305 - `timeline:2008-01-29T15:48Z`
    289306 - `timeline:2008-01-29T16:48+01`
    290 
    291 ''(since Trac 0.11)''
    292 
    293 === wiki: links ===
     307 - `timeline:2008-01-29T16:48+0100`
     308 - `timeline:2008-01-29T16:48+01:00`
     309
     310=== wiki: links
    294311
    295312See 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.
    296313
    297 === Version Control related links ===
    298 
    299 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).
     314=== Version Control related links
     315
     316It 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.
    300317
    301318For 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'`.
    302319
    303 ==== source: links ====
     320==== source: links
     321
    304322 ''aliases:'' `browser:`, `repos:`
    305323
    306 The default behavior for a source:/some/path link is to open the browser in that directory directory
    307 if the path points to a directory or to show the latest content of the file.
     324The 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.
    308325
    309326It's also possible to link directly to a specific revision of a file like this:
    310327 - `source:/some/file@123` - link to the file's revision 123
    311328 - `source:/some/file@head` - link explicitly to the latest revision of the file
     329 - `source:/some/file@named-branch` - link to latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial)
    312330
    313331If the revision is specified, one can even link to a specific line number:
    314332 - `source:/some/file@123#L10`
    315333 - `source:/tag/0.10@head#L10`
     334 - `source:/some/file@named-branch#L10`
    316335
    317336Finally, one can also highlight an arbitrary set of lines:
    318  - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    319    ''(since 0.11)''
     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.
    320339
    321340Note 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)''
    322341
    323 ==== export: links ====
     342==== export: links
    324343
    325344To 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:
     
    327346 * `export:123:/some/file` - get revision 123 of the specified file
    328347 * `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).
    329349
    330350This 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.
     
    332352If 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`).
    333353
    334 ==== log: links ====
     354==== log: links
    335355
    336356The `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.
     
    340360 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    341361 - `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)
    342363
    343364There are short forms for revision ranges as well: