Changes between Initial Version and Version 1 of TracLinks


Ignore:
Timestamp:
Sep 9, 2006, 9:15:00 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v1  
     1= Trac Links =
     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.
     3
     4TracLinks are generally of the form '''type:id''' (where ''id'' represents the
     5number, name or path of the item) though some frequently used kinds of items
     6also have short-hand notations.
     7
     8Some examples:
     9 * Tickets: '''!#1''' or '''!ticket:1'''
     10 * Ticket comments: '''!comment:ticket:1:2'''
     11 * Reports: '''!{1}''' or '''!report:1'''
     12 * Changesets: '''!r1''', '''![1]''' or '''!changeset:1'''
     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'''
     16 * Milestones: '''!milestone:1.0'''
     17 * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
     18 * Files: '''!source:trunk/COPYING'''
     19 * A specific file revision: '''!source:/trunk/COPYING@200'''
     20 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25'''
     21Display:
     22 * Tickets: #1 or ticket:1
     23 * Ticket comments: comment:ticket:1:2
     24 * Reports: {1} or report:1
     25 * Changesets: r1, [1] or changeset:1
     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
     28 * Wiki pages: CamelCase or wiki:CamelCase
     29 * Milestones: milestone:1.0
     30 * Attachment: attachment:ticket:944:attachment.1073.diff
     31 * 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
     34
     35'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     36pages whose names do not follow WikiPageNames rules, i.e., single words,
     37non-alphabetic characters, etc. See WikiPageNames for more about features specific
     38to links to Wiki page names.
     39
     40Trac links using the full (non-shorthand) notation can also be given a custom
     41link title like this:
     42
     43{{{
     44[ticket:1 This is a link to ticket number one].
     45}}}
     46
     47Display: [ticket:1 This is a link to ticket number one].
     48
     49If the title is be omitted, only the id (the part after the colon) is displayed:
     50
     51{{{
     52[ticket:1]
     53}}}
     54
     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
     75
     76== source: links ==
     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== 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]
     110
     111== Quoting space in TracLinks ==
     112
     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"
     117 * !attachment:'the file.txt' or
     118 * !attachment:"the file.txt"
     119 * !attachment:"ticket:123:the file.txt"
     120
     121== Where to use TracLinks ==
     122You can use TracLinks in:
     123
     124 * Source code (Subversion) commit messages
     125 * Wiki pages
     126 * Full descriptions for tickets, reports and milestones
     127
     128and any other text fields explicitly marked as supporting WikiFormatting.
     129
     130== Escaping Links ==
     131
     132To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
     133{{{
     134 !NoLinkHere.
     135 ![42] is not a link either.
     136}}}
     137
     138Display:
     139 !NoLinkHere.
     140 ![42] is not a link either.
     141
     142----
     143See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
     144