summaryrefslogtreecommitdiff
path: root/indexing/xindex/doc/xindex-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-10-29 03:00:39 +0000
committerNorbert Preining <norbert@preining.info>2019-10-29 03:00:39 +0000
commit97f5151099967e6c823d640a90d87bca92c44035 (patch)
tree685caa49488599f87d0caa4e972833b2263d8567 /indexing/xindex/doc/xindex-doc.tex
parent25a647b97ef526aefcc75269dd19c46dbe3ae4c1 (diff)
CTAN sync 201910290300
Diffstat (limited to 'indexing/xindex/doc/xindex-doc.tex')
-rw-r--r--indexing/xindex/doc/xindex-doc.tex85
1 files changed, 45 insertions, 40 deletions
diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex
index c5762e2559..c4d41aca5e 100644
--- a/indexing/xindex/doc/xindex-doc.tex
+++ b/indexing/xindex/doc/xindex-doc.tex
@@ -4,6 +4,7 @@
\documentclass[paper=a4,fontsize=11pt,DIV=13,parskip=half-,
captions=tableabove,twoside=on]{scrartcl}
\usepackage{fontspec}
+%\usepackage{libertinus-otf}
\setmainfont{AccanthisADFStdNo3}[
UprightFont =*-Regular,
BoldFont =*-Bold,
@@ -79,14 +80,21 @@
\def\setVersion#1{\setVVersion#1!!}
\def\setVVersion#1=#2!!{\def\xIndexVersion{#2}}
-\setVersion{version = 0.16}% can be autimatically changed by perl
+\setVersion{version = 0.18}% can be autimatically changed by perl
+
+\setkeys{dtk}{cleanup=true,force=false}
+
\title{Program and package \texttt{xindex} \\--\\ \normalsize \xIndexVersion\ (\today)}
-\author{Herbert Voß\thanks{hvoss@tug.org}}
+\author{\shortstack{Herbert Voß\\\small \href{mailto:hvoss@tug.org}{hvoss@tug.org}}}
\begin{document}
\maketitle
\tableofcontents
+\vfill
+Thanks to: \\
+Mark Baudin;
+Heiko Oberdiek
\clearpage
@@ -194,7 +202,7 @@ are alphabetized.
compiler=lualatex,
crop,
xindex,
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -255,7 +263,7 @@ are converted into the internal strings and later back to the origin meaning.
crop,
xindex,
xindexOptions=-e ">",
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -294,15 +302,15 @@ They are by default \emph{Symbols} followed by \emph{Numbers}. In a new version
it will be customizable.
The predefined language is »en« and currently the following languages are possible:
-
-{\Japanese\small
-indexheader = \{ \\
-\quad de = \{\"{}Symbole\"{}, \"{}Zahlen\"{}\},\\
-\quad en = \{\"{}Symbols\"{}, \"{}Numbers\"{}\},\\
-\quad fr = \{\"{}Symboles\"{},\"{}Chiffre\"{}\},\\
-\quad jp = \{\"{}シンボル\"{},\"{}番号\"{}\},\\
-\}
-%\end{verbatim}
+{\Japanese
+\begin{Verbatim}[fontfamily=helvetica,commandchars=\\<>]
+indexheader = {
+ de = {"Symbole", "Zahlen"},
+ en = {"Symbols", "Numbers"},
+ fr = {"Symboles","Chiffre"},
+\Japanese jp = {"シンボル","番号"},
+}
+\end{Verbatim}
}
The following example was run with \verb|xindex -l de <file>.idx|:
@@ -315,7 +323,7 @@ The following example was run with \verb|xindex -l de <file>.idx|:
crop,
xindex,
xindexOptions=-l de -e ">",
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -354,33 +362,34 @@ The default sorting is unicode aware and uses a translation table for accented c
\begin{verbatim}
alphabet_lower = { -- for sorting
{ ' ' }, -- only for internal tests
- { 'a', 'á', 'à', 'ä', 'å', 'æ', },
+ { 'a', 'á', 'à', 'ä', 'â', 'å', 'æ', },
{ 'b' },
{ 'c', 'ç' },
{ 'd' },
- { 'e', 'é', 'è', 'ë' },
+ { 'e', 'é', 'è', 'ë', 'ê' },
{ 'f' },
{ 'g' },
{ 'h' },
- { 'i', 'í', 'ì', 'ï' },
+ { 'i', 'í', 'ì', 'î', 'ï' },
{ 'j' },
{ 'k' },
{ 'l' },
{ 'm' },
{ 'n', 'ñ' },
- { 'o', 'ó', 'ò', 'ö', 'ø', 'œ'},
+ { 'o', 'ó', 'ò', 'ö', 'ô', 'ø', 'œ', 'ø'},
{ 'p' },
{ 'q' },
{ 'r' },
{ 's', 'š', 'ß' },
{ 't' },
- { 'u', 'ú', 'ù', 'ü' },
+ { 'u', 'ú', 'ù', 'ü' , 'û'},
{ 'v' },
{ 'w' },
{ 'x' },
{ 'y', 'ý', 'ÿ' },
{ 'z', 'ž' }
}
+
\end{verbatim}
There is also a table for the uppercase letters. If it should be edited or extended then copy first the
@@ -393,12 +402,11 @@ the umlauts like ö$\rightarrow$oe:
\begin{verbatim}
alphabet_upper = { -- for sorting
{ ' ' },
- { 'A', 'Á', 'À', 'Å', 'Æ'},
- { 'AE', 'Ä'},
+ { 'A', 'Á', 'À', 'Ä', 'Å', 'Æ'},
{ 'B' },
{ 'C', 'Ç' },
{ 'D' },
- { 'E', 'È', 'È', 'Ë' },
+ { 'E', 'È', 'É', 'Ë' },
{ 'F' },
{ 'G' },
{ 'H' },
@@ -408,15 +416,13 @@ alphabet_upper = { -- for sorting
{ 'L' },
{ 'M' },
{ 'N', 'Ñ' },
- { 'O', 'Ó', 'Ò', 'Ø','Œ' },
- { 'OE', 'Ö' },
+ { 'O', 'Ó', 'Ò', 'Ö', 'Ø','Œ', 'Ø' },
{ 'P' },
{ 'Q' },
{ 'R' },
{ 'S', 'Š' },
{ 'T' },
- { 'U', 'Ú', 'Ù' },
- { 'UE', 'Ü' },
+ { 'U', 'Ú', 'Ù', 'Ü' },
{ 'V' },
{ 'W' },
{ 'X' },
@@ -436,7 +442,7 @@ alphabet_upper = { -- for sorting
crop,
xindex,
xindexOptions=-l de,
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -494,7 +500,7 @@ the word beginninjg with the letter Ö:
crop,
xindex,
xindexOptions=-c DIN2 -l DE,
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -574,7 +580,7 @@ The following runs with \verb|xindex -l jp <file>|:
crop,
xindex,
xindexOptions=-l jp,
- force=true,
+ force=false,
runs=2,
code=false,
docType=latex,
@@ -653,7 +659,7 @@ folium = {
crop,
xindex,
xindexOptions=-l fr,
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -760,7 +766,7 @@ of the same type, so we get \texttt{1f} in the output.
crop,
xindex,
xindexOptions=-l de,
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1070,7 +1076,7 @@ no limit for \Lprog{xindex}.
crop,
xindex,
% xindexOptions=,
- force=true,
+ force=false,
runs=2,code,docType=latex,
showFilename,
align=\centering,
@@ -1260,7 +1266,7 @@ In the documents preamble there is the definition:
-----------------------------------------------------------------------
if not modules then modules = { } end modules ['xindex-header'] = {
- version = 0.14,
+ version = 0.18,
comment = "main configuration to xindex.lua",
author = "Herbert Voss",
copyright = "Herbert Voss",
@@ -1284,21 +1290,21 @@ idxnewletter = "\\idxnewletter"
]]
alphabet_lower = { -- for sorting
{ ' ' }, -- only for internal tests
- { 'a', 'á', 'à', 'ä', 'å', 'æ', },
+ { 'a', 'á', 'à', 'ä', 'â', 'å', 'æ', },
{ 'b' },
{ 'c', 'ç' },
{ 'd' },
- { 'e', 'é', 'è', 'ë' },
+ { 'e', 'é', 'è', 'ë', 'ê' },
{ 'f' },
{ 'g' },
{ 'h' },
- { 'i', 'í', 'ì', 'ï' },
+ { 'i', 'í', 'ì', 'î', 'ï' },
{ 'j' },
{ 'k' },
{ 'l' },
{ 'm' },
{ 'n', 'ñ' },
- { 'o', 'ó', 'ò', 'ö', 'ø', 'œ'},
+ { 'o', 'ó', 'ò', 'ö', 'ô', 'ø', 'œ', 'ø'},
{ 'p' },
{ 'q' },
{ 'r' },
@@ -1317,7 +1323,7 @@ alphabet_upper = { -- for sorting
{ 'B' },
{ 'C', 'Ç' },
{ 'D' },
- { 'E', 'È', 'È', 'Ë' },
+ { 'E', 'È', 'É', 'Ë' },
{ 'F' },
{ 'G' },
{ 'H' },
@@ -1327,7 +1333,7 @@ alphabet_upper = { -- for sorting
{ 'L' },
{ 'M' },
{ 'N', 'Ñ' },
- { 'O', 'Ó', 'Ò', 'Ö', 'Ø','Œ' },
+ { 'O', 'Ó', 'Ò', 'Ö', 'Ø','Œ', 'Ø' },
{ 'P' },
{ 'Q' },
{ 'R' },
@@ -1340,7 +1346,6 @@ alphabet_upper = { -- for sorting
{ 'Y', 'Ý', 'Ÿ' },
{ 'Z', 'Ž' }
}
-
\end{filecontents*}
\makeatletter
\def\theindex{% only for demonstration