15 January 2002:

Update hamlib-doc.dsl stylesheet.  Update hamlib-doc.sgml for version 1.1.3
and 2002 copyright.  Cut out API content in reference.sgml as this is now
handled by the Doxygen package.

Added genindex.sgml for Index framework.

-- N0NB


git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@863 7ae35d74-ebe9-4afe-98af-79ac388436b8

doc/sgml/genindex.sgml

@@ -0,0 +1,5 @@
+<index>
+
+<!-- This file was produced by collateindex.pl.         -->
+<!-- Remove this comment if you edit this file by hand! -->
+</index>

doc/sgml/hamlib-doc.dsl

@@ -2,140 +2,144 @@
 <!ENTITY % html "IGNORE">
 <![%html;[
 <!ENTITY % print "IGNORE">
-<!ENTITY docbook.dsl SYSTEM "/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/html/docbook.dsl" CDATA dsssl>
+<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" CDATA dsssl>
 ]]>
 <!ENTITY % print "INCLUDE">
 <![%print;[
-<!ENTITY docbook.dsl SYSTEM "/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/print/docbook.dsl" CDATA dsssl>
+<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA dsssl>
 ]]>
 ]>
 
-<!-- Cygnus customizations by Mark Galassi -->
-<!-- Shamelessly appropriated for Hamlib-doc by Nate Bargmann
-     n0nb@arrl.net.  Original file is cygnus-both.dsl from the
-     Cygnus tools collection.  This seemed easier than writing
-     a new .dsl and coordinating with this file...
--->
-
-
 <style-sheet>
 
-
 <style-specification id="print" use="docbook">
 <style-specification-body> 
 
-;; ====================
+;; ==============================
 ;; customize the print stylesheet
-;; ====================
+;; ==============================
 
-;; make funcsynopsis look pretty
+(declare-characteristic preserve-sdata?
-(define %funcsynopsis-decoration%
+  ;; this is necessary because right now jadetex does not understand
-  ;; Decorate elements of a FuncSynopsis?
+  ;; symbolic entities, whereas things work well with numeric entities.
-  #t)
+  "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
-
-;; use graphics in admonitions, and have their path be "."
-;; NO: we are not yet ready to use gifs in TeX and so forth
-(define %admon-graphics-path%
-  "./")
-(define %admon-graphics%
   #f)
 
-;; this is necessary because right now jadetex does not understand
+;(define %generate-article-toc%
-;; symbolic entities, whereas things work well with numeric entities.
+;  ;; Should a Table of Contents be produced for Articles?
-(declare-characteristic preserve-sdata?
+;  #t)
-          "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
-          #f)
-(define %two-side% #t)
 
-(define %section-autolabel% 
+(define (toc-depth nd)
+  2)
+
+;(define %generate-article-titlepage-on-separate-page%
+;  ;; Should the article title page be on a separate page?
+;  #t)
+
+(define %section-autolabel%
   ;; Are sections enumerated?
   #t)
-;; (define %title-font-family% 
-;;   ;; The font family used in titles
-;;   "Ariel")
-(define %visual-acuity%
-  ;; General measure of document text size
-  ;; "presbyopic"
-  ;; "large-type"
-  "presbyopic")
 
-(define %generate-part-toc% #t)
+;(define %footnote-ulinks%
+;  ;; Generate footnotes for ULinks?
+;  #f)
 
-;; (define %block-start-indent% 10pt)
+;(define %bop-footnotes%
+;  ;; Make "bottom-of-page" footnotes?
+;  #f)
 
-(define %graphic-default-extension% "eps")
+(define %body-start-indent%
+  ;; Default indent of body text
+  0pi)
 
-;; added by Nate Bargmann to start RefEntry on a new page.
+(define %para-indent-firstpara%
-;; REFERENCE RefEntries and FuncSynopses
+  ;; First line start-indent for the first paragraph
+  12pt)
 
-(define %refentry-new-page% 
+(define %para-indent%
-  ;; REFENTRY refentry-new-page
+  ;; First line start-indent for paragraphs (other than the first)
-  ;; PURP 'RefEntry' starts on new page?
+  0pt)
-  ;; DESC
+
-  ;; If true, each 'RefEntry' begins on a new page.
+(define %block-start-indent%
-  ;; /DESC
+  ;; Extra start-indent for block-elements
-  ;; AUTHOR N/A
+  0pt)
-  ;; /REFENTRY
+
+(define formal-object-float
+  ;; Do formal objects float?
   #t)
 
-(element (varlistentry term)
+(define %hyphenation%
-  (make paragraph
+  ;; Allow automatic hyphenation?
-    space-before: (if (first-sibling?)
+  #t)
-		      %block-sep%
-                      0pt)
-    keep-with-next?: #t
-    first-line-start-indent: 4em
-    start-indent: 0pt
-    (process-children)))
 
+(define %admon-graphics%
+  ;; Use graphics in admonitions?
+  #t)
+
+(define %admon-graphics-path%
+  ;; Path to admonition grpahics
+  "./images/")
+
+(define admon-graphic-default-extension
+  ;; Admonition graphic file extension
+  ".pdf")
 
 </style-specification-body>
 </style-specification>
 
+
 <!--
-;; ====================
+;; ===================================================
-;; customize the html stylesheet
+;; customize the html stylesheet; borrowed from Cygnus
-;; ====================
+;; at http://sourceware.cygnus.com/ (cygnus-both.dsl)
+;; ===================================================
 -->
+
 <style-specification id="html" use="docbook">
 <style-specification-body> 
 
-;; this is necessary because right now jadetex does not understand
-;; symbolic entities, whereas things work well with numeric entities.
 (declare-characteristic preserve-sdata?
-          "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
+  ;; this is necessary because right now jadetex does not understand
-          #f)
+  ;; symbolic entities, whereas things work well with numeric entities.
+  "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
+  #f)
 
-;; put the legal notice in a separate file
 (define %generate-legalnotice-link%
+  ;; put the legal notice in a separate file
   #t)
 
-;; use graphics in admonitions, and have their path be "stylesheet-images"
-;; NO: they do not yet look very good
 (define %admon-graphics-path%
-  "./stylesheet-images/")
+  ;; use graphics in admonitions, set their
+  "../images/")
+
 (define %admon-graphics%
   #f)
 
-;; make funcsynopsis look pretty
 (define %funcsynopsis-decoration%
-  ;; Decorate elements of a FuncSynopsis?
+  ;; make funcsynopsis look pretty
   #t)
 
-(define %html-ext% ".html")
+(define %html-ext%
-(define %body-attr%
+  ".html")
-  ;; What attributes should be hung off of BODY?
-  '())
-;;  (list
-;;   (list "BGCOLOR" "#FFFFFF")
-;;   (list "TEXT" "#000000")))
 
 (define %generate-article-toc% 
   ;; Should a Table of Contents be produced for Articles?
   ;; If true, a Table of Contents will be generated for each 'Article'.
   #t)
 
-(define %generate-part-toc% #t)
+(define %generate-part-toc%
+  #t)
+
+(define %generate-article-titlepage%
+  #t)
+
+(define (chunk-skip-first-element-list)
+  ;; forces the Table of Contents on separate page
+  '())
+
+(define %root-filename%
+  ;; The filename of the root HTML document (e.g, "index").
+  "hamlib-doc")
 
 (define %shade-verbatim%
   #t)
@@ -144,8 +148,16 @@
   ;; Use ID attributes as name for component HTML files?
   #t)
 
-(define %graphic-default-extension% "png")
+(define %graphic-default-extension% 
+  "gif")
 
+(define %section-autolabel%
+  ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.)
+  #t)
+
+(define (toc-depth nd)
+  ;; more depth, 2 levels, to toc, instead of flat hierarchy
+  2)
 
 </style-specification-body>
 </style-specification>

doc/sgml/hamlib-doc.sgml

@@ -1,11 +1,12 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 <!ENTITY preface SYSTEM "preface.sgml">
 <!ENTITY intro SYSTEM "intro.sgml">
 <!ENTITY using SYSTEM "using.sgml">
 <!ENTITY reference SYSTEM "reference.sgml">
 <!ENTITY backend SYSTEM "backend.sgml">
 <!ENTITY internals SYSTEM "internals.sgml">
-<!ENTITY curver "1.1.0 (ALPHA)">
+<!ENTITY genindex SYSTEM "genindex.sgml">
+<!ENTITY curver "1.1.3">
 ]>
   <book>
     <bookinfo>
@@ -18,17 +19,18 @@
       <address>
 	<email>n0nb@networksplus.net</email>
       </address>
-      <pubdate>23 September 2001</pubdate>
+      <pubdate>15 January, 2002</pubdate>
       <copyright>
 	<year>2000</year>
 	<year>2001</year>
-	<holder>Frank Singleton, VK3FCS &amp; KM5WS; Stephane Fillod, F4CFE;
+	<year>2002</year>
+	<holder>Frank Singleton, VK3FCS &amp; KM5WS; Stephane Fillod, F8CFE;
 	Nate Bargmann, N0NB</holder>
       </copyright>
       <legalnotice id="legalnotice">
 	<title>Hamlib-doc - Ham Radio Control Libraries Documentation</title>
 
-	<para>Copyright (C) 2000-2001 Stephane Fillod, Frank Singleton, Nate 
+	<para>Copyright (C) 2000-2002 Stephane Fillod, Frank Singleton, Nate 
 	Bargmann.  This documentation file is part of the Hamlib 
 	package.</para>
 
@@ -55,17 +57,25 @@
 	device.</para>
       </abstract>
       <revhistory>
+	<revision>
+	  <revnumber>0.2.0</revnumber>
+	  <date>15 January 2002</date>
+	  <authorinitials>nfb</authorinitials>
+	  <revremark>Update draft for 1.1.3 and converted to Docbook Version 
+	  4.1 DTD.  Cut down reference.sgml as this is handled by 
+	  Doxygen. Added framework for Index.</revremark>
+	</revision>
 	<revision>
 	  <revnumber>0.1.1</revnumber>
 	  <date>23 September 2001</date>
 	  <authorinitials>nfb</authorinitials>
-	  <revremark>Final final draft for &curver;</revremark>
+	  <revremark>Final final draft for 1.1.0 (ALPHA)</revremark>
 	</revision>
 	<revision>
 	  <revnumber>0.1.0</revnumber>
 	  <date>24 February 2001</date>
 	  <authorinitials>nfb</authorinitials>
-	  <revremark>Final draft for &curver;</revremark>
+	  <revremark>Final draft for 1.1.0 (ALPHA)</revremark>
 	</revision>
 	<revision>
 	  <revnumber>0.0.1</revnumber>
@@ -83,5 +93,6 @@
     &reference;
 <!--    &backend; -->
 <!--    &internals; -->
+    &genindex;
   </book>