peardoc2 converter functional - testing needed
| From: | Greg Beaver | Date: | Wed, 19 Feb 2003 04:48:47 +0000 |
| Subject: | peardoc2 converter functional - testing needed | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-13472@lists.php.net to get a copy of this message | ||
Hi,
After a good deal of work, the phpDocumentor peardoc2 converter is committed
to cvs with working category support. Because the peardoc2 stuff is so
pear-specific, I've decided the best way to implement these things is a
separate converter from the standard DocBook converter. To access peardoc2
templates in CVS, use XML:DocBook/peardoc2:default. This will allow any
future updates to be separate templates as in
XML:DocBook/peardoc2:version3.0 or something, so documentation can be
generated in peardoc2 old/new formats without extra hassle.
The addition of -dc --defaultcategoryname is the simplest way to set the
peardoc2 category for a set of packages. With this command-line, one can
set any category. There is no error-checking yet, so be sure the category
is what openjade expects to see (use "datetime," not "Date and Time"). The
best thing that people can do to assist in the release of this functional
peardoc2 converter is to get anonymous cvs (instructions at
http://www.phpdoc.org) for phpDocumentor, and try it out. Post
bugs at the
sourceforge page, and we will fix them.
The category can also be set in the source code using the @category tag.
Tutorials do not yet have implemented the extraction of category from their
tutorial.ini files, as I literally just thought of this idea just now, but
that will be added next week when I return from a quartet residency in
Indiana.
The most exciting addition in a while has been the efforts of Marco van
Ballmoos. He has adapted the phpedit template to a new template called
"earthli" which can be used by HTML:frames:earthli. The example output is
at http://www.phpdoc.org/docs/HTMLframesConverter/earthli/.
His is the
first template to customize source highlighting, showing the full range of
power of phpDocumentor's source highlighting capabilities. Compare the
source highlighting to other templates, and one can see the difference. The
layout is also tremendously clean and very attractive.
Greg
--
phpDocumentor
http://www.phpdoc.org