Changes between Version 2 and Version 3 of TracLinks


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (15 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v2 v3  
    1 = Trac Links
    2 
     1= Trac Links =
    32[[TracGuideToc]]
    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 
     3
     4TracLinks 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
     6TracLinks are generally of the form '''type:id''' (where ''id'' represents the
     7number, name or path of the item) though some frequently used kinds of items
     8also have short-hand notations.
     9
     10== Where to use TracLinks ==
    1211You can use TracLinks in:
    1312
     
    1817and any other text fields explicitly marked as supporting WikiFormatting.
    1918
    20 == Overview
     19== Overview ==
    2120
    2221||= Wiki Markup =||= Display =||
     
    5251}}}
    5352
    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.
     53'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     54pages whose names do not follow WikiPageNames rules, i.e., single words,
     55non-alphabetic characters, etc. See WikiPageNames for more about features specific
     56to links to Wiki page names.
    5557
    5658
     
    103105TracLinks 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.
    104106
    105 == Advanced use of TracLinks
    106 
    107 === Relative links
     107
     108== Advanced use of TracLinks ==
     109
     110=== Relative links ===
    108111
    109112To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     
    125128
    126129But 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.
     130For resolving the location of a wiki link, it's the target page closest in the hierarchy
     131to the page where the link is written which will be selected. So for example, within
     132a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
    128133This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    129134
    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
     135In order to link explicitly to a [=#toplevel toplevel] Wiki page,
     136use 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.
     137
     138=== Link anchors ===
    133139
    134140To create a link to a specific anchor in a page, use '#':
     
    174180 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
    175181
    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
     182=== InterWiki links ===
     183
     184Other 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.
     185
     186=== InterTrac links ===
    181187
    182188This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     
    187193See InterTrac for the complete details.
    188194
    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''):
     195=== Server-relative links ===
     196
     197It is often useful to be able to link to objects in your project that
     198have no built-in Trac linking mechanism, such as static resources, `newticket`,
     199a shared `/register` page on the server, etc.
     200
     201To link to resources inside the project, use either an absolute path from the project root,
     202or a relative link from the URL of the current page (''Changed in 0.11''):
    194203
    195204{{{
     
    209218Display: [//register Register Here] or [[//register|Register Here]]
    210219
    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.
     220=== Quoting space in TracLinks ===
     221
     222Immediately after a TracLinks prefix, targets containing space characters should
     223be enclosed in a pair of quotes or double quotes.
    214224Examples:
    215225 * !wiki:"The whitespace convention"
     
    222232 * ![[attachment:the file.txt]]
    223233
    224 === Escaping Links
     234=== Escaping Links ===
    225235
    226236To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     
    234244 ![42] is not a link either.
    235245
    236 === Parameterized Trac links
     246
     247=== Parameterized Trac links ===
    237248
    238249Many 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.
     
    244255 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    245256
    246 == TracLinks Reference
    247 
     257
     258== TracLinks Reference ==
    248259The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    249260
    250 === attachment: links
     261=== attachment: links ===
    251262
    252263The link syntax for attachments is as follows:
     
    263274See also [#export:links].
    264275
    265 === comment: links
     276=== comment: links ===
    266277
    267278When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     
    274285 - `ticket:123#comment:description`
    275286
    276 === htdocs: links
     287=== htdocs: links ===
    277288
    278289Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
    279290
    280 === query: links
     291=== query: links ===
    281292
    282293See TracQuery#UsingTracLinks and [#ticket:links].
    283294
    284 === search: links
     295=== search: links ===
    285296
    286297See TracSearch#SearchLinks
    287298
    288 === ticket: links
    289 
    290  ''aliases:'' `bug:`, `issue:`
     299=== ticket: links ===
     300 ''alias:'' `bug:`
    291301
    292302Besides 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.
     
    296306 - `ticket:1,150`
    297307
    298 === timeline: links
     308=== timeline: links ===
    299309
    300310Links 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.
     
    308318 - `timeline:2008-01-29T16:48+01:00`
    309319
    310 === wiki: links
     320=== wiki: links ===
    311321
    312322See 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.
    313323
    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.
     324=== Version Control related links ===
     325
     326It 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).
    317327
    318328For 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'`.
    319329
    320 ==== source: links
    321 
     330==== source: links ====
    322331 ''aliases:'' `browser:`, `repos:`
    323332
    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.
     333The default behavior for a `source:/some/path link` is to open the browser in that directory directory
     334if the path points to a directory or to show the latest content of the file.
    325335
    326336It's also possible to link directly to a specific revision of a file like this:
    327337 - `source:/some/file@123` - link to the file's revision 123
    328338 - `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)
    330339
    331340If the revision is specified, one can even link to a specific line number:
    332341 - `source:/some/file@123#L10`
    333342 - `source:/tag/0.10@head#L10`
    334  - `source:/some/file@named-branch#L10`
    335343
    336344Finally, one can also highlight an arbitrary set of lines:
    337345 - `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.
     346 - 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
    339347
    340348Note 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)''
    341349
    342 ==== export: links
     350==== export: links ====
    343351
    344352To 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:
     
    346354 * `export:123:/some/file` - get revision 123 of the specified file
    347355 * `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).
    349356
    350357This 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.
     
    352359If 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`).
    353360
    354 ==== log: links
     361==== log: links ====
    355362
    356363The `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.
     
    360367 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    361368 - `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)
    363369
    364370There are short forms for revision ranges as well:
     
    373379----
    374380See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
     381