Using ReStructuredText on the Wiki

Martin Pool mbp at canonical.com
Sat Aug 26 02:01:12 BST 2006


On 25 Aug 2006, John Arbash Meinel <john at arbash-meinel.com> wrote:
> I was looking into it, and it seems the latest version of our website is
> restructured text enabled:
> 
> http://bazaar-vcs.org/HelpOnParsers/ReStructuredText
> 
> The help there is a little bit wrong, because you need to start the text as:
> 
> #FORMAT rst
> 
> not as "#!rst"
> 
> Anyway, I was wondering if it is okay to use this for wiki pages. Or
> whether we generally want to use Wiki for consistency.
> 
> I personally prefer rST, since it is also the format we use for our
> offline and now docs.bazaar.org/* documentation.

I prefer it too; also the syntax is somewhat more sensible than that of Moin. 
It might make it a bit more confusing for someone else who comes along
to edit it, but on the whole I think it's OK to use it.

> I really like being able to edit things in Vim (editmoin is very nice).
> But when using editmoin, there is no 'preview' button. So it frequently
> takes several iterations to get all of the wiki syntax correct. And each
> one generates an email that people have to deal with.

You can turn syntax highlighting on, which helps (but doesn't get all of
it.)

-- 
Martin




More information about the bazaar mailing list