Converting HTML to Docbook
| From: | Martin Jansen | Date: | Fri, 26 Jul 2002 18:19:48 +0000 |
| Subject: | Converting HTML to Docbook | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-8036@lists.php.net to get a copy of this message | ||
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).
This layout still misses things like semi-automated function
definitions (parameters, return value etc.), but it should be enough
to give a programmer, who does not want to mess around with Docbook,
the ability to write documentation, that can be automatically
integrated into the manual.
At a later point we will perhaps even be available to create a (HTML-)
skeleton from the PHPDoc comments, which can be edited by the
programmer, but for now I think this system should work out pretty
well.
Please comment on this and tell me your suggestions. I hope to be able
to start working on this next weeek (this is when I'll also try to
finish a first version of the PEAR bug reporting interface). After
that I will be on vacation for two weeks with no PEAR, PHP or email at
all.
--
- Martin Martin Jansen
http://martinjansen.com/