wiki:TracLinks

Version 2 (modified by trac, 19 years ago) ( diff )

--

Trac Links

As you might have guessed, TracLinks are a very fundamental feature of Trac.

They allow hyperlinking between Trac entities (tickets, reports, changesets, Wiki pages, milestones and source files) from anywhere WikiFormatting is used.

TracLinks are generally of the form type:id (where id represents the number, name or path of the item) though some frequently used kinds of items also have short-hand notations.

Some examples:

  • Tickets: #1 or ticket:1
  • Reports: {1} or report:1
  • Changesets: r1, [1] or changeset:1
  • Revision log: r1:3, [1:3] or log:#1:3
  • Wiki pages: CamelCase or wiki:CamelCase
  • Milestones: milestone:1.0
  • Attachment: attachment:ticket:944:attachment.1073.diff
  • Files: source:trunk/COPYING
  • A specific file revision: source:/trunk/COPYING#200

Display:

Note: The wiki:CamelCase form is rarely used, but it can be convenient to refer to pages whose names do not follow WikiPageNames rules, i.e., single words, non-alphabetic characters, etc.

Trac links using the full (non-shorthand) notation can also be given a custom link title like this: 

[ticket:1 This is a link to ticket number one].

Display: This is a link to ticket number one.

If the title is be omitted, only the id (the part after the colon) is displayed: 

[ticket:1]

Display: 1

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.

The link syntax for attachments is as follows:

  • attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
  • attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the MyPage wiki page
  • 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

The default behavior for a source:/some/path link is to open the directory browser if the path points to a directory and otherwise open the log view. It's also possible to link directly to a specific revision of a file like this: source:/some/file@123 or like this to link to the latest revision: source:/some/file@latest. If the revision is specified, one can even link to a specific line number: source:/some/file@123#L10

The usual syntax for quoting space is:

  • attachment:'the file.txt' or
  • attachment:"the file.txt"

You can use TracLinks in:

  • Source code (Subversion) commit messages
  • Wiki pages
  • Full descriptions for tickets, reports and milestones

and any other text fields explicitly marked as supporting WikiFormatting.

To prevent parsing of a TracLink, you can escape it by preceding it with a '!' (exclamation mark). 

 !NoLinkHere.
 ![42] is not a link either.

Display:

NoLinkHere. [42] is not a link either.

See also: WikiFormatting, TracWiki

Note: See TracWiki for help on using the wiki.