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