|
Description
|
<H2> in overview.html gets mapped to ChapterSubHead, but
documentation says it should map to ClassSubHead.
This is because an overview section is closer to a package page,
which also maps to ClassSubHead.
Note 3:
<H2> in an overview file maps internally to "PackageSubHead" (because
there are no overview subheads) but then maps to "ClassSubHead" in
stylemap.properties for convenience.
http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#mappingofhtmltags
In the following case, the developer wants ChapterSubHead to start
a new page, but doesn't want the <H2> in overview.html to start a new page.
-----------------
In my XML book file I have
<chapter>
<overviewfile>../doc/api-overview.html</overviewfile>
</chapter>
<chapter>
<package>com.sun.jini.temp.davis.jeri. customer </package>
<class>com.sun.jini.temp.davis.jeri. customer .TcpServerEndpoint</class>
<class>com.sun.jini.temp.davis.jeri. customer .TcpEndpoint</class>
<sectionfile>doc-files/mux.html</sectionfile>
</chapter>
The mux.html file starts with an <H2> heading. I view this file
as at the same level as classes within the package, so I'd like
this section to start at the top of a page, and I'd like its heading
to have a font size comparable to that of ClassPreHead/ClassHead.
The <H2> gets translated to a ChapterSubHead, so I thought I could
customize my template.mif to make ChapterSubHead be
<PgfPlacement PageTop> and a larger font size than the default 14 pt.
But, the api-overview.html also starts with an <H2> heading which
gets translated to a ChapterSubHead.
and when used as an <overviewfile>,
a "Description" ChapterSubHead also gets prepended. So if I change
ChapterSubHead to be <PgfPlacement PageTop>, my overview ends up
as three pages: a page with nothing but an "Overview" OverviewHead,
a page with nothing but a "Description" ChapterSubHead and a one-sentence
description, and a page with an "Overview" ChapterSubHead and the
actual overview.
Is there a better way to handle this?
- Bob
|
