X-Git-Url: https://git.stg.codes/stg.git/blobdiff_plain/0c9c28efcd43f53ac54aa60b2dfefa69c70dbadf..6b6d9b29e9e9e91f79507a8bf193fb30de311dcc:/doc/help/xslt/params/refentry.source.name.profile.enabled.xml

diff --git a/doc/help/xslt/params/refentry.source.name.profile.enabled.xml b/doc/help/xslt/params/refentry.source.name.profile.enabled.xml
new file mode 100644
index 00000000..f87ec0fe
--- /dev/null
+++ b/doc/help/xslt/params/refentry.source.name.profile.enabled.xml
@@ -0,0 +1,48 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="refentry.source.name.profile.enabled">
+<refmeta>
+<refentrytitle>refentry.source.name.profile.enabled</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>refentry.source.name.profile.enabled</refname>
+<refpurpose>Enable refentry "source name" profiling?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="refentry.source.name.profile.enabled.frag">
+<xsl:param name="refentry.source.name.profile.enabled">0</xsl:param></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If the value of
+<parameter>refentry.source.name.profile.enabled</parameter> is
+non-zero, then during <tag>refentry</tag> metadata gathering, the info
+profile specified by the customizable
+<parameter>refentry.source.name.profile</parameter> parameter is
+used.</para>
+
+<para>If instead the value of
+<parameter>refentry.source.name.profile.enabled</parameter> is zero (the
+default), then "hard coded" logic within the DocBook XSL stylesheets
+is used for gathering <tag>refentry</tag> "source name" data.</para>
+
+<para>If you find that the default <tag>refentry</tag>
+metadata-gathering behavior is causing incorrect "source name" data to
+show up in your output, then consider setting a non-zero value for
+<parameter>refentry.source.name.profile.enabled</parameter> and
+adjusting the value of
+<parameter>refentry.source.name.profile</parameter> to cause correct
+data to be gathered. </para>
+
+<para>Note that the terms "source" and "source name" have special
+meanings in this context. For details, see the documentation for the
+<parameter>refentry.source.name.profile</parameter> parameter.</para>
+
+</refsection>
+</refentry>