Changes between Version 4 and Version 5 of TracLinks

Timestamp:

Sep 8, 2024, 11:08:42 PM (3 months ago)

Author:

trac

Comment:

--

TracLinks

@@ -4 +4 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-TracLinks 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 where WikiFormatting is used.
+TracLinks are a fundamental feature of Trac, allowing 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.
 
 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.
@@ -32 +32 @@
  Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
  Diffs :: `diff:@1:3`, `diff:plugins/0.12/mercurial-plugin@9128:9953`,
-          `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` 
+          `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
           or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
- Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25)
+ Files :: `source:trunk/COPYING`, `source:/trunk/COPYING@200` (at version 200), `source:/trunk/COPYING@200#L25` (at version 200, line 25), `source:/trunk/COPYING@200:27-30#L25` (at version 200, line 25, highlighting lines 27-30)
 }}}
 {{{#!td
@@ -40 +40 @@
  Parent page :: [..]
  Tickets :: #1 or ticket:1
- Ticket comments :: comment:1:ticket:2 
+ Ticket comments :: comment:1:ticket:2
  Reports :: {1} or report:1
  Milestones :: milestone:1.0
@@ -47 +47 @@
  Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
  Diffs :: diff:@1:3, diff:plugins/0.12/mercurial-plugin@9128:9953,
-          diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default 
+          diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
           or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
- Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25)
+ Files :: source:trunk/COPYING, source:/trunk/COPYING@200 (at version 200), source:/trunk/COPYING@200#L25 (at version 200, line 25) source:/trunk/COPYING@200:28-31#L25 (at version 200, line 25, highlighting lines 28-31)
 }}}
 
@@ -78 +78 @@
 }}}
 |--------------------------------------------------------------------------------------
-|||| `wiki` is the default if the namespace part of a full link is omitted:  || 
+|||| `wiki` is the default if the namespace part of a full link is omitted:  ||
 {{{#!td
 {{{
@@ -99 +99 @@
 <wiki:Strange(page@!)>
 }}}
+|--------------------------------------------------------------------------------------
+|||| Quoting can be used with the full notation to allow brackets in the label. ||
+{{{#!td
+{{{
+[TracIni#logging-log_type-option "[logging] log_type"]
+}}}
+}}}
+{{{#!td
+[TracIni#logging-log_type-option "[logging] log_type"]
+}}}
 }}}
 
@@ -125 +135 @@
 
 But in practice you often won't need to add the `../` prefix to link to a sibling page.
-For resolving the location of a wiki link, it's the target page closest in the hierarchy to the page where the link is written which will be selected. So for example, within a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
+For resolving the location of a wiki link, it's the target page closest in the hierarchy to the page where the link is written which will be selected. So for example, within a sub-hierarchy, a sibling page will be targeted in preference to a top-level page.
 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
 
@@ -132 +142 @@
 === Link anchors
 
-To create a link to a specific anchor in a page, use '#':
+To create a link to a specific anchor in a page, use `#`:
 {{{
  [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
@@ -138 +148 @@
   [#Linkanchors Link anchors] or [[#Linkanchors|Link anchors]]
 
-Hint: when you move your mouse over the title of a section, a '¶' character will be displayed. This is a link to that specific section and you can use this to copy the `#...` part inside a relative link to an anchor.
-
-To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with '#/' or '#?':
+To create an anchor in a page, use `[=#...]`:
+{{{
+ [=#myanchor my anchor] or empty form [=#myanchor] 
+}}}
+ [=#myanchor my anchor] or empty form [=#myanchor] 
+
+Hint: when you hover your mouse over the title of a section, a '¶' character will be displayed. This is a link to that specific section and you can use this to copy the `#...` part inside a relative link to an anchor.
+
+To create a link to the first or last occurrence of a term on a page, use a ''pseudo anchor'' starting with `#/` or `#?`:
 {{{
  [#/Milestone first occurrence of Milestone] or
@@ -147 +163 @@
  [#/Milestone first occurrence of Milestone] or
  [#?Milestone last occurrence of Milestone]
-This will also highlight all other matches on the linked page. By default only case sensitive matches are considered. To include case insensitive matches append '/i':
+This will also highlight all other matches on the linked page. By default only case sensitive matches are considered. To include case insensitive matches append `/i`:
 {{{
  [#/Milestone/i first occurrence of Milestone or milestone] or
@@ -166 +182 @@
 (Hint: The line numbers displayed in the source browser are links to anchors on the respective lines.)
 
-Since such links become outdated when the file changes, it can be useful to link using a '#/' pseudo anchor instead:
+Since such links become outdated when the file changes, it can be useful to link using a `#/` pseudo anchor instead:
 {{{
  [trac:source:trunk/trac/wiki/api.py#/IWikiSyntaxProvider IWikiSyntaxProvider] or
@@ -182 +198 @@
 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
 
-Any type of Trac link can be written in one Trac environment and actually refer to resources in another Trac environment. All that is required is to prefix the Trac link with the name of the other Trac environment followed by a colon. The other Trac environment must be registered on the InterTrac page. 
-
-A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links (e.g. `{}`, `r`, `#`) can also be used. For example if T was set as an alias for Trac, links to Trac tickets can be written #T234, links to Trac changesets can be written [trac 1508].
-See InterTrac for the complete details. 
+Any type of Trac link can be written in one Trac environment and actually refer to resources in another Trac environment. All that is required is to prefix the Trac link with the name of the other Trac environment followed by a colon. The other Trac environment must be registered on the InterTrac page.
+
+A distinct advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links can also be used, such as `{}`, `r`, `#`. For example, if T was set as an alias for Trac, then links to Trac tickets can be written as #T234, and links to Trac changesets can be written as [trac 1508].
+See InterTrac for the complete details.
 
 === Server-relative links
@@ -215 +231 @@
  * !wiki:"The whitespace convention"
  * !attachment:'the file.txt' or
- * !attachment:"the file.txt" 
- * !attachment:"the file.txt:ticket:123" 
+ * !attachment:"the file.txt"
+ * !attachment:"the file.txt:ticket:123"
 
 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
@@ -251 +267 @@
 
 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:the_file.txt creates a link to the attachment the_file.txt of the current page
  * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
  * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
 
-Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
+Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt, but is not recommended.
 
 If you'd like to create a direct link to the content of the attached file instead of a link to the attachment page, simply use `raw-attachment:` instead of `attachment:`.
 
-This can be useful for pointing directly to an HTML document, for example. Note that for this use case, you'd have to allow the web browser to render the content by setting `[attachment] render_unsafe_content = yes` (see TracIni#attachment-section). Caveat: only do that in environments for which you're 100% confident you can trust the people who are able to attach files, as otherwise this would open up your site to [wikipedia:Cross-site_scripting cross-site scripting] attacks.
+This can be useful for pointing directly to an HTML document, for example. Note that for this use case, you'd have to allow the web browser to render the content by setting [[TracIni#attachment-render_unsafe_content-option|"[attachment] render_unsafe_content"]] = `enabled`. Caveat: only do that in environments for which you're 100% confident you can trust the people who are able to attach files, as this opens up your site to [https://en.wikipedia.org/wiki/Cross-site_scripting cross-site scripting] attacks.
 
 See also [#export:links].
@@ -267 +283 @@
 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
- - `comment:3:ticket:123` 
+ - `comment:3:ticket:123`
  - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
 It is also possible to link to the ticket's description using one of the following syntax:
@@ -284 +300 @@
 === search: links
 
-See TracSearch#SearchLinks 
+See TracSearch#SearchTracLinks
 
 === ticket: links
@@ -292 +308 @@
 Besides the obvious `ticket:id` form, it is also possible to specify a list of tickets or even a range of tickets instead of the `id`. This generates a link to a custom query view containing this fixed set of tickets.
 
-Example: 
+Example:
  - `ticket:5000-6000`
  - `ticket:1,150`
@@ -312 +328 @@
 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above. It is possible to create a link to a specific page revision using the syntax WikiStart@1.
 
-=== Version Control related links
-
-It should be noted that multiple repository support works by creating a kind of virtual namespace for versioned files in which the toplevel folders correspond to the repository names. Therefore, in presence of multiple repositories, a ''/path'' specification in the syntax of links detailed below should start with the name of the repository. If omitted, the default repository is used. In case a toplevel folder of the default repository has the same name as a repository, the latter "wins". One can always access such folder by fully qualifying it. The default repository can be an alias of a named repository, or conversely, it is always possible to create an alias for the default repository, ask your Trac administrator.
+=== Version Control system links
+
+It should be noted that multiple repository support works by creating a kind of virtual namespace for versioned files in which the toplevel folders correspond to the repository names. Therefore, in presence of multiple repositories, a ''/path'' specification in the syntax of links detailed below should start with the name of the repository. If omitted, the default repository is used. In case a toplevel folder of the default repository has the same name as a repository, the link directs to the latter. One can always access such folder by fully qualifying it. The default repository can be an alias of a named repository, or conversely, there may be one or more aliases for the default repository, ask your Trac administrator.
 
 For example, `source:/trunk/COPYING` targets the path `/trunk/COPYING` in the default repository, whereas `source:/projectA/trunk/COPYING` targets the path `/trunk/COPYING` in the repository named `projectA`. This can be the same file if `'projectA'` is an alias to the default repository or if `''` (the default repository) is an alias to `'projectA'`.
@@ -348 +364 @@
  * `export:/some/file@named-branch` - get latest revision of the specified file in `named-branch` (DVCS such as Git or Mercurial).
 
-This can be very useful for displaying XML or HTML documentation with correct stylesheets and images, in case that has been checked in into the repository. Note that for this use case, you'd have to allow the web browser to render the content by setting `[browser] render_unsafe_content = yes` (see TracIni#browser-section), otherwise Trac will force the files to be downloaded as attachments for security concerns. 
+This can be very useful for displaying XML or HTML documentation with correct stylesheets and images, in case that has been checked in into the repository. Note that for this use case, you'd have to allow the web browser to render the content by setting [[TracIni#browser-render_unsafe_content-option|"[browser] render_unsafe_content"]] = `enabled`, otherwise Trac will force the files to be downloaded as attachments for security concerns.
 
 If the path is to a directory in the repository instead of a specific file, the source browser will be used to display the directory (identical to the result of `source:/some/dir`).
@@ -358 +374 @@
  - `log:/trunk/tools` - the latest revisions in `trunk/tools`
  - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
- - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 
+ - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
  - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
  - `log:/tools@named-branch` - the revisions in `tools` starting from the latest revision in `named-branch` (DVCS such as Git or Mercurial)
@@ -369 +385 @@
 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
 
-In the presence of multiple repositories, the name of the repository should be specified as the first part of the path, e.g. `log:repos/branches` or `[20-40/repos]`.
+==== Multi-repository links
+
+In the presence of multiple repositories, the name of the repository should be specified as the first part of the path:
+- `log:repos/branch`
+- `[20-40/repos]`
+- `r20/repos`
 
 ----