reStructuredText
Sivan Green
sivan at piware.de
Fri Nov 26 20:43:11 UTC 2004
Matt Zimmerman wrote:
>Advantages of reStructuredText:
>
>- Approximately WYSIWYG
>- The renderer produces warnings when it won't do quite what you expect
>
>Disadvantages of reStructuredText:
>
>- Unforgiving (I almost never get it right on the first attempt)
>- Produces warnings even when the user's intent is easily deduced
>- In pursuit of WYSIWYG, places cosmetic burdens on the user as part of the
> markup (e.g., enumerated lists are just painful)
>
>In my opinion, the nature of a wiki implies that the most important
>attributes for the markup language are that it be:
>
>- Forgiving
>- Predictable
>- Easy to learn
>
>so that nearly anyone can jump in and start contributing immediately. I
>think that reStructuredText fails on all three accounts.
>
>Some documents which I originally wrote in moin have since been converted to
>reStructuredText, and I find them difficult to maintain. Has the
>documentation team standardized on reStructuredText? If so, can I beg you
>to reconsider, at least for simple wiki documents? :-)
>
>
I think that you have a very good point there - I have had the same
thoughts about ReST altogether, and I would like us very much to
standardize wiki contributiongs on MoinMoin's wonderful makrup from the
wonderfully put reasons you have just outlined.
I think that our intent to make the wiki a place for no more than really
a sketch of ideas, erreta probiving corner and important updates in the
style of a README.TXT file, suits this also.
We already agreed that wiki should not be used as a document production
platform, but only as a mere draft or idea proposal ground.
No need to beg on my account, I am already using MoinMoin for all my
wiki needs, this might be a good point to be brought on the next
documentation team meetin, when it's scheduled. (We're still finalizing
the times and date)
Anybody oppinions?
Sivan
More information about the ubuntu-doc
mailing list