Documentation improvements from Dave Pawson

diff --git a/xsl/params/admonition.title.properties.xml b/xsl/params/admonition.title.properties.xml
index 34adc6a1e65131069483168aa2f000fa1ba886f3..7955990d16cf7e7f4c73a5ada45c1d1a8ffa117a 100644 (file)
--- a/xsl/params/admonition.title.properties.xml
+++ b/xsl/params/admonition.title.properties.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>admonition.title.properties</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>To set the style for admonitions.</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -13,6 +13,8 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>How do you want admonitions styled? </para>
+<para>Set the font-size, weight etc to the style required</para>
+
 </refsect1>
 </refentry>

diff --git a/xsl/params/autotoc.label.separator.xml b/xsl/params/autotoc.label.separator.xml
index 4a934f49cae4bdc3bdf2611756fa28173f769a81..6b3035c3378623f9e2bf5e4f8be16f60fa4ae025 100644 (file)
--- a/xsl/params/autotoc.label.separator.xml
+++ b/xsl/params/autotoc.label.separator.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refmeta>
 <refentrytitle>autotoc.label.separator</refentrytitle>
-<refmiscinfo role="type"></refmiscinfo>
+<refmiscinfo role="type">string</refmiscinfo>
 </refmeta>
 <refnamediv>
 <refname>autotoc.label.separator</refname>
@@ -14,7 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:</para>
+<para>String to use to seperate labels and title in a table of contents.</para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/body.margin.top.xml b/xsl/params/body.margin.top.xml
index 0600e32fde3b575911f27350fa74911c3db6c03e..30ccedf685f032922cdd51b3b4b584a816efd0f6 100644 (file)
--- a/xsl/params/body.margin.top.xml
+++ b/xsl/params/body.margin.top.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>body.margin.top</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>To specify the size of the top margin of a page</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>

diff --git a/xsl/params/callout.unicode.xml b/xsl/params/callout.unicode.xml
index d80d1ff1958e4acf3a20c83a77a1b176ec47567e..12e39c06affcb2b6676374677e27bfa06d0836d1 100644 (file)
--- a/xsl/params/callout.unicode.xml
+++ b/xsl/params/callout.unicode.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>callout.unicode</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Use Unicode characters rather than images for callouts.</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,7 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
+<para>The stylesheets can use either an image of the numbers one to ten, or the single Unicode character which represents the numeral, in white on a black background. Use this to select the Unicode character option.
 </para>
 
 </refsect1>

diff --git a/xsl/params/component.title.properties.xml b/xsl/params/component.title.properties.xml
index e7a416f450793195070531a6d7ae0cff4c203016..d0936c76b766d72f997f686f49558a5f75b00241 100644 (file)
--- a/xsl/params/component.title.properties.xml
+++ b/xsl/params/component.title.properties.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>component.title.properties</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Specify the styling for the title elements of a component.</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -19,6 +19,12 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+
+<para>A set of attributes are used to style the title of a
+component (chapters, appendixes, articles, etc.). Components are usually
+printed in the <parameter>title.font.family</parameter>.
+Spacing before and after, font size etc are specified
+using this parameter.</para>
+
 </refsect1>
 </refentry>

diff --git a/xsl/params/formal.object.properties.xml b/xsl/params/formal.object.properties.xml
index 835aa2f889d028341317dc3e4f7c63c74e374917..b2ea113882a5db6fa3ddb7ae9a842b61ba04eafb 100644 (file)
--- a/xsl/params/formal.object.properties.xml
+++ b/xsl/params/formal.object.properties.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>formal.object.properties</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Properties associated with a formal object such as a figure, or other component that has a title</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -16,6 +16,6 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>The styling for formal objects in docbook. Specify the spacing before and after the object.</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/formal.title.properties.xml b/xsl/params/formal.title.properties.xml
index be5f221162ebe9b6e2e791ca8e02d5d7392b6574..1374de367a8104dda781d5e03e0cae1c3fbe25bb 100644 (file)
--- a/xsl/params/formal.title.properties.xml
+++ b/xsl/params/formal.title.properties.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>formal.title.properties</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Style the title element of formal object such as a figure.</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -13,6 +13,6 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify how the title should be styled. Specify the font size and weight of the title of the formal object.</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.appendix.toc.xml b/xsl/params/generate.appendix.toc.xml
index b1926ddbd85fbd596f14b658b236bcc1a4bea8c5..4b98d1f76eeb27e53b7983871dacdf6c03c7abbe 100644 (file)
--- a/xsl/params/generate.appendix.toc.xml
+++ b/xsl/params/generate.appendix.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.appendix.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Specify if a table of contents is required for an appendix</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify whether you want a table of contents in each appendix. </para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.article.toc.xml b/xsl/params/generate.article.toc.xml
index 01c3dc8c8bef6b52f337f4b3f2df5666fcd2f16e..d08c0ce707f5671ad137133accc6162617ce56c1 100644 (file)
--- a/xsl/params/generate.article.toc.xml
+++ b/xsl/params/generate.article.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.article.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Specify if a toc is wanted for an article.</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify whether a table of contents is required for an article.</para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.book.equation.lot.xml b/xsl/params/generate.book.equation.lot.xml
index 82dc0006e73376dd9d28ecfff6eaf054b4cabcdd..e819fd9887a07ad01622ddd5928cefd6541ab9cd 100644 (file)
--- a/xsl/params/generate.book.equation.lot.xml
+++ b/xsl/params/generate.book.equation.lot.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.book.equation.lot</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Should a lot be generated for equations?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -13,6 +13,6 @@
 </refsynopsisdiv>
 
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify if  list of equations, like a table of contents, is required.</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.book.example.lot.xml b/xsl/params/generate.book.example.lot.xml
index 188f1841edc781da1e8aa104ae36b417ae048072..ccc2b230e49a268fe9251b6528de72aeb4a10bb8 100644 (file)
--- a/xsl/params/generate.book.example.lot.xml
+++ b/xsl/params/generate.book.example.lot.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.book.example.lot</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Is a list of equations required?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -13,6 +13,6 @@
 </refsynopsisdiv>
 
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify if a list of examples is required, similar to a table of contents but for examples.</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.book.figure.lot.xml b/xsl/params/generate.book.figure.lot.xml
index 74f9309560797593620b3367a8f002ae6288dc4c..3bed3355e79023f612b66e0b7160289fda279949 100644 (file)
--- a/xsl/params/generate.book.figure.lot.xml
+++ b/xsl/params/generate.book.figure.lot.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.book.figure.lot</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Is a list of figures required for book?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -13,6 +13,6 @@
 </refsynopsisdiv>
 
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify if a list of figures is required, similar to a table of contents but for figures.</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.book.table.lot.xml b/xsl/params/generate.book.table.lot.xml
index 44e1ab7b37ff08910cfa149573abd63daf213290..7215bf67fb5d138b1ece9f100f250dfad88d6c87 100644 (file)
--- a/xsl/params/generate.book.table.lot.xml
+++ b/xsl/params/generate.book.table.lot.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.book.table.lot</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want a list of tables in a book?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -13,6 +13,6 @@
 </refsynopsisdiv>
 
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify if a list of tables is required, similar to a table of contents, but for all the tables in the book</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.book.toc.xml b/xsl/params/generate.book.toc.xml
index 18a390c871765035f4304bec0769c0849a884ed2..6c1e389ee30834c530ed3c650545ce799f76318e 100644 (file)
--- a/xsl/params/generate.book.toc.xml
+++ b/xsl/params/generate.book.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.book.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want a table of contents in the book?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify if a table of contents is required in the book.</para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.chapter.toc.xml b/xsl/params/generate.chapter.toc.xml
index a20c7a6eda35010e04a496e3b943bb8321ac81a9..426c38d9f146f16f31b4974c3638daf1f2d81c9c 100644 (file)
--- a/xsl/params/generate.chapter.toc.xml
+++ b/xsl/params/generate.chapter.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.chapter.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want a table of contents for chapters?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify if a table of contents should be generated for each chapter.</para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.index.xml b/xsl/params/generate.index.xml
index a82c5f094b367a142f55c03fa1826878a039e7ee..77cc5317a0b2d57c5e5e304a0790a8f3f1060843 100644 (file)
--- a/xsl/params/generate.index.xml
+++ b/xsl/params/generate.index.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.index</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want an index?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify if an index should be generated. </para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.part.toc.xml b/xsl/params/generate.part.toc.xml
index aa26a6ffb6e37173aa52313f2948b1aa60637ae8..6c9f00025f6491093df1332405ab2757e636fe77 100644 (file)
--- a/xsl/params/generate.part.toc.xml
+++ b/xsl/params/generate.part.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.part.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want an index for each part?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,7 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
+<para>Specify if an index should be generated for each part.
 </para>
 
 </refsect1>

diff --git a/xsl/params/generate.preface.toc.xml b/xsl/params/generate.preface.toc.xml
index 6bbbbdccd041a289c0994ab7dd675e8d32d59aed..915cbaef1ff77ea90c9a19390711bc5fb3beba3d 100644 (file)
--- a/xsl/params/generate.preface.toc.xml
+++ b/xsl/params/generate.preface.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.preface.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want a table of contents for the preface?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify if a table of contents should be generated for the preface</para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/generate.reference.toc.xml b/xsl/params/generate.reference.toc.xml
index 6ece531ea90dfb9d194cda05b7dab3bb55b77d81..1152073bcd121ca4280ebe08981d0904749a9e3b 100644 (file)
--- a/xsl/params/generate.reference.toc.xml
+++ b/xsl/params/generate.reference.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.reference.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want a list of references?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,7 +14,8 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
+<para>Specify if a list of references should be generated, similar to
+a table of contents, but for all <sgmltag>reference</sgmltag> elements.
 </para>
 
 </refsect1>

diff --git a/xsl/params/generate.set.toc.xml b/xsl/params/generate.set.toc.xml
index bb51a8d9f40f38908a13c3177cdc7f441a22d47e..3878923ebdf3999346e1c09e241658c2c6e207ed 100644 (file)
--- a/xsl/params/generate.set.toc.xml
+++ b/xsl/params/generate.set.toc.xml
@@ -5,7 +5,7 @@
 </refmeta>
 <refnamediv>
 <refname>generate.set.toc</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>Do you want a table of contents in each set?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -14,8 +14,7 @@
 
 <refsect1><title>Description</title>
 
-<para>FIXME:
-</para>
+<para>Specify if a table of contents is required in each set.</para>
 
 </refsect1>
 </refentry>

diff --git a/xsl/params/list.block.spacing.xml b/xsl/params/list.block.spacing.xml
index 4a59cdcaa2cbcbc17e418ffc7c5c559de37ddce5..40ab257dcfd7fb2bf21b58d63607a65858d62fc2 100644 (file)
--- a/xsl/params/list.block.spacing.xml
+++ b/xsl/params/list.block.spacing.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>list.block.spacing</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>What spacing do you want before lists?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -12,6 +12,6 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify the spacing required before a list. </para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/list.item.spacing.xml b/xsl/params/list.item.spacing.xml
index 3f220d39d06fd657bc40fa183502d6a8c4a07c3a..b406496248a3ba67261e1e15b18e1a560e979cf6 100644 (file)
--- a/xsl/params/list.item.spacing.xml
+++ b/xsl/params/list.item.spacing.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>list.item.spacing</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>What space do you want between list items?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -12,6 +12,6 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify what spacing you want between each list item.</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/monospace.verbatim.properties.xml b/xsl/params/monospace.verbatim.properties.xml
index d478d4c887d2fcf4a1d1ce079d4fccecdbbbafb2..35398177fe46753c77205e412d7195e978194da6 100644 (file)
--- a/xsl/params/monospace.verbatim.properties.xml
+++ b/xsl/params/monospace.verbatim.properties.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>monospace.verbatim.properties</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>What font and size do you want for monospaced content?</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -16,6 +16,6 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify the font name and size you want for monospaced output</para>
 </refsect1>
 </refentry>

diff --git a/xsl/params/normal.para.spacing.xml b/xsl/params/normal.para.spacing.xml
index 2e8b2711da671c1f2e43a7ad5eedb8cb158c38f3..99a4da87dfbc7f4d50af58616df7e99aed8ec626 100644 (file)
--- a/xsl/params/normal.para.spacing.xml
+++ b/xsl/params/normal.para.spacing.xml
@@ -1,7 +1,7 @@
 <refentry>
 <refnamediv>
 <refname>normal.para.spacing</refname>
-<refpurpose>FIXME:</refpurpose>
+<refpurpose>What space do you want between normal paragraphs</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -12,6 +12,6 @@
 </xsl:attribute-set></src:fragment>
 </refsynopsisdiv>
 <refsect1><title>Description</title>
-<para>FIXME:</para>
+<para>Specify the spacing required between normal paragraphs</para>
 </refsect1>
 </refentry>