summaryrefslogtreecommitdiff
path: root/indexing/xindex/doc/xindex-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-11-08 03:02:49 +0000
committerNorbert Preining <norbert@preining.info>2021-11-08 03:02:49 +0000
commitf3bd7117b5dfa4a51d51c4e416c8a656651f1ce2 (patch)
tree5053c95dab175775cc85badf7990ffa535676f23 /indexing/xindex/doc/xindex-doc.tex
parent8389f0bb8e6af2c5dcbfe3cdad746a9c170d1157 (diff)
CTAN sync 202111080302
Diffstat (limited to 'indexing/xindex/doc/xindex-doc.tex')
-rw-r--r--indexing/xindex/doc/xindex-doc.tex31
1 files changed, 16 insertions, 15 deletions
diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex
index 70a8ada370..bfdb23dc43 100644
--- a/indexing/xindex/doc/xindex-doc.tex
+++ b/indexing/xindex/doc/xindex-doc.tex
@@ -1,4 +1,4 @@
-%% $Id: xindex-doc.tex 635 2017-10-24 18:22:59Z herbert $
+%% $Id: xindex-doc.tex 16 2021-11-07 19:42:57Z hvoss $
%
\listfiles\setcounter{errorcontextlines}{100}
\documentclass[paper=a4,fontsize=11pt,DIV=14,parskip=half-,
@@ -80,7 +80,7 @@
\def\setVersion#1{\setVVersion#1!!}
\def\setVVersion#1=#2!!{\def\xIndexVersion{#2}}
-\setVersion{version = 0.33}% can be automatically changed by perl
+\setVersion{version = 0.34}% can be automatically changed by perl
\setkeys{dtk}{cleanup=true,force}
@@ -103,6 +103,7 @@ Michal Hoftich;
Frank Mittelbach;
Heiko Oberdiek;
Matteo Paolini;
+Stefan Pinnow;
Florent Rougon;
Martin Sievers;
Simon Spiegel
@@ -189,7 +190,7 @@ xindex -c norsk -o index.ind demo1 demo2.bdx demo3.adx
\begin{enumerate}
\item \texttt{-q}: quiet; \texttt{-l fr}: french language setting; \texttt{-b}: no labels; \texttt{myDoc}: input data \texttt{myDoc} or \texttt{myDoc.idx)\newline
output data will be \texttt{myDoc.ind} and logfile \texttt{myDoc.ilg}
-\item \texttt{-l de}: german language setting; \texttt{-c DIN2}: config file \texttt{xindex-DIN2.lua}; \texttt{demo1 demo2 demo3}: input data files with or without
+\item \texttt{-l de}: German language setting; \texttt{-c DIN2}: config file \texttt{xindex-DIN2.lua}; \texttt{demo1 demo2 demo3}: input data files with or without
extension \texttt{.idx} \newline
output data will be \texttt{demo1.ind} and logfile \texttt{xindex.ilg}}
\item \texttt{-c norsk}: config file \texttt{xindex-norsk.lua}; \texttt{-o index.ind}: output file; \texttt{demo1 demo2.bdx demo3.adx}: input data files with or without
@@ -244,7 +245,7 @@ like \texttt{ö}$\rightarrow$\texttt{o}.
\subsection{The \texttt{.idx} file}
There are four characters which must be escaped if used in the command \Lcs{index}:
-\verb=!=, \verb=@=, \verb="=, or \verb=|=. These charactzers have a special meaning for
+\verb=!=, \verb=@=, \verb="=, or \verb=|=. These characters have a special meaning for
the index.\index{"!}\index{"@}\index{"|}
The default \Index{escape character} is the double quote \verb|"|:
@@ -300,7 +301,7 @@ run \texttt{xindex <file.idx>}\index{<file.idx>}\index{123}
\end{externalDocument}
-For the german language the double quote is an active character and it makes live easier
+For the German language the double quote is an active character and it makes live easier
if one chooses another character.
The escape character can be changed easily by the optional argument \verb|-e "<char>"| or
\verb|--escapechar "<char">|. The following example shows how
@@ -464,7 +465,7 @@ alphabet_lower = { -- for sorting
There is also a table for the uppercase letters. If it should be edited or extended then copy first the
base configuration file \Lfile{xindex-cfg.lua} and modify that new file. It can be used by \XI
with the optional argument \texttt{-c newfile} if it is named as \Lfile{xindex-newfile.lua}.
-For german there already exists a configuration
+For German there already exists a configuration
file \Lfile{xindex-DIN2.lua} which uses the so-called »Telefonbuchsortierung« which converts
the umlauts like ö$\rightarrow$oe:
@@ -557,9 +558,9 @@ Sorted with \verb|-l DE|
-The same sorted with the german DIN variant 2 with \verb|--config DIN2|, which
+The same sorted with the German DIN variant 2 with \verb|--config DIN2|, which
is part of the \TeX\ distribution. In this case a letter Ö is converted to Oe before sorting
-the word beginninjg with the letter Ö:
+the word beginning with the letter Ö:
\noindent
\begin{externalDocument}[
@@ -570,7 +571,7 @@ the word beginninjg with the letter Ö:
crop,
xindex,
xindexOptions=-c DIN2 -l DE,
- force=false,
+ force=true,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -740,7 +741,7 @@ Sorted with \verb|-u -l cs|
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
+UCA should be don't in the file \Lfile{xindex-cfg-uca.lua}, which will automatically be read
by \Lprog{xindex}.
@@ -767,7 +768,7 @@ folium = {
da = {"f", "ff"},
de = {"f", "ff"},
en = {"f", "ff"},
- fr = {"\\,sq","\\,sqq"},
+ fr = {"\\,sq.","\\,sqq."},
it = {"f", "ff"},
jp = {"シンボル","番号"},
no = {"\\,f.","\\,ff."},
@@ -784,7 +785,7 @@ folium = {
crop,
xindex,
xindexOptions=-l fr,
- force=false,
+ force=true,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -934,7 +935,7 @@ and the file extension \Lext{lua}, for example: \Lfile{xindex-HAdW-eKO.lua} whic
with \verb|--config HAdW-eKO|. The file must be saved in the documents directory or in
one which is known to \Lprog{kpsewhich}, for example\footnote{The directory \texttt{xindex} must be created
before saving the file.} \verb|$TEXMFLOCAL/tex/lualatex/xindex/| %$
-Don not forgot to update the filename database.
+Do not forget to update the filename database.
A new config file must declare at least the variables which are part of the
default config file: the translation tables and
@@ -1249,7 +1250,7 @@ baz\index{foo!bar!baz} foobar%
\section{Including \LaTeX\ commands into the \Lext{idx} file}
The command \Lcs{addtocontents} doesn't work for the index file. With the \LaTeX\ package
\Lpack{xindex} (same name as the Lua program \Lprog{xindex}) defines a macro \Lcs{writeidx}
-which writes its argument into the \Lext{idx} file. This can be usefull to insert a
+which writes its argument into the \Lext{idx} file. This can be useful to insert a
\Index{pagebreak}/""\Index{columnbreak}
before a new letter in the output of the index file:
@@ -1313,7 +1314,7 @@ such commands are ignored. In the following example we put an horizontal line af
\section{Headings}
-By default the output uses the english headings: \textit{Symbols}, \textit{Numbers}, and \textit{A} \ldots
+By default the output uses the English headings: \textit{Symbols}, \textit{Numbers}, and \textit{A} \ldots
There are three predefined languages \texttt{en}, \texttt{de}, and \texttt{fr}. The definition is in the file
\Lfile{xindex-cfg-common.lua} (see also section \vref{language}).
%