refentry.source.name.profile.enabled.xml 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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.source.name.profile.enabled">
  7. <refmeta>
  8. <refentrytitle>refentry.source.name.profile.enabled</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>refentry.source.name.profile.enabled</refname>
  13. <refpurpose>Enable refentry "source name" profiling?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="refentry.source.name.profile.enabled.frag">
  17. <xsl:param name="refentry.source.name.profile.enabled">0</xsl:param></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If the value of
  21. <parameter>refentry.source.name.profile.enabled</parameter> is
  22. non-zero, then during <tag>refentry</tag> metadata gathering, the info
  23. profile specified by the customizable
  24. <parameter>refentry.source.name.profile</parameter> parameter is
  25. used.</para>
  26. <para>If instead the value of
  27. <parameter>refentry.source.name.profile.enabled</parameter> is zero (the
  28. default), then "hard coded" logic within the DocBook XSL stylesheets
  29. is used for gathering <tag>refentry</tag> "source name" data.</para>
  30. <para>If you find that the default <tag>refentry</tag>
  31. metadata-gathering behavior is causing incorrect "source name" data to
  32. show up in your output, then consider setting a non-zero value for
  33. <parameter>refentry.source.name.profile.enabled</parameter> and
  34. adjusting the value of
  35. <parameter>refentry.source.name.profile</parameter> to cause correct
  36. data to be gathered. </para>
  37. <para>Note that the terms "source" and "source name" have special
  38. meanings in this context. For details, see the documentation for the
  39. <parameter>refentry.source.name.profile</parameter> parameter.</para>
  40. </refsection>
  41. </refentry>