Changes between Initial Version and Version 1 of TracLinks

02/11/05 11:50:10 (15 years ago)



  • TracLinks

    v1 v1  
     1= Trac Links = 
     2As you might have guessed, TracLinks are a very fundamental feature of Trac. 
     4They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki 
     5pages, milestones and source files) from anywhere WikiFormatting is used. 
     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. 
     11Some examples: 
     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''' 
     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 
     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. 
     32Trac links using the full (non-shorthand) notation can also be given a custom 
     33link title like this: 
     36[ticket:1 This is a link to ticket number one]. 
     41[ticket:1 This is a link to ticket number one]. 
     43It might seem a simple enough concept at a glance, but actually allows quite a complex network of information. 
     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. 
     48== source: links == 
     49The default behavior for a source:/some/path link is to open the directory browser if the path points 
     50to a directory and otherwise open the log view. It's also possible to link directly to a specific 
     51revision of a file like this: source:/some/file#123 or like this to link to the latest revision: 
     54== Where to use TracLinks == 
     55You can use TracLinks in: 
     57 * Source code (Subversion) commit messages 
     58 * Wiki pages 
     59 * Full descriptions for tickets, reports and milestones 
     61and any other text fields explicitly marked as supporting WikiFormatting. 
     63== Escaping TracLinks == 
     64To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 
     67 !NoLinkHere. 
     68 ![42] is not a link either. 
     72 !NoLinkHere. 
     73 ![42] is not a link either. 
     76See also: WikiFormatting, TracWiki