Changes between Version 1 and Version 2 of TracLinks
- Timestamp:
- 06/18/06 19:44:21 (1 year ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v1 v2 5 5 pages, milestones and source files) from anywhere WikiFormatting is used. 6 6 7 TracLinks are generally of the form ''' item:id''' (where ''id'' represents the7 TracLinks are generally of the form '''type:id''' (where ''id'' represents the 8 8 number, name or path of the item) though some frequently used kinds of items 9 also have short-hand , alternative, notations.9 also have short-hand notations. 10 10 11 11 Some examples: 12 13 12 * Tickets: '''!#1''' or '''!ticket:1''' 14 13 * Reports: '''!{1}''' or '''!report:1''' 15 * Changesets: '''![1]''' or '''!changeset:1''' 14 * Changesets: '''!r1''', '''![1]''' or '''!changeset:1''' 15 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:#1:3''' 16 16 * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase''' 17 17 * Milestones: '''!milestone:1.0''' 18 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 18 19 * Files: '''!source:trunk/COPYING''' 19 20 * A specific file revision: '''!source:/trunk/COPYING#200''' 20 21 Display: 21 22 * Tickets: #1 or ticket:1 22 23 * Reports: {1} or report:1 23 * Changesets: [1] or changeset:1 24 * Changesets: r1, [1] or changeset:1 25 * Differences: r1:3, [1:3] or log:#1:3 24 26 * Wiki pages: CamelCase or wiki:CamelCase 25 27 * Milestones: milestone:1.0 26 28 * Files: source:trunk/COPYING 29 * Attachment: attachment:ticket:944:attachment.1073.diff 30 * A specific file revision: source:/trunk/COPYING#200 27 31 28 32 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 37 41 }}} 38 42 39 Display: 43 Display: [ticket:1 This is a link to ticket number one]. 40 44 41 [ticket:1 This is a link to ticket number one]. 45 If the title is be omitted, only the id (the part after the colon) is displayed: 42 46 43 It might seem a simple enough concept at a glance, but actually allows quite a complex network of information. 47 {{{ 48 [ticket:1] 49 }}} 44 50 45 In practice though, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's 46 happening in a project or why a particular change was made. 51 Display: [ticket:1] 52 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. 54 55 == attachement: links == 56 57 The link syntax for attachments is as follows: 58 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 59 * !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.txt 47 61 48 62 == source: links == 49 The default behavior for a source:/some/path link is to open the directory browser if the path points 50 to a directory and otherwise open the log view. It's also possible to link directly to a specific 51 revision of a file like this: source:/some/file#123 or like this to link to the latest revision: 52 source:/some/file#latest. 63 64 The default behavior for a source:/some/path link is to open the directory browser 65 if the path points to a directory and otherwise open the log view. 66 It's also possible to link directly to a specific revision of a file like this: source:/some/file@123 67 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)]] 70 71 == Quoting space in TracLinks == 72 73 The usual syntax for quoting space is: 74 75 * !attachment:'the file.txt' or 76 * !attachment:"the file.txt" 53 77 54 78 == Where to use TracLinks == 61 85 and any other text fields explicitly marked as supporting WikiFormatting. 62 86 63 == Escaping TracLinks == 87 == Escaping Links == 88 64 89 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 65 66 90 {{{ 67 91 !NoLinkHere.
