Changes between Version 1 and Version 2 of WikiRestructuredText


Ignore:
Timestamp:
Jan 10, 2010 6:55:07 PM (4 years ago)
Author:
trac
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 
     
    8488}}} 
    8589 
    86 === WikiMacros in reStructuredText === 
     90=== Wiki Macros in reStructuredText === 
    8791 
    88 For doing WikiMacros in ReST you use the same directive as for syntax highlightning 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 
     93code-block. To work you must use a version of trac that has [trac:ticket:801 #801] applied.  
    9094 
    91 === WikiMacro Example === 
     95=== Wiki Macro Example === 
    9296 
    9397{{{ 
     
    9599#!rst 
    96100 
    97 .. code-block:: HelloWorld 
    98   
    99    Something I wanted to say 
     101.. code-block:: RecentChanges 
    100102 
     103   Trac,3 
    101104 
    102105}}} 
    103106}}} 
    104107 
    105 Will result in the below. 
     108Will result in the below: 
    106109 
    107 [[HelloWorld(Something I wanted to say)]] 
     110     [[RecentChanges(Trac,3)]] 
    108111 
     112Or a more concise Wiki Macro like syntax is also available: 
    109113 
    110 === Bigger ReST Example === 
     114{{{ 
     115{{{ 
     116#!rst 
     117 
     118:code-block:`RecentChanges:Trac,3` 
     119}}} 
     120}}} 
     121 
     122=== Bigger RST Example === 
    111123The example below should be mostly self-explanatory: 
    112124{{{