[dbdoclet] Package overviews in reference style
- From: <Jere.Kapyaho@xxxxxxxxx>
- To: <dbdoclet@xxxxxxxxxxxxx>
- Date: Tue, 5 Jul 2005 12:29:28 +0300
Hello Michael,
I returned to dbdoclet after a short pause and tried the reference style with
0.64.2. Seems there is a slight problem with package overview files with the
reference style, or it could be just my ignorance...
If I put a package.html file in the root directory of some package in the
normal JavaDoc way and then generate DocBook XML, the contents of the file are
included, but not as DocBook XML markup. That is, given a package.html file
with this content:
<body>
<p>This is the package overview for the second package.</p>
<h2>Subheading</h2>
<p>Some explanation of the second package contents goes here.</p>
</body>
The result is the following markup in docs/Reference.xml:
<reference id="PACKAGE-1" xreflabel="com.acme.something.package1">
<title>Package com.acme.something.package1</title>
This is the package overview for the first package.<emphasis
remap="h2" role="bold">Subheading</emphasis>SubheadingSome explanation of the
package contents goes here.
<refentry id="CLASS-1" xreflabel="com.acme.something.package1.Inspectable">
(and so on)
Maybe the p tag should be replaced with para, and the h2 maybe with 'bridgehead
renderas="sect2"' or similar? Or is there another way to get the package.html
contents in there neatly? Maybe you haven't had trouble with this because you
don't seem to use package descriptions in the dbdoclet source code.
--Jere
- Follow-Ups:
- [dbdoclet] Re: Package overviews in reference style
- From: Michael Fuchs
Other related posts:
- » [dbdoclet] Package overviews in reference style
- » [dbdoclet] Re: Package overviews in reference style
- [dbdoclet] Re: Package overviews in reference style
- From: Michael Fuchs