Changes between Version 1 and Version 2 of TracLinks
- Timestamp:
- 11/02/2006 04:39:51 PM (18 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v1 v2 1 1 = Trac Links = 2 As you might have guessed, TracLinks are a very fundamental feature of Trac. 3 4 They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki 5 pages, milestones and source files) from anywhere WikiFormatting is used. 2 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. 6 3 7 4 TracLinks are generally of the form '''type:id''' (where ''id'' represents the … … 11 8 Some examples: 12 9 * Tickets: '''!#1''' or '''!ticket:1''' 10 * Ticket comments: '''!comment:ticket:1:2''' 13 11 * Reports: '''!{1}''' or '''!report:1''' 14 * Changesets: '''!r1''', '''![1]''' or '''!changeset:1''' 15 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:#1:3''' 16 * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase''' 12 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' 13 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' 14 * 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''' 15 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 17 16 * Milestones: '''!milestone:1.0''' 18 17 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 19 18 * Files: '''!source:trunk/COPYING''' 20 * A specific file revision: '''!source:/trunk/COPYING#200''' 19 * A specific file revision: '''!source:/trunk/COPYING@200''' 20 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' 21 21 Display: 22 22 * Tickets: #1 or ticket:1 23 * Ticket comments: comment:ticket:1:2 23 24 * Reports: {1} or report:1 24 * Changesets: r1, [1] or changeset:1 25 * Differences: r1:3, [1:3] or log:#1:3 25 * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk 26 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 27 * Diffs (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539 26 28 * Wiki pages: CamelCase or wiki:CamelCase 27 29 * Milestones: milestone:1.0 30 * Attachment: attachment:ticket:944:attachment.1073.diff 28 31 * Files: source:trunk/COPYING 29 * A ttachment: attachment:ticket:944:attachment.1073.diff30 * A specific file revision: source:/trunk/COPYING#20032 * A specific file revision: source:/trunk/COPYING@200 33 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 31 34 32 35 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 33 36 pages whose names do not follow WikiPageNames rules, i.e., single words, 34 non-alphabetic characters, etc. 37 non-alphabetic characters, etc. See WikiPageNames for more about features specific 38 to links to Wiki page names. 35 39 36 40 Trac links using the full (non-shorthand) notation can also be given a custom … … 51 55 Display: [ticket:1] 52 56 53 It might seem a simple enough concept at a glance, but actually allows 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. 57 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''): 54 58 55 == attachement: links == 59 {{{ 60 [SandBox the sandbox] 61 }}} 62 63 Display: [SandBox the sandbox] 64 65 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. 66 67 The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 68 69 == attachment: links == 56 70 57 71 The link syntax for attachments is as follows: 58 72 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 59 73 * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page 60 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 !attachment:wiki:MyPage:the_file.txt74 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 61 75 62 76 == source: links == … … 66 80 It's also possible to link directly to a specific revision of a file like this: source:/some/file@123 67 81 or like this to link to the latest revision: source:/some/file@latest. 68 If the revision is specified, one can even link to a specific line number: !source:/some/file@123#L10 69 [[comment(TODO: remove the ! when Edgewall Trac is upgraded with the support for the line syntax)]] 82 If the revision is specified, one can even link to a specific line number: source:/some/file@123#L10 83 84 == search: and query: links == 85 86 See TracSearch#SearchLinks and TracQuery#UsingTracLinks 87 88 == !SubWiki links == 89 To create a SubWiki link to a SubWiki-page just use a '/': 90 {{{ 91 [wiki:WikiPage/SubWikiPage]. 92 }}} 93 94 == InterWiki links == 95 96 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. 97 98 == InterTrac links == 99 100 Any of the above form 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. See InterTrac for details. 101 102 103 == Server-relative links == 104 105 It is often useful to be able to link to objects on your server that have no built-in 106 Trac linking mechanism, such as static resources, a `/register` page, etc. This 107 can be achieved by simply using either an absolute path from the server root, 108 or a relative link from the URL of the current page: 109 110 {{{ 111 [../newticket newticket] 112 [/ home] 113 }}} 114 115 Display: [../newticket newticket] [/ home] 70 116 71 117 == Quoting space in TracLinks == 72 118 73 The usual syntax for quoting space is: 74 119 Immediately after a TracLinks prefix, targets containing space characters should 120 be enclosed in a pair of quotes or double quotes. 121 Examples: 122 * !wiki:"The whitespace convention" 75 123 * !attachment:'the file.txt' or 76 124 * !attachment:"the file.txt" 125 * !attachment:"ticket:123:the file.txt" 77 126 78 127 == Where to use TracLinks == … … 98 147 99 148 ---- 100 See also: WikiFormatting, TracWiki 149 See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki 101 150