Author: ben
Date: 2007-09-28 19:05:43 -0700 (Fri, 28 Sep 2007)
New Revision: 6689
Modified:
openlaszlo/branches/paperpie/docs/includes/docbook.css
openlaszlo/branches/paperpie/docs/includes/lzx-pretty-print.css
openlaszlo/branches/paperpie/docs/includes/styles.css
openlaszlo/branches/paperpie/docs/src/build.xml
openlaszlo/branches/paperpie/docs/src/xsl/common-html.xsl
openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl
openlaszlo/branches/paperpie/docs/src/xsl/parameters.xsl
openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl
Log:
Change 20070928-ben-3 by [EMAIL PROTECTED] on 2007-09-28 18:24:44 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie
Summary: Make top part of individual pages in the reference guide look more
like 3.4 reference guide
Documentation:
This change is a number of small formatting and processing changes which
make the generated documentation look superficially more like the 3.4
documentation. This mostly means filtering out some of the extra
information that had been added to the top of the page in reference
entries. Several minor CSS changes have been made to match the
look of the old documentation better.
This work was based on getting <tab> to match the 3.4 <tab>
reference. The formatting currently looks "best" for
components; other areas have not been evaluated.
Details:
Tests:
ant clean; ant build doc
passes.
Pages in the reference still look decent, for instance:
http://localhost:8080/paperpie/docs/reference/LzAnimator.html
Modified: openlaszlo/branches/paperpie/docs/includes/docbook.css
===================================================================
--- openlaszlo/branches/paperpie/docs/includes/docbook.css 2007-09-29
02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/includes/docbook.css 2007-09-29
02:05:43 UTC (rev 6689)
@@ -7,9 +7,9 @@
@import "styles.css";
div.book, div.chapter, div.part, div.preface, div.appendix, div.index,
div.glossary, div.refentry, div.reference {
- padding-left : 60;
+ padding-left : 10;
padding-top : 20;
- padding-right : 100;
+ padding-right : 10;
}
.toc .section {
@@ -26,9 +26,9 @@
padding-left : 30px;
}
-h1 { margin-left : -45; }
-h2 { margin-left: -30; }
-h3 { margin-left : -15; }
+h1 { margin-left : 0; }
+h2 { margin-left: 0; }
+h3 { margin-left : 0; }
td {
vertical-align: top;
@@ -52,18 +52,19 @@
max-width: 40%;
margin: 5pt;
padding: 5pt;
- border: 1px solid #7b839a;
- background-color: #E0E0E0;
+ text-align: right;
}
.refsynopsisdiv h2 {
margin-left: 0px;
font-size: 12px;
- border-bottom: solid 1px #7b839a;
margin-top: 5px;
margin-bottom: 5px;
}
+.refsynopsisdiv .term {
+ font-style: normal;
+}
.indexdiv dl dd {
padding-bottom: inherit;
}
@@ -107,10 +108,6 @@
background-color: #5b607c;
}
-.variablelist dd {
- border-bottom: solid 1px #e5e5e5
-}
-
/* Refentry */
.refsect3 {
Modified: openlaszlo/branches/paperpie/docs/includes/lzx-pretty-print.css
===================================================================
--- openlaszlo/branches/paperpie/docs/includes/lzx-pretty-print.css
2007-09-29 02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/includes/lzx-pretty-print.css
2007-09-29 02:05:43 UTC (rev 6689)
@@ -17,8 +17,20 @@
.comment-markup {color: gray; }
.constraint-markup {color: gray}
.constraint-expression {color: red}
+.literal {
+ background-color: #eaeaea;
+ font-family: "Courier New",Courier,monospace;
+ font-size: 13;
+}
-/* Next two styles, .warningheader and .warningheader a,
+.refpurpose {
+ margin-top: 20px;
+ font-style: italic;
+ font-size: 12px;
+ font-weight: normal;
+}
+
+/* Next two styles, .warningheader and .warningheader a,
are for the in-progress tag for the OL4.0.5 reference only.
After 4.0.5, these can be deleted. [bshine 2007.08.30]
Bug LPP-4539. */
Modified: openlaszlo/branches/paperpie/docs/includes/styles.css
===================================================================
--- openlaszlo/branches/paperpie/docs/includes/styles.css 2007-09-29
02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/includes/styles.css 2007-09-29
02:05:43 UTC (rev 6689)
@@ -18,11 +18,12 @@
}
h1 {
- font-size : 18px;
+ font-size : 20px;
}
h2 {
- font-size : 16px;
+ font-size : 18px;
+ margin-bottom: 20px;
}
h3 {
@@ -252,7 +253,7 @@
/* Code ******************************************* */
-.code, .program, .fragment, tt {
+.code, .program, .fragment, tt, .varname {
font-family : "Courier New", Courier, monospace;
font-size : 13px;
font-weight : bold;
Modified: openlaszlo/branches/paperpie/docs/src/build.xml
===================================================================
--- openlaszlo/branches/paperpie/docs/src/build.xml 2007-09-29 02:02:50 UTC
(rev 6688)
+++ openlaszlo/branches/paperpie/docs/src/build.xml 2007-09-29 02:05:43 UTC
(rev 6689)
@@ -208,7 +208,7 @@
<java classname="com.icl.saxon.StyleSheet"
fork="yes"
failonerror="yes"
- maxmemory="512m">
+ maxmemory="1024m">
<classpath refid="saxon.processor.classpath"/>
<jvmarg
value="-Djavax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl"/>
<jvmarg
value="-Djavax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl"/>
@@ -383,7 +383,7 @@
unless="lfc.js2doc.uptodate">
<mkdir dir="${js2doc.build.dir}" />
- <property name="js2doc.args" value="-v --dir ${js2doc.build.dir}
${lfc.src.dir}/LaszloLibrary.lzs" />
+ <property name="js2doc.args" value="--dir ${js2doc.build.dir}
${lfc.src.dir}/LaszloLibrary.lzs" />
<ant dir="${lps.server.dir}" target="js2doc" />
</target>
@@ -412,7 +412,7 @@
</target>
<target name="lfc.js2doc.clean" depends="init">
- <delete failonerror="false" file="${js2doc.build.dir}" />
+ <delete failonerror="false" dir="${js2doc.build.dir}" />
</target>
<target name="lzx2js2doc.transform" depends="init,docbook.catalog.generate">
Modified: openlaszlo/branches/paperpie/docs/src/xsl/common-html.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/common-html.xsl 2007-09-29
02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/src/xsl/common-html.xsl 2007-09-29
02:05:43 UTC (rev 6689)
@@ -38,7 +38,7 @@
<!-- class of html body element -->
<xsl:param name="html.body.class"/>
<!-- Show fixmes if true -->
- <xsl:param name="show.fixmes" select="0"/>
+ <xsl:param name="show.fixmes" select="1"/>
<xsl:param name="textdata.default.encoding"/>
Modified: openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl 2007-09-29
02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/src/xsl/js2doc2dbk.xsl 2007-09-29
02:05:43 UTC (rev 6689)
@@ -21,8 +21,8 @@
<!ENTITY privateslot '(@name="prototype" or @name="__ivars__" or
@name="dependencies" or @name="setters" or @name="tagname")'>
]>
-
-<xsl:stylesheet version="1.0"
+
+<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform";>
<xsl:import href="js2doc-comment2dbk.xsl"/>
@@ -78,7 +78,7 @@
</reference>
</xsl:if>
</xsl:template>
-
+
<xsl:template name="files-all">
<reference><title>Files</title>
<xsl:variable name="units" select="//unit"/>
@@ -100,7 +100,7 @@
<xsl:variable name="desc">
<xsl:apply-templates select="." mode="desc"/>
</xsl:variable>
-
+
<refentry id="[EMAIL PROTECTED]" xreflabel="{$desc}">
<xsl:if test="$lzxname"><anchor
id="{concat('tag.',$lzxname)}"/></xsl:if>
<refmeta>
@@ -120,19 +120,9 @@
</xsl:if>
</refnamediv>
<refsynopsisdiv>
- <xsl:call-template name="insert-refinfo"/>
+ <xsl:call-template name="insert-refinfo"/>
</refsynopsisdiv>
<xsl:call-template name="declaration-description"/>
- <xsl:if test="child::class">
- <refsect1><title>Superclass Chain</title>
- <xsl:call-template name="describe-superclass-chain">
- <xsl:with-param name="class" select="child::class"/>
- </xsl:call-template>
- </refsect1>
- <refsect1><title>Known Subclasses</title>
- <xsl:call-template name="describe-known-subclasses"/>
- </refsect1>
- </xsl:if>
<xsl:apply-templates select="." mode="refentry-details"/>
<xsl:apply-templates select="." mode="detailed-synopsis"/>
</refentry>
@@ -188,7 +178,7 @@
</refsect1>
</xsl:if>
<xsl:if test="doc/text">
- <refsect1><title>Description</title>
+ <refsect1>
<xsl:apply-templates select="doc/text" mode="doc2dbk"/>
</refsect1>
</xsl:if>
@@ -203,7 +193,7 @@
<xsl:template match="property" mode="refentry-details">
<refsect1>
- <title>Details</title>
+ <title>Details</title>
<xsl:variable name="jsname" select="@name"/>
<xsl:variable name="lzxname" select="&tagname;"/>
@@ -252,7 +242,7 @@
<!-- Properties -->
<xsl:call-template name="describe-members">
<xsl:with-param name="members" select="$ivars"/>
- <xsl:with-param name="title" select="'Properties'"/>
+ <xsl:with-param name="title" select="'Attributes'"/>
</xsl:call-template>
<!-- Setters -->
@@ -689,51 +679,23 @@
<xsl:template name="insert-refinfo">
<variablelist>
- <xsl:if test="&tagname;">
- <varlistentry><term>LZX: <xsl:value-of
select="&tagname;"/></term></varlistentry>
- </xsl:if>
-
<xsl:if test="@name">
<varlistentry><term>JavaScript: <xsl:value-of
select="@name"/></term></varlistentry>
</xsl:if>
- <xsl:variable name="decltype"><xsl:apply-templates select="."
mode="type"/></xsl:variable>
- <xsl:if test="$decltype and $decltype != ''">
- <varlistentry><term>Type: <xsl:value-of
select="$decltype"/></term></varlistentry>
- </xsl:if>
-
- <varlistentry><term>Access: <xsl:apply-templates select="."
mode="access"/></term></varlistentry>
-
- <xsl:if test="contains(@keywords, 'deprecated') or contains(@keywords,
'preliminary') or contains(@keywords, 'beta')">
- <varlistentry><term>
- <xsl:text>Status:</xsl:text>
- <xsl:if test="contains(@keywords,
'deprecated')"> Deprecated</xsl:if>
- <xsl:if test="contains(@keywords, 'preliminary') or
contains(@keywords, 'beta')"> Preliminary</xsl:if>
- </term></varlistentry>
- </xsl:if>
-
<xsl:if test="@runtimes">
<varlistentry><term>Runtimes: <xsl:value-of
select="@runtimes"/></term></varlistentry>
</xsl:if>
- <xsl:if test="@includebuilds">
- <varlistentry><term>Build Flags: <xsl:value-of
select="@includebuilds"/></term></varlistentry>
+ <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>
-
- <xsl:variable name="topic" select="@topic"/>
- <xsl:variable name="subtopic" select="@subtopic"/>
- <xsl:if test="$topic">
- <varlistentry><term>Topic: <xref
linkend="{translate(concat('topic.',$topic,'.',$subtopic),'
','_')}"/></term></varlistentry>
- </xsl:if>
-
- <xsl:variable name="parentid" select="@unitid"/>
- <xsl:if test="$parentid">
- <xsl:variable name="visibility"><xsl:value-of
select="key('id',$parentid)/@access"/></xsl:variable>
- <xsl:if test="contains($visibility.filter, $visibility)">
- <varlistentry><term>Declared in: <xref
linkend="{$parentid}"/></term></varlistentry>
- </xsl:if>
- </xsl:if>
-
+
<?ignore
<!-- need to turn path into webapp url, not sure how to do that -->
<xsl:variable name="path" select="@path"/>
@@ -749,10 +711,9 @@
<xsl:template name="classlabel">
<xsl:choose>
<xsl:when test="&tagname;">
+ <xsl:text><</xsl:text>
<xsl:value-of select="&tagname;"/>
- <xsl:if test="@name and not(starts-with(@name,'lz.'))">
- <xsl:text> (</xsl:text><xsl:value-of
select="@name"/><xsl:text>)</xsl:text>
- </xsl:if>
+ <xsl:text>></xsl:text>
</xsl:when>
<xsl:when test="@name">
<xsl:value-of select="@name"/>
Modified: openlaszlo/branches/paperpie/docs/src/xsl/parameters.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/parameters.xsl 2007-09-29
02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/src/xsl/parameters.xsl 2007-09-29
02:05:43 UTC (rev 6689)
@@ -50,6 +50,12 @@
<!-- Miscellaneous -->
<xsl:param name="show.comments">1</xsl:param>
+ <!-- Reference appearance -->
+ <xsl:param name="navig.showtitles">0</xsl:param>
+ <xsl:param name="suppress.header.navigation">1</xsl:param>
+ <xsl:param name="suppress.navigation">1</xsl:param>
+
+
<xsl:param name="generate.toc">
set toc,title,index
book toc,title,figure,table,example,equation,refentry
Modified: openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl
===================================================================
--- openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl 2007-09-29
02:02:50 UTC (rev 6688)
+++ openlaszlo/branches/paperpie/docs/src/xsl/refguide-html.xsl 2007-09-29
02:05:43 UTC (rev 6689)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2006 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2006-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";
@@ -13,11 +13,42 @@
<!-- change to 1 to turn off refentry metadata consistency checking.
This is supposed to speed up build considerably, but on my machine
- didn't make an appreciable difference. -->
+ didn't make an appreciable difference. -->
<xsl:param name="refentry.meta.get.quietly" select="0"/>
<xsl:param name="man.indent.refsect" select="1"/>
<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
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
