From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Tue, 23 Nov 2004 04:52:09 +0000 (+0000)
Subject: Ref. doc change; Filled in a couple of FIXMEs
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a46aacd4e294311bab8d83fbbeee954925cd0816;p=docbook-dsssl

Ref. doc change; Filled in a couple of FIXMEs
---

diff --git a/xsl/params/process.empty.source.toc.xml b/xsl/params/process.empty.source.toc.xml
index 917145a98..933d14560 100644
--- a/xsl/params/process.empty.source.toc.xml
+++ b/xsl/params/process.empty.source.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>process.empty.source.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Generate automated TOC if <sgmltag>toc</sgmltag> element occurs in a source document?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,7 +14,19 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
+<para>Specifies that if an empty <sgmltag>toc</sgmltag> element is
+found in a source document, an automated TOC is generated.
+<note>
+  <para>Depending on what the value of the
+  <parameter>generate.toc</parameter> parameter is, setting this
+  parameter to <literal>1</literal> could result in generation of
+  duplicate automated TOCs. So the
+  <parameter>process.empty.source.toc</parameter> is primarily useful
+  as an "override": by placing an empty <sgmltag>toc</sgmltag> in your
+  document and setting this parameter to <literal>1</literal>, you can
+  force a TOC to be generated even if <sgmltag>generate.toc</sgmltag>
+  says not to.</para>
+</note>
 </para>
 
 </refsect1>
diff --git a/xsl/params/process.source.toc.xml b/xsl/params/process.source.toc.xml
index 0682eb918..a1d254b4e 100644
--- a/xsl/params/process.source.toc.xml
+++ b/xsl/params/process.source.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>process.source.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Process a non-empty <sgmltag>toc</sgmltag> element if it occurs in a source document?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,7 +14,20 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
+<para>Specifies that the contents of a non-empty "hard-coded"
+<sgmltag>toc</sgmltag> element in a source document are processed to
+generate a TOC in output.
+<note>
+  <para>This parameter has no effect on automated generation of
+  TOCs. An automated TOC may still be generated along with the
+  "hard-coded" TOC. To suppress automated TOC generation, adjust the
+  value of the <parameter>generate.toc</parameter> paramameter.</para>
+
+  <para>The <sgmltag>process.source.toc</sgmltag> parameter also has
+  no effect if the <sgmltag>toc</sgmltag> element is empty; handling
+  for empty <sgmltag>toc</sgmltag> is controlled by the
+  <parameter>process.empty.source.toc</parameter> parameter.</para>
+</note>
 </para>
 
 </refsect1>