Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Jun 19, 2006, 2:44:21 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    55pages, milestones and source files) from anywhere WikiFormatting is used.
    66
    7 TracLinks are generally of the form '''item:id''' (where ''id'' represents the
     7TracLinks are generally of the form '''type:id''' (where ''id'' represents the
    88number, name or path of the item) though some frequently used kinds of items
    9 also have short-hand, alternative, notations.
     9also have short-hand notations.
    1010
    1111Some examples:
    12 
    1312 * Tickets: '''!#1''' or '''!ticket:1'''
    1413 * 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'''
    1616 * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase'''
    1717 * Milestones: '''!milestone:1.0'''
     18 * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
    1819 * Files: '''!source:trunk/COPYING'''
    19 
     20 * A specific file revision: '''!source:/trunk/COPYING#200'''
    2021Display:
    2122 * Tickets: #1 or ticket:1
    2223 * 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
    2426 * Wiki pages: CamelCase or wiki:CamelCase
    2527 * Milestones: milestone:1.0
    2628 * Files: source:trunk/COPYING
     29 * Attachment: attachment:ticket:944:attachment.1073.diff
     30 * A specific file revision: source:/trunk/COPYING#200
    2731
    2832'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     
    3741}}}
    3842
    39 Display:
     43Display: [ticket:1 This is a link to ticket number one].
    4044
    41 [ticket:1 This is a link to ticket number one].
     45If the title is be omitted, only the id (the part after the colon) is displayed:
    4246
    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}}}
    4450
    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.
     51Display: [ticket:1]
     52
     53It 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
     57The 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
    4761
    4862== 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
     64The default behavior for a source:/some/path link is to open the directory browser
     65if the path points to a directory and otherwise open the log view.
     66It's also possible to link directly to a specific revision of a file like this: source:/some/file@123
     67or like this to link to the latest revision: source:/some/file@latest.
     68If 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
     73The usual syntax for quoting space is:
     74
     75 * !attachment:'the file.txt' or
     76 * !attachment:"the file.txt"
    5377
    5478== Where to use TracLinks ==
     
    6185and any other text fields explicitly marked as supporting WikiFormatting.
    6286
    63 == Escaping TracLinks ==
     87== Escaping Links ==
     88
    6489To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
    65 
    6690{{{
    6791 !NoLinkHere.