~todd-deshane/openstack-manuals/working

« back to all changes in this revision

Viewing changes to doc/build/docbook-xsl-1.76.1/params/refentry.manual.profile.enabled.xml

  • Committer: Anne Gentle
  • Date: 2011-04-04 17:54:52 UTC
  • Revision ID: anne@openstack.org-20110404175452-gtth3hfrniqhpp5o
Switching from Ant builds to Maven, still working out kinks but should be functional

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.manual.profile.enabled">
7
 
<refmeta>
8
 
<refentrytitle>refentry.manual.profile.enabled</refentrytitle>
9
 
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10
 
</refmeta>
11
 
<refnamediv>
12
 
<refname>refentry.manual.profile.enabled</refname>
13
 
<refpurpose>Enable refentry "manual" profiling?</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv>
17
 
<src:fragment xml:id="refentry.manual.profile.enabled.frag">
18
 
<xsl:param name="refentry.manual.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.manual.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.manual.profile</parameter> parameter is
28
 
used.</para>
29
 
 
30
 
<para>If instead the value of
31
 
<parameter>refentry.manual.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> "manual" data.</para>
34
 
 
35
 
<para>If you find that the default <tag>refentry</tag>
36
 
metadata-gathering behavior is causing incorrect "manual" data to show
37
 
up in your output, then consider setting a non-zero value for
38
 
<parameter>refentry.manual.profile.enabled</parameter> and adjusting
39
 
the value of <parameter>refentry.manual.profile</parameter> to cause
40
 
correct data to be gathered. </para>
41
 
 
42
 
<para>Note that the term "manual" has a special meanings in this
43
 
context. For details, see the documentation for the
44
 
<parameter>refentry.manual.profile</parameter> parameter.</para>
45
 
 
46
 
</refsection>
47
 
</refentry>