]> git.stg.codes - stg.git/blob - doc/xslt/params/use.local.olink.style.xml
Adjusted XML RPC documentation.
[stg.git] / doc / xslt / params / use.local.olink.style.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="use.local.olink.style"> 
7 <refmeta> 
8 <refentrytitle>use.local.olink.style</refentrytitle> 
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> 
10 </refmeta> 
11 <refnamediv> 
12 <refname>use.local.olink.style</refname> 
13 <refpurpose>Process olinks using xref style of current
14 document</refpurpose> 
15 </refnamediv> 
16 <refsynopsisdiv> <src:fragment xml:id="use.local.olink.style.frag">
17 <xsl:param name="use.local.olink.style" select="0"/> </src:fragment> 
18 </refsynopsisdiv> 
19 <refsection><info><title>Description</title></info> 
20  
21 <para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross
22 reference string is formed again from the target title, number, and
23 element name, using the stylesheet processing the targeting document.
24 Then olinks will match the xref style in the targeting document
25 rather than in the target document. If  both documents are processed
26 with the same stylesheet, then the results will be the same.</para> 
27 </refsection> 
28 </refentry>