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