Author: ben
Date: 2007-11-19 14:04:35 -0800 (Mon, 19 Nov 2007)
New Revision: 7323
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
Log:
Change 20071119-ben-4 by [EMAIL PROTECTED] on 2007-11-19 13:29:05 PST
in /Users/ben/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Reference guide doc tools improvements
Documentation:
Improved look of methods list. List methods as classname.methodname( ... )
instead of just methodname.
Added a target for just building the components documentation; it doesn't
entirely work, though:
"ant components.ref.generate"
Tests:
ant clean build doc
Modified: openlaszlo/trunk/docs/includes/docbook.css
===================================================================
--- openlaszlo/trunk/docs/includes/docbook.css 2007-11-19 22:03:21 UTC (rev
7322)
+++ openlaszlo/trunk/docs/includes/docbook.css 2007-11-19 22:04:35 UTC (rev
7323)
@@ -203,11 +203,20 @@
/* Synopsis */
+.methodname {
+ color: #333333;
+ font-size: 14px;
+}
+
+.methodparam {
+ font-size: 14px;
+}
+
.classsynopsis, .methodsynopsis, .fieldsynopsis {
font-family:"Courier New",Courier,monospace;
}
-.classsynopsis .classname, .methodsynopsis .methodname, .fieldsynopsis
.varname {
+.classsynopsis .classname, .methodsynopsis .fieldsynopsis .varname {
font-weight:bold;
}
Modified: openlaszlo/trunk/docs/includes/styles.css
===================================================================
--- openlaszlo/trunk/docs/includes/styles.css 2007-11-19 22:03:21 UTC (rev
7322)
+++ openlaszlo/trunk/docs/includes/styles.css 2007-11-19 22:04:35 UTC (rev
7323)
@@ -83,6 +83,12 @@
color: #1F1F1F;
}
+dt .term {
+ font-size: 13px;
+ color: black;
+ line-height: 18px;
+}
+
dd {
line-height : 14px;
padding-bottom : 5px;
@@ -195,11 +201,10 @@
}
.informaltable th {
- background-color: #EEEEEE;
- color: #1F1F1F;
- font-size: 11px;
- font-weight: bold;
- line-height: 14px;
+ background-color: #F3F3F3;
+ font-size: 10px;
+ font-weight: normal;
+ line-height: 11px;
}
.chaptertoc {
Modified: openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl 2007-11-19
22:03:21 UTC (rev 7322)
+++ openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl 2007-11-19
22:04:35 UTC (rev 7323)
@@ -165,7 +165,7 @@
<methodname><link linkend="{$id}"><xsl:value-of
select="@name"/></link></methodname>
</xsl:when>
<xsl:otherwise>
- <methodname><xsl:value-of select="@name"/></methodname>
+ <methodname><xsl:value-of select="ancestor::property/doc/[EMAIL
PROTECTED]'lzxname']/text"/>.<xsl:value-of select="@name"/></methodname>
</xsl:otherwise>
</xsl:choose>
<xsl:for-each select="function/parameter">
@@ -235,7 +235,7 @@
</xsl:choose>
<xsl:for-each select="parameter">
<methodparam>
- <parameter><xsl:value-of select="@name"/></parameter>
+ <parameter>benhiparameterforfunction<xsl:value-of
select="@name"/></parameter>
<xsl:if test="@type"><type role="javascript"><xsl:value-of
select="@type"/></type></xsl:if>
</methodparam>
</xsl:for-each>
Modified: openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl 2007-11-19 22:03:21 UTC
(rev 7322)
+++ openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl 2007-11-19 22:04:35 UTC
(rev 7323)
@@ -127,11 +127,9 @@
<xsl:variable name="id-for-output">
<xsl:choose>
<xsl:when test="starts-with('lz', $jsname) and
(string-length($jsname) = 2)">
- <xsl:message>We found a thing with javascript name "lz"
sweet!</xsl:message>
<xsl:text>lz.pseudopackage</xsl:text>
</xsl:when>
<xsl:when test="starts-with('Lz', $jsname) and
(string-length($jsname) = 2)">
- <xsl:message>We found a thing with javascript name "Lz"
sweet!</xsl:message>
<xsl:text>library.Lz</xsl:text>
</xsl:when>
<xsl:otherwise><xsl:value-of select="@id"/></xsl:otherwise>
@@ -591,7 +589,8 @@
</term>
<listitem>
<refsect3>
- <xsl:apply-templates select="." mode="synopsis">
+ <!-- this prints the name and function parameters with types,
ie, callMyMethod( doit: Boolean ) -->
+ <xsl:apply-templates select="." mode="synopsis">
<xsl:with-param name="add-link" select="false()"/>
<xsl:with-param name="static" select="$static"/>
<xsl:with-param name="language" select="'javascript'" />
@@ -610,9 +609,8 @@
<colspec colname="Type" />
<colspec colname="Description" />
<thead>
- <row><entry namest="Name" nameend="Description"
align="left">Parameters</entry></row>
<row>
- <entry align="left">Name</entry>
+ <entry align="left">Parameter Name</entry>
<entry align="left">Type</entry>
<entry align="left">Description</entry>
</row>
@@ -760,6 +758,7 @@
<!-- REFENTRY HELPERS -->
+ <!-- This template is unused. [bshine 2007.11.16] -->
<xsl:template name="describe-parameters">
<segmentedlist>
<title>Parameters</title>
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
