man.indent.refsect.xml 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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.indent.refsect">
  7. <refmeta>
  8. <refentrytitle>man.indent.refsect</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.indent.refsect</refname>
  13. <refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.indent.refsect.frag">
  17. <xsl:param name="man.indent.refsect" select="0"/></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If the value of <parameter>man.indent.refsect</parameter> is
  21. non-zero, the width of the left margin for
  22. <tag>refsect1</tag>, <tag>refsect2</tag> and
  23. <tag>refsect3</tag> contents and titles (and first-level,
  24. second-level, and third-level nested
  25. <tag>refsection</tag>instances) is adjusted by the value of
  26. the <parameter>man.indent.width</parameter> parameter. With
  27. <parameter>man.indent.width</parameter> set to its default value of
  28. <literal>3n</literal>, the main results are that:
  29. <itemizedlist>
  30. <listitem>
  31. <para>contents of <tag>refsect1</tag> are output with a
  32. left margin of three characters instead the roff default of seven
  33. or eight characters</para>
  34. </listitem>
  35. <listitem>
  36. <para>contents of <tag>refsect2</tag> are displayed in
  37. console output with a left margin of six characters instead the of
  38. the roff default of seven characters</para>
  39. </listitem>
  40. <listitem>
  41. <para> the contents of <tag>refsect3</tag> and nested
  42. <tag>refsection</tag> instances are adjusted
  43. accordingly.</para>
  44. </listitem>
  45. </itemizedlist>
  46. If instead the value of <parameter>man.indent.refsect</parameter> is
  47. zero, no margin adjustment is done for <literal>refsect*</literal>
  48. output.</para>
  49. <tip>
  50. <para>If your content is primarly comprised of
  51. <tag>refsect1</tag> and <tag>refsect2</tag> content
  52. (or the <tag>refsection</tag> equivalent) – with few or
  53. no <tag>refsect3</tag> or lower nested sections , you may be
  54. able to “conserve” space in your output by setting
  55. <parameter>man.indent.refsect</parameter> to a non-zero value. Doing
  56. so will “squeeze” the left margin in such as way as to provide an
  57. additional four characters of “room” per line in
  58. <tag>refsect1</tag> output. That extra room may be useful
  59. if, for example, you have many verbatim sections with long lines in
  60. them.</para>
  61. </tip>
  62. </refsection>
  63. </refentry>