texlive[47495] Master/texmf-dist: robustindex (25apr18)
commits+karl at tug.org
commits+karl at tug.org
Mon Apr 30 01:02:38 CEST 2018
Revision: 47495
http://tug.org/svn/texlive?view=revision&revision=47495
Author: karl
Date: 2018-04-30 01:02:37 +0200 (Mon, 30 Apr 2018)
Log Message:
-----------
robustindex (25apr18)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/robustindex/README.md
trunk/Master/texmf-dist/doc/latex/robustindex/multisample.pdf
trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex
trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.pdf
trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.tex
trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.pdf
trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.tex
trunk/Master/texmf-dist/doc/latex/robustindex/stind.html
trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/README.md 2018-04-29 23:02:25 UTC (rev 47494)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/README.md 2018-04-29 23:02:37 UTC (rev 47495)
@@ -1,4 +1,5 @@
-Package robustindex.sty, Wilberd van der Kallen 2017.
+Package robustindex.sty, Wilberd van der Kallen 2018.
+Date of last change of _anything_ in the bundle 2018/04/25
This package uses \pageref to ensure that the page numbers in the index are synchronous
with the manuscript, even when a third party changes the page numbers and fails to
@@ -6,16 +7,17 @@
Some features of makeindex had to be disabled.
- https://www.staff.science.uu.nl/~kalle101/stind.html
+ [Home page of package](https://www.staff.science.uu.nl/~kalle101/stind.html)
- There is an option multind for multiple indices with pagerefs.
- It uses just one index file and disables even more features of makeindex.
+ There is an option multind for many indexes with pagerefs.
+ It uses just one index file and relies on the old compile cycle
+ (latex, makeindex, latex) in the standard TeX setup.
-% Copyright 2005, 2017 Wilberd van der Kallen
-%
-% This file may be distributed under the conditions of the LaTeX Project Public
-% License, either version 1.2 of this license or (at your option) any
-% later version. The latest version of this license is in
-% http://www.latex-project.org/lppl.txt
-% and version 1.2 or later is part of all distributions of LaTeX
-% version 1999/12/01 or later.
\ No newline at end of file
+ Copyright 2005, 2017, 2018 Wilberd van der Kallen
+
+ This package may be distributed under the conditions of the
+ LaTeX Project Public License, either version 1.2 of this license or
+ (at your option) any later version. The latest version of this license is in
+ [lpp.txt](http://www.latex-project.org/lppl.txt)
+ and version 1.2 or later is part of all distributions of LaTeX
+ version 1999/12/01 or later.
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/multisample.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex 2018-04-29 23:02:25 UTC (rev 47494)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex 2018-04-29 23:02:37 UTC (rev 47495)
@@ -1,24 +1,23 @@
-% multisample.tex 2017/09/29
+% multisample.tex 2018/04/11
\documentclass{book}
\usepackage{makeidx}
\usepackage[multind]{robustindex}
-\usepackage[plainpages=false,hyperindex=false]{hyperref}
+\usepackage[plainpages=false,hyperindex=false,colorlinks=true]{hyperref}
\title {A file with several indexes}
\author{Wilberd van der Kallen\index{wilberd at Wilberd}}
-\date{2017}
+\date{April 2018}
\makeindex % obligatory with robustindex
-\makeglossary % obligatory with robustglossary
+
\begin{document}
%\renewcommand{\indexcapstyle}[1]{\par\vskip1em plus.5em minus.3em\textbf{\uppercase{#1}}}
\renewcommand\thepage{\roman{page}}
-\index{zz at z}
+\index{z}
-
\setindex{b1}
@@ -35,13 +34,9 @@
\addcontentsline{toc}{chapter}{Preface}
\markboth{Preface}{Preface}
This file illustrates some features of the \verb!robustindex! package with option \verb!multind!. This option
- supports multiple indexes. We require that
-the argument to an \verb!\index! command starts with at least two lower case
-letters or with the symbol \verb!<!. So use \verb!\index{new york at New York}! instead of \verb!\index{New York}!, \verb!\index{za at z}!
-instead of \verb!\index{z}!.
-
-
-Although this is not a book, we have chosen the book style for illustration.
+ supports multiple indexes.
+
+ Although this is not a book, we have chosen the book style for illustration.
Let us say we want to use four indexes. First we choose tags to identify them.
In this file we use the tags \verb|main|, \verb|bis|, \verb|a1|, \verb|b1|.
With the \verb!\setindex! command we activate an index.
@@ -87,7 +82,7 @@
We have hacked various mechanisms of makeindex.
Subentries are still supported. We illustrate this in
\verb|multisample.tex| and appendix \ref{appendix} with alpha, beta and gamma.
-This also illustrates the use of \verb|\gobblepageref|.
+This also illustrates the use of \verb|\gobblepageref|, a variant of \verb!\see!.
\setindex{a1}\index{alpha!see beta}
\index{alpha!see also gamma\gobblepageref}
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.tex 2018-04-29 23:02:25 UTC (rev 47494)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.tex 2018-04-29 23:02:37 UTC (rev 47495)
@@ -1,13 +1,13 @@
-% robustmanual.tex 2017/09/29
+% robustmanual.tex 2018/04/23
\documentclass{article}
-\usepackage{makeidx}
-\usepackage[multind]{robustindex}
-\usepackage[hyperindex=false]{hyperref}
+%\usepackage{makeidx}
+\usepackage[multind]{robustindex}[2018/04/15]
+\usepackage[hyperindex=false,colorlinks=true]{hyperref}
\title {Manual of robustindex package}
-\author{Wilberd van der Kallen\index{wilberd at Wilberd}}
-\date{2017}
+\author{Wilberd van der Kallen\index{Wilberd}}
+\date{April 2018}
\makeindex % obligatory with robustindex
@@ -36,10 +36,10 @@
\section*{Standard usage}
Put
+%$$
+%\verb!\usepackage{makeidx}!
+%$$
$$
-\verb!\usepackage{makeidx}!
-$$
-$$
\verb!\usepackage{robustindex}!
$$
$$\verb!\makeindex!$$
@@ -52,7 +52,7 @@
\verb!\usepackage[plainpages=false,hyperindex=false]{hyperref}!.
$$
-That should be all. (You may have to trash old auxiliary files.)
+That should be all. (You may have to trash old auxiliary files, the \emph{filename}.\verb!ind! file included.)
You can now use \index{alpha}\index{gamma|textbf}
$$\verb!\index{alpha}!$$
@@ -70,7 +70,7 @@
To get \verb!|! as output use the \LaTeX\ command \verb!\vert!.
-We also have a command \verb!\gobblepageref!
+We also have a command \verb!\gobblepageref!, a variant of \verb!\see!,
used as in
$$\verb?\index{alpha!see also gamma\gobblepageref}?$$
\index{alpha!see also gamma\gobblepageref}
@@ -102,18 +102,11 @@
\section*{The \texttt{multind} option}
The \verb!multind! option provides
-support for multiple indexes. For the package to function properly we now require that
-the argument to an \verb!\index! command starts with at least two lower case
-letters or with the symbol \verb!<!.
-So use \verb!\index{new york at New York}! instead of \verb!\index{New York}!, \verb!\index{za at z}!
-instead of \verb!\index{z}!.
+support for many indexes.
+Suppose the preamble contains\\
+ \verb!\usepackage[multind]{robustindex}[2018/04/15]!.\\
+\verb!\makeindex!.
-If you have an entry that should go before the letter a, then start the argument of \verb!\index! with \verb!<!,
-as in \index{<@$<$ comes before alphabet}\verb!\index{<@$<$ comes before alphabet}!.
-
-
-Suppose the preamble contains \verb!\usepackage[multind]{robustindex}!.
-
Let us say we want to use four indexes. First we choose tags to identify them.
Say we use the tags \verb|main|, \verb|bis|, \verb|a1|, \verb|b1|.
The tag \verb|main| is always known and
@@ -126,20 +119,21 @@
before, then a new index with that tag is created.
The \verb!\index! command and
the \verb|\printindex| commands write to/from the active index. All indexes are hidden in one
-big index file and \LaTeX\ knows how to find the active index in there.
+big index file (with extension \verb!ind!) and \LaTeX\ knows how to find the active index in there.
-If you wish you may use \verb!\sindex[bis]{!\emph{entry}\verb!}! as shorthand for\\
+If you wish you may use \verb!\sindex[bis]{!\emph{entry}\verb!}! as shorthand for
-\hspace{5em} \verb!\setindex{bis}\index{!\emph{entry}\verb!}!\\
+\hspace{5em} \verb!\setindex{bis}\index{!\emph{entry}\verb!}!
-and \verb!\sindex{!\emph{entry}\verb!}! as shorthand for\\
+and \verb!\sindex{!\emph{entry}\verb!}! as shorthand for
- \hspace{5em} \verb!\setindex{main}\index{!\emph{entry}\verb!}!.\\
+ \hspace{5em} \verb!\setindex{main}\index{!\emph{entry}\verb!}!.
-The compilation sequence does not change. That is the main point of all our hacking.
-For instance, the file \verb!multisample.tex! produces multiple indexes and is processed like this
+Option \verb!multind! works with the original compilation sequence. That is the main point of all our hacking.
+For instance, the file \verb!multisample.tex! produces multiple indexes and may be processed in this
+old fashioned way:
latex multisample.tex
@@ -147,10 +141,19 @@
latex multisample.tex
-latex multisample.tex
+latex multisample.tex\\
+Older versions of \verb!robustindex.sty!
+may give different results. Use version \verb!2018/04/15! or later.
+We recommend to bundle \verb!robustindex.sty! with your \emph{filename}.\verb!tex! and \emph{filename}.\verb!ind! when moving
+files to another computer.\\
+
+
+If you have an entry that should go before the letter a, then you may start the argument of \verb!\index! with \verb!<!,
+as in \index{<@$<$ comes before alphabet}\verb!\index{<@$<$ comes before alphabet}!.
+
\subsection*{Embellishment}
-One may embellish an index with headings, like this.
+One may embellish an index with letter headings, like this.
\verb!\setindex{main}!
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.tex 2018-04-29 23:02:25 UTC (rev 47494)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.tex 2018-04-29 23:02:37 UTC (rev 47495)
@@ -1,10 +1,10 @@
-% robustsample.tex 2017/09/29
+% robustsample.tex 2018/03/23
\documentclass{book}
\usepackage{makeidx}
\usepackage{robustindex}
\usepackage{robustglossary}
-\usepackage[plainpages=false,hyperindex=false]{hyperref}
+\usepackage[plainpages=false,hyperindex=false,colorlinks=true]{hyperref}
\title {A file with robust index}
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/stind.html
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/stind.html 2018-04-29 23:02:25 UTC (rev 47494)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/stind.html 2018-04-29 23:02:37 UTC (rev 47495)
@@ -14,7 +14,7 @@
<P>It is much nicer to have an index that adapts itself to all
changes but the adding/deleting/rearranging of \index commands.
<P>Our package
-<A HREF="robustindex.sty">robustindex.sty</A> (version 2017/09/28)
+<A HREF="robustindex.sty">robustindex.sty</A> (version 2018/04/25)
achieves this with the \pageref mechanism.
<P>
Here is our <A HREF="robustmanual.pdf">Manual for the robustindex package</A>.
@@ -26,7 +26,7 @@
It also requires the package
<A HREF="robustglossary.sty">robustglossary.sty</A>.
-<P>After
+<P>After the old fashioned
<DL>
<DD>pdflatex <A HREF="robustsample.tex">robustsample.tex</A>
<DD>makeindex robustsample
@@ -35,7 +35,7 @@
</DL>
you should have something like <A HREF="robustsample.pdf">this PDF file</A>.
-<P>If you want multiple indexes with pagerefs you may try
+<P>If you want several indexes with pagerefs you may try
\usepackage[multind]{robustindex}.
<P>After
@@ -46,6 +46,8 @@
<DD>pdflatex multisample.tex
</DL>
you should have something like <A HREF="multisample.pdf">this PDF file</A>.
+So we require very little of the TeX setup. This becomes relevant when the final
+production is done elsewhere.
<BR>
Modified: trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty 2018-04-29 23:02:25 UTC (rev 47494)
+++ trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty 2018-04-29 23:02:37 UTC (rev 47495)
@@ -1,4 +1,4 @@
-% Package robustindex.sty, Wilberd van der Kallen 2005, 2017.
+% Package robustindex.sty, Wilberd van der Kallen 2005, 2017, 2018.
%
% Third parties often change the page numbers without rerunning makeindex.
% One would like to make the page numbers in the index entries more robust.
@@ -37,19 +37,17 @@
% the active one at any given moment.
% This steers the behaviour of \index and \printindex.
%
+% We introduce tools to embellish an index with letter headings.
+%
% That is the positive part.
%
% While robustindex.sty broke the automatic page range feature of
-% makeindex, the multind option also breaks the insertions
-% of \indexspace in the index file. And it messes up the sorting a bit.
-% Therefore, when using the option multind, we require that the argument of
-% an \index command always starts with at least two lower case letters.
-% We then hack some more to restore the placement of \indexspace
-% and also introduce tools to embellish an index with letter headings.
+% makeindex, the multind option also broke the insertions
+% of \indexspace in the index file. And it messed up the sorting.
+% We use various hacks to restore reasonable behaviour. This makes the index file
+% pretty unreadable and style files of makeindex will probably fail.
+%
%
-% The various hacks make the index file pretty unreadable
-% and style files of makeindex will probably fail.
-%
% Remark.
% The package imakeidx also synchronises the index with the manuscript,
% but it has a different method and different requirements.
@@ -56,7 +54,7 @@
%
% https://www.staff.science.uu.nl/~kalle101/stind
%
-% Copyright 2017 Wilberd van der Kallen
+% Copyright 2018 Wilberd van der Kallen
%
% This file may be distributed under the conditions of the LaTeX Project Public
% License, either version 1.2 of this license or (at your option) any
@@ -66,9 +64,11 @@
% version 1999/12/01 or later.
\ProvidesPackage{robustindex}
- [2017/09/28
+ [2018/04/25
index entries with pagerefs]
+\RequirePackage{makeidx}
+
\DeclareOption{multind}{
\AtBeginDocument{\setindex{main}}%
\def\robust at mult{\relax}
@@ -112,11 +112,12 @@
\@esphack
\protected at write
\@indexfile {}{\string \indexentry
- {\string\indnr\robustchoice bs\findencap#1|\relax }{\theindexctr}}%
+ {\string\indnr\robustchoice d\gr at bltr#1-\relax b \findencap#1|\relax}{\theindexctr}}%
\endgroup
\@esphack
}
+
\ifx\robust at mult\undefined\else\let\@wrindex\@multwrindex\fi
\newcommand\sindex{\@ifnextchar[{\@sindex}{\@@sindex}}%
@@ -137,6 +138,12 @@
\newcommand{\indexpreamble}{\relax}% compare the preamble of makeindex
+\newcommand{\mult at err}{\PackageWarning{robustindex}{%
+ Index file is obsolete. Run makeindex. Detected}Index file is obsolete. Run makeindex.
+ \end{theindex}\endinput}%
+
+\newcommand{\gobbletillnine}{\mult at err}
+
\newcommand{\indexincontents}{%
\def\indexpreamble{%
\refstepcounter{subsection}%
@@ -209,6 +216,7 @@
}%
+
% Now it gets ugly, because we wish to implement a poor man's encap
% mechanism, distinguishing \index{entry}, \index{entry|(}, \index{entry|)},
% \index{entry|towrap}, \index{entry|(towrap}, \index{entry|)towrap}, where
@@ -226,6 +234,7 @@
\fi
}%
+
\newcommand{\wr at pencap}{}%
\def\wr at pencap#1|{encpageref{#1}}%
@@ -289,24 +298,29 @@
% Now the part that supports multiple indices. We hack the sorting mechanism of
% Makeindex and put instructions for the mouth of TeX in the index file.
+\newcommand{\gr at bltr}{\relax}%
+
+\def\gr at bltr#1#2\relax{\ifcat A#1\the\uccode`#1\else 60\fi}% to keep "a" and "A" together.
+
% But first some code for embellishing an index. Our hacking brakes the insertion of
% \indexspace at appropriate places. We have to work hard to restore that. While we
% are at it, we may as well add the possibility to insert a letter T after the
-% \indexspace that precedes the entries that start with t.
-% First we describe the default style, without the T.
+% \indexspace that precedes the entries that start with t or T.
+% First we describe the default style, that does not insert the T.
\newcommand{\indexcapstyle}[1]{\indexspace}
% To get the T one changes the style like this
% \renewcommand{\indexcapstyle}[1]{\indexspace\textbf{#1}\par}%
-\newcommand{\nxtletre}{\relax}% nextletter in alphabet
+\newcommand{\nxtletre}{\def\item{\letr at test}}% about next letter in alphabet
\newcommand{\indexcapitalhead}[1]{% Preparing for a heading; not printed.
-\index{#1@\protect\nxtletre\protect\def\protect
-\item{\protect\olditem\protect\letretst}%
-\protect\edef\protect\nwletre{\uppercase{#1}}\gobblepageref}}%
+ \protected at write
+ \@indexfile {}{\string \indexentry
+ {\string\indnr \robustchoice d\gr at bltr#1\relax a #1@\protect\nxtletre
+ \protect\def\protect\nwletre{#1}\string\jmptonine}{9}}%
+}%
\newcommand{\capitalsinindex}[1]{% Will be called by \newindex with full alphabet.
-\index{-@\protect\let\protect\olditem\protect\item\gobblepageref}%
\find at capitals#1\relax}%
\newcommand{\find at capitals}{\relax}%
@@ -317,11 +331,11 @@
\else\find at capitals#2\relax
\fi}%
-\newcommand{\letretst}{\relax}% To test if entry starts with new letter.
+\newcommand{\letr at test}{\relax}% To test if entry starts with new letter.
-\long\def\letretst#1{\ifx#1\nxtletre\else\procletter{#1}\fi}%
+\long\def\letr at test#1{\ifx#1\nxtletre\else\procletter{#1}\fi}%
-\newcommand{\procletter}{\relax}% To process a new letter.
+\newcommand{\procletter}{\relax}%
\def\procletter#1{\long\def\item{\olditem}\indexcapstyle{\nwletre}\ifx#1\indnr
\expandafter\ja@\else #1\fi}%
@@ -328,20 +342,23 @@
\newcommand{\olditem}{\relax}%
-\def\ja@#1s{\fi}% Seems necessary.
+\newcommand{\ja@}{\relax}
+\def\ja@#1 {\fi}% Mysterious. Seems necessary.
+
% All this just to embellish an index. Now the support for multiple indexes.
\newcommand{\setindex}[1]{%
\@bsphack
-\expandafter\ifx\csname#1ind\endcsname\relax
+\expandafter\ifx\csname#1 at rbstind\endcsname\relax
\newindex{#1}%
\else
- \edef\robustchoice{\csname#1ind\endcsname}%
+ \edef\robustchoice{\csname#1 at rbstind\endcsname}%
\fi
\@esphack}%
-\ifx\robust at mult\undefined\def\setindex{\relax}\fi
+\ifx\robust at mult\undefined\def\setindex{\PackageWarning{robustindex}{%
+ \string\setindex{} requires option multind. Detected}}\fi
\newcounter{multindctr}%
\newcommand{\robustcutpoint}{\relax}%
@@ -350,38 +367,46 @@
\newcommand{\robustchoice}{\relax}%
\newcommand{\indnr}{\relax}%
-\setcounter{multindctr}{999}%
+\setcounter{multindctr}{999}% Fewer than 899 indexes expected.
\long\def\untilrobustcutpoint#1\robustcutpoint{\fi}%
% This tels the mouth of TeX not to send too much to the stomach.
% It should only forward the part that belongs to the active index.
-\def\indnr#1s{}%
+\def\indnr#1 {}% The \indnr part is used for sorting by makeindex and needs to be ignored
+ % by TeX thereafter.
-\newcommand{\gobbletillnine}{\relax}
+\newcommand\multindpreamble{\let\olditem\item\let\jmptonine\jmp at tnine}%
+% \multindpreamble may serve as hook for further code.
-\def\gobbletillnine#1 9{\relax}
+\newcommand{\jmptonine}{\mult at err}%
+\newcommand{\jmp at tnine}{\relax}%
+
+\def\jmp at tnine#1 9{\relax}
+
\def\newindex#1{\@bsphack
+\ifx\@indexfile\undefined\PackageWarning{robustindex}{%
+Package needs \string\make index in preamble. Detected}\fi
\ifnum\c at multindctr=999%
\protected at write
\@indexfile {}{\string \indexentry
- {\string\indnr 999bs @\string\nxtletre
- \string\robustcutpoint\string\gobbletillnine}{9}}%
+ {\string\indnr 999b @\string\nxtletre
+ \string\robustcutpoint\string\jmptonine}{9}}%
\@esphack
\fi
\addtocounter{multindctr}{-1}%
-\expandafter\edef\csname#1ind\endcsname{\the\c at multindctr}%
-\edef\robustchoice{\csname#1ind\endcsname}%
+\expandafter\edef\csname#1 at rbstind\endcsname{\the\c at multindctr}%
+\edef\robustchoice{\csname#1 at rbstind\endcsname}%
\@esphack \protected at write
\@indexfile {}{\string \indexentry
- {\string\indnr\the\c at multindctr as @\string\robustcutpoint
-\string\ifnum \string\robustchoice=\the\c at multindctr\string\relax
-\string\else\string\nxtletre\string\untilrobustcutpoint
-\string\fi\string\gobbletillnine
+ {\string\indnr\the\c at multindctr a @\string\robustcutpoint
+\string\ifnum\string\robustchoice=\the\c at multindctr\string\multindpreamble
+\string\else\string\untilrobustcutpoint
+\string\fi\string\jmptonine
}{9}}%
-\capitalsinindex{abcdefghijklmnopqrstuvwxyz}%
+\capitalsinindex{ABCDEFGHIJKLMNOPQRSTUVWXYZ}%
\@esphack
}%
-\endinput
\ No newline at end of file
+\endinput
More information about the tex-live-commits
mailing list