RFR: JDK-8172312 Update docs target and image for new combined docs
Jonathan Gibbons
jonathan.gibbons at oracle.com
Mon Apr 3 23:59:34 UTC 2017
On 04/03/2017 04:42 PM, mark.reinhold at oracle.com wrote:
> 2017/4/3 11:01:13 -0700, jonathan.gibbons at oracle.com:
>> I agree there will need to be some cosmetic cleanup with respect to
>> headings. Given the optionality of whether or not the build is set to
>> import JavaFX, the headings and content of the new overview page will
>> need to be somewhat synthesized.
> Is it possible to have (up to) three sections of modules on the front
> page, where the first is headed by an orange "Java SE Modules" box, the
> second is "JavaFX Modules", and the third is "JDK Modules"?
>
> That, plus an updated title and some prose to explain that the first
> section is standard and the rest are not, would probably do the trick.
I'm not sure that we can partition the modules table in the remaining
time for 9,
although I do like the suggestion.
My thought had been to focus on the prose, so that the introductory text
on the
page has 3 paragraphs with appropriate subheadings, for the 3 groups that
you mention. I was hoping that the makefiles would then be able to
determine
which of those 3 sections would be appropriate for the docs bundle being
generated.
Going forward, I was thinking to repurpose the under-used -group option
to give something like the visual grouping you suggest.
See:
http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#group
Using the existing technology, it might be reasonably easy to change the
existing table, so that the Modules tab can replaced by a series of tabs
labelled "All Modules", "Java SE Modules", "JavaFX Modules" and "JDK
Modules".
I can raise this with the rest of jaavdoc team to see how difficult that
would be
in the remaining time.
>
>> The advantage of being able to generate a single big bundle is that the
>> new "javadoc Search" feature will work as expected. If we partition the
>> docs, then the scope of any search will be restricted to the subset of
>> docs currently being viewed.
> I agree that a unified search experience is very useful.
>
> - Mark
More information about the build-dev
mailing list