Re: [Laszlo-dev] Proposed integration (Fwd: [Laszlo-checkins] r4300)

Wed, 14 Mar 2007 16:35:14 -0800 

Agreed.  I'll prepare a changeset.

Jim Grandy wrote:

I propose we integrate this change to branches/4.0.

Benefits: several visible improvements to the refguide and contribguide

Risks: low, most changes are to comments, no changes to non-doctools code

Begin forwarded message:


From: [EMAIL PROTECTED]
Date: March 14, 2007 4:39:42 PM PDT
To: [email protected]
Subject: [Laszlo-checkins] r4300 - in openlaszlo/branches/legals: . WEB-INF/lps/lfc/core WEB-INF/lps/lfc/data WEB-INF/lps/lfc/data/platform/swf WEB-INF/lps/lfc/services/platform/dhtml WEB-INF/lps/lfc/views WEB-INF/lps/server/src/org/openlaszlo/js2doc docs/src/contributors docs/src/reference docs/src/xsl laszlo-explorer laszlo-explorer/coverpages lps/components/av lps/components/incubator lps/components/incubator/opttree lps/components/incubator/rich-text lps/components/lz 
Reply-To: [email protected]

Author: jgrandy
Date: 2007-03-14 16:39:33 -0700 (Wed, 14 Mar 2007)
New Revision: 4300

Modified:
   openlaszlo/branches/legals/WEB-INF/lps/lfc/core/LzNode.lzs
   openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDatapath.lzs
   openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDataset.lzs
openlaszlo/branches/legals/WEB-INF/lps/lfc/data/platform/swf/LzConnection.lzs openlaszlo/branches/legals/WEB-INF/lps/lfc/services/platform/dhtml/LzHistory.js 
   openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloCanvas.lzs
   openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloView.lzs
   openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LzText.lzs
openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/Comment.java openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java 
   openlaszlo/branches/legals/docs/src/contributors/index.dbk
   openlaszlo/branches/legals/docs/src/reference/preface.dbk
   openlaszlo/branches/legals/docs/src/xsl/js2doc2dbk.xsl
   openlaszlo/branches/legals/docs/src/xsl/parameters.xsl
   openlaszlo/branches/legals/index.jsp
openlaszlo/branches/legals/laszlo-explorer/coverpages/documentation_cover.html 
   openlaszlo/branches/legals/laszlo-explorer/nav.xml
   openlaszlo/branches/legals/laszlo-explorer/nav_dhtml.xml
   openlaszlo/branches/legals/lps/components/av/rtmpstatus.lzx
openlaszlo/branches/legals/lps/components/incubator/opttree/opttree.lzx openlaszlo/branches/legals/lps/components/incubator/rich-text/richtexteditarea.lzx openlaszlo/branches/legals/lps/components/incubator/roundrectbutton.lzx 
   openlaszlo/branches/legals/lps/components/incubator/ulink.lzx
   openlaszlo/branches/legals/lps/components/lz/datepicker.lzx
   openlaszlo/branches/legals/lps/components/lz/edittext.lzx
   openlaszlo/branches/legals/lps/components/lz/menu.lzx
   openlaszlo/branches/legals/lps/components/lz/scrollbar.lzx
Log:
Change 20070314-jgrandyw-B by [EMAIL PROTECTED] on 2007-03-14 14:45:41 PDT 
    in /Users/jgrandyw/dev/svn/openlaszlo/branches/legals
    for http://svn.openlaszlo.org/openlaszlo/branches/legals

Summary: Small refguide tweaks

New Features:

Bugs Fixed:LPP-3708 - RefGuide: two issues with index generation

Technical Reviewer: max
QA Reviewer: jcrowley
Doc Reviewer: jsundman

Documentation:

Release Notes:

Details:
+ add '@access private' to a bunch of private entries (discovered by visually scanning the index) 
    + add '@keywords final' in a couple places, including for LzNode.name
+ support 'read-only' as a modifier. 'readonly' is also accepted as an alternative 
    + make LzNode.isinited 'read-only'
    + support 'const' as a modifier.
+ support '@keyword' as an alternative to '@keywords' after observing that @keyword is used in many places in the sources 
    + mark Contributor's Guide as 'beta' in the title
    + sort TOC entries without regard to prefixing '$' or '_'
+ only include "sortas" and "seealso" elements in indexterms when they are really needed (LPP-3708) + make sure to output indexterms for entries that only have an LZX name, like 'handler' (LPP-3708) 
    + don't create 'deprecated' or 'tag' index -- too expensive
+ tell docbook-xsl that the refguide is entirely in English, in an attempt to speed index generation up (don't ask) + add Contributor's Guide to more places where other documentation is mentioned 

Tests:

Files:
M      WEB-INF/lps/lfc/services/platform/dhtml/LzHistory.js
M      WEB-INF/lps/lfc/core/LzNode.lzs
M      WEB-INF/lps/lfc/views/LzText.lzs
M      WEB-INF/lps/lfc/views/LaszloView.lzs
M      WEB-INF/lps/lfc/views/LaszloCanvas.lzs
M      WEB-INF/lps/lfc/data/platform/swf/LzConnection.lzs
M      WEB-INF/lps/lfc/data/LzDataset.lzs
M      WEB-INF/lps/lfc/data/LzDatapath.lzs
M      WEB-INF/lps/server/src/org/openlaszlo/js2doc/Comment.java
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java 
M      docs/src/contributors/index.dbk
M      docs/src/xsl/js2doc2dbk.xsl
M      docs/src/xsl/parameters.xsl
M      lps/components/lz/menu.lzx
M      lps/components/lz/datepicker.lzx
M      lps/components/lz/scrollbar.lzx
M      lps/components/lz/edittext.lzx
M      lps/components/av/rtmpstatus.lzx
M      lps/components/incubator/roundrectbutton.lzx
M      lps/components/incubator/opttree/opttree.lzx
M      lps/components/incubator/ulink.lzx
M      lps/components/incubator/rich-text/richtexteditarea.lzx
M      laszlo-explorer/nav.xml
M      laszlo-explorer/coverpages/documentation_cover.html
M      laszlo-explorer/nav_dhtml.xml
M      index.jsp


Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/core/LzNode.lzs
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/core/LzNode.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/core/LzNode.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -293,6 +293,7 @@
  * control of the <attribute>initstage</attribute> attribute.
  *
  * @type boolean
+ * @keywords read-only
  * @see initstage
  * @see oninit
  */
@@ -343,9 +344,10 @@
   * </dl>
   * @lzxtype "early" | "normal" | "late" | "immediate" | "defer"
   * @lzxdefault "normal"
-  * @modifiers final
+  * @keywords final
   */
 var initstage = null;
+/** @access private */
 var $isstate = false;
 var doneClassRoot = false;

@@ -370,6 +372,7 @@
   * parent and immediate parent will store a pointer to this node as the
   * given name value.
   * @type String
+  * @keywords final
   */
 var name = null;

@@ -378,7 +381,7 @@
   *
   * @type String
   * @lzxtype xsd:ID
-  * @modifiers final
+  * @keywords final
   */
 var id = null;

@@ -402,7 +405,7 @@
   * the <method>LzNode.determinePlacement</method> method.
   * Defaults to the container itself.
   * @lzxtype string
-  * @modifiers final
+  * @keywords final
   */
 var placement = null;


Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDatapath.lzs
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDatapath.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDatapath.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -549,6 +549,7 @@
     trackDel.register( who , "onDocumentChange" );
 }

+/** @access private */
 setters.__LZmanager = "__LZsetCloneManager";
 /** @access private */
 var __LZisclone = false;

Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDataset.lzs
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDataset.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/data/LzDataset.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -131,7 +131,7 @@
 /** When true, the server will trim
   * whitespace in the XML data (defaults to false).
   * @type Boolean
-  * @modifiers final
+  * @keywords final
   */
 var trimwhitespace = false;
Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/data/platform/swf/LzConnection.lzs 
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/data/platform/swf/LzConnection.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/data/platform/swf/LzConnection.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -57,7 +57,7 @@
* authentication server before allowing the persistent connection, which * is done through a session cookie. The default authentication server it * uses is the <code>AuthenticationServlet</code> bundled with the OpenLaszlo Server. The set of usernames that server uses is located in 
-  * <tt>lps/config/lzusers.xml</tt>. To session and unsession your
+  * <code>lps/config/lzusers.xml</code>. To session and unsession your
   * application, use the connection's <method>login</method> and
   * <method>logout</method> methods.</p>
   *
Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/services/platform/dhtml/LzHistory.js 
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/services/platform/dhtml/LzHistory.js 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/services/platform/dhtml/LzHistory.js 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -43,11 +43,17 @@

 // The current offset (zero-based) in the history value stack.
 LzHistory.offset = 0;
+/** @access private */
 LzHistory.__lzdirty = false;
+/** @access private */
 LzHistory.__lzhistq = [];
+/** @access private */
 LzHistory.__lzcurrstate = {};
+/** @access private */
 LzHistory.__lzloading = false;
+/** @access private */
 LzHistory.__lzloadcache = {};
+/** @access private */
 LzHistory.__loadcacheused = false;

 DeclareEvent(LzHistory, 'onoffset' );
Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloCanvas.lzs 
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloCanvas.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloCanvas.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -237,7 +237,7 @@
* this is the version number of the server that generated the optimized file, not the one 
   * that served it).
   * @type Number
-  * @modifiers final
+  * @keywords final
   */
 var lpsversion;

@@ -245,7 +245,7 @@
* this is the release of the server that generated the optimized file, not the one that 
   * served it).
   * @type String
-  * @modifiers final
+  * @keywords final
   */
 var lpsrelease;


Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloView.lzs
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloView.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LaszloView.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -326,7 +326,7 @@
 /** Clip the view's contents to its size.
   * @lzxtype boolean
   * @lzxdefault "false"
-  * @modifiers final
+  * @keywords final
   */
 setters.clip =  -1;
 setters.x ="setX"
@@ -342,7 +342,7 @@
 /**
   * @lzxtype "left" | "center" | "right" | constraint
   * @lzxdefault "left"
-  * @modifiers final
+  * @keywords final
   */
 setters.align = "setAlign"


Modified: openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LzText.lzs
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LzText.lzs 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/lfc/views/LzText.lzs 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -137,7 +137,7 @@
* the content is modified by calls to <method>setText</method>, or whenever the 
   * width of the text view is modified.
   *
-  * @modifiers final
+  * @keywords final
   * @lzxtype boolean
   * @lzxdefault "false"
   */
Modified: openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/Comment.java 
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/Comment.java 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/Comment.java 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -108,7 +108,8 @@
                 String fieldName = fieldMatcher.group(1);
                 String fieldValue = fieldMatcher.group(2).trim();

-                if (fieldName.compareTo("keywords") == 0) {
+                if (fieldName.equals("keywords") ||
+                    fieldName.equals("keyword")) {
StringTokenizer keywordTokens = new StringTokenizer(fieldValue); 
                     while (keywordTokens.hasMoreTokens()) {
parsedComment.keywords.add(keywordTokens.nextToken());
Modified: openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java 
===================================================================
--- openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -166,11 +166,16 @@
                       keywordName.equals("virtual") ||
                       keywordName.equals("deprecated") ||
                       keywordName.equals("override") ||
-                      keywordName.equals("abstract")) {
+                      keywordName.equals("abstract") ||
+                      keywordName.equals("const")) {

                 appendToAttribute(node, "modifiers", keywordName);
                 return true;

+            } else if (keywordName.equals("read-only") ||
+                       keywordName.equals("readonly")) {
+                appendToAttribute(node, "modifiers", "read-only");
+                return true;
             }
             return false;
         }
@@ -418,6 +423,8 @@
         }

         String keywords = docNode.getAttribute("keywords");
+        if (keywords == null)
+            keywords = docNode.getAttribute("keyword");
         if (keywords != null) {
             docNode.removeAttribute("keywords");
StringTokenizer keywordTokens = new StringTokenizer(keywords); 

Modified: openlaszlo/branches/legals/docs/src/contributors/index.dbk
===================================================================
--- openlaszlo/branches/legals/docs/src/contributors/index.dbk 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/docs/src/contributors/index.dbk 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -6,7 +6,7 @@
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";> 
 <book xmlns:xi="http://www.w3.org/2003/XInclude";>
-  <title>OpenLaszlo 4.0 Contributor's Guide</title>
+  <title>OpenLaszlo 4.0 Contributor's Guide (beta)</title>
   <titleabbrev>OL4 Contributor's Guide</titleabbrev>

   <xi:include href="book-info.dbk"></xi:include>

Modified: openlaszlo/branches/legals/docs/src/reference/preface.dbk
===================================================================
--- openlaszlo/branches/legals/docs/src/reference/preface.dbk 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/docs/src/reference/preface.dbk 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -19,4 +19,20 @@
<member><ulink url="http://forum.laszlosystems.com"; target="_blank"><citetitle>Developer Forums</citetitle></ulink></member> 
     </simplelist>
   </sect1>
+
+  <sect1><title>Using the Reference</title>
+
+    <sect2><title>Section Organization</title>
+    </sect2>
+
+    <sect2><title>Properties, Methods and Events</title>
+
+        <sect3><title>LZX and JavaScript Types</title>
+        </sect3>
+
+    </sect2>
+
+
+  </sect1>
+
 </preface>

Modified: openlaszlo/branches/legals/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/branches/legals/docs/src/xsl/js2doc2dbk.xsl 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/docs/src/xsl/js2doc2dbk.xsl 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -56,7 +56,7 @@
             <title><xsl:value-of select="$subtopic"/></title>
<xsl:message><xsl:value-of select="concat('found ', count($decls), ' visible items in ', $topicdesc)"/></xsl:message> 
             <xsl:for-each select="$decls">
-              <xsl:sort select="@id"/>
+              <xsl:sort select="translate(@id,'_$','  ')"/>
               <xsl:apply-templates select="." mode="refentry"/>
             </xsl:for-each>
           </reference>
@@ -573,40 +573,55 @@
       <xsl:param name="topic" select="@topic"/>
       <xsl:param name="subtopic" select="@subtopic"/>
<xsl:variable name="sortasname" select="translate($name,'_$',' ')"/> 
-      <indexterm>
-        <primary>
-          <xsl:if test="$name != $sortasname">
- <xsl:attribute name="sortas"><xsl:value-of select="$sortasname"/></xsl:attribute> 
-          </xsl:if>
-          <xsl:value-of select="$name"/>
-        </primary>
-        <xsl:if test="$altname">
-          <seealso><xsl:value-of select="$altname"/></seealso>
-        </xsl:if>
-      </indexterm>
-      <xsl:if test="$topic and $subtopic">
-        <indexterm>
-          <primary><xsl:value-of select="$topic"/></primary>
-          <secondary><xsl:value-of select="$subtopic"/></secondary>
-        </indexterm>
-      </xsl:if>
+      <xsl:choose>
+        <xsl:when test="$name and $name!=''">
+          <indexterm>
+            <primary>
+              <xsl:if test="$name != $sortasname">
+ <xsl:attribute name="sortas"><xsl:value-of select="$sortasname"/></xsl:attribute> 
+              </xsl:if>
+              <xsl:value-of select="$name"/>
+            </primary>
+            <xsl:if test="$altname != $name">
+              <seealso><xsl:value-of select="$altname"/></seealso>
+            </xsl:if>
+          </indexterm>
+
 <?ignore
-      <xsl:if test="$altname">
-        <indexterm type="tags">
-          <primary><xsl:value-of select="$altname"/></primary>
-          <xsl:if test="$name != $altname">
-            <seealso><xsl:value-of select="$name"/></seealso>
+          <xsl:if test="$topic and $subtopic">
+            <indexterm>
+              <primary><xsl:value-of select="$topic"/></primary>
+              <secondary><xsl:value-of select="$subtopic"/></secondary>
+            </indexterm>
           </xsl:if>
-        </indexterm>
-      </xsl:if>
-      <xsl:if test="contains(@keywords, 'deprecated')">
-        <indexterm type="deprecated">
-          <primary>
-            <xsl:value-of select="$name"/>
-          </primary>
-        </indexterm>
-      </xsl:if>
+          <xsl:if test="$altname">
+            <indexterm type="tags">
+              <primary><xsl:value-of select="$altname"/></primary>
+              <xsl:if test="$name != $altname">
+                <seealso><xsl:value-of select="$name"/></seealso>
+              </xsl:if>
+            </indexterm>
+          </xsl:if>
+          <xsl:if test="contains(@keywords, 'deprecated')">
+            <indexterm type="deprecated">
+              <primary>
+                <xsl:value-of select="$name"/>
+              </primary>
+            </indexterm>
+          </xsl:if>
 ?>
+        </xsl:when>
+        <xsl:when test="$altname and $altname != ''">
+          <indexterm>
+            <primary>
+              <xsl:value-of select="$altname"/>
+            </primary>
+          </indexterm>
+        </xsl:when>
+        <xsl:otherwise>
+ <xsl:message><xsl:text>couldn't generate index for item with no name</xsl:text></xsl:message> 
+        </xsl:otherwise>
+      </xsl:choose>
     </xsl:template>

     <!-- MISC -->

Modified: openlaszlo/branches/legals/docs/src/xsl/parameters.xsl
===================================================================
--- openlaszlo/branches/legals/docs/src/xsl/parameters.xsl 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/docs/src/xsl/parameters.xsl 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
<!-- * X_LZ_COPYRIGHT_BEGIN *************************************************** -* Copyright 2001-2004 Laszlo Systems, Inc. All Rights Reserved. * +* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved. * * Use is subject to license terms. * * X_LZ_COPYRIGHT_END ****************************************************** --> 
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
@@ -25,6 +25,11 @@
   <xsl:param name="tablecolumns.extension" select="0"/>
   <!-- Automatic labeling -->
   <xsl:param name="section.autolabel" select="1"/>
+  <!-- Indexing -->
+  <xsl:param name="l10n.gentext.language" select="'en'"/>
+  <xsl:param name="index.term.separator" select="', '"/>
+  <xsl:param name="index.number.separator" select="', '"/>
+  <xsl:param name="index.range.separator" select="'-'"/>
   <!-- HTML -->
   <xsl:param name="draft.mode" select="'yes'"/>
<xsl:param name="draft.watermark.image" select="'./images/draft.png'"/> 

Modified: openlaszlo/branches/legals/index.jsp
===================================================================
--- openlaszlo/branches/legals/index.jsp 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/index.jsp 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -90,8 +90,9 @@
             <li><a href="docs/guide">Software Developer's Guide</a></li>
             <li><a href="docs/design">UI Designer's Guide</a></li>
             <li><a href="docs/deploy">Deployer's Guide</a></li>
-            <li><a href="docs/reference">Reference</a></li>
-            <li><a href="docs/tutorials">Tutorials</a></li>
+            <li><a href="docs/reference">Reference Guide</a></li>
+            <li><a href="docs/contributors">Contributor's Guide</a></li>
+ <li><a href="docs/release-notes.html">Latest Release Notes</a></li> 
         </ul>
         <p>OpenLaszlo Admin tools</p>
         <ul>
Modified: openlaszlo/branches/legals/laszlo-explorer/coverpages/documentation_cover.html 
===================================================================
--- openlaszlo/branches/legals/laszlo-explorer/coverpages/documentation_cover.html 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/laszlo-explorer/coverpages/documentation_cover.html 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -32,6 +32,8 @@
    explanations of their construction
(<a href="../../docs/component-design/component-design-2.0.pdf" target="laszlo-componentguide-pdf">PDF</a>). 
    </p>
+ <strong><a href="../../docs/contributors/index.html" target="laszlo-contributorsguide">Contributor's Guide</a> (beta)</strong> + <p>Documentation for use by contributors to the OpenLaszlo platform, including private interfaces and kernel APIs</p> <strong><a href="../../index.html" target="lzquickindex">Quick Index</a></strong> <p>An list of links to all the content and applications referenced by the OpenLaszlo Explorer. 
 </p>

Modified: openlaszlo/branches/legals/laszlo-explorer/nav.xml
===================================================================
--- openlaszlo/branches/legals/laszlo-explorer/nav.xml 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/laszlo-explorer/nav.xml 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -310,6 +310,7 @@
<topic popup="/docs/deploy/index.html" name="Administrator's Guide" action="popup" target="laszlo-dguide" /> <topic popup="/docs/design/index.html" name="UI Designer's Guide" action="popup" target="laszlo-dguide" /> <topic popup="/docs/component-design/index.html" name="Components Guide" action="popup" target="laszlo-componentguide" /> + <topic popup="/docs/contributors/index.html" name="Contributor's Guide" action="popup" target="laszlo-contributorsguide" /> 
     <topic src="/docs/release-notes.html" name="Release Notes" />
<topic src="/tools/index.html" name="Developer's Tools" title="Development Tools" text="Tips for IDEs"/> 
   </section>

Modified: openlaszlo/branches/legals/laszlo-explorer/nav_dhtml.xml
===================================================================
--- openlaszlo/branches/legals/laszlo-explorer/nav_dhtml.xml 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/laszlo-explorer/nav_dhtml.xml 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -306,6 +306,7 @@
<topic popup="/docs/deploy/index.html" name="Administrator's Guide" action="popup" target="laszlo-dguide" /> <topic popup="/docs/design/index.html" name="UI Designer's Guide" action="popup" target="laszlo-dguide" /> <topic popup="/docs/component-design/index.html" name="Components Guide" action="popup" target="laszlo-componentguide" /> + <topic popup="/docs/contributors/index.html" name="Contributor's Guide" action="popup" target="laszlo-contributorsguide" /> 
     <topic src="/docs/release-notes.html" name="Release Notes" />
<topic src="/tools/index.html" name="Developer's Tools" title="Development Tools" text="Tips for IDEs"/> 
   </section>

Modified: openlaszlo/branches/legals/lps/components/av/rtmpstatus.lzx
===================================================================
--- openlaszlo/branches/legals/lps/components/av/rtmpstatus.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/av/rtmpstatus.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -21,6 +21,7 @@





+    <!--- @access private -->
     <attribute name="_updateStageDelegate" value="null"/>


@@ -47,7 +48,7 @@
       ]]>
     </method>

-
+    <!--- @access private -->
     <method name="_updateStage"><![CDATA[
         this.setAttribute('frame', this._rtmp.stage + 1);
       ]]>
Modified: openlaszlo/branches/legals/lps/components/incubator/opttree/opttree.lzx 
===================================================================
--- openlaszlo/branches/legals/lps/components/incubator/opttree/opttree.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/incubator/opttree/opttree.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -284,6 +284,7 @@
             </method>
         </view>

+        <!--- @access private -->
         <method name="_setupDrag">
             this.dragged = new nodeclass( this );
             dragged.setVisible( false );
@@ -315,6 +316,7 @@

         </method>

+        <!--- @access private -->
         <method name="_updateDragged">
             dragged.setY( this.getMouse( 'y' ) - _ydragoff );
         </method>
Modified: openlaszlo/branches/legals/lps/components/incubator/rich-text/richtexteditarea.lzx 
===================================================================
--- openlaszlo/branches/legals/lps/components/incubator/rich-text/richtexteditarea.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/incubator/rich-text/richtexteditarea.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -52,15 +52,15 @@
         <attribute name="insertionpoint" value="0" />

         <!--- Start in selection region.
-              @keywords private -->
+              @access private -->
         <attribute name="_ssel" value="0"/>

         <!--- End in selectionregion.
-              @keywords private -->
+              @access private -->
         <attribute name="_esel" value="0"/>
<!--- Whether to inform toolbar of changes in the caret position. 
-            @keywords private -->
+            @access private -->
         <attribute name="_shouldresettoolbar" value="true" />

         <!--- The size in points of an indent -->
@@ -68,17 +68,17 @@
<!--- the component on which a mousedown originated, if the mouse is 
             currently down
-            @keywords private
+            @access private
             -->
         <attribute name="_mousedownorigin" value="null"/>

         <!--- True if the input text associated with this RTE has focus.
-            @keywords private
+            @access private
             -->
         <attribute name="_fieldhasfocus" value="false" />

         <!--- True if the next onfocus should be ignored.
-              @keywords private -->
+              @access private -->
         <attribute name="_ignorenextfocus" value="false" />
<!-- CONSTRUCTOR .........................................................--> 
@@ -399,7 +399,7 @@
<!--- Called whenever the caret (aka insertion point) moves in this text field. 
                     // see [BUG ZIM-1268]
-              @keywords private
+              @access private
         -->
         <method name="_caretmove">
         // Debug.write("caret");
@@ -480,10 +480,10 @@

         </method>
- <!-- Called by a delegate after we get focus, to get rid of the default + <!--- Called by a delegate after we get focus, to get rid of the default select of everything, and instead just move the insertion point to the end 
             and make sure the insertion point is formatted properly.
-            @keywords private -->
+            @access private -->
         <method name="_focussel">
             // We really should have focus now!
             var havelzfocus =  (LzFocus.getFocus() == this._field);
@@ -498,7 +498,7 @@
<!--- Helper method for applyFormat() to apply format at insertion point. 
             Only do this if the message is html already.
               @param Number ip: insertion point.
-              @keywords private -->
+              @access private -->
         <method name="_formatAtInsertion" args="ip">
             if (this.isHTML) {
                 if (this.getText().length == ip){
@@ -515,7 +515,7 @@
         <!---
Handle the case where a mouse drag began on the RTE but the mouse up 
             was not on the RTE.
-            @keywords private
+            @access private
         -->
         <method name="_handleLostMouseDown">
             var selstart = this._field.getSelectionPosition();
@@ -527,7 +527,7 @@
             Note: this must be called from a delegate in an idle event
*after* flash completes the "frame" in which the selection or focus 
             changed.
-              @keywords private -->
+              @access private -->
         <method name="_restoreSelection">
//------------------------------------------------------------ 
             // FIXME [2005-08-16 pkang]: Need to know in which direction
@@ -541,7 +541,7 @@
<!--- Helper method to set an LzTextFormat to its default for this 
               richtexteditor.
@param LzTextFormat fmt: the format to set to default values. 
-              @keywords private -->
+              @access private -->
         <method name="_resetFormatToDefaults" args="fmt">
             this.currentformat.color = this.defaultfontcolor;
             this.currentformat.font = this.defaultfontname;
@@ -557,7 +557,7 @@
             of the toolbar.
             @param XMLnode? v: ???
             @return string: (need to ask Ben S.)
-            @keywords _private
+            @keywords private
         -->
         <method name="_containsView" args="v">
return (v.searchParents("name", this.name) || v.searchParents("name", this.toolbar.name)); 
@@ -565,7 +565,7 @@
<!--- Returns whether the string passed in is entirely whitespace @return boolean: True if the textfield is completely whitespace, False if not 
-            @keywords _private -->
+            @access private -->
         <method name="_containsOnlyWhitespace"><![CDATA[
             var str = this.getText();
             var len = str.length;
Modified: openlaszlo/branches/legals/lps/components/incubator/roundrectbutton.lzx 
===================================================================
--- openlaszlo/branches/legals/lps/components/incubator/roundrectbutton.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/incubator/roundrectbutton.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -13,7 +13,7 @@
See test/test-roundrectbutton.lzx for several examples of how to use this component.
The component attributes are only used for initialization. They are not live constraints. 
-Currently the best way to change them at runtime is to apply a <style>.
+Currently the best way to change them at runtime is to apply a &lt;style&gt;. 
 -->
 <class name="roundrectbutton" extends="basecomponent" styleable="true">


Modified: openlaszlo/branches/legals/lps/components/incubator/ulink.lzx
===================================================================
--- openlaszlo/branches/legals/lps/components/incubator/ulink.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/incubator/ulink.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -8,7 +8,7 @@
 <library>
     <!--- A class for URL links.
- This differs from the use of the XHTML <a> attribute, e.g in '<text><a href="http://openlaszlo.org";>OpenLaszlo.org</a></text>', in these ways: + This differs from the use of the XHTML &lt;a&gt; attribute, e.g in '&lt;text&gt;&lt;a href="http://openlaszlo.org"&gt;OpenLaszlo.org&lt;/a&gt;lt;/text&gt;', in these ways: 
     - There is a hover effect.  (This defaults to underline.)
     - There is a hover color.  (This defaults to blue.)
     - The link content and target can be databound.

Modified: openlaszlo/branches/legals/lps/components/lz/datepicker.lzx
===================================================================
--- openlaszlo/branches/legals/lps/components/lz/datepicker.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/lz/datepicker.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -38,6 +38,7 @@
     </resource>


+        <!--- @access private -->
<class name="datepickercombobox" extends="basecombobox" fontsize="8" 
         bgcolor="0xeaeaea" editable="false">
         <attribute name="text_y" value="-3"/>
@@ -55,10 +56,12 @@
         </class>


+    <!--- @access private -->
     <class name="datepickerlistitem" extends="textlistitem"
         fontsize="8" text_y="-2" height="12"/>


+    <!--- @access private -->
    <class name="_datepicker_dirButton"
           width="14"
           stretches="height"

Modified: openlaszlo/branches/legals/lps/components/lz/edittext.lzx
===================================================================
--- openlaszlo/branches/legals/lps/components/lz/edittext.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/lz/edittext.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -12,10 +12,6 @@
     </resource>


-    <!-- class for use in windowtext takes its parent's arguments
-         when it constructs
-         @keywords private
-         -->
     <class name="_internalinputtext" extends="inputtext">
         <method name="construct" args="parent, args">
             // args from parent
@@ -25,6 +21,11 @@
if ( parent['multiline'] != null ) args.multiline = parent.multiline; 
             super.construct(  parent, args );
         </method>
+        <doc>
+          <text>Class for use in windowtext takes its parent's arguments
+                when it constructs.</text>
+          <tag name="access"><text>private</text></tag>
+        </doc>
     </class>


@@ -236,7 +237,7 @@
               text input component with lz components look and feel
           </text></tag>
           <text>
- <p>The <tt>edittext</tt> tag provides a text input field which has a + <p>The <varname>edittext</varname> tag provides a text input field which has a look and feel to match the lz component set. It can accept any 
               <tagname>inputtext</tagname> attribute.</p>


Modified: openlaszlo/branches/legals/lps/components/lz/menu.lzx
===================================================================
--- openlaszlo/branches/legals/lps/components/lz/menu.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/lz/menu.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -21,9 +21,9 @@
past its container ( which has the same width as the content ) so 
              it's default width is immediateparent.width + 1 -->
         <attribute name="width"  value="${immediateparent.width + 1}"/>
-        <!--- @keyword private -->
+        <!--- @access private -->
         <attribute name="_clickcounter" value="0" />
-        <!--- @keyword private -->
+        <!--- @access private -->
         <attribute name="_openedmenu" value="0" />


@@ -402,7 +402,8 @@
         </method>

    </class> <!-- menuitem -->
-
+
+   <!--- @access private -->
    <class name="menufloatinglist" extends="floatinglist"
           bgcolor="0x445566" autoscrollbar="false"
           visible="false" focusable="false">

Modified: openlaszlo/branches/legals/lps/components/lz/scrollbar.lzx
===================================================================
--- openlaszlo/branches/legals/lps/components/lz/scrollbar.lzx 2007-03-14 22:26:57 UTC (rev 4299) +++ openlaszlo/branches/legals/lps/components/lz/scrollbar.lzx 2007-03-14 23:39:33 UTC (rev 4300) 
@@ -164,7 +164,7 @@
       <text>
<p>By default, the <tagname>scrollbar</tagname> tag creates a vertical - scrollbar. Setting <tt>axis="x"</tt> produces a horizontal scrollbar. + scrollbar. Setting <code>axis="x"</code> produces a horizontal scrollbar. If you do not specify a <attribute>scrolltarget</attribute>, the scrollbars will also control their own layout: the vertical scrollbar will be aligned the the right of the parent view and horizontal 
@@ -173,7 +173,7 @@
         <p>
Typically one or two scrollbars and a single view that is the contents to be scrolled, the scrolltarget, are contained within a parent view with - <tt>clip=true</tt>. The scrolling effect is produced by moving + <code>clip=true</code>. The scrolling effect is produced by moving the scrolltarget while its visible region is clipped by the parent view. 
         </p>



_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins





--
Regards,
Max Carlson
OpenLaszlo.org

Reply via email to