Re: Converting HTML to Docbook

On Sat Jul 27, 2002 at 10:2844AM +0800, Alan Knowles wrote:
> If you are looking at creating a converter -->to<-->from<-- Docbook..
> Abiwords xml file format would be not that difficult to write a mapping 
> application

What I want to write is a *simple* system that allows programmers to
write documentation as easy as pie, as they can use a techniqe (HTML)
all of them know without having to invest time into learning Docbook
(even if it only takes 1/2 day).
For the programmer this has the advantage that his package looks kinda
complete since it comes with a end-user documentation. For us this has
the advantage that much more contributors to PEAR will write a
documentation for their package, which will make PEAR more acceptable.

> I didnt really want to add large amounts of html code to the phpdoc 
> comments, but a few

You should be able to add HTML to the inline comments already, no?
(Actually I haven't tried it myself so far, but I'm pretty sure I saw
it one time.)

> I think the idea is to try and avoid having multiple documentation 
> locations, with the same information - that have to be kept up to date..

IMO the PHPDoc documentation should point out the technical details of
the package. Documentation targeted to novice users of the package
shouldn't be created from the API documentation, since they usually
only want to know how they can use the package - they aren't
interested in the deepest technical things.

-- 
    - Martin                           Martin Jansen
                            http://martinjansen.com/

-- 
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php