# Changes between Version 1 and Version 2 of TracLinks

Ignore:
Timestamp:
Jun 1, 2010 11:09:27 PM (12 years ago)
Comment:

--

### Legend:

Unmodified
 v1 and any other text fields explicitly marked as supporting WikiFormatting. Some examples: * Tickets: '''!#1''' or '''!ticket:1''' * Ticket comments: '''!comment:1:ticket:2''' * Reports: '''!{1}''' or '''!report:1''' * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''', '''![2:5/trunk]''' * 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''' * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' * Parent page: '''![..]''' * Milestones: '''!milestone:1.0''' * Attachment: '''!attachment:example.tgz''' (for current page attachment), '''!attachment:attachment.1073.diff:ticket:944''' (absolute path) * Files: '''!source:trunk/COPYING''' * A specific file revision: '''!source:/trunk/COPYING@200''' * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' Display: * Tickets: #1 or ticket:1 * Ticket comments: comment:1:ticket:2 * Reports: {1} or report:1 * Changesets: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] * 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 * Wiki pages: CamelCase or wiki:CamelCase * Parent page: [..] * Milestones: milestone:1.0 * Attachment: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) * Files: source:trunk/COPYING * A specific file revision: source:/trunk/COPYING@200 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 == Overview == ||= Wiki Markup =||= Display =|| {{{#!td Wiki pages :: CamelCase or wiki:CamelCase Parent page :: [..] Tickets :: #1 or ticket:1 Ticket comments :: comment:1:ticket:2 Reports :: {1} or report:1 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] Diffs :: 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 Milestones :: milestone:1.0 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) Files :: source:trunk/COPYING A specific file revision :: source:/trunk/COPYING@200 A particular line of a specific file revision :: source:/trunk/COPYING@200#L25 }}} {{{#!td Wiki pages :: CamelCase or wiki:CamelCase Parent page :: [..] Tickets :: #1 or ticket:1 Ticket comments :: comment:1:ticket:2 Reports :: {1} or report:1 Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk] Diffs :: 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 Milestones :: milestone:1.0 Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path) Files :: source:trunk/COPYING A specific file revision :: source:/trunk/COPYING@200 A particular line of a specific file revision :: source:/trunk/COPYING@200#L25 }}} '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to to links to Wiki page names. Trac links using the full (non-shorthand) notation can also be given a custom link title like this: {{{ [ticket:1 This is a link to ticket number one]. }}} Display: [ticket:1 This is a link to ticket number one]. If the title is omitted, only the id (the part after the colon) is displayed: {{{ [ticket:1] }}} Display: [ticket:1] wiki is the default if the namespace part of a full link is omitted (''since version 0.10''): {{{ [SandBox the sandbox] }}} Display: [SandBox the sandbox] {{{#!table class="" |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: || {{{#!td {{{ [ticket:1 This is a link to ticket number one] or [[ticket:1|This is another link to ticket number one]]. }}} }}} {{{#!td [ticket:1 This is a link to ticket number one] or [[ticket:1|This is another link to ticket number one]]. }}} |-------------------------------------------------------------------------------------- |||| If the title is omitted, only the id (the part after the colon) is displayed:  || {{{#!td {{{ [ticket:1] or [[ticket:2]] }}} }}} {{{#!td [ticket:1] or [[ticket:2]] }}} |-------------------------------------------------------------------------------------- |||| wiki is the default if the namespace part of a full link is omitted:  || {{{#!td {{{ [SandBox the sandbox] or [[SandBox|the sandbox]] }}} }}} {{{#!td [SandBox the sandbox] or [[SandBox|the sandbox]] }}} |-------------------------------------------------------------------------------------- |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  || {{{#!td {{{ }}} }}} {{{#!td }}} }}} TracLinks 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. To create a link to a specific anchor in a page, use '#': {{{ [#Relativelinks relative links] [#Relativelinks relative links] or [[#Relativelinks|relative links]] }}} Displays: [#Relativelinks relative links] [#Relativelinks relative links] or [[#Relativelinks|relative links]] Hint: 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. To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..': {{{ [..] }}} To link from a [trac:SubWiki SubWiki] page to a sibling page, use a '../': {{{ [../Sibling see next sibling] }}} ''(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. [..] or [[..]] }}} [..] or [[..]] To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../': {{{ [../Sibling see next sibling] or [[../Sibling|see next sibling]] }}} [../Sibling see next sibling] or [[../Sibling|see next sibling]] But in practice you often won't need to add the ../ prefix to link to a sibling page. 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. This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links. In order 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. ''(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. See [#Server-relativelinks] for the new syntax. === InterWiki links === This can be seen as a kind of InterWiki link specialized for targeting other Trac projects. 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. 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]. 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. 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]. See InterTrac for the complete details. === Server-relative links === {{{ [/newticket Create a new ticket] [/ home] }}} Display: [/newticket newticket] [/ home] To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''): {{{ [//register Register Here] }}} Display: [//register Register Here] [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] [/ home] or [[/|home]] }}} Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]] [/ home] or [[/|home]] To link to another location on the server (possibly outside the project but on the same host), use the // prefix (''Changed in 0.11''): {{{ [//register Register Here] or [[//register|Register Here]] }}} Display: [//register Register Here] or [[//register|Register Here]] === Quoting space in TracLinks === * !attachment:"the file.txt:ticket:123" Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces: * ![[The whitespace convention]] * ![[attachment:the file.txt]] === Escaping Links === === Parameterized Trac links === The 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. Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: Many 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. Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples: - wiki:WikiStart?format=txt - ticket:1?version=1 - [/newticket?component=module1 create a ticket for module1] - [/newticket?summary=Add+short+description+here create a ticket with URL with spaces] == TracLinks Reference == The following sections describe the individual link types in detail, as well as several notes advanced usage of links. The following sections describe the individual link types in detail, as well as notes on advanced usage of links. === attachment: links === === comment: links === When you're inside a given tickets, you can simply write e.g. !comment:3 to link to the third change comment. It's also possible to link to a comment of a specific ticket from anywhere using one of the following syntax: - !comment:3:ticket:123 - !ticket:123#comment:3 (note that you can't write !#123#!comment:3!) When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment. It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax: - comment:3:ticket:123 - ticket:123#comment:3 (note that you can't write #123#!comment:3!) It is also possible to link to the ticket's description using one of the following syntax: - comment:description (within the ticket) - comment:description:ticket:123 - ticket:123#comment:description === query: links === === ticket: links === ''alias:'' bug: Besides 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. - timeline:2008-01-29 - timeline:2008-01-29T15:48 - timeline:2008-01-29T16:48Z+01 - timeline:2008-01-29T15:48Z - timeline:2008-01-29T16:48+01 ''(since Trac 0.11)'' === Version Control related links === ==== source: links ==== The default behavior for a source:/some/path link is to open the directory browser if the path points to a directory and otherwise open the log view. ''aliases:'' browser:, repos: 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. It's also possible to link directly to a specific revision of a file like this: Finally, one can also highlight an arbitrary set of lines: - source:/some/file@123:10-20,100,103#L99 - highlight lines 10 to 20, and lines 100 and 103. ''(since 0.11)'' ''(since 0.11)'' Note 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)'' ==== export: links ==== ==== log: links ==== The 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. The 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. - log:/ - the latest revisions starting at the root of the repository - log:/trunk/tools - the latest revisions in trunk/tools - log:/trunk/tools@10000 - the revisions in trunk/tools starting from  revision 10000 - log:@20788,20791:20795 - list revision 20788 and the 20791 to 20795 revision range - log:/trunk/tools@20788,20791:20795 - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path - log:@20788,20791:20795 - list revision 20788 and the revisions from 20791 to 20795 - log:/trunk/tools@20788,20791:20795 - list revision 20788 and the revisions from 20791 to 20795 which affect the given path There are short forms for revision ranges as well: - r20791:20795 (but not r20788,20791:20795 nor r20791:20795/trunk) Finally, note that in all of the above, a revision range can be written indifferently x:y or x-y. Finally, note that in all of the above, a revision range can be written either as x:y or x-y. In 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]. ----