Re: reStructuredText
| From: | Martin Jansen | Date: | Thu, 12 Jun 2003 18:15:52 +0000 |
| Subject: | Re: reStructuredText | ||
| References: | 1 2 3 4 5 6 7 8 9 10 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-17359@lists.php.net to get a copy of this message | ||
On Thu Jun 12, 2003 at 02:2111PM +0200, Pierre-Alain Joye wrote:
> On 12 Jun 2003 14:10:41 +0200
> Christian Stocker <chregu@bitflux.ch> wrote:
> > At the moment, the Bitflux Editor is not that advanced to be used with
> > full blown docbook as phpdoc is, but we are currently developing a
> > much improved version, so please don't judge about the demo and come
> > to LinuxTag ;)
>
> Again, I like your vision :). Docbook should be the format;
What is the problem with a reST -> Docbook parser? This way we can
easily import the documentation written in reST into the manual and we
have a easy-to-use format for the developers. => No need to leave
Docbook.
> That said, reST is obviously a specific syntax.
Tell me a format that has no 'specific syntax'.
> It will a pain for the peardoc team to work with many formats. Docbook
> can quickly have something to edit the files in a wysiwyg tool, using
> post transformations to get peardoc2 files (phpdocu?).
I guess everybody agrees with you that phpDocumentor is great for API
documentation. But why do you fail to see that API documentation and
end-user documentation are different things? I don't think that
"controlling" the end-user documentation in the API documentation is a
good thing.
> I doubt this will
> be possible to get that quickly with reST.
Jon already posted a link for Docbook converter.
--
- Martin Martin Jansen
http://martinjansen.com/