]> git.stg.codes - stg.git/blob - doc/xslt/params/collect.xref.targets.xml
Help book chapter 2 complete
[stg.git] / doc / xslt / params / collect.xref.targets.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="collect.xref.targets"> 
7 <refmeta> 
8 <refentrytitle>collect.xref.targets</refentrytitle> 
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
10 <refmiscinfo class="other" otherclass="value">no</refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
12 <refmiscinfo class="other" otherclass="value">only</refmiscinfo>
13 </refmeta> 
14 <refnamediv> 
15 <refname>collect.xref.targets</refname> 
16 <refpurpose>Controls whether cross reference data is
17 collected</refpurpose> 
18 </refnamediv> 
19 <refsynopsisdiv> <src:fragment xml:id="collect.xref.targets.frag">
20 <xsl:param name="collect.xref.targets">no</xsl:param>
21 </src:fragment> 
22 </refsynopsisdiv> 
23 <refsection><info><title>Description</title></info> 
24  
25 <para>
26 In order to resolve olinks efficiently, the stylesheets can
27 generate an external data file containing information about
28 all potential cross reference endpoints in a document.
29 This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is  <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output.
30 See also <parameter>targets.filename</parameter>.
31 </para> 
32 </refsection> 
33 </refentry>