[Laszlo-dev] For Review: Change 20080825-lou-j Summary: dguide: make sure classes and tags are up to date, e.g., lz.text instead of LzText

Donald Anderson dda at ddanderson.com
Tue Aug 26 08:29:18 PDT 2008


Comments:
---- In datareplication.dbk:

       <H2>Tags/APIs discussed in this chapter</h2>
       <ul>
           <li><classname link="true">LzDataElement</classname></li>
           <li><classname link="true">LzDataNode</classname></li>
           <li><classname link="true">LzDataText</classname></li>
           <li><classname link="true">LzDatapointer</classname></li>
           <li><classname link="true">lz.datapath</classname></li>
           <li><classname link="true">LzReplicationManager</ 
classname></li>
           <li><classname link="true">LzLazyReplicationManager</ 
classname></li>
           <li><classname link="true">lz.dataselectionmanager</ 
classname></li>
       </ul>

some of these are lz.* and some are not.   I don't know how  
<classname> is used, will
it be able to make a link correctly?

---- In doc-backwards-xform.dbk, there are problems with all the  
diffs, since they apply to internal lzs coding,
where developers must have knowledge of the 'real' class names.

1)
     Turn to lz.text.lzs, to find where these variables were  
declared:</para>

the names of source files have not changed.  Should be LzText.lzs .

2)
         &lt;class extends=&quot;lz.view&quot;&gt;
           &lt;property access=&quot;private&quot;  
id=&quot;lz.text.tagname&quot; <emphasis>name=&quot;tagname&quot;  
value=&quot;text&quot;&gt;</emphasis>&lt;!-- region 6 --&gt;

should be LzText.tagname since the classnames have not changed  
intenally.

3)
         &lt;property id=&quot;lz.text.prototype.format&quot;  
<emphasis>name=&quot;format&quot;</emphasis>&lt;!-- regions 1, 2 --&gt;

This is talking about <property> generated by the doc tool -- The  
property should be LzText.prototype.format

4)
               Formats its arguments using &lt;xref  
linkend=&quot;lz.Formatter.formatToString&quot;/&gt; and sets the text  
of the

It's still LzFormatter.formatToString for linkend .  Unfortunately,  
anyone working at the lzs level needs to know
that the names of classes internally are LzFoo, and that is what the  
doc tools use.
Perhaps we need to add something to the content to say this.

5)
     <para>To carry this reasoning all the way back to the javascript  
code definining the method, in <literal>WEB-INF/lps/lfc/views/ 
lz.text.lzs</literal>:</para>

Again LzText.lzs

6)
         * linkend=&quot;lz.Formatter.formatToString&quot;/&gt; and  
sets the text of the

Should be LzFormatter.formatToString when used with linkend


---- input-gestures.dbk

this can be accomplished by defining a custom resource for the cursor  
and using it with LzCursor service as shown below.

should be lz.Cursor service

(I think you figured out, and I should have mentioned that for  
services, the class name LzCursorService translates to lz.Cursor.
I think the class name used to be LzCursor, so it's still a simple  
transition for programmers)

---- media-resourse.dbk

     <literal>LzView.play()</literal> method. Conversely, when

lz.view.play()

---- rpc-javarpc.dbk

<para>lz.rpc can be found in <literal>$LPS_HOME/lps/components/rpc/ 
library/lz.rpc.js</literal>.</para>

File name is $LPS_HOME/lps/components/rpc/library/rpc.js

---- rpc.dbk

<para><indexterm significance="preferred"><primary>dataobject</ 
primary></indexterm><glossterm>dataobject</glossterm>: (Dataset| 
lz.DataElement) if set, the return value will

Should be (lz.dataset|lz.DataElement)


---- states.dbk

  as in, for example, <literal>an lz.node.setParent(otherlz.node)</ 
literal>, but it's not).

Better:  lz.node.setParent(otherNode)

---- Not your error, but noticed in passing:
Misspelled Browser in doc-toolchain.dbk

+              <entry>the <literal>lz.Browswer</literal> class, as it  
exists only in the dhtml runtime.</entry>

Otherwise, approved!

On Aug 25, 2008, at 11:36 AM, Lou Iorio wrote:

> Change 20080825-lou-j by lou at loumac.local on 2008-08-25 11:19:43 AST
>    in /Users/lou/src/svn/openlaszlo/trunk
>    for http://svn.openlaszlo.org/openlaszlo/trunk
>
> Summary: dguide: make sure classes and tags are up to date, e.g.,  
> lz.text instead of LzText
>
> Bugs Fixed: LPP-6878, LPP-6869 (partial)
>
> Technical Reviewer: donald anderson
> QA Reviewer: (pending)
> Doc Reviewer: (pending)
>
> Details: interim checkin so Don can review what's done so far.
>
> Tests: ant clean build doc, visual verify
> grep Lz[A-Z]
>
> Files:
> M      docs/src/developers/lzunit.dbk
> M      docs/src/developers/classes-powerprogramming.dbk
> M      docs/src/developers/components-design.dbk
> M      docs/src/developers/delegates.dbk
> M      docs/src/developers/performance.dbk
> M      docs/src/developers/rpc-javarpc.dbk
> M      docs/src/developers/initialization-and-instantiation.dbk
> M      docs/src/developers/rpc-soap.dbk
> M      docs/src/developers/rpc.dbk
> M      docs/src/developers/media-resources.dbk
> M      docs/src/developers/fonts.dbk
> M      docs/src/developers/debugging.dbk
> M      docs/src/developers/doc-toolchain.dbk
> M      docs/src/developers/doc-backwards-xform.dbk
> M      docs/src/developers/input-gestures.dbk
> M      docs/src/developers/classes-introductory.dbk
> M      docs/src/developers/states.dbk
> M      docs/src/developers/browser-integration.dbk
> M      docs/src/developers/animation.dbk
> M      docs/src/developers/layout-and-design.dbk
> M      docs/src/developers/language-preliminaries.dbk
> M      docs/src/developers/text.dbk
> M      docs/src/developers/programs/databinding-$14.lzx
> M      docs/src/developers/programs/databinding-$19.lzx
> M      docs/src/developers/programs/databinding-$16.lzx
> M      docs/src/developers/programs/data-accessing-lzdataelement.lzx
> M      docs/src/developers/structure.dbk
> M      docs/src/developers/datareplication.dbk
> M      docs/src/developers/databinding.dbk
> M      docs/src/developers/constraints.dbk
>
>
> Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080825-lou-j.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/20080826/cadbbd67/attachment.html


More information about the Laszlo-dev mailing list