doc/xslt/params/man.th.extra2.suppress.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.th.extra2.suppress">
   7 <refmeta>
   8 <refentrytitle>man.th.extra2.suppress</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>man.th.extra2.suppress</refname>
  13 <refpurpose>Suppress extra2 part of header/footer?</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="man.th.extra2.suppress.frag">
  18 <xsl:param name="man.th.extra2.suppress">0</xsl:param></src:fragment>
  19 </refsynopsisdiv>
  20
  21 <refsection><info><title>Description</title></info>
  22
  23 <para>If the value of <parameter>man.th.extra2.suppress</parameter> is
  24 non-zero, then the <literal>extra2</literal> part of the
  25 <literal>.TH</literal> title line header/footer is suppressed.</para>
  26
  27 <para>The content of the <literal>extra2</literal> field is usually
  28 displayed in the left footer of the page and is typically "source"
  29 data, often in the form
  30 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
  31 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
  32 man page).</para>
  33
  34 <note>
  35   <para>You can use the
  36   <parameter>refentry.source.name.suppress</parameter> and
  37   <parameter>refentry.version.suppress</parameter> parameters to
  38   independently suppress the <replaceable>Name</replaceable> and
  39   <replaceable>Version</replaceable> parts of the
  40   <literal>extra2</literal> field.</para>
  41 </note>
  42
  43 </refsection>
  44 </refentry>