stylesheets/styleguide/docbook-xsl-1.75.2/params/man.subheading.divider.enabled.xml

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