]> git.stg.codes - stg.git/blobdiff - doc/help/xslt/params/collect.xref.targets.xml
DocBook documentation stub added
[stg.git] / doc / help / xslt / params / collect.xref.targets.xml
diff --git a/doc/help/xslt/params/collect.xref.targets.xml b/doc/help/xslt/params/collect.xref.targets.xml
new file mode 100644 (file)
index 0000000..378c969
--- /dev/null
@@ -0,0 +1,33 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="collect.xref.targets"> 
+<refmeta> 
+<refentrytitle>collect.xref.targets</refentrytitle> 
+<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
+<refmiscinfo class="other" otherclass="value">no</refmiscinfo>
+<refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
+<refmiscinfo class="other" otherclass="value">only</refmiscinfo>
+</refmeta> 
+<refnamediv> 
+<refname>collect.xref.targets</refname> 
+<refpurpose>Controls whether cross reference data is
+collected</refpurpose> 
+</refnamediv> 
+<refsynopsisdiv> <src:fragment xml:id="collect.xref.targets.frag">
+<xsl:param name="collect.xref.targets">no</xsl:param>
+</src:fragment> 
+</refsynopsisdiv> 
+<refsection><info><title>Description</title></info> 
+<para>
+In order to resolve olinks efficiently, the stylesheets can
+generate an external data file containing information about
+all potential cross reference endpoints in a document.
+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.
+See also <parameter>targets.filename</parameter>.
+</para> 
+</refsection> 
+</refentry>