[Laszlo-dev] For Review: Change 20071010-ben-0 Summary: Doctools improvements for reference.

[Benjamin Shine]

Change 20071010-ben-0 by ben at slim.local on 2007-10-10 17:26:57 PDT
     in /Users/ben/src/svn/openlaszlo/trunk
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Doctools improvements for reference.

Technical Reviewer: raju (pending)
QA Reviewer: (pending)
Doc Reviewer: sundman (pending)

Documentation:
This change merges paperpie doctools work in to trunk. It makes
the generated documentation look superficially more like the 3.4
documentation. This mostly means filtering out some of the extra
information that had been added to the top of the page in reference
entries. Several minor CSS changes have been made to match the
look of the old documentation better.

This does not yet list *all* the inherited attributes, methods, and
events, but it gets *most* of the obvious ones.

Release Notes:

Details:
    docs/src/build.xml
       Turned up maximum memory to 1024m, which makes build go faster.
       Made major doc build step be less verbose.

    docs/src/xsl/js2doc2dbk.xsl
       Commented out some code I don't understand from jgrandy.
       Simplified information displayed at top of page. Moved
       where we list superclasses to match 3.4 doc. Added
       headings (Description, Attributes, Methods, Events) to match
       3.4 docs. Added xsl to create listing of inherited attributes,
       methods, and events,  with links to the reference for that member
       in the superclasses, in each reference entry. Reversed
       order of superclass chain listing, now goes from subclass
       to superclass. Took out
       xsl to generate info on class access, deprecated, preliminary,
       build flags, which file it's declared in.

   docs/src/xsl/common-html.xsl
       Turned on "fixme" display.

   docs/src/xsl/refguide-html.xsl
       Changed first thing on page to be  name of tag, displayed
       with angle brackets. Made the "purpose" be the second thing
       on the page, to match 3.4 docs.

   docs/src/xsl/parameters.xsl
       Configured docbook to not show up/next/prev/home stuff
       at top of each page, and other small cosmetic stuff in html
       output.

    docs/includes/lzx-pretty-print.css
    docs/includes/docbook.css
    docs/includes/styles.css
       Cosmetic changes to make the 4.1 docs look more like the 3.4
       docs.




Tests:
ant clean; ant build doc
passes.
Pages in the reference still look decent, for instance:
http://localhost:8080/trunk/docs/reference/LzAnimator.html

Files:
  M     .
M      docs/src/build.xml
A  +   docs/src/xsl/simple-driver.xsl
M      docs/src/xsl/js2doc2dbk.xsl
M      docs/src/xsl/common-html.xsl
M      docs/src/xsl/refguide-html.xsl
M      docs/src/xsl/parameters.xsl
M      docs/includes/lzx-pretty-print.css
M      docs/includes/docbook.css
M      docs/includes/styles.css

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20071010- 
ben-0.tar