Changes between Version 1 and Version 2 of WikiRestructuredTextLinks


Ignore:
Timestamp:
07/30/08 10:19:03 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiRestructuredTextLinks

    v1 v2  
    11= TracLinks in reStructuredText = 
    22 
    3 This document is for testing the ``..trac::`` directive. The page is written like 
     3This document illustrates how to use the ``..trac::`` directive in reStructureThe page is written like 
    44 
    55{{{ 
    … …  
    77#!rst  
    88 
    9 Examples 
    10 ... 
    11 ... 
     9Examples: 
     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 (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` 
     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` 
    1222 
    1323}}} 
    1424}}} 
    1525 
     26Provided you have docutils installed, the above block will render as: 
     27---- 
     28{{{ 
     29#!rst  
    1630 
    17 This is a list of example uses of the ''trac'' directive, providing use of TracLinks in WikiRestructuredText. 
    18 Note that not all that functionality has been merged yet. The patch attached to #801 provides all of these. 
     31Examples: 
     32 * Tickets: :trac:`#1` or :trac:`ticket:1` 
     33 * Ticket comments: :trac:`comment:ticket:1:2` 
     34 * Reports: :trac:`{1}` or :trac:`report:1` 
     35 * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1` 
     36 * 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` 
     38 * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase` 
     39 * Milestones: :trac:`milestone:1.0` 
     40 * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff` 
     41 * Files: :trac:`source:trunk/COPYING` 
     42 * A specific file revision: :trac:`source:/trunk/COPYING@200` 
     43 * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25` 
    1944 
     45}}} 
     46---- 
     47 
     48Note also that any of the above could have been written using the alternate syntax for roles: 
     49{{{ 
     50{{{ 
     51#!rst 
     52 
     53See _`ticket:123` 
     54 
     55 .. trac:: ticket:123 Ticket 123 
     56}}} 
     57}}} 
     58---- 
    2059 
    2160{{{ 
    2261#!rst 
    2362 
    24 Examples 
    25 -------- 
     63See _`ticket:123` 
    2664 
    27 trac role 
    28 ========= 
    29 Syntax is \`link\`\:trac: or :trac:\`link\`, and could be put anywhere in the text. 'link' has the same format as explain for the ``.. trac::`` directive below. 
    30  
    31 ``In the middle of my text `WikiFormatting`:trac: see!!!!``  
    32    In the middle of my text `WikiFormatting`:trac: see!!!! 
    33  
    34 or 
    35  
    36 ``In the middle of my text :trac:`WikiFormatting` see!!!!``  
    37    In the middle of my text :trac:`WikiFormatting` see!!!! 
    38  
    39  
    40 wiki 
    41 ==== 
    42 ``.. trac:: WikiFormatting`` 
    43         .. trac:: WikiFormatting 
    44  
    45 ``.. trac:: wiki:WikiFormatting`` 
    46        .. trac:: wiki:WikiFormatting 
    47  
    48 ``.. trac:: wiki:WikiFormatting WikiFormatting`` 
    49         .. trac:: wiki:WikiFormatting WikiFormatting 
    50  
    51 ``.. trac:: wiki:WikiFormatting LinkText`` 
    52         .. trac:: wiki:WikiFormatting LinkText 
    53  
    54 tickets 
    55 ======= 
    56  
    57 ``.. trac:: #1`` 
    58         .. trac:: #1 
    59 ``.. trac:: #1 ticket one`` 
    60         .. trac:: #1 ticket one 
    61 ``.. trac:: ticket:1`` 
    62         .. trac:: ticket:1 
    63 ``.. trac:: ticket:1 ticket one`` 
    64         .. trac:: ticket:1 ticket one 
    65  
    66 reports 
    67 ======= 
    68  
    69 ``.. trac:: {1}`` 
    70         .. trac:: {1} 
    71 ``.. trac:: {1} report one`` 
    72         .. trac:: {1} report one 
    73 ``.. trac:: report:1`` 
    74         .. trac:: report:1 
    75 ``.. trac:: report:1 report one`` 
    76         .. trac:: report:1 report one 
    77  
    78 changesets 
    79 ========== 
    80  
    81 ``.. trac:: [42]`` 
    82         .. trac:: [42] 
    83 ``.. trac:: [42] changeset 42`` 
    84         .. trac:: [42] changeset 42 
    85 ``.. trac:: changeset:42`` 
    86         .. trac:: changeset:42 
    87 ``.. trac:: changeset:42 changeset 42`` 
    88         .. trac:: changeset:42 changeset 42 
    89 ``.. trac:: foo`` 
    90         .. trac:: foo 
    91  
    92 files 
    93 ===== 
    94  
    95 ``.. trac:: browser:/trunk/trac`` 
    96         .. trac:: browser:/trunk/trac 
    97  
    98 The leading ``/`` can be omitted... 
    99  
    100 ``.. trac:: repos:trunk/trac trunk/trac`` 
    101         .. trac:: repos:trunk/trac trunk/trac 
    102 ``.. trac:: source:trunk/trac Trac source code`` 
    103         .. trac:: source:trunk/trac Trac source code 
    104  
    105 ``.. trac:: browser:trunk/README`` 
    106         .. trac:: browser:trunk/README 
    107 ``.. trac:: repos:trunk/README trunk/README`` 
    108         .. trac:: repos:trunk/README trunk/README 
    109 ``.. trac:: source:trunk/README README in trunk`` 
    110         .. trac:: source:trunk/README README in trunk 
    111  
    112 Note that if ``hoo`` is a file, the link targets its revision log. In order to see the file's content, you need to specify the revision explicitely, like here: 
    113  
    114 ``.. trac:: browser:/trunk/README#latest latest of trunk/README`` 
    115         .. trac:: browser:/trunk/README#latest latest of trunk/README 
    116 ``.. trac:: repos:trunk/README#42 trunk/README in rev 42`` 
    117         .. trac:: repos:trunk/README#42 trunk/README in rev 42 
     65.. trac:: ticket:123 Ticket 123 
    11866}}} 
     67---- 
     68The above form has the additional benefit of allowing you to specify an explicit label for the link. 
    11969 
    12070---- 
    121 See also: WikiRestructuredTextLinks, TracLinks 
     71See also: WikiRestructuredText, TracLinks