diff options
Diffstat (limited to 'indexing')
-rw-r--r-- | indexing/xindex/CHANGELOG | 1 | ||||
-rw-r--r-- | indexing/xindex/doc/xindex-doc.pdf | bin | 586805 -> 588580 bytes | |||
-rw-r--r-- | indexing/xindex/doc/xindex-doc.tex | 90 | ||||
-rw-r--r-- | indexing/xindex/latex/xindex.sty | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-AU.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-HAdW-eKO.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-RU.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-base.lua | 18 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-baselib.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-cfg-common.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-cfg-uca.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-cfg.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-danteedition.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-dtk.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-lib.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-norsk.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-pretty.lua | 2 | ||||
-rw-r--r-- | indexing/xindex/lualatex/xindex-yannis.lua | 2 | ||||
-rwxr-xr-x | indexing/xindex/scripts/xindex.lua | 2 |
19 files changed, 83 insertions, 56 deletions
diff --git a/indexing/xindex/CHANGELOG b/indexing/xindex/CHANGELOG index ad8eb4a5c7..df515fcbec 100644 --- a/indexing/xindex/CHANGELOG +++ b/indexing/xindex/CHANGELOG @@ -1,3 +1,4 @@ +0.55 2023-07-30 - fix for wrong presort -- disabled the use of \writeidx 0.54 2023-07-28 - do not print control output for testing 0.53 2023-07-16 - added function literize to escape special lua characters for gsub and xindex's escape character diff --git a/indexing/xindex/doc/xindex-doc.pdf b/indexing/xindex/doc/xindex-doc.pdf Binary files differindex 9bfb596be9..31143f6fe1 100644 --- a/indexing/xindex/doc/xindex-doc.pdf +++ b/indexing/xindex/doc/xindex-doc.pdf diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex index f452980050..df19098a87 100644 --- a/indexing/xindex/doc/xindex-doc.tex +++ b/indexing/xindex/doc/xindex-doc.tex @@ -81,7 +81,7 @@ \def\setVersion#1{\setVVersion#1!!} \def\setVVersion#1=#2!!{\def\xIndexVersion{#2}} -\setVersion{version = 0.54}% can be automatically changed by perl +\setVersion{version = 0.55}% can be automatically changed by perl @@ -364,11 +364,12 @@ For the German language the double quote is an active character and it makes lif 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 -it works for the \Index{escape character} »>« (greater). By default the expression »>!">« will +it works for the \Index{escape character} »>« (greater). By default the expression »\verb|>>|«\index{>\kern0pt>} +will be a \TeX\ ligature with the output »>>«. %Internally the escape sequences are -With the beginning of \Lprog{xindex }the escaped chars -are converted into the internal strings and later back to the origin meaning. +With the beginning of \Lprog{xindex}the escaped chars +are converted into the internal strings and later back to the original meaning. The two characters \verb|{}| cannot be used as \verb|\{\}| inside the argument of \Lcs{index}. The package \Lpack{xindex} defines the two helper macros @@ -385,7 +386,7 @@ The following example shows how to use it: frame, compiler=lualatex, crop, - force=true, + force=false, xindex, xindexOptions=-e ">", runs=2,code,docType=latex, @@ -456,7 +457,7 @@ The following example was run with \verb|xindex -l it <file>.idx|: frame, compiler=lualatex, crop, - force=true, + force=false, xindex, xindexOptions=-l it -e ">", runs=2,code,docType=latex, @@ -503,7 +504,7 @@ package \Lpack{babel} or \Lpack{polyglossia} are used. frame, compiler=lualatex, crop, - force=true, + force=false, xindex, xindexOptions=-k -e "?", runs=2,code,docType=latex, @@ -604,7 +605,7 @@ This allows to have different indexes with different language. - +\clearpage \section{Sorting} @@ -883,7 +884,7 @@ by Michal Hoftich's Lua package \texttt{LUA-UCA}, which should be part of any \T 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 +UCA should be done in the file \Lfile{xindex-cfg-uca.lua}, which will automatically be read by \Lprog{xindex}. \iffalse @@ -908,7 +909,7 @@ where you define your own sorting scheme, you should not use the \verb|-u| optio frame=false, compiler=lualatex, crop, - force=true, + force=false, xindex, xindexOptions=-u -l cs, runs=2,code,docType=latex, @@ -1174,6 +1175,7 @@ folium = { pages={6}, frame=false, compiler=lualatex, + force=false, crop, xindex, xindexOptions=-l fr, @@ -1193,6 +1195,7 @@ folium = { \let\item\@idxitem} \makeatother %StartVisiblePreamble +\usepackage[french]{babel} \usepackage{makeidx}\makeindex %StopVisiblePreamble \pagestyle{empty} @@ -1231,7 +1234,7 @@ of the same type, so we get \texttt{1f} in the output. frame=false, compiler=lualatex, crop, - force=true, + force=false, xindex, xindexOptions=-l de, runs=2,code,docType=latex, @@ -1298,7 +1301,7 @@ envStop = "\\end{description}" % xindexOptions=-c description -g, runs=2, code,docType=latex, - force=true, + force=false, %xindex -c description -n -g xindex-17.idx %xindex -c description -n --no_pagenumber gls.idx % runsequence={lualatex,{xindex -c description -n -g},lualatex,lualatex}, @@ -1399,8 +1402,9 @@ composed of an equal number of quarks and antiquarks: $S=0$.}pion. \section{The config file} -The main config file is \Lfile{xindex-cfg.lua} is used by default and loading it by the -optional parameter -c makes no sense. A new config file must have the prefix \texttt{xindex-} +The main config file is \Lfile{xindex-cfg.lua} and used by default. % and loading it by the +%optional parameter -c makes no sense. +A new config file must have the prefix \texttt{xindex-} and the file extension \Lext{lua}, for example: \Lfile{xindex-HAdW-eKO.lua} which can be used 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 @@ -1415,7 +1419,7 @@ itemPageDelimiter = "," -- Hello, 14 compressPages = true -- something like 12--15, instead of 12,13,14,15. the |( ... |) syntax is still valid fCompress = true -- 3f -> page 3, 4 and 3ff -> page 3, 4, 5 -minCompress = 3 -- 14--17 or +minCompress = 3 -- 14--17 rangeSymbol = "--" numericPage = true -- for non numerical pagenumbers, like "VI-17" sublabels = {"", "-\\-", "--\\-", "---\\-"} @@ -1468,9 +1472,10 @@ function specialCompressPageList(pages) end \end{verbatim} +The above code is a special function which can handle \Index{page number}s like VII-17, VIII/2/1-186. Internally exists a function \verb|compressPageList| which is used if no -\verb|specialCompressPageList| is defined. +\verb|specialCompressPageList| is defined. \begin{externalDocument}[ grfOptions={scale=0.9},% width=\dimexpr\linewidth-2\fboxsep-2\fboxrule}, @@ -1563,6 +1568,15 @@ Internally exists a function \verb|compressPageList| which is used if no \end{document} \end{externalDocument} +The \Lext{idx} file of the above example looks like + +\begin{verbatim} +\indexentry{Karl!V., Kaiser}{VI/2-1210} +\indexentry{Braunschweig-Wolfenbüttel!Karl Viktor von, Herzog}{VI/1-83} +\indexentry{Schleswig-Holstein!Rudolf von, Herzog}{VII/2/1-758} +\indexentry{Schleswig-Holstein!Rudolf von, Herzog}{VII/2/1-759} +[...] +\end{verbatim} @@ -1590,11 +1604,17 @@ end \end{verbatim} -The following example runs \verb|xindex -c dtk -l de -n <input>| +The following example runs \verb|xindex -c dtk -l de -n <input>| and the \Lext{idx} file looks like + +\begin{verbatim} +\indexentry{BährendtsenElke@Elke Bährendtsen!\Email {elke"@xyz.de}}{14} +\indexentry{JacekJonasson Jared@Jonasson Jared Jazek!\Email {mail"@jones.net}}{20} +[...] +\end{verbatim} \begin{externalDocument}[ grfOptions={scale=0.9},% width=\dimexpr\linewidth-2\fboxsep-2\fboxrule}, - mpwidth=0.25\linewidth, +% mpwidth=0.25\linewidth, pages={1}, frame=false, compiler=lualatex, @@ -1708,7 +1728,7 @@ baz\index{foo!bar!baz} foobar% -\clearpage +%\clearpage \section{\texttt{hyperref}} @@ -1779,7 +1799,7 @@ problem. frame=false, compiler=lualatex, crop, - force=true, + force=false, shellesc, % xindex, % xindexOptions=-, @@ -1828,7 +1848,7 @@ problem. 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 useful to insert a -\Index{pagebreak}/""\Index{columnbreak} +\Index{pagebreak}\slash\Index{columnbreak} before a new letter in the output of the index file: @@ -1853,10 +1873,11 @@ such commands are ignored. In the following example we put an horizontal line af \begin{externalDocument}[ % grfOptions={width=\dimexpr\linewidth-2\fboxsep-2\fboxrule}, - mpwidth=0.55\linewidth, +% mpwidth=0.55\linewidth, pages={2}, frame=false, compiler=lualatex, + force=false, crop, xindex, xindexOptions=-l de, @@ -1945,14 +1966,22 @@ an own config file \Lfile{xindex-header.lua} which has the line \verb|idxnewletter = "\\idxnewletter"| + +\clearpage + + In the documents preamble there is the definition: \verb|\newcommand\idxnewletter[1]{\textbf{\textit{#1}}}| + + + \begin{externalDocument}[ % grfOptions={width=\dimexpr\linewidth-2\fboxsep-2\fboxrule}, - mpwidth=0.55\linewidth, + mpwidth=0.6\linewidth, pages={2}, + force=false, frame=false, compiler=lualatex, crop, @@ -2063,11 +2092,11 @@ alphabet_upper = { -- for sorting \parskip\z@ \@plus .3\p@\relax \parindent\z@ \let\item\@idxitem} \makeatother +\pagestyle{empty} %StartVisiblePreamble \usepackage{makeidx}\makeindex \newcommand\idxnewletter[1]{\textbf{\textit{#1}}} %StopVisiblePreamble -\pagestyle{empty} \begin{document} \section{Escaping characters} \begin{itemize} @@ -2078,15 +2107,14 @@ alphabet_upper = { -- for sorting \item At character @ \index{At ("@)} \end{itemize} run \verb|xindex -c header <file.idx>| -\index{<file.idx>@\texttt{<file.idx>}} +\index{<file.idx>@\texttt{<file.idx>}} \index{123} -\newpage -\printindex +\newpage \printindex \end{document} \end{externalDocument} -\clearpage +%\clearpage \section{Automatic index creation} @@ -2099,10 +2127,10 @@ and adds the program \Lprog{xindex} as the default program to \Lpack{imakeidx}. mpwidth=0.55\linewidth, pages={6}, frame=false, - force=true, + force=false, compiler=lualatex, crop, - force=true, + force=false, % xindex, % xindexOptions=-l de, runs=2,code,docType=latex, @@ -2284,7 +2312,7 @@ Test \index{A!Test} oder auch \index{B!Test} \end{externalDocument} -%\clearpage +\clearpage \begin{externalDocument}[ diff --git a/indexing/xindex/latex/xindex.sty b/indexing/xindex/latex/xindex.sty index 29d84f4db1..24d0076590 100644 --- a/indexing/xindex/latex/xindex.sty +++ b/indexing/xindex/latex/xindex.sty @@ -13,7 +13,7 @@ % % % ------------------------------------- -\ProvidesPackage{xindex}[2023/07/10 v. 0.54 write into an idx file (hv)] +\ProvidesPackage{xindex}[2023/07/30 v. 0.55 write into an idx file (hv)] % \RequirePackage{xkeyval} diff --git a/indexing/xindex/lualatex/xindex-AU.lua b/indexing/xindex/lualatex/xindex-AU.lua index 2d0780edc1..59c26294bf 100644 --- a/indexing/xindex/lualatex/xindex-AU.lua +++ b/indexing/xindex/lualatex/xindex-AU.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-AU'] = { - version = 0.54, + version = 0.55, comment = "configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-HAdW-eKO.lua b/indexing/xindex/lualatex/xindex-HAdW-eKO.lua index 2b1f338977..ecf51a290d 100644 --- a/indexing/xindex/lualatex/xindex-HAdW-eKO.lua +++ b/indexing/xindex/lualatex/xindex-HAdW-eKO.lua @@ -11,7 +11,7 @@ -- configuration for index files of the Heidelberger Akademie der Wissenschaften if not modules then modules = { } end modules ['xindex-HAdW-eKO'] = { - version = 0.54, + version = 0.55, comment = "configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-RU.lua b/indexing/xindex/lualatex/xindex-RU.lua index 2e2b9e3f1f..626cc1c17d 100644 --- a/indexing/xindex/lualatex/xindex-RU.lua +++ b/indexing/xindex/lualatex/xindex-RU.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-RU'] = { - version = 0.54, + version = 0.55, comment = "configuration to xindex.lua", author = "Alexey Kuznetzov", copyright = "Herbert Voß", diff --git a/indexing/xindex/lualatex/xindex-base.lua b/indexing/xindex/lualatex/xindex-base.lua index eb5dc51b65..ff44943724 100644 --- a/indexing/xindex/lualatex/xindex-base.lua +++ b/indexing/xindex/lualatex/xindex-base.lua @@ -8,7 +8,7 @@ -- $Id: xindex-base.lua 22 2022-02-07 12:18:15Z hvoss $ ----------------------------------------------------------------------- -local info = { version = 0.54 } +local info = { version = 0.55 } -- check config if pageNoPrefixDel ~= "" then @@ -50,18 +50,16 @@ end writeLog(1,"check for hyperpages ... ",0) hyperpage, lines = checkHyperpage(lines) -- hyperref used? --writeLog(1,"done \n",0) -if hyperpage then writeLog(1,"We have hyperpages.\n",1) end +if hyperpage + then writeLog(1,"We have hyperpages.\n",1) + else writeLog(1,"We have no hyperpages.\n",1) + end -print("Presort of \\indexentry lines") --- for _,l in pairs(lines) do print (l) end -table.sort(lines) ---if vlevel > 1 then - --print("Pre-Sorted index list:") - --for _,l in pairs(lines) do print (l) end ---end +--print("Presort of \\indexentry lines") +--table.sort(lines) -- no presort to keep macros inserted by \writeidx if vlevel > 1 then - writeLog(1,"--------------- Input data (presorted) -----------------\n",2) + writeLog(1,"--------------- Input data (mot sorted) ----------------\n",2) for _,l in pairs(lines) do writeLog(1,l.."\n",2) end writeLog(1,"--------------- end Input data -------------------------\n",2) end diff --git a/indexing/xindex/lualatex/xindex-baselib.lua b/indexing/xindex/lualatex/xindex-baselib.lua index 418847bfca..36269520c9 100644 --- a/indexing/xindex/lualatex/xindex-baselib.lua +++ b/indexing/xindex/lualatex/xindex-baselib.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-baselib'] = { - version = 0.54, + version = 0.55, comment = "base library to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-cfg-common.lua b/indexing/xindex/lualatex/xindex-cfg-common.lua index 4277c89757..e02da6f3fc 100644 --- a/indexing/xindex/lualatex/xindex-cfg-common.lua +++ b/indexing/xindex/lualatex/xindex-cfg-common.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-cfg-common'] = { - version = 0.54, + version = 0.55, comment = "configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-cfg-uca.lua b/indexing/xindex/lualatex/xindex-cfg-uca.lua index d6805ef6f6..8dad47adda 100644 --- a/indexing/xindex/lualatex/xindex-cfg-uca.lua +++ b/indexing/xindex/lualatex/xindex-cfg-uca.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-cfg-lua'] = { - version = 0.54, + version = 0.55, comment = "configuration to xindex-cfg-uca.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-cfg.lua b/indexing/xindex/lualatex/xindex-cfg.lua index d0aac11e19..b9960963bd 100644 --- a/indexing/xindex/lualatex/xindex-cfg.lua +++ b/indexing/xindex/lualatex/xindex-cfg.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-cfg'] = { - version = 0.54, + version = 0.55, comment = "main configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-danteedition.lua b/indexing/xindex/lualatex/xindex-danteedition.lua index 530177233d..477eb5ccca 100644 --- a/indexing/xindex/lualatex/xindex-danteedition.lua +++ b/indexing/xindex/lualatex/xindex-danteedition.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-cfg'] = { - version = 0.54, + version = 0.55, comment = "configuration file for the DANTE Edition", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-dtk.lua b/indexing/xindex/lualatex/xindex-dtk.lua index 29431c4b62..b420597720 100644 --- a/indexing/xindex/lualatex/xindex-dtk.lua +++ b/indexing/xindex/lualatex/xindex-dtk.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-cfg'] = { - version = 0.54, + version = 0.55, comment = "DTK configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-lib.lua b/indexing/xindex/lualatex/xindex-lib.lua index c11826ad8c..60c4d9a196 100644 --- a/indexing/xindex/lualatex/xindex-lib.lua +++ b/indexing/xindex/lualatex/xindex-lib.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-lib'] = { - version = 0.54, + version = 0.55, comment = "main library to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-norsk.lua b/indexing/xindex/lualatex/xindex-norsk.lua index 7e7ec2a346..f51d19db0e 100644 --- a/indexing/xindex/lualatex/xindex-norsk.lua +++ b/indexing/xindex/lualatex/xindex-norsk.lua @@ -10,7 +10,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-no'] = { - version = 0.54, + version = 0.55, comment = "configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/lualatex/xindex-pretty.lua b/indexing/xindex/lualatex/xindex-pretty.lua index a496c9e9ae..bdf6591ff8 100644 --- a/indexing/xindex/lualatex/xindex-pretty.lua +++ b/indexing/xindex/lualatex/xindex-pretty.lua @@ -7,7 +7,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-pretty'] = { - version = 0.54, + version = 0.55, comment = "dump a Lua table for debugging", author = "Steve Donovan", copyright = "Steve Donovan", diff --git a/indexing/xindex/lualatex/xindex-yannis.lua b/indexing/xindex/lualatex/xindex-yannis.lua index babeb15512..a07d5e2f4d 100644 --- a/indexing/xindex/lualatex/xindex-yannis.lua +++ b/indexing/xindex/lualatex/xindex-yannis.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- if not modules then modules = { } end modules ['xindex-yannis'] = { - version = 0.54, + version = 0.55, comment = "main configuration to xindex.lua", author = "Herbert Voss", copyright = "Herbert Voss", diff --git a/indexing/xindex/scripts/xindex.lua b/indexing/xindex/scripts/xindex.lua index f2ecb9fe90..041235d289 100755 --- a/indexing/xindex/scripts/xindex.lua +++ b/indexing/xindex/scripts/xindex.lua @@ -9,7 +9,7 @@ ----------------------------------------------------------------------- xindex = xindex or { } - local version = 0.54 + local version = 0.55 xindex.version = version --xindex.self = "xindex" |