]> git.stg.codes - stg.git/blob - doc/xslt/params/olink.debug.xml
Added parameter description.
[stg.git] / doc / xslt / params / olink.debug.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="olink.debug">
7 <refmeta>
8 <refentrytitle>olink.debug</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>olink.debug</refname>
13 <refpurpose>Turn on debugging messages for olinks</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="olink.debug.frag">
18 <xsl:param name="olink.debug" select="0"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>If non-zero, then each olink will generate several
25 messages about how it is being resolved during processing.
26 This is useful when an olink does not resolve properly
27 and the standard error messages are not sufficient to
28 find the problem. 
29 </para>
30
31 <para>You may need to read through the olink XSL templates
32 to understand the context for some of the debug messages.
33 </para>
34
35 </refsection>
36 </refentry>