summaryrefslogtreecommitdiff
path: root/indexing/xindex/doc/xindex-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'indexing/xindex/doc/xindex-doc.tex')
-rw-r--r--indexing/xindex/doc/xindex-doc.tex69
1 files changed, 62 insertions, 7 deletions
diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex
index 6502c3deac..050d21dca2 100644
--- a/indexing/xindex/doc/xindex-doc.tex
+++ b/indexing/xindex/doc/xindex-doc.tex
@@ -80,7 +80,7 @@
\def\setVersion#1{\setVVersion#1!!}
\def\setVVersion#1=#2!!{\def\xIndexVersion{#2}}
-\setVersion{version = 0.22}% can be automatically changed by perl
+\setVersion{version = 0.23}% can be automatically changed by perl
\setkeys{dtk}{cleanup=true,force=false}
@@ -94,6 +94,8 @@
\vfill
Thanks to: \\
Mark Baudoin;
+Denis Bitouzé;
+Michal Hoftich;
Heiko Oberdiek;
Matteo Paolini
@@ -162,6 +164,7 @@ xindex
[-o,--output ] default is <input>.ind
[-l,--language ] default is en
[-p,--prefix] default L
+ [-u,--use_UCA ] default is false
<input file>
\end{verbatim}
@@ -306,11 +309,13 @@ The predefined language is »en« and currently the following languages are poss
{\Japanese
\begin{Verbatim}[fontfamily=helvetica,commandchars=\\<>]
indexheader = {
+ cs = {"Symboly", "Čísla"},
+ da = {"Symboler", "Tal"},
de = {"Symbole", "Zahlen"},
en = {"Symbols", "Numbers"},
- fr = {"Symboles","Chiffre"},
+ fr = {"Symboles","Nombres"},
it = {"Simboli", "Numeri"},
-\Japanese jp = {"シンボル","番号"},
+ jp = {"シンボル","番号"},
}
\end{Verbatim}
}
@@ -325,7 +330,7 @@ The following example was run with \verb|xindex -l it <file>.idx|:
crop,
xindex,
xindexOptions=-l it -e ">",
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -358,7 +363,7 @@ Run \texttt{xindex} with \texttt{xindex -l it -e ">"}\index{123}
\section{Sorting}
-
+\subsection{Default sorting by a character table}
The default sorting is unicode aware and uses a translation table for accented characters:
\begin{verbatim}
@@ -624,6 +629,54 @@ The following runs with \verb|xindex -l jp <file>|:
\end{externalDocument}
\end{minipage}
+\subsection{Sorting by using UCA (Unicode Collation Algorithm)}
+With the optional argument \verb|-u| or alternatively \verb|--use_UCA| the sorting will be done
+by Michal Hoftich's Lua package \texttt{LUA-UCA}, which should be part of any \TeX{} installation.
+
+
+\begin{externalDocument}[
+% grfOptions={width=\dimexpr\linewidth-2\fboxsep-2\fboxrule},
+ mpwidth=0.55\linewidth,
+% pages={6},
+ frame=false,
+ compiler=lualatex,
+ crop,
+ xindex,
+ xindexOptions=-u -l cs,
+ force=true,
+ runs=2,code,docType=latex,
+ showFilename,
+ align=\centering,
+ lstOptions={columns=fixed}]{xindex}
+\documentclass[paper=a6]{scrartcl}
+\makeatletter
+\def\theindex{% only for demonstration
+ \section*{\indexname}
+ \parskip\z@ \@plus .3\p@\relax \parindent\z@
+ \let\item\@idxitem}
+\makeatother
+%StartVisiblePreamble
+\usepackage{multicol}
+\usepackage{makeidx}\makeindex
+\def\Index#1{#1\index{#1}}
+%StopVisiblePreamble
+\pagestyle{empty}
+\begin{document}
+Sorted with \verb|-u -l cs|
+\Index{ahoj} \Index{crha}, \Index{čaj}, \Index{chachar},
+\Index{rak}, \Index{řeka}, \Index{srp}, \Index{šutr},
+\Index{hudba}, \Index{linux}, \Index{zebra},
+\Index{žába}, \Index{7 dubů}
+\begin{multicols}{2} \printindex \end{multicols}
+\end{document}
+\end{externalDocument}
+
+The sorting order can be easliy modified. Read the documentation of the package \texttt{LUA-UCA}
+on how to do it and what languages are supported so far. Any additional code setting for
+UCA should be dont in the file \Lfile{xindex-cfg-uca.lua}, which will automatically be read
+by \Lprog{xindex}.
+
+
%\clearpage
@@ -643,12 +696,14 @@ file \Lfile{xindex-cfg-common.cfg}:
\small
\begin{Verbatim}[fontfamily=helvetica]
folium = {
+ cs = {"f.", "ff."},
+ da = {"f", "ff"},
de = {"f", "ff"},
en = {"f", "ff"},
- fr = {"\,sq","\,sqq"},
+ fr = {"\\,sq","\\,sqq"},
it = {"f", "ff"},
- no = {"\\,f.","\\,ff."},
jp = {"シンボル","番号"},
+ no = {"\\,f.","\\,ff."},
}
\end{Verbatim}
}