Author: junrue
Date: Wed Oct 18 16:37:02 2006
New Revision: 347
Modified:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-symbols.xml
trunk/docs/manual/glossary.xml
trunk/docs/manual/introduction.xml
trunk/docs/website/index.html
Log:
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 16:37:02 2006
@@ -58,26 +58,6 @@
</xsl:element>
</xsl:template>
- <xsl:template name="emit-syntax">
- <xsl:element name="bridgehead">
- <xsl:attribute name="renderas">sect2</xsl:attribute>
- syntax
- </xsl:element>
-
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- (<xsl:call-template name="create-id"/>
- <xsl:element name="emphasis">
- <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:element>
- </xsl:element>
- </xsl:template>
-
<xsl:template name="emit-symbol-description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
@@ -90,19 +70,11 @@
</xsl:element>
</xsl:template>
- <xsl:template name="emit-ref-target">
- <xsl:param name="role">normal</xsl:param>
- <xsl:choose>
- <xsl:when test="$role='small'">
- <xsl:element name="para">
- <xsl:attribute name="role"><xsl:value-of select="$role"/></xsl:attribute>
- <xsl:value-of select="."/>
- </xsl:element>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="."/>
- </xsl:otherwise>
- </xsl:choose>
+ <xsl:template match="para">
+ <xsl:copy>
+ <xsl:copy-of select="@*"/>
+ <xsl:apply-templates/>
+ </xsl:copy>
</xsl:template>
<xsl:template match="refargument">
@@ -112,38 +84,56 @@
</xsl:template>
<xsl:template match="reftopic">
- <xsl:param name="role">normal</xsl:param>
<xsl:element name="link">
<xsl:attribute name="linkend"><xsl:value-of select="."/></xsl:attribute>
- <xsl:call-template name="emit-ref-target">
- <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
- </xsl:call-template>
+ <xsl:choose>
+ <xsl:when test="@label">
+ <xsl:value-of select="@label"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="."/>
+ </xsl:otherwise>
+ </xsl:choose>
</xsl:element>
</xsl:template>
<xsl:template match="refclhs">
- <xsl:param name="role">normal</xsl:param>
<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:call-template name="emit-ref-target">
- <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
- </xsl:call-template>
+ <xsl:value-of select="."/>
</xsl:element>
</xsl:template>
<xsl:template match="refwin32api">
- <xsl:param name="role">normal</xsl:param>
<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:call-template name="emit-ref-target">
- <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
- </xsl:call-template>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="syntax">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ syntax
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ (<xsl:call-template name="create-id"/>
+ <xsl:element name="emphasis">
+ <xsl:for-each select="arguments/argument">
+ <xsl:value-of select="concat(' ', @name)"/>
+ </xsl:for-each>
+ </xsl:element>) =>
+ <xsl:element name="emphasis">
+ <xsl:apply-templates select="return"/>
+ </xsl:element>
</xsl:element>
</xsl:template>
@@ -200,15 +190,17 @@
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
<xsl:element name="para">
- <xsl:attribute name="role">small</xsl:attribute>
+ <xsl:attribute name="role">normal</xsl:attribute>
inherits:
</xsl:element>
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
- <xsl:apply-templates>
- <xsl:with-param name="role">small</xsl:with-param>
- </xsl:apply-templates>
+ <xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</xsl:element>
</xsl:element>
</xsl:template>
@@ -218,15 +210,17 @@
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
<xsl:element name="para">
- <xsl:attribute name="role">small</xsl:attribute>
+ <xsl:attribute name="role">normal</xsl:attribute>
inherited by:
</xsl:element>
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
- <xsl:apply-templates>
- <xsl:with-param name="role">small</xsl:with-param>
- </xsl:apply-templates>
+ <xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</xsl:element>
</xsl:element>
</xsl:template>
@@ -247,12 +241,25 @@
<xsl:attribute name="role">normal</xsl:attribute>
<xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
<xsl:apply-templates select="."/>
<xsl:if test="not(position()=last())">, </xsl:if>
</xsl:for-each>
</xsl:element>
</xsl:template>
+ <xsl:template match="structure/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="class/description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
@@ -318,8 +325,6 @@
<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>
@@ -330,6 +335,12 @@
</xsl:call-template>
</xsl:template>
+ <xsl:template match="structure">
+ <xsl:call-template name="emit-type-section">
+ <xsl:with-param name="page-type">Structure</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="condition">
<xsl:call-template name="emit-type-section">
<xsl:with-param name="page-type">Condition</xsl:with-param>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 16:37:02 2006
@@ -7,6 +7,8 @@
<package name="gfs">
+ <!-- CONDITIONS -->
+
<condition name="toolkit-error">
<description>
<hierarchy>
@@ -159,20 +161,217 @@
</seealso>
</condition>
- <slot-reader name="code">
- <arguments>
- <argument name="condition">
+ <!-- CLASSES -->
+
+ <class name="native-object">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:display</reftopic>
+ <reftopic>gfg:image-data-plugin</reftopic>
+ <reftopic>gfg:image</reftopic>
+ <reftopic>gfg:icon-bundle</reftopic>
+ <reftopic>gfg:graphics-context</reftopic>
+ <reftopic>gfg:font</reftopic>
+ <reftopic>gfw:event-source</reftopic>
+ </inheritedby>
+ </hierarchy>
+ <para role="normal">
+ This is the abstract base class for objects representing a system resource
+ such as a window or device context.
+ </para>
+
+ <para role="normal">
+ Graphic-Forms does not register any finalizer for coordination with the
+ garbage collector, since the destruction of these system resources has
+ important application semantics which cannot be postponed. Also, there
+ are often related system resources (especially other native handles) that
+ occupy scarce heap space within system components, so these must be cleaned
+ up promptly as well.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":handle">
+ <description>
+ A Win32 HANDLE or foreign pointer.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfs:handle</reftopic>
+ <reftopic>gfs:disposed-error</reftopic>
+ <reftopic>gfs:disposed-p</reftopic>
+ </seealso>
+ </class>
+
+ <!-- STRUCTURES -->
+
+ <structure name="point">
+ <description>
+ This structure represents a point in the Cartesian plane.
+ </description>
+ <initargs>
+ <argument name=":x">
+ <description>
+ An <refclhs>integer</refclhs> specifying the point's X coordinate.
+ </description>
+ </argument>
+ <argument name=":y">
+ <description>
+ An <refclhs>integer</refclhs> specifying the point's Y coordinate.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:copy-point</reftopic>
+ <reftopic>gfs:make-point</reftopic>
+ <reftopic>gfs:point-x</reftopic>
+ <reftopic>gfs:point-y</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="rectangle">
+ <description>
+ This structure represents a rectangle in the Cartesian plane.
+ </description>
+ <initargs>
+ <argument name=":location">
+ <description>
+ A <reftopic>gfs:point</reftopic> specifying the rectangle's upper-left
+ corner.
+ </description>
+ </argument>
+ <argument name=":size">
+ <description>
+ A <reftopic>gfs:size</reftopic> specifying the rectangle's dimensions.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:copy-rectangle</reftopic>
+ <reftopic>gfs:location</reftopic>
+ <reftopic>gfs:make-rectangle</reftopic>
+ <reftopic>gfs:size</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="size">
+ <description>
+ This structure represents a 2-dimensional area.
+ </description>
+ <initargs>
+ <argument name=":height">
<description>
- The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
- object to be queried.
+ An <refclhs>integer</refclhs> specifying the height of the area.
</description>
</argument>
- </arguments>
- <return type="integer"/>
+ <argument name=":width">
+ <description>
+ An <refclhs>integer</refclhs> specifying the width of the area.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:copy-size</reftopic>
+ <reftopic>gfs:equal-size-p</reftopic>
+ <reftopic>gfs:make-size</reftopic>
+ <reftopic>gfs:size-height</reftopic>
+ <reftopic>gfs:size-width</reftopic>
+ <reftopic>gfs:rectangle</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="span">
+ <description>
+ This structure represents a contiguous range of <refclhs>integer</refclhs>
+ values.
+ </description>
+ <initargs>
+ <argument name=":start">
+ <description>
+ An <refclhs>integer</refclhs> specifying the starting value.
+ </description>
+ </argument>
+ <argument name=":end">
+ <description>
+ An <refclhs>integer</refclhs> specifying the ending value.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:copy-span</reftopic>
+ <reftopic>gfs:empty-span-p</reftopic>
+ <reftopic>gfs:make-span</reftopic>
+ <reftopic>gfs:span-start</reftopic>
+ <reftopic>gfs:span-end</reftopic>
+ </seealso>
+ </structure>
+
+ <!-- FUNCTIONS -->
+
+ <slot-reader name="code">
+ <syntax>
+ <arguments>
+ <argument name="condition">
+ <description>
+ The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
+ object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
<description>
Returns the Win32 error code for <refargument>condition</refargument>
as determined by <refwin32api>GetLastError</refwin32api>.
</description>
</slot-reader>
+ <slot-reader name="copy-point">
+ <syntax>
+ <arguments>
+ <argument name="point">
+ <description>
+ The <reftopic>gfs:point</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new point">gfs:point</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates
+ were copied from the original.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-point</reftopic>
+ </seealso>
+ </slot-reader>
+
+ <slot-reader name="copy-rectangle">
+ <syntax>
+ <arguments>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new rectangle">gfs:rectangle</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:rectangle</reftopic> whose location and
+ dimension values were (shallow) copied from the original.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-rectangle</reftopic>
+ </seealso>
+ </slot-reader>
+
</package>
Modified: trunk/docs/manual/glossary.xml
==============================================================================
--- trunk/docs/manual/glossary.xml (original)
+++ trunk/docs/manual/glossary.xml Wed Oct 18 16:37:02 2006
@@ -3,9 +3,10 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<glossary><title>Glossary</title>
+<glossary id="glossary"><title>Glossary</title>
+<indexterm><primary>Glossary</primary></indexterm>
-<glossdiv><title>A</title>
+<glossdiv id="glossary-A"><title>A</title>
<glossentry id="accelerator"><glossterm>accelerator</glossterm>
<glossdef>
@@ -35,10 +36,10 @@
</glossdiv>
-<glossdiv><title>B</title>
+<glossdiv id="glossary-B"><title>B</title>
</glossdiv>
-<glossdiv><title>C</title>
+<glossdiv id="glossary-C"><title>C</title>
<glossentry id="control"><glossterm>control</glossterm>
<glossdef>
@@ -52,7 +53,7 @@
</glossdiv>
-<glossdiv><title>D</title>
+<glossdiv id="glossary-D"><title>D</title>
<glossentry id="default action"><glossterm>default action</glossterm>
<glossdef>
@@ -81,7 +82,7 @@
</glossdiv>
-<glossdiv><title>E</title>
+<glossdiv id="glossary-E"><title>E</title>
<glossentry id="extension"><glossterm>extension</glossterm>
<glossdef>
@@ -98,28 +99,28 @@
</glossdiv>
-<glossdiv><title>F</title>
+<glossdiv id="glossary-F"><title>F</title>
</glossdiv>
-<glossdiv><title>G</title>
+<glossdiv id="glossary-G"><title>G</title>
</glossdiv>
-<glossdiv><title>H</title>
+<glossdiv id="glossary-H"><title>H</title>
</glossdiv>
-<glossdiv><title>I</title>
+<glossdiv id="glossary-I"><title>I</title>
</glossdiv>
-<glossdiv><title>J</title>
+<glossdiv id="glossary-J"><title>J</title>
</glossdiv>
-<glossdiv><title>K</title>
+<glossdiv id="glossary-K"><title>K</title>
</glossdiv>
-<glossdiv><title>L</title>
+<glossdiv id="glossary-L"><title>L</title>
</glossdiv>
-<glossdiv><title>M</title>
+<glossdiv id="glossary-M"><title>M</title>
<glossentry id="menu"><glossterm>menu</glossterm>
<glossdef>
@@ -132,7 +133,7 @@
</glossdef>
</glossentry>
- <glossentry id="mix-in class"><glossterm>mix-in class</glossterm>
+ <glossentry id="mix-in"><glossterm>mix-in class</glossterm>
<glossdef>
<para>
A mix-in class represents a specific abstraction that complements
@@ -155,13 +156,13 @@
</glossentry>
</glossdiv>
-<glossdiv><title>N</title>
+<glossdiv id="glossary-N"><title>N</title>
</glossdiv>
-<glossdiv><title>O</title>
+<glossdiv id="glossary-O"><title>O</title>
</glossdiv>
-<glossdiv><title>P</title>
+<glossdiv id="glossary-P"><title>P</title>
<glossentry id="plugin"><glossterm>plugin</glossterm>
<glossdef>
@@ -177,34 +178,34 @@
</glossdiv>
-<glossdiv><title>Q</title>
+<glossdiv id="glossary-Q"><title>Q</title>
</glossdiv>
-<glossdiv><title>R</title>
+<glossdiv id="glossary-R"><title>R</title>
</glossdiv>
-<glossdiv><title>S</title>
+<glossdiv id="glossary-S"><title>S</title>
</glossdiv>
-<glossdiv><title>T</title>
+<glossdiv id="glossary-T"><title>T</title>
</glossdiv>
-<glossdiv><title>U</title>
+<glossdiv id="glossary-U"><title>U</title>
</glossdiv>
-<glossdiv><title>V</title>
+<glossdiv id="glossary-V"><title>V</title>
</glossdiv>
-<glossdiv><title>W</title>
+<glossdiv id="glossary-W"><title>W</title>
</glossdiv>
-<glossdiv><title>X</title>
+<glossdiv id="glossary-X"><title>X</title>
</glossdiv>
-<glossdiv><title>Y</title>
+<glossdiv id="glossary-Y"><title>Y</title>
</glossdiv>
-<glossdiv><title>Z</title>
+<glossdiv id="glossary-Z"><title>Z</title>
</glossdiv>
</glossary>
Modified: trunk/docs/manual/introduction.xml
==============================================================================
--- trunk/docs/manual/introduction.xml (original)
+++ trunk/docs/manual/introduction.xml Wed Oct 18 16:37:02 2006
@@ -5,10 +5,10 @@
-->
<chapter>
<title>Introduction</title>
+ <indexterm><primary>Introduction</primary></indexterm>
<bridgehead renderas="sect2">Background</bridgehead>
<para role="normal">
- <indexterm><primary>Introduction</primary></indexterm>
Graphic-Forms is a user interface library implemented in Common Lisp
focusing on the Windows platform. Graphic-Forms is licensed under the
terms of the BSD License. The goal is to provide a Common Lisp-based
Modified: trunk/docs/website/index.html
==============================================================================
--- trunk/docs/website/index.html (original)
+++ trunk/docs/website/index.html Wed Oct 18 16:37:02 2006
@@ -10,7 +10,7 @@
<body>
<div class="header">
<h1>Graphic-Forms</h1>
- <h2>A user interface toolkit for the Windows platform.</h2>
+ <h2>A user interface toolkit for Windows.</h2>
</div>
<div class="NavBar">
