Re: reStructuredText

On Thu, Jun 12, 2003 at 08:20:17PM +0200, Pierre-Alain Joye wrote: > > Tell me a format that has no 'specific syntax'. > > Tell me a tool to edit reST as we should do it with some office tools or > with future version of bitflux? I use a text editor to edit reST. I don't think user documentation for a PEAR package really requires advanced editing features such as those provided by an office tool. I just need headings, example blocks, and hyperlinks. Syntactially, reST is simpler than HTML, and I'm sure most PEAR developers don't require an office tool to author HTML. > > 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. > > Please, *read* the phpdocumentor documentation and come back :) I don't want to wade into the "one tool to rule them all" argument any further. It's becoming one of those "When you have a hammer, everything starts to look like a nail" kinds of things. > > Jon already posted a link for Docbook converter. > > Python, do I have to remember you the phpdoc history? why depends of > python as we have all in hands to do it with php? I really wonder why. What do you have against Python? I get the feeling if the reST tools I advocate were written in Perl or some language with which PHP folks were more comfortable, this would be less of an issue. Again, I advocate the Python tools because they already exist and work well. The code speaks for itself, and I'm sorry that you have to 'rpm -i python' (or whatever your preferred installation method is) in order to use them. This is getting silly. -- Jon Parise (jon@php.net) :: The PHP Project (http://www.php.net/)