Re: Converting HTML to Docbook
| From: | Tomas V.V.Cox | Date: | Mon, 29 Jul 2002 12:36:01 +0000 |
| Subject: | Re: Converting HTML to Docbook | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-8064@lists.php.net to get a copy of this message | ||
Martin Jansen wrote:
>
> Hi,
>
> the following text describes my plans for HTML2Docbook converter for
> PEAR.
>
> A programmer can use some very basic HTML tags in order to create his
> documentation for the package. This tags are:
>
> * <h1 />
> * <h2 />
> * <p />
> * <code />
> * <tt />
> * <a />
>
> <h1 /> is the title of the package (e.g. 'XML_RSS'). <h2 /> starts a new
> subelement (e.g. 'Introduction' or the documentation of a
> function). <p /> defines a paragraph with text while <code /> defines
> a sourcecode listing (aka PHP example code). <tt> can be used to point
> out filenames during texts in paragraphs. <a /> can either define
> internal or external links.
>
> Perhaps we could even abuse <div> to start special areas of the
> documentation (like examples, warning or notes).
I'd add <ul> too. In my tutorials at vulcanonet.com/soft I basically use
<h>, <p>, <b>, <i>, <code>, <ul> and that's all and I think
it looks
enough readable and pretty. Hope to see that kind of tool working, go go
:-)
Tomas V.V.Cox