Changes between Version 1 and Version 2 of WikiRestructuredText
- Timestamp:
- Jul 30, 2012 5:33:18 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiRestructuredText
v1 v2 27 27 28 28 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text. 29 30 Example: 31 {{{ 32 {{{ 33 #!rst 34 This is a reference to |a ticket| 35 36 .. |a ticket| trac:: #42 37 }}} 38 }}} 29 ||= Wiki Markup ||= Display || 30 {{{#!td 31 {{{ 32 {{{ 33 #!rst 34 This is a reference to |a ticket| 35 36 .. |a ticket| trac:: #42 37 }}} 38 }}} 39 }}} 40 {{{#!td 41 {{{ 42 #!rst 43 This is a reference to |a ticket| 44 45 .. |a ticket| trac:: #42 46 }}} 47 }}} 39 48 40 49 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role. 41 42 Example: 43 {{{ 44 {{{ 45 #!rst 46 This is a reference to ticket `#12`:trac: 47 48 To learn how to use Trac, see `TracGuide`:trac: 49 }}} 50 }}} 50 ||= Wiki Markup ||= Display || 51 {{{#!td 52 {{{ 53 {{{ 54 #!rst 55 This is a reference to ticket `#12`:trac: 56 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: 65 66 To learn how to use Trac, see `TracGuide`:trac: 67 }}} 68 }}} 51 69 52 70 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks. … … 58 76 code-block 59 77 60 Example 61 62 {{{ 63 {{{ 64 #!rst 65 66 .. code-block:: python 67 68 class Test: 69 70 def TestFunction(self): 71 pass 72 73 }}} 74 }}} 75 76 Will result in the below. 77 78 {{{ 79 #!rst 80 81 .. code-block:: python 82 83 class Test: 84 85 def TestFunction(self): 86 pass 87 88 }}} 78 ||= Wiki Markup ||= Display || 79 {{{#!td 80 {{{ 81 {{{ 82 #!rst 83 84 .. code-block:: python 85 86 class Test: 87 88 def TestFunction(self): 89 pass 90 91 }}} 92 }}} 93 }}} 94 {{{#!td 95 {{{ 96 #!rst 97 98 .. code-block:: python 99 100 class Test: 101 102 def TestFunction(self): 103 pass 104 105 }}} 106 }}} 107 Note the need to indent the code at least one character after the `.. code-block` directive. 89 108 90 109 === Wiki Macros in reStructuredText === 91 110 92 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e 93 code-block. To work you must use a version of trac that has [trac:ticket:801 #801] applied. 94 95 === Wiki Macro Example === 96 97 {{{ 98 {{{ 99 #!rst 100 101 .. code-block:: RecentChanges 102 103 Trac,3 104 105 }}} 106 }}} 107 108 Will result in the below: 109 110 [[RecentChanges(Trac,3)]] 111 112 Or a more concise Wiki Macro like syntax is also available: 113 114 {{{ 115 {{{ 116 #!rst 117 118 :code-block:`RecentChanges:Trac,3` 119 }}} 111 For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block. 112 113 ||= Wiki Markup ||= Display || 114 {{{#!td 115 {{{ 116 {{{ 117 #!rst 118 119 .. code-block:: RecentChanges 120 121 Trac,3 122 123 }}} 124 }}} 125 }}} 126 {{{#!td 127 {{{ 128 #!rst 129 130 .. code-block:: RecentChanges 131 132 Trac,3 133 134 }}} 135 }}} 136 137 Or a more concise Wiki Macro like syntax is also available, using the `:code-block:` role: 138 139 ||= Wiki Markup ||= Display || 140 {{{#!td 141 {{{ 142 {{{ 143 #!rst 144 145 :code-block:`RecentChanges:Trac,3` 146 }}} 147 }}} 148 }}} 149 {{{#!td 150 {{{ 151 #!rst 152 153 :code-block:`RecentChanges:Trac,3` 154 }}} 120 155 }}} 121 156 122 157 === Bigger RST Example === 123 158 The example below should be mostly self-explanatory: 159 160 ||= Wiki Markup ||= Display || 161 {{{#!td 124 162 {{{ 125 163 #!html … … 151 189 }}}</pre> 152 190 }}} 153 154 155 Results in: 191 }}} 192 {{{#!td 156 193 {{{ 157 194 #!rst … … 180 217 .. _webpage: http://docutils.sourceforge.net/rst.html 181 218 }}} 182 219 }}} 183 220 184 221 ----