]> git.stg.codes - stg.git/blob - doc/xslt/params/index.number.separator.xml
Fixed compilaton errors.
[stg.git] / doc / xslt / params / index.number.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="index.number.separator">
7 <refmeta>
8 <refentrytitle>index.number.separator</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>index.number.separator</refname>
13 <refpurpose>Override for punctuation separating page numbers in index</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="index.number.separator.frag">
18 <xsl:param name="index.number.separator"></xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>This parameter permits you to override the text to insert between
25 page references in a formatted index entry.  Typically 
26 that would be a comma and a space.
27 </para>
28
29 <para>Because this text may be locale dependent,
30 this parameter's value is normally taken from a gentext
31 template named 'number-separator' in the
32 context 'index' in the stylesheet
33 locale file for the language
34 of the current document.
35 This parameter can be used to override the gentext string,
36 and would typically be used on the command line.
37 This parameter would apply to all languages.
38 </para>
39
40 <para>So this text string can be customized in two ways.
41 You can reset the default gentext string using
42 the <parameter>local.l10n.xml</parameter> parameter, or you can
43 override the gentext with the content of this parameter.
44 The content can be a simple string, or it can be
45 something more complex such as a call-template.
46 </para>
47
48 <para>In HTML index output, section title references are used instead of
49 page number references.  This punctuation appears between
50 such section titles in an HTML index.
51 </para>
52
53 </refsection>
54 </refentry>