Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
Apr 7, 2008, 11:15:27 AM (10 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.
     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.
    33
    4 They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki
    5 pages, milestones and source files) from anywhere WikiFormatting is used.
    6 
    7 TracLinks are generally of the form '''item:id''' (where ''id'' represents the
     4TracLinks are generally of the form '''type:id''' (where ''id'' represents the
    85number, name or path of the item) though some frequently used kinds of items
    9 also have short-hand, alternative, notations.
     6also have short-hand notations.
    107
    118Some examples:
    12 
    139 * Tickets: '''!#1''' or '''!ticket:1'''
     10 * Ticket comments: '''!comment:ticket:1:2'''
    1411 * Reports: '''!{1}''' or '''!report:1'''
    15  * Changesets: '''![1]''' or '''!changeset:1'''
    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'''
    1716 * Milestones: '''!milestone:1.0'''
     17 * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
    1818 * Files: '''!source:trunk/COPYING'''
    19 
     19 * A specific file revision: '''!source:/trunk/COPYING@200'''
     20 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25'''
    2021Display:
    2122 * Tickets: #1 or ticket:1
     23 * Ticket comments: comment:ticket:1:2
    2224 * Reports: {1} or report:1
    23  * Changesets: [1] or changeset:1
     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
    2428 * Wiki pages: CamelCase or wiki:CamelCase
    2529 * Milestones: milestone:1.0
     30 * Attachment: attachment:ticket:944:attachment.1073.diff
    2631 * Files: source:trunk/COPYING
     32 * A specific file revision: source:/trunk/COPYING@200
     33 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25
    2734
    2835'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    2936pages whose names do not follow WikiPageNames rules, i.e., single words,
    30 non-alphabetic characters, etc.
     37non-alphabetic characters, etc. See WikiPageNames for more about features specific
     38to links to Wiki page names.
    3139
    3240Trac links using the full (non-shorthand) notation can also be given a custom
     
    3745}}}
    3846
    39 Display:
     47Display: [ticket:1 This is a link to ticket number one].
    4048
    41 [ticket:1 This is a link to ticket number one].
     49If the title is be omitted, only the id (the part after the colon) is displayed:
    4250
    43 It might seem a simple enough concept at a glance, but actually allows quite a complex network of information.
     51{{{
     52[ticket:1]
     53}}}
    4454
    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.
     55Display: [ticket:1]
     56
     57`wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):
     58
     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 ==
     70
     71The link syntax for attachments is as follows:
     72 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
     73 * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
     74 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753
    4775
    4876== 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.
     77
     78The default behavior for a source:/some/path link is to open the directory browser
     79if the path points to a directory and otherwise open the log view.
     80It's also possible to link directly to a specific revision of a file like this: source:/some/file@123
     81or like this to link to the latest revision: source:/some/file@latest.
     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== !SubWiki links ==
     89To create a SubWiki link to a SubWiki-page just use a '/':
     90{{{
     91 [wiki:WikiPage/SubWikiPage].
     92}}}
     93
     94== InterWiki links ==
     95
     96Other 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
     100Any 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
     105It is often useful to be able to link to objects on your server that have no built-in
     106Trac linking mechanism, such as static resources, a `/register` page, etc. This
     107can be achieved by simply using either an absolute path from the server root,
     108or a relative link from the URL of the current page:
     109
     110{{{
     111[../newticket newticket]
     112[/ home]
     113}}}
     114
     115Display: [../newticket newticket] [/ home]
     116
     117== Quoting space in TracLinks ==
     118
     119Immediately after a TracLinks prefix, targets containing space characters should
     120be enclosed in a pair of quotes or double quotes.
     121Examples:
     122 * !wiki:"The whitespace convention"
     123 * !attachment:'the file.txt' or
     124 * !attachment:"the file.txt"
     125 * !attachment:"ticket:123:the file.txt"
    53126
    54127== Where to use TracLinks ==
     
    61134and any other text fields explicitly marked as supporting WikiFormatting.
    62135
    63 == Escaping TracLinks ==
     136== Escaping Links ==
     137
    64138To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
    65 
    66139{{{
    67140 !NoLinkHere.
     
    74147
    75148----
    76 See also: WikiFormatting, TracWiki
     149See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
    77150