From dd467927d8df97b2a18d4011fac3550bcea91e5e Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Tue, 6 Nov 2001 01:27:31 +0000 Subject: [PATCH] Documentation improvements from Dave Pawson --- xsl/params/admonition.title.properties.xml | 6 ++++-- xsl/params/autotoc.label.separator.xml | 4 ++-- xsl/params/body.margin.top.xml | 2 +- xsl/params/callout.unicode.xml | 4 ++-- xsl/params/component.title.properties.xml | 10 ++++++++-- xsl/params/formal.object.properties.xml | 4 ++-- xsl/params/formal.title.properties.xml | 4 ++-- xsl/params/generate.appendix.toc.xml | 5 ++--- xsl/params/generate.article.toc.xml | 5 ++--- xsl/params/generate.book.equation.lot.xml | 4 ++-- xsl/params/generate.book.example.lot.xml | 4 ++-- xsl/params/generate.book.figure.lot.xml | 4 ++-- xsl/params/generate.book.table.lot.xml | 4 ++-- xsl/params/generate.book.toc.xml | 5 ++--- xsl/params/generate.chapter.toc.xml | 5 ++--- xsl/params/generate.index.xml | 5 ++--- xsl/params/generate.part.toc.xml | 4 ++-- xsl/params/generate.preface.toc.xml | 5 ++--- xsl/params/generate.reference.toc.xml | 5 +++-- xsl/params/generate.set.toc.xml | 5 ++--- xsl/params/list.block.spacing.xml | 4 ++-- xsl/params/list.item.spacing.xml | 4 ++-- xsl/params/monospace.verbatim.properties.xml | 4 ++-- xsl/params/normal.para.spacing.xml | 4 ++-- 24 files changed, 56 insertions(+), 54 deletions(-) diff --git a/xsl/params/admonition.title.properties.xml b/xsl/params/admonition.title.properties.xml index 34adc6a1e..7955990d1 100644 --- a/xsl/params/admonition.title.properties.xml +++ b/xsl/params/admonition.title.properties.xml @@ -1,7 +1,7 @@ admonition.title.properties -FIXME: +To set the style for admonitions. @@ -13,6 +13,8 @@ Description -FIXME: +How do you want admonitions styled? +Set the font-size, weight etc to the style required + diff --git a/xsl/params/autotoc.label.separator.xml b/xsl/params/autotoc.label.separator.xml index 4a934f49c..6b3035c33 100644 --- a/xsl/params/autotoc.label.separator.xml +++ b/xsl/params/autotoc.label.separator.xml @@ -1,7 +1,7 @@ autotoc.label.separator - +string autotoc.label.separator @@ -14,7 +14,7 @@ Description -FIXME: +String to use to seperate labels and title in a table of contents. diff --git a/xsl/params/body.margin.top.xml b/xsl/params/body.margin.top.xml index 0600e32fd..30ccedf68 100644 --- a/xsl/params/body.margin.top.xml +++ b/xsl/params/body.margin.top.xml @@ -5,7 +5,7 @@ body.margin.top -FIXME: +To specify the size of the top margin of a page diff --git a/xsl/params/callout.unicode.xml b/xsl/params/callout.unicode.xml index d80d1ff19..12e39c06a 100644 --- a/xsl/params/callout.unicode.xml +++ b/xsl/params/callout.unicode.xml @@ -5,7 +5,7 @@ callout.unicode -FIXME: +Use Unicode characters rather than images for callouts. @@ -14,7 +14,7 @@ Description -FIXME: +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. diff --git a/xsl/params/component.title.properties.xml b/xsl/params/component.title.properties.xml index e7a416f45..d0936c76b 100644 --- a/xsl/params/component.title.properties.xml +++ b/xsl/params/component.title.properties.xml @@ -1,7 +1,7 @@ component.title.properties -FIXME: +Specify the styling for the title elements of a component. @@ -19,6 +19,12 @@ Description -FIXME: + +A set of attributes are used to style the title of a +component (chapters, appendixes, articles, etc.). Components are usually +printed in the title.font.family. +Spacing before and after, font size etc are specified +using this parameter. + diff --git a/xsl/params/formal.object.properties.xml b/xsl/params/formal.object.properties.xml index 835aa2f88..b2ea11388 100644 --- a/xsl/params/formal.object.properties.xml +++ b/xsl/params/formal.object.properties.xml @@ -1,7 +1,7 @@ formal.object.properties -FIXME: +Properties associated with a formal object such as a figure, or other component that has a title @@ -16,6 +16,6 @@ Description -FIXME: +The styling for formal objects in docbook. Specify the spacing before and after the object. diff --git a/xsl/params/formal.title.properties.xml b/xsl/params/formal.title.properties.xml index be5f22116..1374de367 100644 --- a/xsl/params/formal.title.properties.xml +++ b/xsl/params/formal.title.properties.xml @@ -1,7 +1,7 @@ formal.title.properties -FIXME: +Style the title element of formal object such as a figure. @@ -13,6 +13,6 @@ Description -FIXME: +Specify how the title should be styled. Specify the font size and weight of the title of the formal object. diff --git a/xsl/params/generate.appendix.toc.xml b/xsl/params/generate.appendix.toc.xml index b1926ddbd..4b98d1f76 100644 --- a/xsl/params/generate.appendix.toc.xml +++ b/xsl/params/generate.appendix.toc.xml @@ -5,7 +5,7 @@ generate.appendix.toc -FIXME: +Specify if a table of contents is required for an appendix @@ -14,8 +14,7 @@ Description -FIXME: - +Specify whether you want a table of contents in each appendix. diff --git a/xsl/params/generate.article.toc.xml b/xsl/params/generate.article.toc.xml index 01c3dc8c8..d08c0ce70 100644 --- a/xsl/params/generate.article.toc.xml +++ b/xsl/params/generate.article.toc.xml @@ -5,7 +5,7 @@ generate.article.toc -FIXME: +Specify if a toc is wanted for an article. @@ -14,8 +14,7 @@ Description -FIXME: - +Specify whether a table of contents is required for an article. diff --git a/xsl/params/generate.book.equation.lot.xml b/xsl/params/generate.book.equation.lot.xml index 82dc0006e..e819fd988 100644 --- a/xsl/params/generate.book.equation.lot.xml +++ b/xsl/params/generate.book.equation.lot.xml @@ -5,7 +5,7 @@ generate.book.equation.lot -FIXME: +Should a lot be generated for equations? @@ -13,6 +13,6 @@ Description -FIXME: +Specify if list of equations, like a table of contents, is required. diff --git a/xsl/params/generate.book.example.lot.xml b/xsl/params/generate.book.example.lot.xml index 188f1841e..ccc2b230e 100644 --- a/xsl/params/generate.book.example.lot.xml +++ b/xsl/params/generate.book.example.lot.xml @@ -5,7 +5,7 @@ generate.book.example.lot -FIXME: +Is a list of equations required? @@ -13,6 +13,6 @@ Description -FIXME: +Specify if a list of examples is required, similar to a table of contents but for examples. diff --git a/xsl/params/generate.book.figure.lot.xml b/xsl/params/generate.book.figure.lot.xml index 74f930956..3bed3355e 100644 --- a/xsl/params/generate.book.figure.lot.xml +++ b/xsl/params/generate.book.figure.lot.xml @@ -5,7 +5,7 @@ generate.book.figure.lot -FIXME: +Is a list of figures required for book? @@ -13,6 +13,6 @@ Description -FIXME: +Specify if a list of figures is required, similar to a table of contents but for figures. diff --git a/xsl/params/generate.book.table.lot.xml b/xsl/params/generate.book.table.lot.xml index 44e1ab7b3..7215bf67f 100644 --- a/xsl/params/generate.book.table.lot.xml +++ b/xsl/params/generate.book.table.lot.xml @@ -5,7 +5,7 @@ generate.book.table.lot -FIXME: +Do you want a list of tables in a book? @@ -13,6 +13,6 @@ Description -FIXME: +Specify if a list of tables is required, similar to a table of contents, but for all the tables in the book diff --git a/xsl/params/generate.book.toc.xml b/xsl/params/generate.book.toc.xml index 18a390c87..6c1e389ee 100644 --- a/xsl/params/generate.book.toc.xml +++ b/xsl/params/generate.book.toc.xml @@ -5,7 +5,7 @@ generate.book.toc -FIXME: +Do you want a table of contents in the book? @@ -14,8 +14,7 @@ Description -FIXME: - +Specify if a table of contents is required in the book. diff --git a/xsl/params/generate.chapter.toc.xml b/xsl/params/generate.chapter.toc.xml index a20c7a6ed..426c38d9f 100644 --- a/xsl/params/generate.chapter.toc.xml +++ b/xsl/params/generate.chapter.toc.xml @@ -5,7 +5,7 @@ generate.chapter.toc -FIXME: +Do you want a table of contents for chapters? @@ -14,8 +14,7 @@ Description -FIXME: - +Specify if a table of contents should be generated for each chapter. diff --git a/xsl/params/generate.index.xml b/xsl/params/generate.index.xml index a82c5f094..77cc5317a 100644 --- a/xsl/params/generate.index.xml +++ b/xsl/params/generate.index.xml @@ -5,7 +5,7 @@ generate.index -FIXME: +Do you want an index? @@ -14,8 +14,7 @@ Description -FIXME: - +Specify if an index should be generated. diff --git a/xsl/params/generate.part.toc.xml b/xsl/params/generate.part.toc.xml index aa26a6ffb..6c9f00025 100644 --- a/xsl/params/generate.part.toc.xml +++ b/xsl/params/generate.part.toc.xml @@ -5,7 +5,7 @@ generate.part.toc -FIXME: +Do you want an index for each part? @@ -14,7 +14,7 @@ Description -FIXME: +Specify if an index should be generated for each part. diff --git a/xsl/params/generate.preface.toc.xml b/xsl/params/generate.preface.toc.xml index 6bbbbdccd..915cbaef1 100644 --- a/xsl/params/generate.preface.toc.xml +++ b/xsl/params/generate.preface.toc.xml @@ -5,7 +5,7 @@ generate.preface.toc -FIXME: +Do you want a table of contents for the preface? @@ -14,8 +14,7 @@ Description -FIXME: - +Specify if a table of contents should be generated for the preface diff --git a/xsl/params/generate.reference.toc.xml b/xsl/params/generate.reference.toc.xml index 6ece531ea..1152073bc 100644 --- a/xsl/params/generate.reference.toc.xml +++ b/xsl/params/generate.reference.toc.xml @@ -5,7 +5,7 @@ generate.reference.toc -FIXME: +Do you want a list of references? @@ -14,7 +14,8 @@ Description -FIXME: +Specify if a list of references should be generated, similar to +a table of contents, but for all reference elements. diff --git a/xsl/params/generate.set.toc.xml b/xsl/params/generate.set.toc.xml index bb51a8d9f..3878923eb 100644 --- a/xsl/params/generate.set.toc.xml +++ b/xsl/params/generate.set.toc.xml @@ -5,7 +5,7 @@ generate.set.toc -FIXME: +Do you want a table of contents in each set? @@ -14,8 +14,7 @@ Description -FIXME: - +Specify if a table of contents is required in each set. diff --git a/xsl/params/list.block.spacing.xml b/xsl/params/list.block.spacing.xml index 4a59cdcaa..40ab257dc 100644 --- a/xsl/params/list.block.spacing.xml +++ b/xsl/params/list.block.spacing.xml @@ -1,7 +1,7 @@ list.block.spacing -FIXME: +What spacing do you want before lists? @@ -12,6 +12,6 @@ Description -FIXME: +Specify the spacing required before a list. diff --git a/xsl/params/list.item.spacing.xml b/xsl/params/list.item.spacing.xml index 3f220d39d..b40649624 100644 --- a/xsl/params/list.item.spacing.xml +++ b/xsl/params/list.item.spacing.xml @@ -1,7 +1,7 @@ list.item.spacing -FIXME: +What space do you want between list items? @@ -12,6 +12,6 @@ Description -FIXME: +Specify what spacing you want between each list item. diff --git a/xsl/params/monospace.verbatim.properties.xml b/xsl/params/monospace.verbatim.properties.xml index d478d4c88..35398177f 100644 --- a/xsl/params/monospace.verbatim.properties.xml +++ b/xsl/params/monospace.verbatim.properties.xml @@ -1,7 +1,7 @@ monospace.verbatim.properties -FIXME: +What font and size do you want for monospaced content? @@ -16,6 +16,6 @@ Description -FIXME: +Specify the font name and size you want for monospaced output diff --git a/xsl/params/normal.para.spacing.xml b/xsl/params/normal.para.spacing.xml index 2e8b2711d..99a4da87d 100644 --- a/xsl/params/normal.para.spacing.xml +++ b/xsl/params/normal.para.spacing.xml @@ -1,7 +1,7 @@ normal.para.spacing -FIXME: +What space do you want between normal paragraphs @@ -12,6 +12,6 @@ Description -FIXME: +Specify the spacing required between normal paragraphs -- 2.40.0