[Laszlo-checkins] r9051 - in openlaszlo/trunk/docs: includes src/xsl
dda@openlaszlo.org
dda at openlaszlo.org
Fri May 9 10:23:54 PDT 2008
Author: dda
Date: 2008-05-09 10:23:48 -0700 (Fri, 09 May 2008)
New Revision: 9051
Modified:
openlaszlo/trunk/docs/includes/docbook.css
openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
Log:
Change 20080509-dda-y by dda at lester.local on 2008-05-09 13:03:38 EDT
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc2
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Some doctools cleanup for reference
New Features:
Bugs Fixed: LPP-5939 (partial), LPP-5942 (partial), LPP-5944 (complete), LPP-5924 (complete)
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)
Documentation:
Release Notes:
Details:
Note -- this fixes some JIRA bugs only partially, many doc tools issues are known
to remain, and limitations of fixes are given below:
LPP-5924: used lower case concise 'extends' and 'with' to be consistent with language (per Tucker).
LPP-5924: if a mixin/superclass does not contribute an event/method/attribute, a header for that
inheritence is not shown
LPP-5924: trailing commas on list of events/methods/attributes removed.
LPP-5944: events/methods/attributes for mixins are now listed first before those from class inheritence.
LPP-5939: Details header removed, Attributes/Events/Methods white on dark blue now shown when
the class has Attributes/Events/Methods. They do not yet have a link.
LPP-5942: methods names now appear with a gray background, the background is not currently
extended to the right, ruled lines are not yet added.
Tests:
cd docs/src; ant clean reference
examine individual doc files
Modified: openlaszlo/trunk/docs/includes/docbook.css
===================================================================
--- openlaszlo/trunk/docs/includes/docbook.css 2008-05-09 17:23:34 UTC (rev 9050)
+++ openlaszlo/trunk/docs/includes/docbook.css 2008-05-09 17:23:48 UTC (rev 9051)
@@ -76,9 +76,18 @@
margin-bottom: 5px;
}
-.refsynopsisdiv .term {
+.refsynopsisdiv {
font-style: normal;
}
+
+.term {
+ font-style: normal;
+ font-family : Verdana, Geneva, Arial, Helvetica, sans-serif;
+ font-size : 13px;
+ font-weight : bold;
+ color: #000000;
+ background-color: #e8e8e8;
+}
.indexdiv dl dd {
padding-bottom: inherit;
}
@@ -208,9 +217,15 @@
/* Synopsis */
+.methodclass {
+ color: #333333;
+ font-size: 14px;
+}
+
.methodname {
color: #333333;
font-size: 14px;
+ font-weight:bold;
}
.methodparam {
Modified: openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl 2008-05-09 17:23:34 UTC (rev 9050)
+++ openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl 2008-05-09 17:23:48 UTC (rev 9051)
@@ -249,8 +249,6 @@
<xsl:template match="property" mode="refentry-details">
<refsect1>
- <title>Details</title>
-
<xsl:variable name="jsname" select="@name"/>
<xsl:variable name="lzxname" select="&tagname;"/>
<xsl:variable name="ivars" select="&objectvalue;/property[@name='__ivars__']/object/property[&isvisible;]"/>
@@ -493,7 +491,7 @@
<xsl:variable name="visible-members" select="$members[contains($visibility.filter, at access)]"/>
<xsl:if test="count($visible-members) > 0">
- <refsect2><title><xsl:value-of select="$title"/></title>
+ <variablelist><title><xsl:value-of select="$title"/></title></variablelist>
<informaltable frame="none" colsep="0">
<tgroup cols="4">
<colspec colname="Name" />
@@ -522,7 +520,6 @@
</tbody>
</tgroup>
</informaltable>
- </refsect2>
</xsl:if>
</xsl:template>
@@ -541,7 +538,7 @@
</xsl:variable>
<xsl:if test="count($visible-members) > 0">
- <refsect2><title>Events</title>
+ <variablelist><title>Events</title></variablelist>
<informaltable frame="none" colsep="0" rowsep="0">
<tgroup cols="2">
<colspec colname="Name" />
@@ -572,9 +569,7 @@
</tbody>
</tgroup>
</informaltable>
- </refsect2>
</xsl:if>
-
</xsl:template>
<xsl:template match="initarg|property" mode="describe-member">
@@ -1003,7 +998,7 @@
<xsl:if test="child::class[@extends]">
<refsect1>
- <xsl:text>Extends </xsl:text>
+ <xsl:text>extends </xsl:text>
<xsl:call-template name="describe-superclass-chain">
<xsl:with-param name="class" select="child::class"/>
</xsl:call-template>
@@ -1012,7 +1007,7 @@
<xsl:if test="child::class/@inherits">
<xsl:variable name="inheritslist" select="child::class/@inherits"/>
<refsect1>
- <xsl:text>With </xsl:text>
+ <xsl:text>with </xsl:text>
<xsl:call-template name="describe-mixin-chain">
<xsl:with-param name="mixins" select="$inheritslist"/>
</xsl:call-template>
@@ -1142,7 +1137,7 @@
<xsl:variable name="extends" select="$class/@extends"/>
<xsl:variable name="inheritslist" select="$class/@inherits"/>
<xsl:call-template name="iterate-inherited">
- <xsl:with-param name="values" select="concat($extends,',',$inheritslist)"/>
+ <xsl:with-param name="values" select="concat($inheritslist,',',$extends)"/>
<xsl:with-param name="memberkind" select="'attributes'"/>
</xsl:call-template>
</xsl:template>
@@ -1150,7 +1145,10 @@
<xsl:template name="describe-inherited-attributes-for">
<xsl:param name="superclass"/>
<xsl:if test="$superclass">
- <refsect2>
+ <xsl:variable name="inheritedattrs" select="$superclass/class/property[@name='__ivars__']/object/property[@access='public']"></xsl:variable>
+ <xsl:variable name="allinheritedattrs" select="$inheritedattrs[not &isevent;]" />
+ <xsl:if test="count($allinheritedattrs) > 0">
+ <refsect2>
<title>
<xsl:text>Attributes inherited from </xsl:text>
<xsl:call-template name="show-super-link">
@@ -1158,8 +1156,6 @@
</xsl:call-template>
</title>
<para>
- <xsl:variable name="inheritedattrs" select="$superclass/class/property[@name='__ivars__']/object/property[@access='public']"></xsl:variable>
- <xsl:variable name="allinheritedattrs" select="$inheritedattrs[not &isevent;]" />
<xsl:for-each select="$allinheritedattrs">
<xsl:sort select="@name"/>
<!-- even if attributes are public, if the class is not, there will
@@ -1172,10 +1168,13 @@
<xsl:value-of select="@name"/>
</xsl:otherwise>
</xsl:choose>
- <xsl:text>, </xsl:text>
+ <xsl:if test="position() != last()">
+ <xsl:text>, </xsl:text>
+ </xsl:if>
</xsl:for-each>
</para>
- </refsect2>
+ </refsect2>
+ </xsl:if>
<xsl:choose>
<xsl:when test="contains($visibility.filter, $superclass/@access)">
<xsl:call-template name="describe-inherited-attributes">
@@ -1191,6 +1190,7 @@
</xsl:template>
+
<xsl:template name="describe-inherited-methods">
<xsl:param name="class"/>
@@ -1201,7 +1201,7 @@
<xsl:variable name="inheritslist" select="$class/@inherits"/>
<xsl:call-template name="iterate-inherited">
- <xsl:with-param name="values" select="concat($extends,',',$inheritslist)"/>
+ <xsl:with-param name="values" select="concat($inheritslist,',',$extends)"/>
<xsl:with-param name="memberkind" select="'methods'"/>
</xsl:call-template>
</xsl:template>
@@ -1211,8 +1211,9 @@
<xsl:param name="superclass"/>
<xsl:if test="$superclass">
- <refsect2>
<xsl:variable name="inheritedmethods" select="$superclass/class/property/object/property[@access='public']/function"></xsl:variable>
+ <xsl:if test="count($inheritedmethods) > 0">
+ <refsect2>
<title>
<xsl:text>Methods inherited from </xsl:text>
<xsl:call-template name="show-super-link">
@@ -1232,10 +1233,13 @@
<xsl:value-of select="../@name"/>
</xsl:otherwise>
</xsl:choose>
- <xsl:text>, </xsl:text>
+ <xsl:if test="position() != last()">
+ <xsl:text>, </xsl:text>
+ </xsl:if>
</xsl:for-each>
</para>
- </refsect2>
+ </refsect2>
+ </xsl:if>
<xsl:choose>
<xsl:when test="contains($visibility.filter, $superclass/@access)">
<xsl:call-template name="describe-inherited-methods">
@@ -1263,7 +1267,7 @@
<xsl:variable name="inheritslist" select="$class/@inherits"/>
<xsl:call-template name="iterate-inherited">
- <xsl:with-param name="values" select="concat($extends,',',$inheritslist)"/>
+ <xsl:with-param name="values" select="concat($inheritslist,',',$extends)"/>
<xsl:with-param name="memberkind" select="'events'"/>
</xsl:call-template>
</xsl:template>
@@ -1273,7 +1277,8 @@
<xsl:if test="$superclass">
<xsl:variable name="inheritedevents" select="$superclass/class/property[@name='__ivars__']/object/property[doc/tag[@name='lzxtype']/text = 'event' and &ispublic;]"></xsl:variable>
- <refsect2>
+ <xsl:if test="count($inheritedevents) > 0">
+ <refsect2>
<title>
<xsl:text>Events inherited from </xsl:text>
<xsl:call-template name="show-super-link">
@@ -1293,10 +1298,13 @@
<xsl:value-of select="@name"/>
</xsl:otherwise>
</xsl:choose>
- <xsl:text>, </xsl:text>
+ <xsl:if test="position() != last()">
+ <xsl:text>, </xsl:text>
+ </xsl:if>
</xsl:for-each>
</para>
- </refsect2>
+ </refsect2>
+ </xsl:if>
<xsl:choose>
<xsl:when test="contains($visibility.filter, $superclass/@access)">
<xsl:call-template name="describe-inherited-events">
More information about the Laszlo-checkins
mailing list