Author: ben
Date: 2007-10-31 11:38:34 -0700 (Wed, 31 Oct 2007)
New Revision: 7063
Modified:
openlaszlo/branches/paperpie/docs/includes/docbook.css
openlaszlo/branches/paperpie/docs/includes/styles.css
openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl
openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl
openlaszlo/branches/paperpie/docs/src/xsl/simple-driver.xsl
openlaszlo/branches/paperpie/docs/src/xsl/xref.xsl
Log:
Change 20071031-ben-8 by [EMAIL PROTECTED] on 2007-10-31 10:58:36 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie
Summary: Improvements and fixes to reference
New Features:
Bugs Fixed:
LPP-4977 Refguide links to developers' guide chapters are wrongly mapped
LPP-4712 should not have two files with the same name and different caps in the
same directory: lz.html and Lz.html
Technical Reviewer: none
QA Reviewer: frisco (pending)
Doc Reviewer: sundman (pending)
Documentation:
Added documentation of return type to methods documentation. Improved
layout of attribute list. Improved links from reference guide to
developer's guides. Avoided file-name conflict in reference output.
Release Notes:
Note to reviewers: the proof is in the pudding; please await a
new deployed build on labs, and review there.
Details:
docs/src/xsl/js2doc2dbk.xsl - watch out for things named "Lz" or "lz",
and give each of them a unique id. This makes sure that we don't generate
more than one file named [Ll]z.html, since this is the cause of bug
LPP-4712.
docs/includes/docbook.css - minor output formatting changes.
docs/includes/styles.css - make attributes list look a little nicer
docs/src/xsl/simple-driver.xsl - unimportant figuring-stuff-out changes
docs/src/xsl/refguide-html.xsl - moving two templates from this
xsl file into jsdoc2dbk.xsl, because they are "about" generating
docbook from js2doc.
docs/src/xsl/xref.xsl - further work towards making links from
reference to developer's guide work better. Fixes
LPP-4966 Refguide links to developers' guide chapters are wrongly mapped
Tests:
Modified: openlaszlo/branches/paperpie/docs/includes/docbook.css
===================================================================
--- openlaszlo/branches/paperpie/docs/includes/docbook.css 2007-10-31
18:36:17 UTC (rev 7062)
+++ openlaszlo/branches/paperpie/docs/includes/docbook.css 2007-10-31
18:38:34 UTC (rev 7063)
@@ -46,7 +46,7 @@
.refsect1 {
clear: both;
- margin-top: -5px;
+ margin-top: 5px;
}
@@ -167,6 +167,7 @@
}
.refentry td {
+ font-size: 10px;
border-bottom-width: 1px;
}
Modified: openlaszlo/branches/paperpie/docs/includes/styles.css
===================================================================
--- openlaszlo/branches/paperpie/docs/includes/styles.css 2007-10-31
18:36:17 UTC (rev 7062)
+++ openlaszlo/branches/paperpie/docs/includes/styles.css 2007-10-31
18:38:34 UTC (rev 7063)
@@ -194,6 +194,14 @@
text-decoration: none;
}
+.informaltable th {
+ background-color: #EEEEEE;
+ color: #1F1F1F;
+ font-size: 11px;
+ font-weight: bold;
+ line-height: 14px;
+}
+
.chaptertoc {
float: left;
}
Modified: openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl 2007-10-31
18:36:17 UTC (rev 7062)
+++ openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl 2007-10-31
18:38:34 UTC (rev 7063)
@@ -117,8 +117,24 @@
<xsl:variable name="desc">
<xsl:apply-templates select="." mode="desc"/>
</xsl:variable>
+
+ <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>
+ </xsl:choose>
- <refentry id="[EMAIL PROTECTED]" xreflabel="{$desc}">
+ </xsl:variable>
+
+
+ <refentry id="{$id-for-output}" xreflabel="{$desc}">
<xsl:if test="$lzxname"><anchor
id="{concat('tag.',$lzxname)}"/></xsl:if>
<refmeta>
<refentrytitle><xsl:value-of select="$desc"/></refentrytitle>
@@ -153,7 +169,7 @@
<refentry id="[EMAIL PROTECTED]" xreflabel="{$desc}">
<refnamediv>
<refname>
- <filename><xsl:value-of select="$file-path"/></filename>
+ <filename><xsl:value-of select="$file-path"/></filename>
</refname>
<xsl:if test="&shortdesc;">
<refpurpose>
@@ -185,6 +201,36 @@
<xsl:template match="*" mode="refentry">
</xsl:template>
+
+
+ <xsl:template match="refnamediv">
+ <div class="{name(.)}">
+ <xsl:call-template name="dir">
+ <xsl:with-param name="inherit" select="1"/>
+ </xsl:call-template>
+ <xsl:call-template name="anchor"/>
+ <!-- Just show the name of the tag, not "Name: " -->
+ <h2><xsl:apply-templates/></h2>
+ </div>
+ </xsl:template>
+
+ <xsl:template match="refpurpose">
+ <xsl:if test="node()">
+ <div class="refpurpose">
+ <xsl:apply-templates/>
+ </div>
+ </xsl:if>
+ </xsl:template>
+
+ <xsl:template match="refsynopsisdiv">
+ <div class="{name(.)}">
+ <xsl:call-template name="dir">
+ <xsl:with-param name="inherit" select="1"/>
+ </xsl:call-template>
+ <xsl:call-template name="anchor"/>
+ <xsl:apply-templates/>
+ </div>
+ </xsl:template>
<!-- DESCRIPTION -->
@@ -496,19 +542,6 @@
</tgroup>
</table>
- <!-- Also list the event out the old way. This seems to be necessary
- to get the xref in properly. [bshine 10.11.2007] -->
- <!--
- <xsl:for-each select="$visible-members">
- <xsl:sort select="translate(@name,'_$',' ')"/>
- <xsl:apply-templates select="." mode="describe-member">
- <xsl:with-param name="static" select="$static"/>
- <xsl:with-param name="describe-js" select="$describe-js"/>
- <xsl:with-param name="describe-lzx" select="$describe-lzx"/>
- </xsl:apply-templates>
- </xsl:for-each>
-
- -->
</xsl:if>
@@ -560,13 +593,13 @@
</xsl:if>
<xsl:if test="function/parameter">
<refsect3>
- <table frame="none" colsep="0" rowsep="0">
- <title><xsl:text>Parameters</xsl:text></title>
+ <informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="3">
<colspec colname="Name" />
<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">Type</entry>
@@ -576,16 +609,40 @@
<tbody>
<xsl:for-each select="function/parameter">
<row>
- <entry><xsl:value-of select="@name"/></entry>
+ <entry><xsl:attribute
name="class">parametername</xsl:attribute><xsl:value-of select="@name"/></entry>
<entry><xsl:value-of select="@type"/></entry>
<entry><xsl:value-of select="doc/text"/></entry>
</row>
</xsl:for-each>
</tbody>
</tgroup>
- </table>
+ </informaltable>
</refsect3>
</xsl:if>
+ <xsl:if test="function/returns">
+ <refsect3>
+ <para>function/returns exists benyeah</para>
+ <informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
+ <tgroup cols="2">
+ <colspec colname="Type" />
+ <colspec colname="Description" />
+ <thead>
+ <row><entry namest="Type" nameend="Description"
align="left">Returns</entry></row>
+ <row>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><xsl:value-of
select="function/returns/@type"/></entry>
+ <entry><xsl:value-of
select="function/returns/doc/text"/></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect3>
+ </xsl:if>
</listitem>
</varlistentry>
</xsl:template>
@@ -879,37 +936,38 @@
<!-- MISC -->
- <xsl:template name="insert-refinfo">
- <variablelist>
+ <xsl:template name="insert-refinfo">
+
+ <xsl:if test="@name">
+ <refsect1>
+ <xsl:text>JavaScript: </xsl:text><xsl:value-of select="@name"/>
+ </refsect1>
+ </xsl:if>
- <xsl:if test="@name">
- <varlistentry><term>JavaScript: <xsl:value-of
select="@name"/></term></varlistentry>
- </xsl:if>
-
- <xsl:if test="@runtimes">
- <varlistentry><term>Runtimes: <xsl:value-of
select="@runtimes"/></term></varlistentry>
- </xsl:if>
-
- <xsl:if test="child::class">
- <refsect1>
- <xsl:text>Extends </xsl:text>
- <xsl:call-template name="describe-superclass-chain">
- <xsl:with-param name="class" select="child::class"/>
- </xsl:call-template>
- </refsect1>
- </xsl:if>
-
-<?ignore
+ <xsl:if test="@runtimes">
+ <refsect1>
+ <xsl:text>Runtimes: </xsl:text> <xsl:value-of select="@runtimes"/>
+ </refsect1>
+ </xsl:if>
+
+ <xsl:if test="child::class">
+ <refsect1>
+ <xsl:text>Extends </xsl:text>
+ <xsl:call-template name="describe-superclass-chain">
+ <xsl:with-param name="class" select="child::class"/>
+ </xsl:call-template>
+ </refsect1>
+ </xsl:if>
+
+ <?ignore
<!-- need to turn path into webapp url, not sure how to do that -->
<xsl:variable name="path" select="@path"/>
<xsl:if test="$path and $path != ''">
- <xsl:variable name="pathurl" select="$pathurl"/>
- <varlistentry><term>Source: <ulink
url="{$pathurl}"/></term></varlistentry>
+ <xsl:variable name="pathurl" select="$pathurl"/>
+ <varlistentry><term>Source: <ulink
url="{$pathurl}"/></term></varlistentry>
</xsl:if>
-?>
- </variablelist>
-
- </xsl:template>
+ ?>
+ </xsl:template>
<xsl:template name="classlabel">
<xsl:choose>
@@ -1089,7 +1147,12 @@
<xsl:value-of select="$desc"/>
</term>
<row>
- <entry><xsl:value-of select="@name"/></entry>
+ <xsl:if test="not (doc/text)">
+ <xsl:attribute name="rowsep">0</xsl:attribute>
+ </xsl:if>
+ <entry><literal>
+ <xsl:value-of select="@name"/>
+ </literal></entry>
<!-- "Usage" will go here <entry>(unknown)</entry> -->
<entry><xsl:value-of select="&lzxtype;" /> </entry>
<entry>
@@ -1111,7 +1174,7 @@
-->
</row>
<xsl:if test="doc/text">
- <row>
+ <row rowsep="1">
<entry namest="TagType" nameend="Category">
<xsl:value-of select="doc/text" />
</entry>
Modified: openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl 2007-10-31
18:36:17 UTC (rev 7062)
+++ openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl 2007-10-31
18:38:34 UTC (rev 7063)
@@ -20,35 +20,7 @@
<xsl:param name="linenumbering.extension.frag" select="0"/>
- <xsl:template match="refnamediv">
- <div class="{name(.)}">
- <xsl:call-template name="dir">
- <xsl:with-param name="inherit" select="1"/>
- </xsl:call-template>
- <xsl:call-template name="anchor"/>
- <!-- Just show the name of the tag, not "Name: " -->
- <h2><xsl:apply-templates/></h2>
- </div>
- </xsl:template>
+
- <xsl:template match="refpurpose">
- <xsl:if test="node()">
- <div class="refpurpose">
- <xsl:apply-templates/>
- </div>
- </xsl:if>
- </xsl:template>
-
- <xsl:template match="refsynopsisdiv">
- <div class="{name(.)}">
- <xsl:call-template name="dir">
- <xsl:with-param name="inherit" select="1"/>
- </xsl:call-template>
- <xsl:call-template name="anchor"/>
- <xsl:apply-templates/>
- </div>
- </xsl:template>
-
-
</xsl:stylesheet>
\ No newline at end of file
Modified: openlaszlo/branches/paperpie/docs/src/xsl/simple-driver.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/simple-driver.xsl 2007-10-31
18:36:17 UTC (rev 7062)
+++ openlaszlo/branches/paperpie/docs/src/xsl/simple-driver.xsl 2007-10-31
18:38:34 UTC (rev 7063)
@@ -41,6 +41,9 @@
<xsl:key name="superclass" match="property[child::class]"
use="class/@extends"/>
<xsl:template match="/">
+ <h3>
+ <xsl:attribute name="class">goofy</xsl:attribute>
+ hi there</h3>
<xsl:for-each select="descendant::refsect1[1]">
$relative.path.to.lpshome: <xsl:value-of
select="$relative.path.to.lpshome"/>
local.lps.path:<xsl:call-template name="local.lps.path" />
Modified: openlaszlo/branches/paperpie/docs/src/xsl/xref.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/xref.xsl 2007-10-31 18:36:17 UTC
(rev 7062)
+++ openlaszlo/branches/paperpie/docs/src/xsl/xref.xsl 2007-10-31 18:38:34 UTC
(rev 7063)
@@ -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 ****************************************************** -->
<!DOCTYPE xsl:stylsheet [
@@ -40,16 +40,16 @@
<xsl:value-of select="concat($lpsdir, 'demos/')"/>
</xsl:when>
<xsl:when test="$key = 'dguide'">
- <xsl:value-of select="concat($docsdir, 'guide/')"/>
+ <xsl:value-of select="concat($docsdir, 'developers/')"/>
</xsl:when>
<xsl:when test="$key = 'deploy'">
- <xsl:value-of select="concat($docsdir, 'deploy/')"/>
+ <xsl:value-of select="concat($docsdir, 'deployers/')"/>
</xsl:when>
<xsl:when test="$key = 'design'">
- <xsl:value-of select="concat($docsdir, 'design/')"/>
+ <xsl:value-of select="concat($docsdir, 'designers/')"/>
</xsl:when>
<xsl:when test="$key = 'develop'">
- <xsl:value-of select="concat($docsdir, 'guide/')"/>
+ <xsl:value-of select="concat($docsdir, 'developers/')"/>
</xsl:when>
<xsl:when test="$key = 'examples'">
<xsl:value-of select="concat($lpsdir, 'examples/')"/>
@@ -58,7 +58,7 @@
<xsl:value-of select="$reference.dir"/>
</xsl:when>
<xsl:when test="$key = 'tutorials'">
- <xsl:value-of select="concat($docsdir, 'guide/')"/>
+ <xsl:value-of select="concat($docsdir, 'developers/tutorials/')"/>
</xsl:when>
<xsl:otherwise>
<xsl:message terminate="yes">
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
