← Back to branch summary

~todd-deshane/openstack-manuals/working

« back to all changes in this revision

Viewing changes to doc/build/docbook-xsl-1.76.1/params/man.justify.xml

  • Committer: Anne Gentle
  • Date: 2011-04-04 17:54:52 UTC
  • Revision ID: anne@openstack.org-20110404175452-gtth3hfrniqhpp5o
Switching from Ant builds to Maven, still working out kinks but should be functional

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/build/docbook-xsl-1.76.1/params/man.justify.xml
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.justify">
7
 
<refmeta>
8
 
<refentrytitle>man.justify</refentrytitle>
9
 
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10
 
</refmeta>
11
 
<refnamediv>
12
 
<refname>man.justify</refname>
13
 
<refpurpose>Justify text to both right and left margins?</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv>
17
 
<src:fragment xml:id="man.justify.frag">
18
 
<xsl:param name="man.justify">0</xsl:param></src:fragment>
19
 
</refsynopsisdiv>
20
 
 
21
 
<refsection><info><title>Description</title></info>
22
 
 
23
 
<para>If non-zero, text is justified to both the right and left
24
 
margins (or, in roff terminology, "adjusted and filled" to both the
25
 
right and left margins). If zero (the default), text is adjusted to
26
 
the left margin only -- producing what is traditionally called
27
 
"ragged-right" text.</para>
28
 
 
29
 
<note>
30
 
<para>The default value for this parameter is zero because justified
31
 
text looks good only when it is also hyphenated. Without hyphenation,
32
 
excessive amounts of space often end up getting between words, in
33
 
order to "pad" lines out to align on the right margin.</para>
34
 
 
35
 
<para>The problem is that groff is not particularly smart about how it
36
 
does hyphenation; it can end up hyphenating a lot of things that you
37
 
don't want hyphenated. So, disabling both justification and
38
 
hyphenation ensures that hyphens won't get inserted where you don't
39
 
want to them, and you don't end up with lines containing excessive
40
 
amounts of space between words.</para>
41
 
 
42
 
<para>However, if do you decide to set a non-zero value for the
43
 
<parameter>man.justify</parameter> parameter (to enable
44
 
justification), then you should probably also set a non-zero value for
45
 
<parameter>man.hyphenate</parameter> (to enable hyphenation).</para>
46
 
 
47
 
<para>Yes, these default settings run counter to how most existing man
48
 
pages are formatted. But there are some notable exceptions, such as
49
 
the <literal>perl</literal> man pages.</para>
50
 
</note>
51
 
</refsection>
52
 
</refentry>