The following 324 words could not be found in the dictionary of 615 words (including 615 LocalSpellingWords) and are highlighted below:

above   additional   adds   all   allows   alone   already   an   and   application   apt   areas   around   aspects   asterisks   at   Attachment   attachment   attachments   attacks   available   be   because   been   Before   behavior   below   Besides   block   box   but   by   can   candidates   cause   considered   contains   contents   converted   creates   creating   css   currently   Debian   default   denial   depends   designed   different   directive   directives   disallowed   displayed   distribution   distributions   docs   docstrings   document   documentation   documents   docutils   Docutils   does   domains   due   easier   easy   enable   Example   example   exist   expected   Experimental   experimental   explicit   extensibility   extensively   external   Features   features   file   find   following   footer   For   for   format   formatted   formatting   from   get   guarantee   header   Help   However   hyperlink   If   image   Images   improperly   in   Include   include   Included   included   including   Inline   inline   insert   inserting   install   Installation   installation   installed   instead   interpretation   into   isn   issue   Issues   italics   January   jpg   Known   lack   learn   lightweight   like   limited   line   link   Links   links   Linux   local   macro   Macro   macros   means   message   might   modified   module   more   most   must   name   named   natural   need   needs   net   new   newer   normal   note   now   number   of   often   on   On   or   order   Other   other   others   outlined   output   overlap   package   packages   page   Page   pages   Parser   parser   Parsers   part   People   picture   place   plaintext   prevent   previous   Primer   probably   produce   produces   program   provides   python   Python   Quick   quickly   quickref   raw   Re   re   read   reading   recent   recommended   recursive   Reference   reference   related   release   replace   replaced   replacement   restrictions   retrieval   revision   rightsidebar   roles   Rst   rst   same   schemes   search   Search   Second   security   see   See   sentence   service   Setext   sets   severe   sidebar   simple   simply   since   slightly   snapshot   sole   some   Some   source   sourceforge   special   specific   stand   Structured   such   Support   support   supported   Supported   supports   surrounding   syntax   system   systems   target   targets   Targets   ten   testing   text   Text   than   that   The   the   theme   then   there   These   They   this   This   through   Title   title   titles   to   To   too   took   two   type   typical   Typically   typically   Unknown   unknown   unsupported   upload   uploading   urls   Use   use   used   useful   user   Using   using   version   versions   very   web   well   What   what   When   when   which   while   whole   will   with   within   word   work   would   writer   Yesterday   yesterday   you   your   zip  

Clear message

    HelpOnParsers/ReStructuredText

What is ReStructured Text?

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 stand-alone documents. ReStructuredText is designed for extensibility for specific application domains. ReStructuredText is a revision and re-interpretation of the StructuredText and Setext lightweight markup systems.

People new to Wikis often find the ReStructuredText markup more natural and easier to learn than the default markup of MoinMoin.

ReStructuredText Parser

Installation

Before you can use it, you need to install the Python docutils package, which provides the additional ReStructuredText support that MoinMoin needs.

The docutils version you will need depends on the MoinMoin version. If you are reading this text here as part of your MoinMoin installation, you probably have MoinMoin 1.5 or newer, which currently (as of January 2006) needs docutils 0.4.0 or newer, or a recent 0.3.10 snapshot. If you are using MoinMoin on Linux, docutils is probably already available as part of your Linux distribution. For example on Debian GNU/Linux you simply need to type apt-get install python-docutils. Other Linux distributions use other means to install packages: See the documentation of your Linux distribution.

The Parser in MoinMoin

The parser supports the same features that are supported by the docutils HTML writer. However, some aspects have been slightly modified to work well with MoinMoin. These areas are outlined below. This parser is part of the MoinMoin distribution since release 1.3.2. However it can also be used with all versions of MoinMoin 1.2.X and 1.3.X.

Using ReST in MoinMoin

Example

Rendering of reStructured text is not possible, please install docutils.
This is a *very* simple example. If you see two asterisks around the word "very" in the previous sentence, then the module docutils is improperly installed (or not installed at all). When the module docutils is there, the word is displayed in italics and this whole block of text is not displayed in a special source-code-like format, but like a normal part of the page.

Unknown Targets

Unknown targets are used to create wiki links. Typically an unknown target would cause an error in a reStructuredText document. To enable wiki like behavior, unknown targets now create links to wiki pages using the target name as the name of the wiki page. For example: 

  • #!rst 
 
Here is a link to a MoinMoin page named SecondPage_.
    Rendering of reStructured text is not possible, please install docutils.
     
Here is a link to a MoinMoin page named SecondPage_.

The above contains a reStructuredText reference to "SecondPage". The reference would typically cause an unknown target error from the docutils parser. This is because there isn't a target in the document named "SecondPage". However, with the MoinMoin parser, the "SecondPage_" reference instead creates a link to a MoinMoin page named "SecondPage".

Support for MoinMoin-specific link schemes

MoinMoin-specific link schemes are supported when used in a reStructuredText explicit hyperlink target. For example: 

  • #!rst 
Here is a link to a page attachment__.

__ attachment:Attachment.zip
    Rendering of reStructured text is not possible, please install docutils.
    Here is a link to a page attachment__.

__ attachment:Attachment.zip

The above creates a link to an attachment named Attachment.zip. If the attachment for the page does not exist, the link text will be replaced with the typical MoinMoin replacement text for uploading an attachment. Supported MoinMoin-specific link schemes are:

  • wiki:

  • attachment:

  • inline:

  • drawing:

Inline Images

Docutils image directives, that are not urls, are converted to MoinMoin inline: links. This produces the expected behavior of inserting the image into the document. If the image attachment does not exist, the typical MoinMoin upload new attachment message will be displayed instead. For example: 

  • #!rst 
Here is the picture I took yesterday |image|

.. |image| image:: Yesterday.jpg
    Rendering of reStructured text is not possible, please install docutils.
    Here is the picture I took yesterday |image|

.. |image| image:: Yesterday.jpg

The above will insert the image "Yesterday.jpg" in place of |image|.

Experimental Features

The include and macro directives are considered experimental due to lack of testing. They are expected to work but have not been used extensively.

Include Support

The reStructuredText include directive is supported with some restrictions. The directive allows including wiki pages from the same wiki (page attachments are not candidates for the include directive). Included pages must be formatted using reStructuredText (wiki formatted pages will produce improperly formatted documents). For example, the following would insert the pages header and footer surrounding the page contents. 

  • #!rst 
.. include:: header

The sole document sentence.

.. include:: footer

The number of included documents is limited to ten. This is to prevent denial of service attacks using recursive include directives.

Macro Support

The MoinMoin reStructuredText parser adds a new MoinMoin specific macro directive. The directive allows access to MoinMoin macros from within a reStructuredText document. For example: 

  • #!rst 
Use the title search macro to insert a search box to search through page titles.

.. macro:: [[TitleSearch]]
    Rendering of reStructured text is not possible, please install docutils.
    Use the title search macro to insert a search box to search through page titles.

.. macro:: [[TitleSearch]]

Known Issues

  • Docutils and MoinMoin use different sets of css directives. Some directives overlap, while others do not. For example, the note directive is not displayed with any special formatting. This issue is most severe when using the rightsidebar theme with the docutils sidebar directive. The docutils sidebar will replace the MoinMoin sidebar. It is currently recommended that the sidebar directive not be used with MoinMoin.

  • Features related to external URL and local file retrieval are unsupported by the parser in order to guarantee local security. Besides that, raw roles and other features that might support the user to output raw HTML are disallowed, too.

Links

Recent