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