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