[Laszlo-dev] For Review: Change 20080730-dda-n Summary: lz.* renaming in doc and associated cleanups

[Donald Anderson]

(committed in advance).

Change 20080730-dda-n by dda at lester.local on 2008-07-30 11:52:43 EDT
     in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc2
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: lz.* renaming in doc and associated cleanups

New Features:

Bugs Fixed: LPP-6591  Adjust doc tool to list Javascript name of <tag>  
as `lz.tag`		
             LPP-6593  Adjust javascript type declarations to not use  
LzView		
             LPP-6588  Clean up reference 'left nav' to uniformly use  
<tagname> and lz.classname (PARTIAL)

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

Documentation:

Release Notes:

Details:
     All class names in the documentation infrastructure are now  
handled (nearly) consistently in the refguide.
     By infrastructure, I mean:
       - Contents, Classes, Tags tabs on the refguide navbar
         (these changes are nearly complete, some inconsistencies  
remain - LPP-6588 will be used to track)
       - class names that appear in the title of the each page
       - class names that appear in 'extends ...' or 'Attrbutes/Events/ 
Methods inherited from ...'
       - class names that appear as type arguments, or return types in  
method signatures
       - class names that appear as (Javascript) typing for attributes.
     type names that appear in the content of pages is not changed by  
this, and may need additional cleanup.

     Any class that has an associated lzx tag <foo> is now referred to  
as 'lz.foo'.
     Otherwise a class name formally known aas LzFooBar is now  
referred to as 'lz.FooBar'.

     All the above cases are now handled in a single xslt template  
(lztype-rename), which has been modified to
     apply the above rules.  In addition, more complex types have been  
fixed: an array of view ([lz.view])
     now appears correctly.

     Debug has been added to the classes list, it was not there before.

     Additional checks have been made against the TOC to verify that  
the naming used in Contents tab
     corresponds to the name in the Tags or Classes tabs.  This has  
pointed up some inconsistencies
     that we're tracking separately.

Tests:
     Regenerate doc and check selected pages for output.

Files:
M      docs/src/nav/toc.xml
M      docs/src/reference/navbuilder/toccheck.rb
M      docs/src/reference/navbuilder/navxmlbuilder.rb
M      docs/src/xsl/js2doc2dbk/utilities.xsl

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080730-dda-n.tar



--

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

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



-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.openlaszlo.org/pipermail/laszlo-dev/attachments/20080730/e8805862/attachment.html