source: wiki/pages/WikiRestructuredTextLinks @ 40558

Last change on this file since 40558 was 40558, checked in by obi, 5 years ago

reset wiki

File size: 2.6 KB
Line 
1= TracLinks in reStructuredText =
2
3This document illustrates how to use the `:trac:` role in [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html reStructuredText]. The page is written like:
4
5{{{
6{{{
7#!rst
8Examples:
9
10 * Tickets: :trac:`#1` or :trac:`ticket:1`
11 * Ticket comments: :trac:`comment:ticket:1:2`
12 * Reports: :trac:`{1}` or :trac:`report:1`
13 * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
14 * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
15 * Diffs: :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
16 * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
17 * Milestones: :trac:`milestone:1.0`
18 * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff`
19 * Files: :trac:`source:trunk/COPYING`
20 * A specific file revision: :trac:`source:/trunk/COPYING@200`
21 * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
22
23An explicit label can be specified, separated from the link by a space:
24
25 * See :trac:`#1 ticket 1` and the :trac:`source:trunk/COPYING license`.
26}}}
27}}}
28
29Provided you have [http://docutils.sourceforge.net/ docutils] installed, the above block will render as:
30----
31{{{
32#!rst
33Examples:
34
35 * Tickets: :trac:`#1` or :trac:`ticket:1`
36 * Ticket comments: :trac:`comment:ticket:1:2`
37 * Reports: :trac:`{1}` or :trac:`report:1`
38 * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
39 * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
40 * Diffs: :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
41 * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
42 * Milestones: :trac:`milestone:1.0`
43 * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff`
44 * Files: :trac:`source:trunk/COPYING`
45 * A specific file revision: :trac:`source:/trunk/COPYING@200`
46 * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
47
48An explicit label can be specified, separated from the link by a space:
49
50 * See :trac:`#1 ticket 1` and the :trac:`source:trunk/COPYING license`.
51}}}
52----
53
54Note that the above could have been written using substitution references and the `trac::` directive:
55{{{
56{{{
57#!rst
58See |ticket123|.
59
60 .. |ticket123| trac:: ticket:123 this ticket
61}}}
62}}}
63
64This renders as:
65----
66
67{{{
68#!rst
69See |ticket123|.
70
71 .. |ticket123| trac:: ticket:123 this ticket
72}}}
73
74----
75See also: WikiRestructuredText, TracLinks
Note: See TracBrowser for help on using the repository browser.