[Laszlo-checkins] r9105 - in openlaszlo/trunk/docs: includes src/xsl src/xsl/js2doc2dbk

dda@openlaszlo.org dda at openlaszlo.org
Tue May 13 05:33:00 PDT 2008


Author: dda
Date: 2008-05-13 05:32:54 -0700 (Tue, 13 May 2008)
New Revision: 9105

Modified:
   openlaszlo/trunk/docs/includes/docbook.css
   openlaszlo/trunk/docs/includes/styles.css
   openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
   openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl
   openlaszlo/trunk/docs/src/xsl/synop-javascript.xsl
   openlaszlo/trunk/docs/src/xsl/synop-lzx.xsl
Log:
Change 20080513-dda-a by dda at lester.local on 2008-05-13 08:10:49 EDT
    in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc2
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: doc: fix bolding issues for methods, removed background gray for attributes

New Features:

Bugs Fixed: LPP-5946, LPP-5949 (partial)

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

Documentation:

Release Notes:

Details:
    Separated out name of class from method into different tags.
    For (static) class methods there are
      <methodstaticclass>Class.</methodstaticclass></methodname>methodName</methodname>
    For non-class methods there are
      <methodclass>Class.</methodclass></methodname>methodName</methodname>
    Associated style sheets for each is set up.

    Attribute names when listed should not be gray.  (LPP-5949 - part 1).

Tests:



Modified: openlaszlo/trunk/docs/includes/docbook.css
===================================================================
--- openlaszlo/trunk/docs/includes/docbook.css	2008-05-13 12:16:35 UTC (rev 9104)
+++ openlaszlo/trunk/docs/includes/docbook.css	2008-05-13 12:32:54 UTC (rev 9105)
@@ -222,6 +222,11 @@
     font-size: 14px;
 }
 
+.methodstaticclass {
+    color: #333333;
+    font-size: 14px;
+}
+
 .methodname {
     color: #333333;
     font-size: 14px;

Modified: openlaszlo/trunk/docs/includes/styles.css
===================================================================
--- openlaszlo/trunk/docs/includes/styles.css	2008-05-13 12:16:35 UTC (rev 9104)
+++ openlaszlo/trunk/docs/includes/styles.css	2008-05-13 12:32:54 UTC (rev 9105)
@@ -376,6 +376,7 @@
 
 /* Attributes List ****************** */
 td .literal {
+    background-color: white;
     font-size: 12px;
     font-weight: bold; 
     line-height: 18px;

Modified: openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl	2008-05-13 12:16:35 UTC (rev 9104)
+++ openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl	2008-05-13 12:32:54 UTC (rev 9105)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2007 Laszlo Systems, Inc.  All Rights Reserved.                   *
+* Copyright 2007-2008 Laszlo Systems, Inc.  All Rights Reserved.              *
 * Use is subject to license terms.                                            *
 * X_LZ_COPYRIGHT_END ****************************************************** -->
 <!DOCTYPE xsl:stylesheet [
@@ -166,24 +166,26 @@
             <methodname><link linkend="{$id}"><xsl:value-of select="@name"/></link></methodname>
           </xsl:when>
           <xsl:otherwise>
-            <methodname>
               <xsl:choose>
               <xsl:when test="$static">
                 <!-- For static methods, show the class name --> 
-                <xsl:value-of select="../../@name"/>.<xsl:value-of select="@name"/>
+                <methodstaticclass><xsl:value-of select="../../@name"/>.</methodstaticclass><methodname><xsl:value-of select="@name"/></methodname>
               </xsl:when>
               <xsl:when test="ancestor::property/doc/tag[@name='lzxname']/text">
-                <!-- For instance methods, show the name of the class --> 
-                <xsl:value-of select="ancestor::property/doc/tag[@name='lzxname']/text"/>.<xsl:value-of select="@name"/>
+                <!-- For instance methods, show name of tag if there is one --> 
+                <methodclass><xsl:value-of select="ancestor::property/doc/tag[@name='lzxname']/text"/>.</methodclass><methodname><xsl:value-of select="@name"/></methodname>
               </xsl:when>
+              <xsl:when test="ancestor::property/@name">
+                <!-- Or for instance methods, show the name of the class --> 
+                <methodclass><xsl:value-of select="ancestor::property/@name"/>.</methodclass><methodname><xsl:value-of select="@name"/></methodname>
+              </xsl:when>
                <xsl:otherwise>        
                  <xsl:if test="$warn.classname.not.found">
                    <xsl:message>No class name found for function synopsis: <xsl:value-of select="@id"/></xsl:message>
                  </xsl:if>                   
-                 <xsl:value-of select="@name"/>                                    
+                 <methodname><xsl:value-of select="@name"/></methodname>
                </xsl:otherwise>
               </xsl:choose>                
-            </methodname>
           </xsl:otherwise>
         </xsl:choose>
         <xsl:for-each select="function/parameter">

Modified: openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl	2008-05-13 12:16:35 UTC (rev 9104)
+++ openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl	2008-05-13 12:32:54 UTC (rev 9105)
@@ -492,7 +492,7 @@
     <xsl:variable name="visible-members" select="$members[contains($visibility.filter, at access)]"/>
     <xsl:if test="count($visible-members) > 0">
       <variablelist><title><xsl:value-of select="$title"/></title></variablelist>
-      <informaltable frame="none" colsep="0">
+      <informaltable frame="none" colsep="0" rowsep="1" width="100%">
         <tgroup cols="4">
           <colspec colname="Name" />
           <colspec colname="TypeTag" />

Modified: openlaszlo/trunk/docs/src/xsl/synop-javascript.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/synop-javascript.xsl	2008-05-13 12:16:35 UTC (rev 9104)
+++ openlaszlo/trunk/docs/src/xsl/synop-javascript.xsl	2008-05-13 12:32:54 UTC (rev 9105)
@@ -1,6 +1,6 @@
 <?xml version='1.0'?>
 <!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2006-2007 Laszlo Systems, Inc.  All Rights Reserved.              *
+* Copyright 2006-2008 Laszlo Systems, Inc.  All Rights Reserved.              *
 * Use is subject to license terms.                                            *
 * X_LZ_COPYRIGHT_END ****************************************************** -->
 <!DOCTYPE xsl:stylesheet [
@@ -145,6 +145,20 @@
   </span>
 </xsl:template>
 
+<xsl:template match="methodclass" mode="javascript">
+  <xsl:variable name="class" select="ooclass[not(@role)]"/>  
+  <span class="{name(.)}">
+    <xsl:apply-templates mode="javascript"/>
+  </span>
+</xsl:template>
+
+<xsl:template match="methodstaticclass" mode="javascript">
+  <xsl:variable name="class" select="ooclass[not(@role)]"/>  
+  <span class="{name(.)}">
+    <xsl:apply-templates mode="javascript"/>
+  </span>
+</xsl:template>
+
 <xsl:template match="methodparam" mode="javascript">
   <span class="{name(.)}">
     <xsl:apply-templates select="parameter" mode="javascript"/>
@@ -196,6 +210,8 @@
       <xsl:text>&nbsp;</xsl:text>
     </xsl:for-each>
   
+    <xsl:apply-templates select="methodstaticclass" mode="javascript"/>
+    <xsl:apply-templates select="methodclass" mode="javascript"/>
     <xsl:apply-templates select="methodname" mode="javascript"/>
 
     <xsl:text>(</xsl:text>

Modified: openlaszlo/trunk/docs/src/xsl/synop-lzx.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/synop-lzx.xsl	2008-05-13 12:16:35 UTC (rev 9104)
+++ openlaszlo/trunk/docs/src/xsl/synop-lzx.xsl	2008-05-13 12:32:54 UTC (rev 9105)
@@ -1,6 +1,6 @@
 <?xml version='1.0'?>
 <!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2006-2007 Laszlo Systems, Inc.  All Rights Reserved.              *
+* Copyright 2006-2008 Laszlo Systems, Inc.  All Rights Reserved.              *
 * Use is subject to license terms.                                            *
 * X_LZ_COPYRIGHT_END ****************************************************** -->
 <!DOCTYPE xsl:stylesheet [
@@ -98,7 +98,7 @@
   </div>
 </xsl:template>
 
-<xsl:template match="type|varname|initializer|methodname|parameter" mode="lzx">
+<xsl:template match="type|varname|initializer|methodname|methodclass|methodstaticclass|parameter" mode="lzx">
   <span class="{name(.)}"><xsl:apply-templates mode="lzx"/></span>
 </xsl:template>
 
@@ -126,6 +126,8 @@
     </xsl:if>
     <!-- TODO: add modifiers as preceding js2doc comment -->
     <xsl:text>&lt;method name="</xsl:text>
+    <xsl:apply-templates select="methodclass" mode="lzx"/>
+    <xsl:apply-templates select="methodstaticclass" mode="lzx"/>
     <xsl:apply-templates select="methodname" mode="lzx"/>
     <xsl:text>"</xsl:text>
     <xsl:if test="methodparam">



More information about the Laszlo-checkins mailing list