]> git.stg.codes - stg.git/blob - doc/xslt/params/xref.label-page.separator.xml
Documentation updated (DocBook)
[stg.git] / doc / xslt / params / xref.label-page.separator.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="xref.label-page.separator">
7 <refmeta>
8 <refentrytitle>xref.label-page.separator</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>xref.label-page.separator</refname>
13 <refpurpose>Punctuation or space separating label from page number in xref</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="xref.label-page.separator.frag"><xsl:param name="xref.label-page.separator"><xsl:text> </xsl:text></xsl:param></src:fragment>
18 </refsynopsisdiv>
19
20 <refsection><info><title>Description</title></info>
21
22 <para>
23 This parameter allows you to control the punctuation of certain
24 types of generated cross reference text.
25 When cross reference text is generated for an 
26 <tag class="element">xref</tag> or 
27 <tag class="element">olink</tag> element
28 using an <tag class="attribute">xrefstyle</tag> attribute
29 that makes use of the <literal>select:</literal> feature,
30 and the selected components include both label and page
31 but no title,
32 then the value of this parameter is inserted between
33 label and page number in the output.  
34 If a title is included, then other separators are used.
35 </para>
36
37 </refsection>
38 </refentry>