PEAR-Doc Was: Re: [PEAR-DEV] Where is the value ?
| From: | Alexander Merz | Date: | Mon, 02 Jul 2001 23:07:36 +0000 |
| Subject: | PEAR-Doc Was: Re: [PEAR-DEV] Where is the value ? | ||
| References: | 1 2 3 4 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-534@lists.php.net to get a copy of this message | ||
> documentation publisher system (used by the PHP Manual), but I also know
> that perhaps it is too much for writing quick and small docs. I've
ACK. I discuss this topic on the german php-mailing-list, but with not much
feedback. Egon Schmid, the maintainer of the php-manual, said to me, to take a
look of existing docbook php documentation of PEAR and to use it as pattern.
This statment is now 3 weeks old and the Config doc is still plain text...
> develop my own ultra limited system (the one I used to build the doc for
> Pear DB), that reads standar Pear definition packages (package.xml),
Perhaps we should really think about a doc-format language equal to pod, easy
to understand and to learn. But in opposition to pod the documentation should
by XML.
After two beers, i have this idea: Use the HTML-Syntax and mix it with some
docbook-keywords.
Example:
<div id="chapter" name="Config">
<div id="title">Config</div>
<ul>
<li><a href="#parseInput">parseInput()</a></li>
...
</ul>
<a name="parseInput">
<div id="paragraph" name="parseInput">
<div id="title">parseInput()</div>
<div id="funcdecl">mixed parseInput( $datasrc, $options)</div>
<div id="paragraph">
Read and transform the given datasource into the internal ...
</div>
<div id="example" name="Example for parseInput">
</div>
</div>
The HTML-syntax is already know, browsers can show this stuff without any
transformations ( big different to docbook or phpdoc-comments!), the keywords
are easy to memorize, and it should be not a big task to transform this into
docbook.