summaryrefslogtreecommitdiff
path: root/params/man.subheading.divider.enabled.xml
diff options
context:
space:
mode:
authorLorry <lorry@roadtrain.codethink.co.uk>2012-07-20 16:48:06 +0100
committerLorry <lorry@roadtrain.codethink.co.uk>2012-07-20 16:48:06 +0100
commit8e8edc70b402e69953fb9135a58d7faee12dc088 (patch)
treee8815e7ef185ccaba26bcd616eace378572b922e /params/man.subheading.divider.enabled.xml
downloaddocbook-xsl-8e8edc70b402e69953fb9135a58d7faee12dc088.tar.gz
Tarball conversion
Diffstat (limited to 'params/man.subheading.divider.enabled.xml')
-rw-r--r--params/man.subheading.divider.enabled.xml37
1 files changed, 37 insertions, 0 deletions
diff --git a/params/man.subheading.divider.enabled.xml b/params/man.subheading.divider.enabled.xml
new file mode 100644
index 0000000..1156c5f
--- /dev/null
+++ b/params/man.subheading.divider.enabled.xml
@@ -0,0 +1,37 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version="5.0" xml:id="man.subheading.divider.enabled">
+<refmeta>
+<refentrytitle>man.subheading.divider.enabled</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.subheading.divider.enabled</refname>
+<refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.subheading.divider.enabled.frag">
+<xsl:param name="man.subheading.divider.enabled">0</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If the value of the
+<parameter>man.subheading.divider.enabled</parameter> parameter is
+non-zero, the contents of the
+<parameter>man.subheading.divider</parameter> parameter are used to
+add a "divider" before and after subheadings in the roff
+output. <emphasis role="bold">The divider is not visisble in the
+rendered man page</emphasis>; it is added as a comment, in the source,
+simply for the purpose of increasing reability of the source.</para>
+
+<para>If <parameter>man.subheading.divider.enabled</parameter> is zero
+(the default), the subheading divider is suppressed.</para>
+
+</refsection>
+</refentry>