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