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