Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
02/08/11 21:48:17 (10 years ago)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiRestructuredText

    v1 v2  
    66 "''reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser   system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating  simple web pages, and for standalone documents. reStructuredText is designed for extensibility for  specific application domains. ''"
    77
     8If you want a file from your Subversion repository be displayed as reStructuredText in Trac's source browser, set `text/x-rst` as value for the Subversion property `svn:mime-type`. See [trac:source:/trunk/INSTALL this example].
     9
    810=== Requirements ===
    911Note that to activate RST support in Trac, the python docutils package must be installed.
    1012If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].
     13
     14Install docutils using `easy_install docutils`. Do not use the package manager of your OS (e.g. `apt-get install python-docutils`), because Trac will not find docutils then.
    1115
    1216=== More information on RST ===
     
    2226=== TracLinks in reStructuredText ===
    2327
    24  * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.
     28 * Trac provides a custom RST directive `trac::` to allow TracLinks from within RST text.
    2529
    2630 Example:
     
    3438 }}}
    3539
    36  For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks.
    37 
    38 
    39  * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme.
     40 * Trac allows an even easier way of creating TracLinks in RST, using the custom `:trac:` role.
    4041
    4142 Example:
     
    4950 }}}
    5051
     52 For a complete example of all uses of the `:trac:` role, please see WikiRestructuredTextLinks.
     53
     54
    5155=== Syntax highlighting in reStructuredText ===
    5256
    53 There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
     57There is a directive for doing TracSyntaxColoring in RST as well. The directive is called
    5458code-block
    5559
     
    8690=== Wiki Macros in reStructuredText ===
    8791
    88 For doing [TracWikiMacros Wiki Macros] in ReST you use the same directive as for syntax highlighting i.e
    89 code-block. To work you must use a version of trac that has #801 applied.
     92For doing [WikiMacros Wiki Macros] in RST you use the same directive as for syntax highlighting i.e code-block.
    9093
    9194=== Wiki Macro Example ===
     
    9598#!rst
    9699
    97 .. code-block:: HelloWorld
    98  
    99    Something I wanted to say
     100.. code-block:: RecentChanges
    100101
     102   Trac,3
    101103
    102104}}}
     
    105107Will result in the below:
    106108
    107     [[HelloWorld(Something I wanted to say)]]
     109     [[RecentChanges(Trac,3)]]
    108110
    109 Or a more concise WikiMacro like syntax is also available:
     111Or a more concise Wiki Macro like syntax is also available:
    110112
    111113{{{
     
    113115#!rst
    114116
    115 :code-block:`HelloWorld:Something I wanted to say`
     117:code-block:`RecentChanges:Trac,3`
    116118}}}
    117119}}}
    118120
    119 === Bigger ReST Example ===
     121=== Bigger RST Example ===
    120122The example below should be mostly self-explanatory:
    121123{{{