stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.hyphenate.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.hyphenate">\r
   7 <refmeta>\r
   8 <refentrytitle>man.hyphenate</refentrytitle>\r
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
  10 </refmeta>\r
  11 <refnamediv>\r
  12 <refname>man.hyphenate</refname>\r
  13 <refpurpose>Enable hyphenation?</refpurpose>\r
  14 </refnamediv>\r
  15 \r
  16 <refsynopsisdiv>\r
  17 <src:fragment xml:id="man.hyphenate.frag">\r
  18 <xsl:param name="man.hyphenate">0</xsl:param></src:fragment>\r
  19 </refsynopsisdiv>\r
  20 \r
  21 <refsection><info><title>Description</title></info>\r
  22 \r
  23 <para>If non-zero, hyphenation is enabled.</para>\r
  24 \r
  25 <note>\r
  26 <para>The default value for this parameter is zero because groff is\r
  27 not particularly smart about how it does hyphenation; it can end up\r
  28 hyphenating a lot of things that you don't want hyphenated. To\r
  29 mitigate that, the default behavior of the stylesheets is to suppress\r
  30 hyphenation of computer inlines, filenames, and URLs. (You can\r
  31 override the default behavior by setting non-zero values for the\r
  32 <parameter>man.hyphenate.urls</parameter>,\r
  33 <parameter>man.hyphenate.filenames</parameter>, and\r
  34 <parameter>man.hyphenate.computer.inlines</parameter> parameters.) But\r
  35 the best way is still to just globally disable hyphenation, as the\r
  36 stylesheets do by default.</para>\r
  37 \r
  38 <para>The only good reason to enabled hyphenation is if you have also\r
  39 enabled justification (which is disabled by default). The reason is\r
  40 that justified text can look very bad unless you also hyphenate it; to\r
  41 quote the <quote>Hypenation</quote> node from the groff info page:\r
  42 \r
  43 <blockquote>\r
  44   <para><emphasis>Since the odds are not great for finding a set of\r
  45   words, for every output line, which fit nicely on a line without\r
  46   inserting excessive amounts of space between words, 'gtroff'\r
  47   hyphenates words so that it can justify lines without inserting too\r
  48   much space between words.</emphasis></para>\r
  49 </blockquote>\r
  50 \r
  51 So, if you set a non-zero value for the\r
  52 <parameter>man.justify</parameter> parameter (to enable\r
  53 justification), then you should probably also set a non-zero value for\r
  54 <parameter>man.hyphenate</parameter> (to enable hyphenation).</para>\r
  55 </note>\r
  56 \r
  57 \r
  58 </refsection>\r
  59 </refentry>\r