Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-5044589

Generated HTML should be designed for style-sheet customization: class, div, id

XMLWordPrintable

      Name: gm110360 Date: 05/10/2004

      A DESCRIPTION OF THE REQUEST :
      I wouid like to have a lot of control over the look of my document, but not change the standard layout. For example, I want to play with the background colors/images of of table headers, font weights for various components, table lines, fonts for particular headings, etc.

      The current standard doclet has a very limited stab in this direction, but it is no more than the smallest start. I would expect something like the following:

      Each major area should have a class. These should nest. An entire page of a class doc should have one class (different from a package page), and so on. Maybe something like:

      ClassPage
          NavBar
              NavBarCurrent
              ...
          Overview
              PackageName
              ClassName
              Hierarchy
          Summary
              Class
              Constructor
                  Inherited
              Field
                  Inherited
              Method
                  Inherited
          Detail
              Field
                  Identifier
                  Declaration
                  Description
              Constructor
                  Identifier
                  Declaration
                  Description
                  Parameters
                  Returns
                  Throws
              Method
                  Identifier
                  Declaration
                  Description
                  Parameters
                  Returns
                  Throws

      and so on. As I've laid it out, the class names show both hierarchy and a cross-cut of functionality. For example, if I chose to make all descriptions of inherited members on pink, I can do that for all the summaries in one declaration in my stylesheet (using the class "Inherited"). Or I could decide that all fields should be in a cursive font and make that true for botht he summary and the detail.


      JUSTIFICATION :
      I think that with such a mechanism, more people could use the standard doclet. At least for me, I have no particular need to create a new layout, but I want to make our documentation look both familiar (all Java programmers know how to use the standard doclet-generated stuff) and personal (using the corporate palette and make other stylistic adjustments).

      (Incident Review ID: 261399)
      ======================================================================

            bpatel Bhavesh Patel (Inactive)
            gmanwanisunw Girish Manwani (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: