Re: [Laszlo-dev] For Review: Change 20080917-dda-F Summary: Change output naming for refguide to match lz.xxx naming convention

[Lou Iorio]

 approved
On Wed, Sep 17, 2008 at  4:17 PM , Donald Anderson wrote:

 Change 20080917-dda-F by [EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]> on 
2008-09-17 15:42:05 EDT  <mailto:[EMAIL PROTECTED]>
    in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc5 
<mailto:[EMAIL PROTECTED]>
    for http://svn.openlaszlo.org/openlaszlo/trunk 
<http://svn.openlaszlo.org/openlaszlo/trunk> 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Summary: Change output naming for refguide to match lz.xxx naming 
convention  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
New Features:  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Bugs Fixed: LPP-7000 (name doc output files corresponding to new lz.xxx 
naming convention)  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Technical Reviewer: (pending) 
<http://svn.openlaszlo.org/openlaszlo/trunk>
QA Reviewer: (pending)  <http://svn.openlaszlo.org/openlaszlo/trunk>
Doc Reviewer: liorio (pending) 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Documentation:  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Release Notes:  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Details:  <http://svn.openlaszlo.org/openlaszlo/trunk>
    Committed in advance for review 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    The general technique is to insert a <?dbhtml filename="zzzz.html" 
?> processing instruction  <http://svn.openlaszlo.org/openlaszlo/trunk>
    into the stream seen by docbook.   We choose the filename based on 
lz.tagname if there is a tagname 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    (AKA lzxname); if there is none, lz.Classname; if there is none, 
the unique @id that is currently 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    used.   This ends up changing many of the names. 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    The known fallout is listed here and is fixed as part of this 
changeset.   It's possible that this has 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    also introduced broken links for any links that reference a fixed 
page name.  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - toc.xml needs many updates to use the new naming 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - navxmlbuilder.tb, used to create classes.xml and tags.xml has 
been updated to use the new naming 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - some lzxnames had spaces in them, e.g. '<splash view>'.   Any 
spaces are converted to underscore. 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - any time pluses (e.g. +as3, +debug) appears in the @id, these are 
preserved in the file name.   That way 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      we can continue to have filenames that are architecture dependent 
or runtime version dependent. 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - added a 'docfilename' tag (e.g. javadoc @docfile xxxx) to 
indicate the basename of the resulting 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      xxxx.html output file.   We're using this currently only in 
wrappers.xml and attributes.xml to generate 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      'canned' pages that need to be named specially.   This gives us 
an escape mechanism for filename 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      tweaks if we need them. 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - fixed a couple &lt; &gt; issues in wrappers.xml .   These need to 
appear in the lzxname for certain 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      tags (e.g. the lzxname for <a> is actually &lt;a&gt;   -- this 
makes <a> appear correctly in the output 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      page).   Not sure why these are needed or how to get rid of them, 
this was an expedient fix.  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    - pushed the original javascript name into a 'postprocessing' 
comment.  <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    Not part of the fallout, but a broken reference to Debug+debug.html 
has been commented out of the TOC, 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    there doesn't seem to be a replacement page in place to describe 
the new debugger.   This change 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    was needed to get the build to complete without error. 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
    Also, needed to turn the docbook 'chunk.fast' parameter to 0 in 
order to get the <?dbhtml processing instruction 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    to work.   This doesn't seem to be documented in docbook. 
Unfortunately this makes the doc builds 
<http://svn.openlaszlo.org/openlaszlo/trunk>
    take a little longer, it seems. 
<http://svn.openlaszlo.org/openlaszlo/trunk>
      <http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Tests:  <http://svn.openlaszlo.org/openlaszlo/trunk>
    Built ref, spot checked pages and naming. 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Files:  <http://svn.openlaszlo.org/openlaszlo/trunk>
M       docs/src/nav/toc.xml 
<http://svn.openlaszlo.org/openlaszlo/trunk>
M       docs/src/reference/wrappers.xml 
<http://svn.openlaszlo.org/openlaszlo/trunk>
C       docs/src/reference/postprocess.rb 
<http://svn.openlaszlo.org/openlaszlo/trunk>
M       docs/src/reference/info.xml 
<http://svn.openlaszlo.org/openlaszlo/trunk>
M       docs/src/reference/navbuilder/navxmlbuilder.rb 
<http://svn.openlaszlo.org/openlaszlo/trunk>
M       docs/src/xsl/js2doc2dbk.xsl 
<http://svn.openlaszlo.org/openlaszlo/trunk>
M       docs/src/xsl/parameters.xsl 
<http://svn.openlaszlo.org/openlaszlo/trunk>

 <http://svn.openlaszlo.org/openlaszlo/trunk>
Changeset: 
http://svn.openlaszlo.org/openlaszlo/patches/20080917-dda-F.tar 
<http://svn.openlaszlo.org/openlaszlo/patches/20080917-dda-F.tar> 
<http://svn.openlaszlo.org/openlaszlo/patches/20080917-dda-F.tar>


--  <http://svn.openlaszlo.org/openlaszlo/patches/20080917-dda-F.tar>

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

voice: 617-547-7881
email:  [EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]>
www:  http://www.ddanderson.com <http://www.ddanderson.com/>
 <http://www.ddanderson.com/>