Re: reStructuredText (was: RE: [PEAR-DEV] Net_SMTP user's guide)
| From: | Pierre-Alain Joye | Date: | Wed, 11 Jun 2003 18:43:29 +0000 |
| Subject: | Re: reStructuredText (was: RE: [PEAR-DEV] Net_SMTP user's guide) | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-17322@lists.php.net to get a copy of this message | ||
On Wed, 11 Jun 2003 14:36:31 -0400
Jon Parise <jon@php.net> wrote:
> On Wed, Jun 11, 2003 at 07:06:42PM +0200, Lukas Smith wrote:
>
> > > I mention this here because I authored the documentation using
> > > reStructuredText and docutils (http://docutils.sf.net/). I found
> > > it to be a very comfortable system for writing package
> > > documenation and wanted to mention it to the development community
> > > at large.
> >
> > This looks to be like what wiki is to CMS for documentation :-)
>
> Yes, that's a good analogy. A lot of wikis use a form of structured
> text in their markup engines.
>
> I like it for documentation because, unlike DocBook, the "source"
> document is as readable as the rendered versions.
Funny things from Norm Walsh :-)
http://www.xmlhack.com/read.php?item=1990
As we discussed before about it, I like the format. However, I would
like to do not depend on an external tools to document/generate
documentation for PEAR.
I still have to look what is currently needed to provide an easy edition
solution to write/edit/translate documentations and tutorials. My eyes
look in the direction of phpdocumentor for the generation. My fingers
look at the different office tools for the edition :)
pierre