Edgewall Software

Changes between Initial Version and Version 1 of 1.1/TracLinks


Ignore:
Timestamp:
May 21, 2016, 5:48:50 AM (3 years ago)
Author:
Ryan J Ollos
Comment:

Copied from TracLinks@97.

Legend:

Unmodified
Added
Removed
Modified
  • 1.1/TracLinks

    v1 v1  
     1= Trac Links
     2
     3[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
     5[[TranslatedPages]]
     6
     7TracLinks 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.
     8
     9TracLinks 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.
     10
     11== Where to use TracLinks
     12
     13You can use TracLinks in:
     14
     15 * Source code (Subversion) commit messages
     16 * Wiki pages
     17 * Full descriptions for tickets, reports and milestones
     18
     19and any other text fields explicitly marked as supporting WikiFormatting.
     20
     21== Overview
     22
     23||= Wiki Markup =||= Display =||
     24{{{#!td
     25 Wiki pages :: `CamelCase` or `wiki:CamelCase`
     26 Parent page :: `[..]`
     27 Tickets :: `#1` or `ticket:1`
     28 Ticket comments :: `comment:1:ticket:2`
     29 Reports :: `{1}` or `report:1`
     30 Milestones :: `milestone:1.0`
     31 Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
     32 Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`, `[1/repository]`
     33 Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
     34 Diffs :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`,
     35          `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
     36          or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
     37 Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25)
     38}}}
     39{{{#!td
     40 Wiki pages :: CamelCase or wiki:CamelCase
     41 Parent page :: [..]
     42 Tickets :: #1 or ticket:1
     43 Ticket comments :: comment:1:ticket:2
     44 Reports :: {1} or report:1
     45 Milestones :: milestone:1.0
     46 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
     47 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk, [1/repository]
     48 Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
     49 Diffs :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953,
     50          diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
     51          or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
     52 Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25)
     53}}}
     54
     55'''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.
     56
     57
     58{{{#!table class=""
     59|||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
     60{{{#!td
     61{{{
     62[ticket:1 This is a link to ticket number one] or
     63[[ticket:1|This is another link to ticket number one]].
     64}}}
     65}}}
     66{{{#!td
     67[ticket:1 This is a link to ticket number one] or
     68[[ticket:1|This is another link to ticket number one]].
     69}}}
     70|--------------------------------------------------------------------------------------
     71|||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
     72{{{#!td
     73{{{
     74[ticket:1] or [[ticket:2]]
     75}}}
     76}}}
     77{{{#!td
     78[ticket:1] or [[ticket:2]]
     79}}}
     80|--------------------------------------------------------------------------------------
     81|||| `wiki` is the default if the namespace part of a full link is omitted:  ||
     82{{{#!td
     83{{{
     84[SandBox the sandbox] or
     85[[SandBox|the sandbox]]
     86}}}
     87}}}
     88{{{#!td
     89[SandBox the sandbox] or
     90[[SandBox|the sandbox]]
     91}}}
     92|--------------------------------------------------------------------------------------
     93|||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
     94{{{#!td
     95{{{
     96<wiki:Strange(page@!)>
     97}}}
     98}}}
     99{{{#!td
     100<wiki:Strange(page@!)>
     101}}}
     102}}}
     103
     104TracLinks 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.
     105
     106== Advanced use of TracLinks
     107
     108=== Relative links
     109
     110To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     111{{{
     112 WikiPage/SubWikiPage or ./SubWikiPage
     113}}}
     114
     115To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     116{{{
     117  [..] or [[..]]
     118}}}
     119  [..] or [[..]]
     120
     121To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
     122{{{
     123  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     124}}}
     125  [../Sibling see next sibling] or [[../Sibling|see next sibling]]
     126
     127But in practice you often won't need to add the `../` prefix to link to a sibling page.
     128For 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.
     129This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
     130
     131To 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.
     132
     133=== Link anchors
     134
     135To create a link to a specific anchor in a page, use '#':
     136{{{
     137 [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
     138}}}
     139  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
     140
     141Hint: 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.
     142
     143To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?':
     144{{{
     145 [#/Milestone first occurrence of Milestone] or
     146 [#?Milestone last occurrence of Milestone]
     147}}}
     148 [#/Milestone first occurrence of Milestone] or
     149 [#?Milestone last occurrence of Milestone]
     150This 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':
     151{{{
     152 [#/Milestone/i first occurrence of Milestone or milestone] or
     153 [#?Milestone/i last occurrence of Milestone or milestone]
     154}}}
     155 [#/Milestone/i first occurrence of Milestone or milestone] or
     156 [#?Milestone/i last occurrence of Milestone or milestone]
     157
     158''(since Trac 1.0)''
     159
     160Such anchors can be very useful for linking to specific lines in a file in the source browser:
     161{{{
     162 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or
     163 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
     164}}}
     165 [trac:source:tags/trac-0.12/trac/wiki/api.py#L127 Line 127] or
     166 [trac:source:tags/trac-0.12/trac/ticket/roadmap.py#L47 Line 47]
     167(Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.)
     168
     169Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead:
     170{{{
     171 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
     172 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
     173}}}
     174 [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
     175 [trac:source:trunk/trac/env.py#/ISystemInfoProvider ISystemInfoProvider]
     176
     177=== InterWiki links
     178
     179Other 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.
     180
     181=== InterTrac links
     182
     183This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     184
     185Any 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.
     186
     187A 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].
     188See InterTrac for the complete details.
     189
     190=== Server-relative links
     191
     192It 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.
     193
     194To 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
     196{{{
     197[/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     198[/ home] or [[/|home]]
     199}}}
     200
     201Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
     202[/ home] or [[/|home]]
     203
     204To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''):
     205
     206{{{
     207[//register Register Here] or [[//register|Register Here]]
     208}}}
     209
     210Display: [//register Register Here] or [[//register|Register Here]]
     211
     212=== Quoting space in TracLinks
     213
     214Immediately after a TracLinks prefix, targets containing space characters should be enclosed in a pair of quotes or double quotes.
     215Examples:
     216 * !wiki:"The whitespace convention"
     217 * !attachment:'the file.txt' or
     218 * !attachment:"the file.txt"
     219 * !attachment:"the file.txt:ticket:123"
     220
     221Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
     222 * ![[The whitespace convention]]
     223 * ![[attachment:the file.txt]]
     224
     225=== Escaping Links
     226
     227To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     228{{{
     229 !NoLinkHere.
     230 ![42] is not a link either.
     231}}}
     232
     233Display:
     234 !NoLinkHere.
     235 ![42] is not a link either.
     236
     237=== Parameterized Trac links
     238
     239Many 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.
     240
     241Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
     242 - `wiki:WikiStart?format=txt`
     243 - `ticket:1?version=1`
     244 - `[/newticket?component=module1 create a ticket for module1]`
     245 - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
     246
     247== TracLinks Reference
     248
     249The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
     250
     251=== attachment: links
     252
     253The link syntax for attachments is as follows:
     254 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
     255 * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
     256 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
     257
     258Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
     259
     260If 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:`.
     261
     262This 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.
     263
     264See also [#export:links].
     265
     266=== comment: links
     267
     268When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
     269It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
     270 - `comment:3:ticket:123`
     271 - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
     272It is also possible to link to the ticket's description using one of the following syntax:
     273 - `comment:description` (within the ticket)
     274 - `comment:description:ticket:123`
     275 - `ticket:123#comment:description`
     276
     277=== htdocs: links
     278
     279Use `htdocs:path/to/file` to reference files in the `htdocs` directory of the Trac environment, the [TracEnvironment#DirectoryStructure web resource directory].
     280
     281=== query: links
     282
     283See TracQuery#UsingTracLinks and [#ticket:links].
     284
     285=== search: links
     286
     287See TracSearch#SearchLinks
     288
     289=== ticket: links
     290
     291 ''alias:'' `bug:`
     292
     293Besides 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.
     294
     295Example:
     296 - `ticket:5000-6000`
     297 - `ticket:1,150`
     298
     299=== timeline: links
     300
     301Links 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.
     302
     303Examples:
     304 - `timeline:2008-01-29`
     305 - `timeline:2008-01-29T15:48`
     306 - `timeline:2008-01-29T15:48Z`
     307 - `timeline:2008-01-29T16:48+01`
     308 - `timeline:2008-01-29T16:48+0100`
     309 - `timeline:2008-01-29T16:48+01:00`
     310
     311=== wiki: links
     312
     313See 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.
     314
     315=== Version Control related links
     316
     317It 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.
     318
     319For 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'`.
     320
     321==== source: links
     322
     323 ''aliases:'' `browser:`, `repos:`
     324
     325The 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.
     326
     327It's also possible to link directly to a specific revision of a file like this:
     328 - `source:/some/file@123` - link to the file's revision 123
     329 - `source:/some/file@head` - link explicitly to the latest revision of the file
     330 - `source:/some/file@named-branch` - link to latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial)
     331
     332If the revision is specified, one can even link to a specific line number:
     333 - `source:/some/file@123#L10`
     334 - `source:/tag/0.10@head#L10`
     335 - `source:/some/file@named-branch#L10`
     336
     337Finally, one can also highlight an arbitrary set of lines:
     338 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103, and target line 99
     339 - 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.
     340
     341Note 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)''
     342
     343==== export: links
     344
     345To 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:
     346 * `export:/some/file` - get the HEAD revision of the specified file
     347 * `export:123:/some/file` - get revision 123 of the specified file
     348 * `export:/some/file@123` - get revision 123 of the specified file
     349 * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial).
     350
     351This 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.
     352
     353If 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`).
     354
     355==== log: links
     356
     357The `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.
     358 - `log:/` - the latest revisions starting at the root of the repository
     359 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
     360 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
     361 - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
     362 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
     363 - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial)
     364
     365There are short forms for revision ranges as well:
     366 - `[20788,20791:20795]`
     367 - `[20788,20791:20795/trunk/tools]`
     368 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
     369
     370Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
     371
     372In the presence of multiple repositories, the name of the repository should be specified as the first part of the path, e.g. `log:repos/branches` or `[20-40/repos]`.
     373
     374----
     375See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki