Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
2006-09-10T00:41:18Z (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    11= 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.
     2TracLinks 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.
    63
    74TracLinks are generally of the form '''type:id''' (where ''id'' represents the
     
    118Some examples:
    129 * Tickets: '''!#1''' or '''!ticket:1'''
     10 * Ticket comments: '''!comment:ticket:1:2'''
    1311 * Reports: '''!{1}''' or '''!report:1'''
    1412 * Changesets: '''!r1''', '''![1]''' or '''!changeset:1'''
    15  * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:#1:3'''
    16  * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase'''
     13 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3'''
     14 * Diffs (requires [milestone: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'''
    1716 * Milestones: '''!milestone:1.0'''
    1817 * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
    1918 * 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'''
    2121Display:
    2222 * Tickets: #1 or ticket:1
     23 * Ticket comments: comment:ticket:1:2
    2324 * Reports: {1} or report:1
    2425 * Changesets: r1, [1] or changeset:1
    25  * Differences: r1:3, [1:3] or log:#1:3
     26 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3
     27 * Diffs (requires [milestone: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
    2628 * Wiki pages: CamelCase or wiki:CamelCase
    2729 * Milestones: milestone:1.0
     30 * Attachment: attachment:ticket:944:attachment.1073.diff
    2831 * Files: source:trunk/COPYING
    29  * Attachment: attachment:ticket:944:attachment.1073.diff
    30  * A specific file revision: source:/trunk/COPYING#200
     32 * A specific file revision: source:/trunk/COPYING@200
     33 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25
    3134
    3235'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    3336pages whose names do not follow WikiPageNames rules, i.e., single words,
    34 non-alphabetic characters, etc.
     37non-alphabetic characters, etc. See WikiPageNames for more about features specific
     38to links to Wiki page names.
    3539
    3640Trac links using the full (non-shorthand) notation can also be given a custom
     
    5155Display: [ticket:1]
    5256
    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''):
    5458
    55 == attachement: links ==
     59{{{
     60[SandBox the sandbox]
     61}}}
     62
     63Display: [SandBox the sandbox]
     64
     65TracLinks 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
     67The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
     68
     69== attachment: links ==
    5670
    5771The link syntax for attachments is as follows:
    5872 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
    5973 * !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
     74 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753
    6175
    6276== source: links ==
     
    6680It's also possible to link directly to a specific revision of a file like this: source:/some/file@123
    6781or 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)]]
     82If 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
     86See TracSearch#SearchLinks and TracQuery#UsingTracLinks
     87
     88== InterWiki links ==
     89
     90Other 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.
     91
     92== InterTrac links ==
     93
     94Any 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.
     95
     96
     97== Server-relative links ==
     98
     99It is often useful to be able to link to objects on your server that have no built-in
     100Trac linking mechanism, such as static resources, a `/register` page, etc. This
     101can be achieved by simply using either an absolute path from the server root,
     102or a relative link from the URL of the current page:
     103
     104{{{
     105[../newticket newticket]
     106[/ home]
     107}}}
     108
     109Display: [../newticket newticket] [/ home]
    70110
    71111== Quoting space in TracLinks ==
    72112
    73 The usual syntax for quoting space is:
    74 
     113Immediately after a TracLinks prefix, targets containing space characters should
     114be enclosed in a pair of quotes or double quotes.
     115Examples:
     116 * !wiki:"The whitespace convention"
    75117 * !attachment:'the file.txt' or
    76118 * !attachment:"the file.txt"
     119 * !attachment:"ticket:123:the file.txt"
    77120
    78121== Where to use TracLinks ==
     
    98141
    99142----
    100 See also: WikiFormatting, TracWiki
     143See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
    101144