HelpOnRST

Using RST on the Wiki

We recently updated the Wiki so we can write Wiki pages using ReStructuredText (rst) rather than the default BizarStructuredText. The short of it is this:

• The first characters of your Wiki page must be:

  #format rst                                                                 

  This tells MoinMoin that the language of the page is rst.

• You can use rst as you normally do with the exception of include directives. These are disabled in MoinMoin "for security reasons."

• MoinMoin makes Wiki links out of any undefined rst links. In other words, if WikiLink is not valid, then the following rst will link to the Wiki Page named WikiLink:

  Look!  It's a WikiLink_!

  In the rendered page, this looks like:

  Look! It's a WikiLink!

  You can do external URL references as you would in normal rst. As a refresher:

  We use Python__ for  `our research`__.
  
  __ http://www.python.org
  
  __ http://o2s.csail.mit.edu
  
  Sometimes we also use Java_.
  
  .. _Java: http://java.sun.com

  Gets rendered as:

  We use Python for our research.

  Sometimes we also use Java.

  Tip

  Rembember, when using named targets like the Java example above, the link ends in _ and the target starts with _. If you keep getting a WikiLink when you don't expect it, you probably confused these.

• Some things don't get rendered properly, but that's a CSS issue more than anything else.
• For more details, see ReStructuredText on the MoinMoin Wiki.

I've started documenting the iPAQs in rst, so you can look at InstallingPython for a live example or the source to this page.