[Laszlo-dev] For Review: Change 20080513-dda-m Summary: Doc formatting fixes via ruby postprocessing

[Donald Anderson]

Change 20080513-dda-m by dda at lester.local on 2008-05-13 22:20:10 EDT
     in /Users/clients/laszlo/src/svn/openlaszlo/trunk-doc3
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Doc formatting fixes via ruby postprocessing

New Features:

Bugs Fixed: LPP-5942, LPP-5946

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)

Documentation:

Release Notes:

Details:
   This is not pretty but it works.  At various places, we just want  
to inject some html,
   like <b> around certain elements, and that is not always trivial to  
do in the docbook
   XSL framework.  After hours spent on various bugs, I'm ready for a  
hack fix.
   Now, we can inject items that look like <postprocess-XXXX> and  
these are processed
   after the doc is completed by a ruby script.

   Two not-so-nice side effects:
    - lots of warnings of the form:
        Element postprocess-XXXX in namespace '' encountered in term,  
but no template matches.
    - the pages put into reference/*.html will no longer be 'complete'  
as soon as they are
      written.  Until the ruby script is run (near the end of the  
reference doc build),
      these html files will have red annotations in them.

   Someday it would be nice to do this all in docbook and back this  
change out.
   All the places where it is used are trivial to locate via:
      grep '<postprocess-'  docs/src/xsl/*.xsl
   A clever XSL coder could probably clean these all up right quick.

   Here's what it fixes:
   - puts an hrule at the end of every method in the reference
   - marks method parameters as bold in their table
   - extends the method name grey background all the way to the right  
edge
   - puts an hrule at the end of every section in the info- 
attributes.html file
   and it will probably enable more fixes in the future.

Tests:

Files:
M      docs/src/build.xml
A      docs/src/reference/postprocess.rb
M      docs/src/reference/info.xml
M      docs/src/xsl/js2doc2dbk.xsl

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080513-dda-m.tar



--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: dda at ddanderson.com
www: http://www.ddanderson.com