Re: PEAR Docs... again
| From: | Arnaud Limbourg | Date: | Sun, 02 May 2004 10:06:58 +0000 |
| Subject: | Re: PEAR Docs... again | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-28690@lists.php.net to get a copy of this message | ||
I would put that along with the wiki formatting which makes it easy to write doc and easy to convert
to another format.
It goes along the line with what blog tools like textile and markdown try to do. They make it easy
to write text with formatting syntax which is converted to xhtml. From there it is a little step
towards other formats.
Arnaud.
> Pears,
>
> I have been thinking a little today. It hurt, I won't do it again rest
> assured.
>
> I have been wondering if anybody is interested in this:
>
> Write you documentation as nice (easy) HTML of the form:
>
> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
>
> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
> <html xmlns="http://www.w3.org/1999/xhtml">
> <head>
> <title>Package Name</title>
> </head>
> <body>
> <h1>Section Name</h1>
> <p>
> Section stuff.
> </p>
> <code>
> <?php echo "Some Example"?>
> </code>
> <h1>New Section</h1>
> <p>
> More section stuff
> </p>
> <h2>Sub-Section Name</h2>
> <p>
> even more section stuff
> </p>
> <h2>Second Sub-Section Name</h2>
> <p>
> yet more section stuff
> </p>
> </body>
> </html>
>
> You then upload your documentation as a tar(.gz?) file to a website.
>
> This nice, easy HTML, will be automatically converted to DocBook using
> the new PHP5 XSLT stuff - with the ability to call PHP functions, I can
> output to the seperate files/generate TOC and such that is needed.
>
> The DocBook is then validated on the server, so you don't need to worry
> about that. If its valid, the results will be served to you as a .tar.gz
> (or if the validation takes a little while, you will be mailed a link to
> the .tar.gz)
>
> This seems like at the very least, another good solution to contribute
> to solving the Documentation problem...
>
> Thoughts?
>
> - Davey
>
> --
> PEAR Development Mailing List (http://pear.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>