doc/xslt/params/refentry.version.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="refentry.version.suppress">
   7 <refmeta>
   8 <refentrytitle>refentry.version.suppress</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>refentry.version.suppress</refname>
  13 <refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="refentry.version.suppress.frag">
  18 <xsl:param name="refentry.version.suppress">0</xsl:param></src:fragment>
  19 </refsynopsisdiv>
  20
  21 <refsection><info><title>Description</title></info>
  22
  23 <para>If the value of <parameter>refentry.version.suppress</parameter>
  24 is non-zero, then during <tag>refentry</tag> metadata gathering, no
  25 "version" data is added to the <tag>refentry</tag> "source"
  26 contents. Instead (unless
  27 <parameter>refentry.source.name.suppress</parameter> is also
  28 non-zero), only "source name" data is added to the "source"
  29 contents.</para>
  30
  31 <para>If you find that the <tag>refentry</tag> metadata gathering
  32 mechanism is causing unwanted "version" data to show up in your output
  33 -- for example, in the footer (or possibly header) of a man page --
  34 then you might consider setting a non-zero value for
  35 <parameter>refentry.version.suppress</parameter>.</para>
  36
  37 <para>Note that the terms "source", "source name", and "version" have
  38 special meanings in this context. For details, see the documentation
  39 for the <parameter>refentry.source.name.profile</parameter>
  40 parameter.</para>
  41
  42 </refsection>
  43 </refentry>