From: Bob Stayton <bobs@sagehill.net>
Date: Thu, 29 Sep 2005 07:11:37 +0000 (+0000)
Subject: Added parameters to localize punctuation in indexes.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=26df9bba614f507ee1cc1ffcfb39ab478e1ce161;p=docbook-dsssl

Added parameters to localize punctuation in indexes.
---

diff --git a/xsl/params/index.number.separator.xml b/xsl/params/index.number.separator.xml
new file mode 100644
index 000000000..1e516b9a7
--- /dev/null
+++ b/xsl/params/index.number.separator.xml
@@ -0,0 +1,46 @@
+<refentry id="index.number.separator">
+<refmeta>
+<refentrytitle>index.number.separator</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>index.number.separator</refname>
+<refpurpose>Punctuation separating page numbers in index</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='index.number.separator.frag'>
+<xsl:param name="index.number.separator">
+  <xsl:call-template name="gentext.template">
+    <xsl:with-param name="context">index</xsl:with-param>
+    <xsl:with-param name="name">number-separator</xsl:with-param>
+  </xsl:call-template>
+</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>This parameter contains the text to insert between
+page references in a formatted index entry.  Typically 
+that would be a comma and a space.
+</para>
+
+<para>Because this text may be locale dependent,
+this parameter's value is taken from a gentext
+template named 'number-separator' in the
+context 'index' in the stylesheet
+locale file for the language
+of the current document.
+</para>
+
+<para>So this text string can be customized in two ways.
+You can override the default gentext string using
+the <parameter>local.l10n.xml</parameter> parameter, or you can
+directly replace the content of this parameter.
+The content can be a simple string, or it can be
+something more complex such as a call-template.
+</para>
+
+</refsect1>
+</refentry>
diff --git a/xsl/params/index.range.separator.xml b/xsl/params/index.range.separator.xml
new file mode 100644
index 000000000..004cc1c3e
--- /dev/null
+++ b/xsl/params/index.range.separator.xml
@@ -0,0 +1,49 @@
+<refentry id="index.range.separator">
+<refmeta>
+<refentrytitle>index.range.separator</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>index.range.separator</refname>
+<refpurpose>Punctuation separating the two numbers
+in a page range in index</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='index.range.separator.frag'>
+<xsl:param name="index.range.separator">
+  <xsl:call-template name="gentext.template">
+    <xsl:with-param name="context">index</xsl:with-param>
+    <xsl:with-param name="name">range-separator</xsl:with-param>
+  </xsl:call-template>
+</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>This parameter contains the text to insert between
+the two numbers of a page range in an index.
+This parameter is only used by those XSL-FO processors
+that support an extension for generating such page ranges
+(such as XEP).
+</para>
+
+<para>Because this text may be locale dependent,
+this parameter's value is taken from a gentext
+template named 'range-separator' in the
+context 'index' in the stylesheet
+locale file for the language
+of the current document.
+</para>
+
+<para>So this text string can be customized in two ways.
+You can override the default gentext string using
+the <parameter>local.l10n.xml</parameter> parameter, or you can
+directly replace the content of this parameter.
+The content can be a simple string, or it can be
+something more complex such as a call-template.
+</para>
+
+</refsect1>
+</refentry>
diff --git a/xsl/params/index.term.separator.xml b/xsl/params/index.term.separator.xml
new file mode 100644
index 000000000..cff276116
--- /dev/null
+++ b/xsl/params/index.term.separator.xml
@@ -0,0 +1,49 @@
+<refentry id="index.term.separator">
+<refmeta>
+<refentrytitle>index.term.separator</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>index.term.separator</refname>
+<refpurpose>Punctuation separating an index term 
+from its list of page references in an index</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='index.term.separator.frag'>
+<xsl:param name="index.term.separator">
+  <xsl:call-template name="gentext.template">
+    <xsl:with-param name="context">index</xsl:with-param>
+    <xsl:with-param name="name">term-separator</xsl:with-param>
+  </xsl:call-template>
+</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>This parameter contains 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 taken from a gentext
+template named 'term-separator' in the
+context 'index' in the stylesheet
+locale file for the language
+of the current document.
+</para>
+
+<para>So this text string can be customized in two ways.
+You can override the default gentext string using
+the <parameter>local.l10n.xml</parameter> parameter, or you can
+directly replace the content of this 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 <sgmltag>fo:leader</sgmltag>
+element to provide space of a specific length, or a dot leader.
+</para>
+
+</refsect1>
+</refentry>