Keka
the Mac OS X file archiver
Download Changelog Forum Help Trac Project

Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
03/03/12 13:16:24 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v1 v2  
    2727
    2828 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
    29    ||= Wiki Markup ||= Display ||
    30    {{{#!td
    31      {{{
    32      {{{
    33      #!rst
    34      This is a reference to |a ticket|
    3529
    36      .. |a ticket| trac:: #42
    37      }}}
    38      }}}
    39    }}}
    40    {{{#!td
    41      {{{
    42      #!rst
    43      This is a reference to |a ticket|
     30 Example:
     31 {{{
     32 {{{
     33 #!rst
     34 This is a reference to |a ticket|
    4435
    45      .. |a ticket| trac:: #42
    46      }}}
    47    }}}
     36 .. |a ticket| trac:: #42
     37 }}}
     38 }}}
    4839
    4940 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
    50    ||= Wiki Markup ||= Display ||
    51    {{{#!td
    52      {{{
    53      {{{
    54      #!rst
    55      This is a reference to ticket `#12`:trac:
    5641
    57      To learn how to use Trac, see `TracGuide`:trac:
    58      }}}
    59      }}}
    60    }}}
    61    {{{#!td
    62      {{{
    63      #!rst
    64      This is a reference to ticket `#12`:trac:
     42 Example:
     43 {{{
     44 {{{
     45 #!rst
     46 This is a reference to ticket `#12`:trac:
    6547
    66      To learn how to use Trac, see `TracGuide`:trac:
    67      }}}
    68    }}}
     48 To learn how to use Trac, see `TracGuide`:trac:
     49 }}}
     50 }}}
    6951
    7052 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
     
    7658code-block
    7759
    78 ||= Wiki Markup ||= Display ||
    79 {{{#!td
    80   {{{
    81   {{{
    82   #!rst
     60Example
    8361
    84   .. code-block:: python
     62{{{
     63{{{
     64#!rst
    8565
    86      class Test:
     66.. code-block:: python
    8767
    88          def TestFunction(self):
    89              pass
    90  
    91   }}}
    92   }}}
     68 class Test:
     69
     70    def TestFunction(self):
     71        pass
     72
    9373}}}
    94 {{{#!td
    95   {{{
    96   #!rst
     74}}}
    9775
    98   .. code-block:: python
     76Will result in the below.
    9977
    100      class Test:
     78{{{
     79#!rst
    10180
    102          def TestFunction(self):
    103              pass
     81.. code-block:: python
    10482
    105   }}}
     83 class Test:
     84
     85    def TestFunction(self):
     86        pass
     87
    10688}}}
    107 Note the need to indent the code at least one character after the `.. code-block` directive.
    10889
    10990=== Wiki Macros in reStructuredText ===
     
    11192For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.
    11293
    113 ||= Wiki Markup ||= Display ||
    114 {{{#!td
    115   {{{
    116   {{{
    117   #!rst
     94=== Wiki Macro Example ===
    11895
    119   .. code-block:: RecentChanges
     96{{{
     97{{{
     98#!rst
    12099
    121      Trac,3
     100.. code-block:: RecentChanges
    122101
    123   }}}
    124   }}}
     102   Trac,3
     103
    125104}}}
    126 {{{#!td
    127   {{{
    128   #!rst
    129 
    130   .. code-block:: RecentChanges
    131 
    132      Trac,3
    133 
    134   }}}
    135105}}}
    136106
    137 Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role:
     107Will result in the below:
    138108
    139 ||= Wiki Markup ||= Display ||
    140 {{{#!td
    141   {{{
    142   {{{
    143   #!rst
     109     [[RecentChanges(Trac,3)]]
    144110
    145   :code-block:`RecentChanges:Trac,3`
    146   }}}
    147   }}}
     111Or a more concise Wiki Macro like syntax is also available:
     112
     113{{{
     114{{{
     115#!rst
     116
     117:code-block:`RecentChanges:Trac,3`
    148118}}}
    149 {{{#!td
    150   {{{
    151   #!rst
    152 
    153   :code-block:`RecentChanges:Trac,3`
    154   }}}
    155119}}}
    156120
    157121=== Bigger RST Example ===
    158122The example below should be mostly self-explanatory:
    159 
    160 ||= Wiki Markup ||= Display ||
    161 {{{#!td
    162123{{{
    163124#!html
     
    189150}}}</pre>
    190151}}}
    191 }}}
    192 {{{#!td
     152
     153
     154Results in:
    193155{{{
    194156#!rst
     
    217179.. _webpage: http://docutils.sourceforge.net/rst.html
    218180}}}
    219 }}}
     181
    220182
    221183----