[graphic-forms-cvs] r340 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Wed Oct 18 03:24:18 UTC 2006
Author: junrue
Date: Tue Oct 17 23:24:17 2006
New Revision: 340
Added:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-function-data.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/api.xml
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/graphic-forms.xsl
trunk/docs/manual/system-package.xml
Log:
initial steps at generating DocBook content
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Tue Oct 17 23:24:17 2006
@@ -5,11 +5,15 @@
# Copyright (c) 2006, Jack D. Unrue
#
-docs:
+docs: system-functions.xml
xsltproc --nonet 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
+
clean:
+ rm -f system-functions.xml
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
scrub: clean
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml (original)
+++ trunk/docs/manual/api.xml Tue Oct 17 23:24:17 2006
@@ -10,6 +10,6 @@
This chapter documents the Graphic-Forms programming interface.
</para>
- &systempkg;
+ &gfspkg;
</chapter>
Added: trunk/docs/manual/gf-data.xsl
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gf-data.xsl Tue Oct 17 23:24:17 2006
@@ -0,0 +1,106 @@
+<?xml version="1.0"?>
+<!--
+ gf-data.xsl
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+<xsl:stylesheet
+ xmlns:exsl="http://exslt.org/common"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version="1.0">
+
+ <xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
+
+ <xsl:template name="page-type">
+ <xsl:param name="type-str"/>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:value-of select="$type-str"/>
+ </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: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:value-of select="$package"/>:<xsl:value-of select="$name"/>
+ <xsl:element name="emphasis">
+ <xsl:value-of select="$arguments"/>
+ </xsl:element>) =>
+ <xsl:element name="emphasis">
+ <xsl:value-of select="$return-type"/>
+ </xsl:element>
+ </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>
+ </xsl:template>
+
+ <xsl:template match="arguments">
+ <xsl:element name="bridgehead">
+ <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:element>
+ </xsl:template>
+
+ <xsl:template match="slot-accessor/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:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="slot-accessor">
+ <xsl:element name="section">
+ <xsl:element name="title">
+ <xsl:value-of select="@package"/>:<xsl:value-of select="@name"/>
+ </xsl:element>
+
+ <xsl:call-template name="page-type">
+ <xsl:with-param name="type-str">[Slot Accessor]</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:call-template>
+
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+</xsl:stylesheet>
Added: trunk/docs/manual/gfs-function-data.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfs-function-data.xml Tue Oct 17 23:24:17 2006
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!--
+ gfs-function-data.xml
+
+ 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>
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Tue Oct 17 23:24:17 2006
@@ -9,7 +9,8 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
- <!ENTITY systempkg SYSTEM "system-package.xml">
+ <!ENTITY gfspkg SYSTEM "system-package.xml">
+ <!ENTITY gfsfuncs SYSTEM "system-functions.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
Modified: trunk/docs/manual/graphic-forms.xsl
==============================================================================
--- trunk/docs/manual/graphic-forms.xsl (original)
+++ trunk/docs/manual/graphic-forms.xsl Tue Oct 17 23:24:17 2006
@@ -5,6 +5,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
<xsl:import href="htmlhelp.xsl"/>
<xsl:param name="chapter.autolabel" select="0"/>
<xsl:param name="chunk.first.sections" select="1"/>
@@ -26,4 +27,5 @@
Copyright © 2006, Jack D. Unrue
</div>
</xsl:template>
+
</xsl:stylesheet>
Modified: trunk/docs/manual/system-package.xml
==============================================================================
--- trunk/docs/manual/system-package.xml (original)
+++ trunk/docs/manual/system-package.xml Tue Oct 17 23:24:17 2006
@@ -1,12 +1,12 @@
<!--
- system-pkg.xml
+ system-package.xml
Copyright (c) 2006, Jack D. Unrue
-->
<chapter>
<title>graphic-forms.uitoolkit.system</title>
- <para role="normal">[package]</para>
+ <para role="normal">[Package]</para>
<bridgehead renderas="sect2">nickname</bridgehead>
<para role="normal">GFS</para>
@@ -38,4 +38,6 @@
win32-warning
</para>
+ &gfsfuncs;
+
</chapter>
More information about the Graphic-forms-cvs
mailing list