+++ /dev/null
-<refentry xmlns="http://docbook.org/ns/docbook"\r
- xmlns:xlink="http://www.w3.org/1999/xlink"\r
- xmlns:xi="http://www.w3.org/2001/XInclude"\r
- xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
- version="5.0" xml:id="index.method">\r
-<refmeta>\r
-<refentrytitle>index.method</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>\r
-<refmiscinfo class="other" otherclass="value">basic</refmiscinfo>\r
-<refmiscinfo class="other" otherclass="value">kosek</refmiscinfo>\r
-<refmiscinfo class="other" otherclass="value">kimber</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>index.method</refname>\r
-<refpurpose>Select method used to group index entries in an index</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="index.method.frag">\r
-<xsl:param name="index.method">basic</xsl:param>\r
-</src:fragment>\r
-</refsynopsisdiv>\r
-\r
-<refsection><info><title>Description</title></info>\r
-\r
-<para>This parameter lets you select which method to use for sorting and grouping\r
- index entries in an index.\r
-Indexes in Latin-based languages that have accented characters typically\r
-sort together accented words and unaccented words.\r
-Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort together\r
-with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in the <quote>A</quote>\r
-section of the index.\r
-Languages using other alphabets (such as Russian, which is written in the Cyrillic alphabet)\r
-and languages using ideographic chararacters (such as Japanese)\r
-require grouping specific to the languages and alphabets.\r
-</para>\r
-\r
-<para>The default indexing method is limited.\r
-It can group accented characters in Latin-based languages only.\r
-It cannot handle non-Latin alphabets or ideographic languages.\r
-The other indexing methods require extensions of one type or\r
-another, and do not work with\r
-all XSLT processors, which is why they are not used by default.</para>\r
-\r
-<para>The three choices for indexing method are:</para>\r
-<variablelist>\r
-<varlistentry>\r
-<term><literal>basic</literal></term>\r
-<listitem>\r
-<para>\r
-(default) Sort and groups words based only on the Latin alphabet.\r
-Words with accented Latin letters will group and sort with\r
-their respective primary letter, but\r
-words in non-Latin alphabets will be\r
-put in the <quote>Symbols</quote> section of the index.\r
-</para>\r
-</listitem>\r
-</varlistentry>\r
-<varlistentry>\r
-<term><literal>kosek</literal></term>\r
-<listitem>\r
-<para>\r
-This method sorts and groups words based on letter groups configured in\r
-the DocBook locale file for the given language.\r
-See, for example, the French locale file <filename>common/fr.xml</filename>.\r
-This method requires that the XSLT processor\r
-supports the EXSLT extensions (most do).\r
-It also requires support for using \r
-user-defined functions in xsl:key (xsltproc does not).\r
-</para>\r
-<para>This method is suitable for any language for which you can\r
-list all the individual characters that should appear\r
-in each letter group in an index.\r
-It is probably not practical to use it for ideographic languages\r
-such as Chinese that have hundreds or thousands of characters.\r
-</para>\r
-\r
-<para>To use the kosek method, you must:</para>\r
-\r
-<orderedlist>\r
-<listitem>\r
-<para>Use a processor that supports its extensions, such as\r
-Saxon 6 or Xalan (xsltproc and Saxon 8 do not).\r
-</para>\r
-</listitem>\r
-<listitem>\r
-<para>Set the index.method parameter's value to <quote>kosek</quote>.\r
-</para>\r
-</listitem>\r
-<listitem>\r
-<para>Import the appropriate index extensions stylesheet module\r
-<filename>fo/autoidx-kosek.xsl</filename> or \r
-<filename>html/autoidx-kosek.xsl</filename> into your\r
-customization.\r
-</para>\r
-</listitem>\r
-</orderedlist>\r
-\r
-</listitem>\r
-</varlistentry>\r
-<varlistentry>\r
-<term><literal>kimber</literal></term>\r
-<listitem>\r
-<para>\r
-This method uses extensions to the Saxon processor to implement\r
-sophisticated indexing processes. It uses its own \r
-configuration file, which can include information for any number of\r
-languages. Each language's configuration can group\r
-words using one of two processes. In the\r
-enumerated process similar to that used in the kosek method,\r
-you indicate the groupings character-by-character.\r
-In the between-key process, you specify the\r
-break-points in the sort order that should start a new group.\r
-The latter configuration is useful for ideographic languages\r
-such as Chinese, Japanese, and Korean.\r
-You can also define your own collation algorithms and how you\r
-want mixed Latin-alphabet words sorted.</para>\r
-<itemizedlist>\r
-<listitem>\r
-<para>For a whitepaper describing the extensions, see:\r
-<link xlink:href="http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://www.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf</link>.\r
-</para>\r
-</listitem>\r
-<listitem>\r
-<para>To download the extension library, see\r
-<link xlink:href="http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-isogen.com/knowledge_center/tools_downloads/i18nsupport</link>.\r
-</para>\r
-</listitem>\r
-</itemizedlist>\r
-\r
-<para>To use the kimber method, you must:</para>\r
-\r
-<orderedlist>\r
-<listitem>\r
-<para>Use Saxon (version 6 or 8) as your XSLT processor.\r
-</para>\r
-</listitem>\r
-<listitem>\r
-<para>Install and configure the Innodata Isogen library, using\r
-the documentation that comes with it.\r
-</para>\r
-</listitem>\r
-<listitem>\r
-<para>Set the index.method parameter's value to <quote>kimber</quote>.\r
-</para>\r
-</listitem>\r
-<listitem>\r
-<para>Import the appropriate index extensions stylesheet module\r
-<filename>fo/autoidx-kimber.xsl</filename> or \r
-<filename>html/autoidx-kimber.xsl</filename> into your\r
-customization.\r
-</para>\r
-</listitem>\r
-</orderedlist>\r
-\r
-</listitem>\r
-</varlistentry>\r
-</variablelist>\r
-\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff