summaryrefslogtreecommitdiff
path: root/indexing/xindex/doc/xindex-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2023-07-01 03:01:25 +0000
committerNorbert Preining <norbert@preining.info>2023-07-01 03:01:25 +0000
commit3a29216caca37803e25b84a50fd5f7f91ebc04d3 (patch)
tree45c329c33b2bc8601810e0983b3590448a3279ec /indexing/xindex/doc/xindex-doc.tex
parent711112a97f2a98854236304a216213632d61eeb7 (diff)
CTAN sync 202307010301
Diffstat (limited to 'indexing/xindex/doc/xindex-doc.tex')
-rw-r--r--indexing/xindex/doc/xindex-doc.tex176
1 files changed, 139 insertions, 37 deletions
diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex
index 767ea1b072..25058bc065 100644
--- a/indexing/xindex/doc/xindex-doc.tex
+++ b/indexing/xindex/doc/xindex-doc.tex
@@ -81,9 +81,9 @@
\def\setVersion#1{\setVVersion#1!!}
\def\setVVersion#1=#2!!{\def\xIndexVersion{#2}}
-\setVersion{version = 0.47}% can be automatically changed by perl
+\setVersion{version = 0.48}% can be automatically changed by perl
-\setkeys{hv}{cleanup=false,force=false}
+\setkeys{hv}{cleanup=true,force=false,ExampleDir=Examples,moveToExampleDir}
\title{Program and package \texttt{xindex} \\--\\ \normalsize \xIndexVersion\ (\today)}
@@ -95,7 +95,8 @@
%\enlargethispage{1cm}
\tableofcontents
-\vfill
+\clearpage
+\bgroup\raggedright
Thanks to: \\
Mark Baudoin;
Denis Bitouzé;
@@ -113,7 +114,8 @@ Stefan Pinnow;
Florent Rougon;
Martin Sievers;
Simon Spiegel;
-Jürhen Spitzmüller;
+Jürgen Spitzmüller;
+\egroup
\clearpage
\section{Introduction}
@@ -181,6 +183,7 @@ xindex
[-o,--output ] default is <input>.ind
[-k,--checklang ] default ist false
[-l,--language ] default is en
+ [-g,--no_pagenumber] default is false
[-p,--prefix] default L
[-u,--use_UCA ] default is false
[-s,--use_stdin ] default is false
@@ -253,7 +256,6 @@ are alphabetized.
compiler=lualatex,
crop,
xindex,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -316,7 +318,6 @@ are converted into the internal strings and later back to the origin meaning.
crop,
xindex,
xindexOptions=-e ">",
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -382,7 +383,6 @@ The following example was run with \verb|xindex -l it <file>.idx|:
crop,
xindex,
xindexOptions=-l it -e ">",
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -427,7 +427,6 @@ the \Lfile{aux} file(s). This is only possible if package \Lpack{babel} or \Lpa
crop,
xindex,
xindexOptions=-k -e "?",
- force=true,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -477,7 +476,6 @@ This allows to have different indexes with different language.
crop,
xindex,
xindexOptions=-u -l RU -c RU,
- force=true,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -616,7 +614,6 @@ alphabet_upper = { -- for sorting
crop,
xindex,
xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
usefancyvrb,
@@ -677,7 +674,6 @@ the word beginning with the letter Ö:
crop,
xindex,
xindexOptions=-c DIN2 -l DE,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -758,7 +754,6 @@ The following runs with \verb|xindex -l jp <file>|:
crop,
xindex,
xindexOptions=-l jp,
- force=false,
runs=2,
code=false,
docType=latex,
@@ -807,6 +802,11 @@ The following runs with \verb|xindex -l jp <file>|:
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.
+The sorting order can be easily 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 don't in the file \Lfile{xindex-cfg-uca.lua}, which will automatically be read
+by \Lprog{xindex}.
+
\begin{externalDocument}[
% grfOptions={width=\dimexpr\linewidth-2\fboxsep-2\fboxrule},
@@ -817,7 +817,6 @@ by Michal Hoftich's Lua package \texttt{LUA-UCA}, which should be part of any \T
crop,
xindex,
xindexOptions=-u -l cs,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -846,10 +845,6 @@ Sorted with \verb|-u -l cs|
\end{document}
\end{externalDocument}
-The sorting order can be easily 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 don't in the file \Lfile{xindex-cfg-uca.lua}, which will automatically be read
-by \Lprog{xindex}.
\subsection{Case sensitive index entries}
@@ -867,7 +862,6 @@ the \verb|xindex-???| series because uppercase letters are sorted before lowerca
crop,
xindex,
% xindexOptions=,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -923,7 +917,6 @@ The same example sorted with the \verb|-a| or \verb|--no_casesensitive| has anot
crop,
xindex,
xindexOptions=-a,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -981,7 +974,6 @@ By default \textsf{alpha sort} will be sorted \emph{before} \textsf{alphaA}:
crop,
xindex,
% xindexOptions=,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1020,7 +1012,6 @@ This can be changed with the optional argument \verb|-i| or \verb|--ignoreSpace|
crop,
xindex,
xindexOptions=-i,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1049,8 +1040,9 @@ Test
-%\clearpage
+\clearpage
+\section{Pagenumbers}
\subsection{Compressing pagenumber series}\label{Compressing}
By default page sequences of an entry are compressed to
\begin{description}
@@ -1088,7 +1080,6 @@ folium = {
crop,
xindex,
xindexOptions=-l fr,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1142,7 +1133,6 @@ of the same type, so we get \texttt{1f} in the output.
crop,
xindex,
xindexOptions=-l de,
- force=false,,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1170,9 +1160,132 @@ und foo\index{foo|fbox}
\end{document}
\end{externalDocument}
+\subsection{Supress Pagenumber}
+Instead of printing an index in the default way, one can also print a glossary without
+the pagenumbers. This is possible with the optional argument \verb|-g| which is equivalent
+to the long form \verb|--no_pagenumber|. The following example uses an own config file for
+the definition of the \Lenv{description} environment:
+\begin{verbatim}
+itemPageDelimiter = ""
+compressPages = true
+fCompress = false
+minCompress = 2
+rangeSymbol = "--"
+numericPage = true
+sublabels = {"", "\\item", "\\item", "\\item"}
+pageNoPrefixDel = ""
+idxnewletter = "\\textbf"
+envStart = "\\begin{description}"
+indexOpening = "\\makeatletter\z
+ \\def\\subitem{\\@idxitem} \\def\\subsubitem{\\@idxitem}\z
+ \\def\\subsubsubitem{\\@idxitem}\z
+ \\makeatother\z
+ \\itemsep 0.1ex" -- commands after envStart
+envStop = "\\end{description}"
+\end{verbatim}
+\begin{externalDocument}[
+% grfOptions={width=\dimexpr\linewidth-2\fboxsep-2\fboxrule},
+% mpwidth=0.55\linewidth,
+ pages={2,3},
+ frame=true,
+ compiler=lualatex,
+ %crop,
+ force=true,
+% xindex,
+% xindexOptions=-c description -g,
+ runs=2,code,docType=latex,
+ showFilename,
+ align=\centering,
+ grfOptions={width=0.45\linewidth},
+ usefancyvrb,
+ %lstOptions={columns=fixed}
+ ]{xindex}
+%! lualatex
+\documentclass{article}
+\usepackage[a5paper]{geometry}
+\usepackage{libertinus}
+\setmonofont{DejaVu Sans Mono}[Scale=0.88,FakeStretch=0.9]
+\makeatletter
+\def\theindex{% only for demonstration
+ \section*{\indexname}
+ \parskip\z@ \@plus .3\p@\relax \parindent\z@
+ \let\item\@idxitem}
+\makeatother
+\begin{filecontents}[force,noheader]{xindex-description.lua}
+itemPageDelimiter = "" -- Hello, 14
+compressPages = true -- something like 12--15, instead of 12,13,14,15. the |( ... |) syntax is still valid
+fCompress = false -- 3f -> page 3, 4 and 3ff -> page 3, 4, 5
+minCompress = 2 -- 1--3
+rangeSymbol = "--"
+numericPage = true -- for non numerical pagenumbers, like "VI-17"
+sublabels = {"", "\\item", "\\item", "\\item"} -- for the (sub(sub(sub-items first one is for item
+pageNoPrefixDel = "" -- a delimiter for page numbers like "VI-17" -- not used !!!
+idxnewletter = "\\textbf" -- Only valid if -n is not set
+envStart = "\\begin{description}"
+indexOpening = "\\makeatletter\z
+ \\def\\subitem{\\@idxitem} \\def\\subsubitem{\\@idxitem} \\def\\subsubsubitem{\\@idxitem}\z
+ \\makeatother\z
+ \\itemsep 0.1ex" -- commands after envStart
+envStop = "\\end{description}"
+
+alphabet_lower = { { 'е', 'ё' } }
+alphabet_upper = { { 'Е', 'Ё' } }
+\end{filecontents}
+%StartVisiblePreamble
+\usepackage[english]{babel}
+\usepackage[imakeidx]{xindex}% run xindex internally
+\makeindex[options= -c description -n -g ] % -g same as --no_pagenumber
+\makeindex[name=gls, options= -c description -n --no_pagenumber]
+%StopVisiblePreamble
+\pagestyle{empty}
+\begin{document}
+Abbreviations:
+
+XAS,\index{XAS --- X-ray absorption spectroscopy.}
+XAFS,\index{XAFS --- Extended x-ray absorption fine structure.}
+EXAFS,\index{EXAFS --- Extended x-ray absorption fine structure.}
+XANES,\index{XANES --- X-ray absorption near edge structure.}
+PES,\index{PES --- Photo emission spectroscopy.}
+ARPES,\index{ARPES --- Angle resolved photo electron spectroscopy.}
+SCES,\index{SCES --- Strongly correlated tlectron systems.}
+HTSC,\index{HTSC --- High temperature superconductivity.}
+MOCVD,\index{MOCVD --- Metalorganic chemical vapour deposition.}
+PLD.\index{PLD ---Pulsed laser deposition.}
+
+\smallskip Terms.
+
+Fermions:
+\index[gls]{Fermions@[Fermions]}%
+\index[gls]{Fermions@[Fermions]![\sf Fermion] --- a particle with a
+ half-odd-integer spin $S$.}electron,
+\index[gls]{Fermions@[Fermions]![\sf Electron] --- a subatomic particle
+ with a negative elementary electric charge: $S=1/2$.}proton,
+\index[gls]{Fermions@[Fermions]![\sf Proton] --- a subatomic particle with a
+ positive elementary electric charge: $S=1/2$.}positron,
+\index[gls]{Fermions@[Fermions]![\sf Positron] --- a particle with a positive
+ elementary electric charge, and the same mass as an electron: $S=1/2$.}neutron,
+\index[gls]{Fermions@[Fermions]![\sf Neutron] --- a subatomic electrically
+ neutral particle: $S=1/2$.}neutrino.
+\index[gls]{Fermions@[Fermions]![\sf Neutrino] --- an elementary electrically
+ neutral particle with very small rest mass: $S=1/2$.}
+
+Bosons:
+\index[gls]{Bosons@[Bosons]}%
+\index[gls]{Bosons@[Bosons]![\sf Boson] --- a particle with an
+integer spin $S$.}photon,
+\index[gls]{Bosons@[Bosons]![\sf Photon] --- a quantum of the
+electromagnetic field: $S=1$.}meson,
+\index[gls]{Bosons@[Bosons]![\sf Meson] --- a hadronic subatomic particle
+composed of an equal number of quarks and antiquarks: $S=0$.}pion.
+\index[gls]{Bosons@[Bosons]![\sf Pion] --- any of $\pi^0$-, $\pi^+$-,
+ $\pi^-$- mesons consisting of quark and antiquark: $S=0$.}
+\printindex
+\printindex[gls]
+\end{document}
+\end{externalDocument}
@@ -1261,7 +1374,6 @@ Internally exists a function \verb|compressPageList| which is used if no
crop,
xindex,
xindexOptions=-c HAdW-eKO,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1382,7 +1494,6 @@ The following example runs \verb|xindex -c dtk -l de -n <input>|
crop,
xindex,
xindexOptions=-c dtk -n -l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1455,7 +1566,6 @@ no limit for \Lprog{xindex}.
crop,
xindex,
% xindexOptions=,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1490,7 +1600,7 @@ baz\index{foo!bar!baz} foobar%
-
+\clearpage
\section{\texttt{hyperref}}
@@ -1507,7 +1617,6 @@ Using the package \Lpack{hyperref} is no problem:
crop,
xindex,
xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1584,7 +1693,6 @@ such commands are ignored. In the following example we put an horizontal line af
crop,
xindex,
xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1632,7 +1740,6 @@ the vertical space between different first letters:
crop,
xindex,
xindexOptions=-n,
- force=false,,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1684,7 +1791,6 @@ In the documents preamble there is the definition:
crop,
xindex,
xindexOptions=-c header,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1813,7 +1919,7 @@ run \verb|xindex -c header <file.idx>|
\end{externalDocument}
-
+\clearpage
\section{Automatic index creation}
@@ -1830,7 +1936,6 @@ and adds the program \Lprog{xindex} as the default program to \Lpack{imakeidx}.
crop,
xindex,
xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1932,7 +2037,6 @@ in the argument of \Lcs{indexentry}.
crop,
xindex,
xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1982,7 +2086,6 @@ Duplicate alpha beta gamma.\index{alpha!beta!gamma}
crop,
xindex,
xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -2020,7 +2123,6 @@ Test \index{A!Test} oder auch \index{B!Test}
crop,
xindex,
% xindexOptions=-l de,
- force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,