man.subheading.divider.enabled.xml 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637
  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.enabled">
  7. <refmeta>
  8. <refentrytitle>man.subheading.divider.enabled</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.subheading.divider.enabled</refname>
  13. <refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.subheading.divider.enabled.frag">
  17. <xsl:param name="man.subheading.divider.enabled">0</xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>If the value of the
  22. <parameter>man.subheading.divider.enabled</parameter> parameter is
  23. non-zero, the contents of the
  24. <parameter>man.subheading.divider</parameter> parameter are used to
  25. add a "divider" before and after subheadings in the roff
  26. output. <emphasis role="bold">The divider is not visisble in the
  27. rendered man page</emphasis>; it is added as a comment, in the source,
  28. simply for the purpose of increasing reability of the source.</para>
  29. <para>If <parameter>man.subheading.divider.enabled</parameter> is zero
  30. (the default), the subheading divider is suppressed.</para>
  31. </refsection>
  32. </refentry>