[graphic-forms-cvs] r352 - trunk/docs/manual - graphic-forms-cvs@common-lisp.net - mailman3.common-lisp.net

19 Oct 2006

Author: junrue
Date: Wed Oct 18 23:20:23 2006
New Revision: 352
Added:
   trunk/docs/manual/gfg-symbols.xml
   trunk/docs/manual/gfw-symbols.xml
Modified:
   trunk/docs/manual/Makefile
   trunk/docs/manual/api.xml
   trunk/docs/manual/gf-package.xsl
   trunk/docs/manual/gfs-symbols.xml
   trunk/docs/manual/graphic-forms.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================

--- trunk/docs/manual/Makefile	(original)
+++ trunk/docs/manual/Makefile	Wed Oct 18 23:20:23 2006
@@ -7,20 +7,33 @@
COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml
-TMP-XML     = gfs-tmp-pkg.xml gfs-tmp-syms.xml
+TMP-XML     = gfs-tmp-pkg.xml gfs-tmp-syms.xml gfg-tmp-pkg.xml gfg-tmp-syms.xml \
+              gfw-tmp-pkg.xml gfw-tmp-syms.xml
XSLT-PROC   = xsltproc --nonet
-graphic-forms.chm: gfs-tmp-pkg.xml
+graphic-forms.chm: gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml
    $(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
    -hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1
-gfs-tmp-pkg.xml: gfs-tmp-syms.xml $(COMMON-DEPS)
-	$(XSLT-PROC) --output $@ gf-package.xsl gfs-symbols.xml
-
 gfs-tmp-syms.xml: gfs-symbols.xml $(COMMON-DEPS)
    $(XSLT-PROC) --output $@ gf-data.xsl gfs-symbols.xml
+gfs-tmp-pkg.xml: gfs-tmp-syms.xml gfs-symbols.xml $(COMMON-DEPS)
+	$(XSLT-PROC) --stringparam symbol-file gfs-tmp-syms.xml --output $@ gf-package.xsl gfs-symbols.xml
+
+gfg-tmp-syms.xml: gfg-symbols.xml $(COMMON-DEPS)
+	$(XSLT-PROC) --output $@ gf-data.xsl gfg-symbols.xml
+
+gfg-tmp-pkg.xml: gfg-tmp-syms.xml gfg-symbols.xml $(COMMON-DEPS)
+	$(XSLT-PROC) --stringparam symbol-file gfg-tmp-syms.xml --output $@ gf-package.xsl gfg-symbols.xml
+
+gfw-tmp-syms.xml: gfw-symbols.xml $(COMMON-DEPS)
+	$(XSLT-PROC) --output $@ gf-data.xsl gfw-symbols.xml
+
+gfw-tmp-pkg.xml: gfw-tmp-syms.xml gfw-symbols.xml $(COMMON-DEPS)
+	$(XSLT-PROC) --stringparam symbol-file gfw-tmp-syms.xml --output $@ gf-package.xsl gfw-symbols.xml
+
 clean:
    rm -f $(TMP-XML)
    find . ( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" ) -exec rm {} ;
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml	(original)
+++ trunk/docs/manual/api.xml	Wed Oct 18 23:20:23 2006
@@ -10,6 +10,8 @@
     This chapter documents the Graphic-Forms programming interface.
   </para>
+  &gfgpkg;
   &gfspkg;
+  &gfwpkg;
</chapter>
Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl	(original)
+++ trunk/docs/manual/gf-package.xsl	Wed Oct 18 23:20:23 2006
@@ -11,14 +11,34 @@
<xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
+  <xsl:param name="symbol-file"/>
+
+  <xsl:template name="upcase">
+    <xsl:param name="orig-text"/>
+    <xsl:value-of select="translate($orig-text,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/>
+  </xsl:template>
+
   <xsl:template match="/package">
+
     <chapter>
       <title><xsl:value-of select="@fullname"/></title>
+      <indexterm>
+        <primary>
+          <xsl:call-template name="upcase">
+            <xsl:with-param name="orig-text"><xsl:value-of select="@name"/></xsl:with-param>
+          </xsl:call-template>
+        </primary>
+      </indexterm>
+      <indexterm><primary><xsl:value-of select="@fullname"/></primary></indexterm>
<para role="normal">[Package]</para>
<bridgehead renderas="sect2">nickname</bridgehead>
-      <para role="normal"><xsl:value-of select="translate(@name,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/></para>
+      <para role="normal">
+        <xsl:call-template name="upcase">
+          <xsl:with-param name="orig-text"><xsl:value-of select="@name"/></xsl:with-param>
+        </xsl:call-template>
+      </para>
<xsl:for-each select="description">
         <xsl:element name="bridgehead">
@@ -68,7 +88,7 @@
         </xsl:for-each>
       </para>
-      <xsl:for-each select="document('gfs-tmp-syms.xml')/data/section">
+      <xsl:for-each select="document($symbol-file)/data/section">
         <xsl:copy-of select="current()"/>
       </xsl:for-each>
Added: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfg-symbols.xml	Wed Oct 18 23:20:23 2006
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!--
+    gfg-symbols.xml
+
+    Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfg" fullname="graphic-forms.uitoolkit.graphics">
+
+  <description>
+    This package exports the symbols corresponding to graphics meta-data
+    and drawing operations. This package and GFW together comprise the bulk
+    of the public API.
+  </description>
+
+  <!-- CONDITIONS -->
+
+  <!-- CLASSES -->
+
+  <!-- STRUCTURES -->
+
+  <!-- FUNCTIONS -->
+
+  <!-- GENERIC FUNCTIONS -->
+
+  <!-- ACCESSORS -->
+
+</package>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml	(original)
+++ trunk/docs/manual/gfs-symbols.xml	Wed Oct 18 23:20:23 2006
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
-    gfs-package-data.xml
+    gfs-symbols.xml
Copyright (c) 2006, Jack D. Unrue
 -->
Added: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfw-symbols.xml	Wed Oct 18 23:20:23 2006
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!--
+    gfg-symbols.xml
+
+    Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfw" fullname="graphic-forms.uitoolkit.widgets">
+
+  <description>
+    This package contains symbols for user interface widget classes,
+    event-handling methods, and management functions. This package and
+    GFG together constitute the bulk of the public API.
+  </description>
+
+  <!-- CONDITIONS -->
+
+  <!-- CLASSES -->
+
+  <!-- STRUCTURES -->
+
+  <!-- FUNCTIONS -->
+
+  <!-- GENERIC FUNCTIONS -->
+
+  <!-- ACCESSORS -->
+
+</package>
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml	(original)
+++ trunk/docs/manual/graphic-forms.xml	Wed Oct 18 23:20:23 2006
@@ -9,7 +9,9 @@
   <!ENTITY legal         SYSTEM "legal.xml">
   <!ENTITY introduction  SYSTEM "introduction.xml">
   <!ENTITY api           SYSTEM "api.xml">
+  <!ENTITY gfgpkg        SYSTEM "gfg-tmp-pkg.xml">      <!-- generated file -->
   <!ENTITY gfspkg        SYSTEM "gfs-tmp-pkg.xml">      <!-- generated file -->
+  <!ENTITY gfwpkg        SYSTEM "gfw-tmp-pkg.xml">      <!-- generated file -->
   <!ENTITY misctopics    SYSTEM "miscellaneous-topics.xml">
   <!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
   <!ENTITY glossary      SYSTEM "glossary.xml">

    