[graphic-forms-cvs] r341 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Wed Oct 18 06:54:47 UTC 2006
Author: junrue
Date: Wed Oct 18 02:54:47 2006
New Revision: 341
Added:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gfs-type-data.xml
trunk/docs/manual/win32-api-table.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-function-data.xml
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/graphic-forms.xsl
trunk/docs/manual/system-package.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Oct 18 02:54:47 2006
@@ -5,15 +5,24 @@
# Copyright (c) 2006, Jack D. Unrue
#
-docs: system-functions.xml
- xsltproc --nonet graphic-forms.xsl graphic-forms.xml
+COMMON-DEPS = gf-data.xsl clhs-table.xml win32-api-table.xml
+
+INTERIM-XML = system-types.xml system-functions.xml
+
+XSLT-PROC = xsltproc --nonet
+
+docs: system-types.xml system-functions.xml
+ $(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp
-system-functions.xml: gfs-function-data.xml gf-data.xsl
- xsltproc --nonet --output system-functions.xml gf-data.xsl gfs-function-data.xml
+system-types.xml: gfs-type-data.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfs-type-data.xml
+
+system-functions.xml: gfs-function-data.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfs-function-data.xml
clean:
- rm -f system-functions.xml
+ rm -f $(INTERIM-XML)
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
scrub: clean
Added: trunk/docs/manual/clhs-table.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/clhs-table.xml Wed Oct 18 02:54:47 2006
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+ clhs-table.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<clhs-table>
+ <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+ <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+</clhs-table>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 02:54:47 2006
@@ -11,21 +11,43 @@
<xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
- <xsl:template name="page-type">
- <xsl:param name="type-str"/>
+ <xsl:variable name="win32-table" select="document('win32-api-table.xml')"/>
+ <xsl:variable name="clhs-table" select="document('clhs-table.xml')"/>
+
+ <xsl:template name="create-id">
+ <xsl:value-of select="concat(../@name,':', at name)"/>
+ </xsl:template>
+
+ <xsl:template name="emit-table">
+ <xsl:param name="col2-width"/>
+
+ <xsl:element name="informaltable">
+ <xsl:attribute name="frame">none</xsl:attribute>
+ <xsl:element name="tgroup">
+ <xsl:attribute name="cols">2</xsl:attribute>
+ <xsl:element name="colspec">
+ <xsl:attribute name="colwidth">*</xsl:attribute>
+ </xsl:element>
+ <xsl:element name="colspec">
+ <xsl:attribute name="colwidth"><xsl:value-of select="$col2-width"/></xsl:attribute>
+ </xsl:element>
+ <xsl:element name="tbody">
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template name="emit-page-type">
+ <xsl:param name="page-type"/>
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- <xsl:value-of select="$type-str"/>
+ <xsl:value-of select="$page-type"/>
</xsl:element>
</xsl:template>
- <xsl:template name="syntax">
- <xsl:param name="package"/>
- <xsl:param name="name"/>
- <xsl:param name="arguments"/>
- <xsl:param name="return-type"/>
-
+ <xsl:template name="emit-syntax">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
syntax
@@ -33,20 +55,81 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- (<xsl:value-of select="$package"/>:<xsl:value-of select="$name"/>
+ (<xsl:call-template name="create-id"/>
<xsl:element name="emphasis">
- <xsl:value-of select="$arguments"/>
+ <xsl:for-each select="arguments/argument">
+ <xsl:value-of select="concat(' ', @name)"/>
+ </xsl:for-each>
</xsl:element>) =>
<xsl:element name="emphasis">
- <xsl:value-of select="$return-type"/>
+ <xsl:value-of select="return/@type"/>
</xsl:element>
</xsl:element>
</xsl:template>
+ <xsl:template name="emit-symbol-description">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ description
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="refargument">
+ <xsl:element name="emphasis">
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="reftopic">
+ <xsl:element name="link">
+ <xsl:attribute name="linkend"><xsl:value-of select="."/></xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="refclhs">
+ <xsl:variable name="tmp" select="string()"/>
+ <xsl:element name="ulink">
+ <xsl:attribute name="url">
+ <xsl:value-of select="$clhs-table//entry[string(@name)=$tmp]/@url"/>
+ </xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="refwin32api">
+ <xsl:variable name="tmp" select="string()"/>
+ <xsl:element name="ulink">
+ <xsl:attribute name="url">
+ <xsl:value-of select="$win32-table//entry[string(@name)=$tmp]/@url"/>
+ </xsl:attribute>
+ <xsl:value-of select="."/>()
+ </xsl:element>
+ </xsl:template>
+
<xsl:template match="argument">
<xsl:element name="row">
- <xsl:element name="entry"><xsl:value-of select="@name"/></xsl:element>
- <xsl:element name="entry"><xsl:value-of select="description"/></xsl:element>
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:element name="emphasis">
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:element>
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:apply-templates select="description"/>
+ </xsl:element>
+ </xsl:element>
</xsl:element>
</xsl:template>
@@ -55,18 +138,52 @@
<xsl:attribute name="renderas">sect2</xsl:attribute>
arguments
</xsl:element>
- <xsl:element name="informaltable">
- <xsl:attribute name="frame">none</xsl:attribute>
- <xsl:element name="tgroup">
- <xsl:attribute name="cols">2</xsl:attribute>
- <xsl:element name="tbody">
- <xsl:apply-templates/>
- </xsl:element>
- </xsl:element>
+ <xsl:call-template name="emit-table">
+ <xsl:with-param name="col2-width">5*</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="initargs">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ initargs
</xsl:element>
+ <xsl:call-template name="emit-table">
+ <xsl:with-param name="col2-width">5*</xsl:with-param>
+ </xsl:call-template>
</xsl:template>
- <xsl:template match="slot-accessor/description">
+ <xsl:template match="inherits">
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ inherits:<xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="inheritedby">
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ inherited by:<xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="*/seealso">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ see also
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+
+ <xsl:for-each select="*">
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="class/description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
description
@@ -74,33 +191,73 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- <xsl:value-of select="."/>
+ <xsl:apply-templates/>
</xsl:element>
</xsl:template>
- <xsl:template match="slot-accessor">
+ <xsl:template match="slot-accessor/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
+ <xsl:template match="slot-reader/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
+ <xsl:template name="emit-type-section">
+ <xsl:param name="page-type"/>
+
<xsl:element name="section">
+ <xsl:attribute name="id"><xsl:call-template name="create-id"/></xsl:attribute>
+
<xsl:element name="title">
- <xsl:value-of select="@package"/>:<xsl:value-of select="@name"/>
+ <xsl:call-template name="create-id"/>
</xsl:element>
- <xsl:call-template name="page-type">
- <xsl:with-param name="type-str">[Slot Accessor]</xsl:with-param>
+ <xsl:call-template name="emit-page-type">
+ <xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
</xsl:call-template>
- <xsl:call-template name="syntax">
- <xsl:with-param name="package"><xsl:value-of select="@package"/></xsl:with-param>
- <xsl:with-param name="name"><xsl:value-of select="@name"/></xsl:with-param>
- <xsl:with-param name="arguments">
- <xsl:for-each select="arguments/argument">
- <xsl:element name="foo"><xsl:value-of select="concat(' ', @name)"/></xsl:element>
- </xsl:for-each>
- </xsl:with-param>
- <xsl:with-param name="return-type"><xsl:value-of select="return/@type"/></xsl:with-param>
+ <xsl:apply-templates/>
+ </xsl:element>
+
+ </xsl:template>
+
+ <xsl:template name="emit-function-section">
+ <xsl:param name="page-type"/>
+
+ <xsl:element name="section">
+ <xsl:attribute name="id"><xsl:call-template name="create-id"/></xsl:attribute>
+
+ <xsl:element name="title">
+ <xsl:call-template name="create-id"/>
+ </xsl:element>
+
+ <xsl:call-template name="emit-page-type">
+ <xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
</xsl:call-template>
+ <xsl:call-template name="emit-syntax"/>
+
<xsl:apply-templates/>
</xsl:element>
</xsl:template>
+ <xsl:template match="/package/class">
+ <xsl:call-template name="emit-type-section">
+ <xsl:with-param name="page-type">Class</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="/package/slot-accessor">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Slot Accessor</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="/package/slot-reader">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Slot Reader</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
</xsl:stylesheet>
Modified: trunk/docs/manual/gfs-function-data.xml
==============================================================================
--- trunk/docs/manual/gfs-function-data.xml (original)
+++ trunk/docs/manual/gfs-function-data.xml Wed Oct 18 02:54:47 2006
@@ -5,17 +5,23 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<slot-accessor package="gfs" name="code">
- <arguments>
- <argument name="condition" type="cl:condition">
- <description>
- The condition object to be queried; must be of type
- win32-error or win32-warning or subclasses thereof.
- </description>
- </argument>
- </arguments>
- <return type="integer"/>
- <description>
- Returns the Win32 error code for the specified condition.
- </description>
-</slot-accessor>
+<package name="gfs">
+
+ <slot-reader name="code">
+ <arguments>
+ <argument name="condition" type="cl:condition">
+ <description>
+ The <reftopic>win32-error</reftopic> or <reftopic>win32-warning</reftopic>
+ object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return type="integer"/>
+ <description>
+ Returns the Win32 error code for <refargument>condition</refargument>
+ as determined by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </slot-reader>
+
+</package>
+
Added: trunk/docs/manual/gfs-type-data.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfs-type-data.xml Wed Oct 18 02:54:47 2006
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+ gfs-type-data.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfs">
+
+ <class name="toolkit-error">
+ <description>
+ <inherits>
+ <refclhs>error</refclhs>
+ </inherits>
+ <inheritedby>
+ <reftopic>win32-error</reftopic>
+ </inheritedby>
+ This error is raised to indicate invalid argument values or inconsistent
+ state.
+ </description>
+ <initargs>
+ <argument name=":detail">
+ <description>
+ A <refclhs>string</refclhs> supplying additional problem information.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>detail</reftopic>
+ <reftopic>toolkit-warning</reftopic>
+ <reftopic>win32-warning</reftopic>
+ </seealso>
+ </class>
+
+</package>
+
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Wed Oct 18 02:54:47 2006
@@ -10,6 +10,7 @@
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
<!ENTITY gfspkg SYSTEM "system-package.xml">
+ <!ENTITY gfstypes SYSTEM "system-types.xml"> <!-- generated file -->
<!ENTITY gfsfuncs SYSTEM "system-functions.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
Modified: trunk/docs/manual/graphic-forms.xsl
==============================================================================
--- trunk/docs/manual/graphic-forms.xsl (original)
+++ trunk/docs/manual/graphic-forms.xsl Wed Oct 18 02:54:47 2006
@@ -22,6 +22,12 @@
<xsl:param name="htmlhelp.hhc.folders.instead.books" select="0"/>
<xsl:param name="htmlhelp.show.advanced.search" select="1"/>
<xsl:param name="suppress.navigation" select="1"/>
+<!--
+ xsltproc doesn't implement the adjustColumnWidths function
+
+ <xsl:param name="use.extensions" select="1"/>
+ <xsl:param name="tablecolumn.extensions" select="1"/>
+-->
<xsl:template name="user.footer.content">
<div class="footer">
Copyright © 2006, Jack D. Unrue
Modified: trunk/docs/manual/system-package.xml
==============================================================================
--- trunk/docs/manual/system-package.xml (original)
+++ trunk/docs/manual/system-package.xml Wed Oct 18 02:54:47 2006
@@ -38,6 +38,7 @@
win32-warning
</para>
+ &gfstypes;
&gfsfuncs;
</chapter>
Added: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/win32-api-table.xml Wed Oct 18 02:54:47 2006
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+ win32-api-table.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<win32-api-table>
+ <entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/getlasterror.asp"/>
+</win32-api-table>
More information about the Graphic-forms-cvs
mailing list