From f008fc632f906448b4bdbc5cd96ab7d98e68b0b9 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Thu, 8 Jul 2021 03:00:51 +0000 Subject: CTAN sync 202107080300 --- indexing/xindex/doc/xindex-doc.tex | 74 +++++++++++++++++++++++++++++++++----- 1 file changed, 65 insertions(+), 9 deletions(-) (limited to 'indexing/xindex/doc/xindex-doc.tex') diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex index 71f6139d4f..8adac4c59c 100644 --- a/indexing/xindex/doc/xindex-doc.tex +++ b/indexing/xindex/doc/xindex-doc.tex @@ -1,7 +1,7 @@ %% $Id: xindex-doc.tex 635 2017-10-24 18:22:59Z herbert $ % \listfiles\setcounter{errorcontextlines}{100} -\documentclass[paper=a4,fontsize=11pt,DIV=13,parskip=half-, +\documentclass[paper=a4,fontsize=11pt,DIV=14,parskip=half-, captions=tableabove,twoside=on]{scrartcl} \usepackage{fontspec} %\usepackage{libertinus-otf} @@ -53,6 +53,7 @@ \def\Lpack#1{\texttt{#1}\index{#1 package@\texttt{#1} package}} \def\Lprog#1{\texttt{#1}\index{#1 program@\texttt{#1} program}} \def\Loption#1{\texttt{#1}\index{#1@\texttt{#1} package option}} +\def\Largb#1{\emph{\{#1\}}} %\usepackage[bibstyle=dtk]{biblatex} %\addbibresource{\jobname.bib} @@ -80,9 +81,9 @@ \def\setVersion#1{\setVVersion#1!!} \def\setVVersion#1=#2!!{\def\xIndexVersion{#2}} -\setVersion{version = 0.29}% can be automatically changed by perl +\setVersion{version = 0.30}% can be automatically changed by perl -\setkeys{dtk}{cleanup=true,force=false} +\setkeys{dtk}{cleanup=true,force} \title{Program and package \texttt{xindex} \\--\\ \normalsize \xIndexVersion\ (\today)} @@ -101,7 +102,8 @@ Denis Bitouzé; Brian Dunn; Michal Hoftich; Heiko Oberdiek; -Matteo Paolini; +Matteo Paolini;\\ +Florent Rougon; Martin Sievers; Simon Spiegel @@ -165,7 +167,8 @@ xindex [-v ] verbose [-c,--config ] default is cfg [-e,--escapechar ] default is " - [-a, --nocasesensitive ] default is false + [-a, --no_casesensitive ] default is false + [-b,--no_labels ] default is false [-n,--noheadings ] default is false [-o,--output ] default is .ind [-l,--language ] default is en @@ -174,6 +177,32 @@ xindex \end{verbatim} +For example: + +\begin{verbatim} +xindex -q -l fr -b myDoc +\end{verbatim} + +\iffalse +local args = require ('xindex-lapp') [[ + parameter handling + -q,--quiet + -h,--help + -v... Verbosity level; can be -v, -vv, -vvv + -c,--config (default cfg) + -e,--escapechar (default ") + -n,--noheadings + -a,--no_casesensitive + -b,--no_labels + -o,--output (default "") + -l,--language (default en) + -p,--prefix (default L) + -u,--use_UCA + (string) +]] +\fi + + The \Index{language} has to be chosen as an international abbreviation in lower- or uppercase letters, see @@ -656,7 +685,7 @@ by Michal Hoftich's Lua package \texttt{LUA-UCA}, which should be part of any \T crop, xindex, xindexOptions=-u -l cs, - force=true, + force=false, runs=2,code,docType=latex, showFilename, align=\centering, @@ -1079,7 +1108,7 @@ The following example runs \verb|xindex -c dtk -l de -n | crop, xindex, xindexOptions=-c dtk -n -l de, - force=false, + force, runs=2,code,docType=latex, showFilename, align=\centering, @@ -1134,7 +1163,7 @@ The following example runs \verb|xindex -c dtk -l de -n | %StopVisiblePreamble \pagestyle{empty} \begin{document} -\mbox{}\ref{president} +\mbox{}\label{president} \printindex \end{document} \end{externalDocument} @@ -1586,7 +1615,7 @@ and adds the program \Lprog{xindex} as the default program to \Lpack{imakeidx}. crop, xindex, xindexOptions=-l de, - force=true, + force=false, runs=2,code,docType=latex, showFilename, align=\centering, @@ -1640,6 +1669,33 @@ foo\index[persons]{Volovich,~ Vladimir} You have to run \LaTeX\ with the \verb|--shell-escape|\index{Shell escape} option to run \Lprog{xindex} from within the \LaTeX\ document. + +\section{Labels} +By default \XI creates \Index{label}s in the index for the \Index{symbols}, \Index{numbers}, and other parts (letters) to which one can refer. +with \Lcs{ref}\Largb{label}. +The labels are named \verb|L-xindex-|. The prefix \verb|L| can be changed by the config file. \verb|| +maybe \verb|symbols|, \verb|numbers|, or \verb|A| (a letter). For example + +\begin{verbatim} +\begin{theindex} +\par\textbf{Symbols}\label{L-xindex-symbols} +\nopagebreak[4] + \item @, \hyperpage{3} + \item (, \hyperpage{3} + \item !, \hyperpage{3} + +\indexspace +\textbf{A}\label{L-xindex-A} +[...] +\end{verbatim} + +The labels can be used to create a reference to a specific part in the index, for example the +letter X is in the index on page \pageref{L-xindex-X} (\Lcs{pageref}\Largb{L-xindex-X}). + +With the optional argument \verb|-b| for the run of \XI one can supress the creation of the +labels, e.g. \verb|xindex -b -l fr ...| + + \section{Demerits} \begin{itemize} \item For more than 5000 entries in the \Lext{idx} file the internal Lua function -- cgit v1.2.3