55 lines
1.9 KiB
XML
55 lines
1.9 KiB
XML
|
<refentry xmlns="http://docbook.org/ns/docbook"
|
||
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||
|
|
xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
|
||
|
|
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||
|
|
version="5.0" xml:id="index.term.separator">
|
||
|
|
<refmeta>
|
||
|
|
<refentrytitle>index.term.separator</refentrytitle>
|
||
|
|
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>index.term.separator</refname>
|
||
|
|
<refpurpose>Override for punctuation separating an index term
|
||
|
|
from its list of page references in an index</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
|
||
|
|
<refsynopsisdiv>
|
||
|
|
<src:fragment xml:id="index.term.separator.frag">
|
||
|
|
<xsl:param name="index.term.separator"></xsl:param>
|
||
|
|
</src:fragment>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
|
||
|
|
<refsection><info><title>Description</title></info>
|
||
|
|
|
||
|
|
<para>This parameter permits you to override
|
||
|
|
the text to insert between
|
||
|
|
the end of an index term and its list of page references.
|
||
|
|
Typically that might be a comma and a space.
|
||
|
|
</para>
|
||
|
|
|
||
|
|
<para>Because this text may be locale dependent,
|
||
|
|
this parameter's value is normally taken from a gentext
|
||
|
|
template named 'term-separator' in the
|
||
|
|
context 'index' in the stylesheet
|
||
|
|
locale file for the language
|
||
|
|
of the current document.
|
||
|
|
This parameter can be used to override the gentext string,
|
||
|
|
and would typically be used on the command line.
|
||
|
|
This parameter would apply to all languages.
|
||
|
|
</para>
|
||
|
|
|
||
|
|
<para>So this text string can be customized in two ways.
|
||
|
|
You can reset the default gentext string using
|
||
|
|
the <parameter>local.l10n.xml</parameter> parameter, or you can
|
||
|
|
fill in the content for this normally empty
|
||
|
|
override parameter.
|
||
|
|
The content can be a simple string, or it can be
|
||
|
|
something more complex such as a call-template.
|
||
|
|
For fo output, it could be an <tag>fo:leader</tag>
|
||
|
|
element to provide space of a specific length, or a dot leader.
|
||
|
|
</para>
|
||
|
|
|
||
|
|
</refsection>
|
||
|
|
</refentry>
|