Code

Changes between Version 1 and Version 2 of TracLinks


Ignore:
Timestamp:
08/02/05 10:07:42 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLinks

    v1 v2  
    11= Trac Links = 
    2  
    32As you might have guessed, TracLinks are a very fundamental feature of Trac. 
    43 
    5 They allow easy hyperlinking to files, changesets, bugs/issues and wiki pages from anywhere in the system where WikiFormatting is used.  
     4They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki 
     5pages, milestones and source files) from anywhere WikiFormatting is used. 
    66 
    7 TracLinks can refer to tickets, reports and changesets by simply writing the 
    8 ticket, report and changeset numbers in the following notation: 
    9 {{{ 
    10  * Ticket #1 or ticket:1 
    11  * Report {1} or report:1 
    12  * Changeset [1] or changeset:1 
    13  * File source:trunk/COPYING. 
    14 }}} 
     7TracLinks are generally of the form '''item:id''' (where ''id'' represents the 
     8number, name or path of the item) though some frequently used kinds of items 
     9also have short-hand, alternative, notations.  
     10 
     11Some examples: 
     12 
     13 * Tickets: '''!#1''' or '''!ticket:1''' 
     14 * Reports: '''!{1}''' or '''!report:1''' 
     15 * Changesets: '''![1]''' or '''!changeset:1''' 
     16 * Wiki pages: '''CamelCase''' or '''!wiki:CamelCase''' 
     17 * Milestones: '''!milestone:1.0''' 
     18 * Files: '''!source:trunk/COPYING''' 
     19 
    1520Display: 
    16  * Ticket #1 or ticket:1 
    17  * Report {1} or report:1 
    18  * Changeset [1] or changeset:1 
    19  * File source:trunk/COPYING. 
     21 * Tickets: #1 or ticket:1 
     22 * Reports: {1} or report:1 
     23 * Changesets: [1] or changeset:1 
     24 * Wiki pages: CamelCase or wiki:CamelCase 
     25 * Milestones: milestone:1.0 
     26 * Files: source:trunk/COPYING 
    2027 
    21 Trac links can also be given a custom link title like this: 
     28'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 
     29pages whose names do not follow WikiPageNames rules, i.e., single words, 
     30non-alphabetic characters, etc. 
     31 
     32Trac links using the full (non-shorthand) notation can also be given a custom 
     33link title like this: 
     34 
    2235{{{ 
    2336[ticket:1 This is a link to ticket number one]. 
     
    2841[ticket:1 This is a link to ticket number one]. 
    2942 
    30 It seems a simple enough concept at a glance, but actually allows quite a complex network of information.  
     43It might seem a simple enough concept at a glance, but actually allows quite a complex network of information. 
    3144 
    32 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. 
     45In practice though, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's 
     46happening in a project or why a particular change was made. 
    3347 
    3448== source: links == 
    35  
    3649The default behavior for a source:/some/path link is to open the directory browser if the path points 
    3750to a directory and otherwise open the log view. It's also possible to link directly to a specific 
     
    4255You can use TracLinks in: 
    4356 
     57 * Source code (Subversion) commit messages 
    4458 * Wiki pages 
    45  * Ticket descriptions 
    46  * Source code (Subversion) commit messages 
     59 * Full descriptions for tickets, reports and milestones 
    4760 
    48 See also: WikiFormatting 
     61and any other text fields explicitly marked as supporting WikiFormatting. 
     62 
     63== Escaping TracLinks == 
     64To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 
     65 
     66{{{ 
     67 !NoLinkHere. 
     68 ![42] is not a link either. 
     69}}} 
     70 
     71Display: 
     72 !NoLinkHere. 
     73 ![42] is not a link either. 
     74 
     75---- 
     76See also: WikiFormatting, TracWiki 
     77