close
Warning:
Can't synchronize with repository "(default)" (The repository directory has changed, you should resynchronize the repository with: trac-admin $ENV repository resync '(default)'). Look in the Trac log for more information.
- Timestamp:
-
2011-07-31T04:33:06-07:00 (13 years ago)
- Author:
-
trac
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
v1
|
v2
|
|
1 | 1 | = TracLinks in reStructuredText = |
2 | 2 | |
3 | | This document illustrates how to use the ``..trac::`` directive in reStructureThe page is written like |
| 3 | This document illustrates how to use the `:trac:` role in reStructuredText. The page is written like: |
4 | 4 | |
5 | 5 | {{{ |
6 | 6 | {{{ |
7 | 7 | #!rst |
| 8 | Examples: |
8 | 9 | |
9 | | Examples: |
10 | 10 | * Tickets: :trac:`#1` or :trac:`ticket:1` |
11 | 11 | * Ticket comments: :trac:`comment:ticket:1:2` |
… |
… |
|
21 | 21 | * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25` |
22 | 22 | |
| 23 | An 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`. |
23 | 26 | }}} |
24 | 27 | }}} |
… |
… |
|
28 | 31 | {{{ |
29 | 32 | #!rst |
| 33 | Examples: |
30 | 34 | |
31 | | Examples: |
32 | 35 | * Tickets: :trac:`#1` or :trac:`ticket:1` |
33 | 36 | * Ticket comments: :trac:`comment:ticket:1:2` |
… |
… |
|
43 | 46 | * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25` |
44 | 47 | |
| 48 | An 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`. |
45 | 51 | }}} |
46 | 52 | ---- |
47 | 53 | |
48 | | Note also that any of the above could have been written using the alternate syntax for roles: |
| 54 | Note also that any of the above could have been written using substitution references and the `trac::` directive: |
49 | 55 | {{{ |
50 | 56 | {{{ |
51 | 57 | #!rst |
| 58 | See |ticket123|. |
52 | 59 | |
53 | | See `ticket:123`_ |
54 | | |
55 | | .. :trac: ticket:123 Ticket 123 |
| 60 | .. |ticket123| trac:: ticket:123 this ticket |
56 | 61 | }}} |
57 | 62 | }}} |
| 63 | |
| 64 | This renders as: |
58 | 65 | ---- |
59 | 66 | |
60 | 67 | {{{ |
61 | 68 | #!rst |
| 69 | See |ticket123|. |
62 | 70 | |
63 | | See _`ticket:123` |
64 | | |
65 | | .. trac:: ticket:123 Ticket 123 |
| 71 | .. |ticket123| trac:: ticket:123 this ticket |
66 | 72 | }}} |
67 | | ---- |
68 | | The above form has the additional benefit of allowing you to specify an explicit label for the link. |
69 | 73 | |
70 | 74 | ---- |