]> git.stg.codes - stg.git/blob - doc/help/xslt/params/olink.base.uri.xml
--stringparam base.path replaces with -o
[stg.git] / doc / help / xslt / params / olink.base.uri.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.base.uri"> 
7 <refmeta> 
8 <refentrytitle>olink.base.uri</refentrytitle> 
9 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> 
10 </refmeta> 
11 <refnamediv> 
12 <refname>olink.base.uri</refname> 
13 <refpurpose>Base URI used in olink hrefs</refpurpose> 
14 </refnamediv> 
15 <refsynopsisdiv> <src:fragment xml:id="olink.base.uri.frag">
16 <xsl:param name="olink.base.uri"></xsl:param>
17 </src:fragment> 
18 </refsynopsisdiv> 
19 <refsection><info><title>Description</title></info> 
20  
21 <para>When cross reference data is collected for resolving olinks, it
22 may be necessary to prepend a base URI to each target's href. This
23 parameter lets you set that base URI when cross reference data is
24 collected. This feature is needed when you want to link to a document
25 that is processed without chunking. The output filename for such a
26 document is not known to the XSL stylesheet; the only target
27 information consists of fragment identifiers such as
28 <literal>#idref</literal>. To enable the resolution of olinks between
29 documents, you should pass the name of the HTML output file as the
30 value of this parameter. Then the hrefs recorded in the cross
31 reference data collection look like
32 <literal>outfile.html#idref</literal>, which can be reached as links
33 from other documents.</para>
34 </refsection> 
35 </refentry>