Edgewall Software

Changes between Initial Version and Version 1 of 0.12/TracLinks


Ignore:
Timestamp:
Feb 6, 2010, 6:33:00 PM (10 years ago)
Author:
Christian Boos
Comment:

copied from TracLinks@74

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracLinks

    v1 v1  
     1= Trac Links =
     2[[TracGuideToc]]
     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 ==
     11You can use TracLinks in:
     12
     13 * Source code (Subversion) commit messages
     14 * Wiki pages
     15 * Full descriptions for tickets, reports and milestones
     16
     17and any other text fields explicitly marked as supporting WikiFormatting.
     18
     19Some 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''' (absolute path)
     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'''
     33Display:
     34 * Tickets: #1 or ticket:1
     35 * Ticket comments: comment:1:ticket:2
     36 * Reports: {1} or report:1
     37 * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
     38 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
     39 * 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
     40 * Wiki pages: CamelCase or wiki:CamelCase
     41 * Parent page: [..]
     42 * Milestones: milestone:1.0
     43 * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
     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
     49pages whose names do not follow WikiPageNames rules, i.e., single words,
     50non-alphabetic characters, etc. See WikiPageNames for more about features specific
     51to links to Wiki page names.
     52
     53Trac links using the full (non-shorthand) notation can also be given a custom
     54link title like this:
     55
     56{{{
     57[ticket:1 This is a link to ticket number one].
     58}}}
     59
     60Display: [ticket:1 This is a link to ticket number one].
     61
     62If the title is omitted, only the id (the part after the colon) is displayed:
     63
     64{{{
     65[ticket:1]
     66}}}
     67
     68Display: [ticket:1]
     69
     70`wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):
     71
     72{{{
     73[SandBox the sandbox]
     74}}}
     75
     76Display: [SandBox the sandbox]
     77
     78TracLinks 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
     85To create a link to a specific anchor in a page, use '#':
     86{{{
     87 [#Relativelinks relative links]
     88}}}
     89Displays:
     90  [#Relativelinks relative links]
     91
     92Hint: 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
     94To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
     95{{{
     96 WikiPage/SubWikiPage or ./SubWikiPage
     97}}}
     98
     99To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
     100{{{
     101  [..]
     102}}}
     103
     104To link from a [trac:SubWiki 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
     113Other 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
     117This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
     118
     119Any 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
     121A 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
     125It is often useful to be able to link to objects in your project that
     126have no built-in Trac linking mechanism, such as static resources, `newticket`,
     127a shared `/register` page on the server, etc.
     128
     129To link to resources inside the project, use either an absolute path from the project root,
     130or a relative link from the URL of the current page (''Changed in 0.11''):
     131
     132{{{
     133[/newticket Create a new ticket]
     134[/ home]
     135}}}
     136
     137Display: [/newticket Create a new ticket] [/ home]
     138
     139To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''):
     140
     141{{{
     142[//register Register Here]
     143}}}
     144
     145Display: [//register Register Here]
     146
     147=== Quoting space in TracLinks ===
     148
     149Immediately after a TracLinks prefix, targets containing space characters should
     150be enclosed in a pair of quotes or double quotes.
     151Examples:
     152 * !wiki:"The whitespace convention"
     153 * !attachment:'the file.txt' or
     154 * !attachment:"the file.txt"
     155 * !attachment:"the file.txt:ticket:123"
     156
     157=== Escaping Links ===
     158
     159To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     160{{{
     161 !NoLinkHere.
     162 ![42] is not a link either.
     163}}}
     164
     165Display:
     166 !NoLinkHere.
     167 ![42] is not a link either.
     168
     169
     170=== Parameterized Trac links ===
     171
     172The 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
     174Any 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 ==
     181The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
     182
     183=== attachment: links ===
     184
     185The 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:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
     188 * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
     189
     190Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
     191
     192If 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:`.
     193
     194This 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.
     195
     196See also [#export:links].
     197
     198=== comment: links ===
     199
     200When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment.
     201It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
     202 - !comment:3:ticket:123
     203 - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!)
     204It is also possible to link to the ticket's description using one of the following syntax:
     205 - !comment:description
     206 - !comment:description:ticket:123
     207 - !ticket:123#comment:description
     208
     209=== query: links ===
     210
     211See TracQuery#UsingTracLinks and [#ticket:links].
     212
     213=== search: links ===
     214
     215See TracSearch#SearchLinks
     216
     217=== ticket: links ===
     218
     219Besides 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.
     220
     221Example:
     222 - `ticket:5000-6000`
     223 - `ticket:1,150`
     224
     225''(since Trac 0.11)''
     226
     227=== timeline: links ===
     228
     229Links 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.
     230
     231Examples:
     232 - `timeline:2008-01-29`
     233 - `timeline:2008-01-29T15:48`
     234 - `timeline:2008-01-29T15:48Z`
     235 - `timeline:2008-01-29T16:48+01`
     236
     237''(since Trac 0.11)''
     238
     239=== wiki: links ===
     240
     241See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
     242
     243=== Version Control related links ===
     244==== source: links ====
     245
     246The default behavior for a source:/some/path link is to open the directory browser
     247if the path points to a directory and otherwise open the log view.
     248
     249It's also possible to link directly to a specific revision of a file like this:
     250 - `source:/some/file@123` - link to the file's revision 123
     251 - `source:/some/file@head` - link explicitly to the latest revision of the file
     252
     253If the revision is specified, one can even link to a specific line number:
     254 - `source:/some/file@123#L10`
     255 - `source:/tag/0.10@head#L10`
     256
     257Finally, one can also highlight an arbitrary set of lines:
     258 - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
     259''(since 0.11)''
     260
     261==== export: links ====
     262
     263To 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:
     264 * `export:/some/file` - get the HEAD revision of the specified file
     265 * `export:123:/some/file` - get revision 123 of the specified file
     266 * `export:/some/file@123` - get revision 123 of the specified file
     267
     268This 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.
     269
     270If 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`).
     271
     272==== log: links ====
     273
     274The `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.
     275 - `log:/` - the latest revisions starting at the root of the repository
     276 - `log:/trunk/tools` - the latest revisions in `trunk/tools`
     277 - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
     278 - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range
     279 - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path
     280
     281There are short forms for revision ranges as well:
     282 - `[20788,20791:20795]`
     283 - `[20788,20791:20795/trunk/tools]`
     284 - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
     285
     286Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.
     287
     288----
     289See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
     290