refentry.version.suppress.xml 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="refentry.version.suppress.frag">
  17. <xsl:param name="refentry.version.suppress">0</xsl:param></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If the value of <parameter>refentry.version.suppress</parameter>
  21. is non-zero, then during <tag>refentry</tag> metadata gathering, no
  22. "version" data is added to the <tag>refentry</tag> "source"
  23. contents. Instead (unless
  24. <parameter>refentry.source.name.suppress</parameter> is also
  25. non-zero), only "source name" data is added to the "source"
  26. contents.</para>
  27. <para>If you find that the <tag>refentry</tag> metadata gathering
  28. mechanism is causing unwanted "version" data to show up in your output
  29. -- for example, in the footer (or possibly header) of a man page --
  30. then you might consider setting a non-zero value for
  31. <parameter>refentry.version.suppress</parameter>.</para>
  32. <para>Note that the terms "source", "source name", and "version" have
  33. special meanings in this context. For details, see the documentation
  34. for the <parameter>refentry.source.name.profile</parameter>
  35. parameter.</para>
  36. </refsection>
  37. </refentry>