Re: reStructuredText

Martin Jansen wrote:

On Wed Jun 11, 2003 at 10:4531PM +0200, Pierre-Alain Joye wrote:

On Wed, 11 Jun 2003 22:32:55 +0200 Martin Jansen <mj@php.net> wrote:

Using phpDocumentor for *all* documentation related topics still implies for me that the documentation (usage examples, tutorials) will be stored within the source code. This definitively isn't optimal.

You may look again at phpDocumentor. You will see there is something about general documentations and not inline docs. Using only it allows us to make link from the inline docs to outline documentations/tutorials.

In which format will this external documentation be written? Is it interchangeable, so that we can easily export it to Docbook, PDF or HTML?

The format for the external documentation is docbook, with the ability to use the same tags as you would in your source. An example is: http://cvs.phpdoc.org/co.php/phpdoc/tutorials/phpDocumentor/manual.pkg?r=1.6 I haven't checked out reStructuredText but I don't see any reason why someone couldn't add a code to phpDocumentor to all it to be used for tutorials instead of docbook (still leaving docbook as an option of course) -joshua eichorn