]> git.stg.codes - stg.git/blob - doc/xslt/params/man.subheading.divider.xml
Merge branch 'naffanya-dev'
[stg.git] / doc / xslt / params / man.subheading.divider.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="man.subheading.divider">
7 <refmeta>
8 <refentrytitle>man.subheading.divider</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.subheading.divider</refname>
13 <refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.subheading.divider.frag">
18 <xsl:param name="man.subheading.divider">========================================================================</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>If the value of the
25 <parameter>man.subheading.divider.enabled</parameter> parameter is
26 non-zero, the contents of the
27 <parameter>man.subheading.divider</parameter> parameter are used to
28 add a "divider" before and after subheadings in the roff
29 output. <emphasis role="bold">The divider is not visisble in the
30 rendered man page</emphasis>; it is added as a comment, in the source,
31 simply for the purpose of increasing reability of the source.</para>
32
33 <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
34 (the default), the subheading divider is suppressed.</para>
35
36 </refsection>
37 </refentry>