Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 4 and Version 5 of WikiRestructuredTextLinks


Ignore:
Timestamp:
Mar 18, 2017, 3:45:33 PM (3 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredTextLinks

    v4 v5  
    11= TracLinks in reStructuredText =
    22
    3 This document illustrates how to use the ``..trac::`` directive in reStructureThe page is written like
     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:
    44
    55{{{
    66{{{
    77#!rst
     8Examples:
    89
    9 Examples:
    1010 * Tickets: :trac:`#1` or :trac:`ticket:1`
    1111 * Ticket comments: :trac:`comment:ticket:1:2`
     
    1313 * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
    1414 * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
    15  * Diffs (since version 0.10): :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`
     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`
    1616 * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
    1717 * Milestones: :trac:`milestone:1.0`
     
    2121 * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
    2222
     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`.
    2326}}}
    2427}}}
    2528
    26 Provided you have docutils installed, the above block will render as:
     29Provided you have [http://docutils.sourceforge.net/ docutils] installed, the above block will render as:
    2730----
    2831{{{
    2932#!rst
     33Examples:
    3034
    31 Examples:
    3235 * Tickets: :trac:`#1` or :trac:`ticket:1`
    3336 * Ticket comments: :trac:`comment:ticket:1:2`
     
    3538 * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
    3639 * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
    37  * Diffs (since version 0.10): :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`
     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`
    3841 * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
    3942 * Milestones: :trac:`milestone:1.0`
     
    4346 * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`
    4447
     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`.
    4551}}}
    4652----
    4753
    48 Note also that any of the above could have been written using the alternate syntax for roles:
     54Note that the above could have been written using substitution references and the `trac::` directive:
    4955{{{
    5056{{{
    5157#!rst
     58See |ticket123|.
    5259
    53 See _`ticket:123`
    54 
    55  .. trac:: ticket:123 Ticket 123
     60 .. |ticket123| trac:: ticket:123 this ticket
    5661}}}
    5762}}}
     63
     64This renders as:
    5865----
    5966
    6067{{{
    6168#!rst
     69See |ticket123|.
    6270
    63 See _`ticket:123`
    64 
    65 .. trac:: ticket:123 Ticket 123
     71 .. |ticket123| trac:: ticket:123 this ticket
    6672}}}
    67 ----
    68 The above form has the additional benefit of allowing you to specify an explicit label for the link.
    6973
    7074----