1 | <refentry id="refentry.source.name.suppress">
|
---|
2 | <refmeta>
|
---|
3 | <refentrytitle>refentry.source.name.suppress</refentrytitle>
|
---|
4 | <refmiscinfo role="type">boolean</refmiscinfo>
|
---|
5 | </refmeta>
|
---|
6 | <refnamediv>
|
---|
7 | <refname>refentry.source.name.suppress</refname>
|
---|
8 | <refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose>
|
---|
9 | </refnamediv>
|
---|
10 |
|
---|
11 | <refsynopsisdiv>
|
---|
12 | <src:fragment id='refentry.source.name.suppress.frag'>
|
---|
13 | <xsl:param name="refentry.source.name.suppress">0</xsl:param></src:fragment>
|
---|
14 | </refsynopsisdiv>
|
---|
15 |
|
---|
16 | <refsect1><title>Description</title>
|
---|
17 |
|
---|
18 | <para>If the value of
|
---|
19 | <parameter>refentry.source.name.suppress</parameter> is non-zero, then
|
---|
20 | during <tag>refentry</tag> metadata gathering, no "source name" data
|
---|
21 | is added to the <tag>refentry</tag> "source" contents. Instead (unless
|
---|
22 | <parameter>refentry.version.suppress</parameter> is also non-zero),
|
---|
23 | only "version" data is added to the "source" contents.</para>
|
---|
24 |
|
---|
25 | <para>If you find that the <tag>refentry</tag> metadata gathering
|
---|
26 | mechanism is causing unwanted "source name" data to show up in your
|
---|
27 | output -- for example, in the footer (or possibly header) of a man
|
---|
28 | page -- then you might consider setting a non-zero value for
|
---|
29 | <parameter>refentry.source.name.suppress</parameter>.</para>
|
---|
30 |
|
---|
31 | <para>Note that the terms "source", "source name", and "version" have
|
---|
32 | special meanings in this context. For details, see the documentation
|
---|
33 | for the <parameter>refentry.source.name.profile</parameter>
|
---|
34 | parameter.</para>
|
---|
35 |
|
---|
36 | </refsect1>
|
---|
37 | </refentry>
|
---|