texlive[45452] Master/texmf-dist: robustindex (1oct17)
commits+karl at tug.org
commits+karl at tug.org
Mon Oct 2 23:58:28 CEST 2017
Revision: 45452
http://tug.org/svn/texlive?view=revision&revision=45452
Author: karl
Date: 2017-10-02 23:58:27 +0200 (Mon, 02 Oct 2017)
Log Message:
-----------
robustindex (1oct17)
Modified Paths:
--------------
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/multisample.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex 2017-10-02 21:58:12 UTC (rev 45451)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/multisample.tex 2017-10-02 21:58:27 UTC (rev 45452)
@@ -1,22 +1,22 @@
-% multisample.tex
+% multisample.tex 2017/09/29
\documentclass{book}
\usepackage{makeidx}
\usepackage[multind]{robustindex}
-\usepackage{robustglossary}
\usepackage[plainpages=false,hyperindex=false]{hyperref}
\title {A file with several indexes}
-\author{Wilberd van der Kallen\index{Wilberd}}
+\author{Wilberd van der Kallen\index{wilberd at Wilberd}}
\date{2017}
\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}
\setindex{b1}
@@ -35,8 +35,12 @@
\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, albeit in a plain style only.
+ 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.
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|.
@@ -46,8 +50,7 @@
before, then a new index with that tag is created. The tag \verb|main| is always known and
the index with tag \verb|main| becomes active at the \verb|\begin{document}|.
The \verb!\index! command and
-the \verb|\printindex| commands write to/from the active index.
-This is all you need to know about the option \verb!multind!.\\
+the \verb|\printindex| commands write to/from the active index.\\
If you wish you may use \verb!\sindex[bis]{!\emph{entry}\verb!}! as shorthand for\\
@@ -76,12 +79,9 @@
That is inherent in our method.
Indeed we had to disable the implicit page range formation of makeindex.
-Of course the index file {\it filename}.\texttt{ind}
-may be edited to remedy such flaws, but our hacking has made this file pretty unreadable.
-Use the option \verb!multind! only if you are willing to keep the indexes simple. Even without editing the index file
-one may create complicated effects like the page ranges on
-page \pageref{range}, which use several fonts in their page numbers.
-That is bad style, but it is possible. Note that if you open a page range you must close
+The index file {\it filename}.\texttt{ind} has become quite unreadable. Do not edit it.
+Use the option \verb!multind! only if you are willing to keep the indexes standard.
+Note that if you open a page range you must close
it again with the same index active as when you opened the range.
We have hacked various mechanisms of makeindex.
@@ -124,8 +124,9 @@
\usepackage{makeidx}
\usepackage[multind]{robustindex}
+\usepackage[plainpages=false,hyperindex=false]{hyperref}
...
-...\author{Wilberd van der Kallen\index{Wilberd}}
+...\author{Wilberd van der Kallen\index{wilberd at Wilberd}}
...
\makeindex % obligatory with robustindex
@@ -141,22 +142,21 @@
\setindex{a1}\index{alpha!see beta} % on page 5
\index{alpha!see also gamma\gobblepageref} % on page 5
...
-...
\indexincontents % before the index.
\setindex{main}
\printindex
-
-\renewcommand{\indexname}{Index bis}
-....
+...
+\renewcommand{\indexcapstyle}[1]{\indexspace\textsc{#1}\par}
+\renewcommand{\indexname}{Index with headings}
+\setindex{main}
+\printindex
\end{document}
\end{verbatim}
-\index{c1int at as! t at is}
+\index{as! t at is}
-\index{998b at 998}
+\index{tris}
-\index{997b at tris}
-
\setindex{main}\index{alpha}
\setindex{a1}\index{gamma}
@@ -163,13 +163,13 @@
\setindex{bis}\index{bis}
-\setindex{main}\index{hier at vardelta}
+\setindex{main}\index{delta!vardelta}
-%\setindex{main}\index{hier at animal!than at fish}
-\setindex{main}\index{hier at animal!than at fish}
-\setindex{main}\index{hier at animal!ruminant!cow}
+\setindex{main}\index{animal!than at fish}
+\setindex{main}\index{animal!ruminant!cow}
+
\setindex{main}\index{time!here at now}
@@ -195,7 +195,7 @@
latex \emph{filename}.tex, makeindex \emph{filename}, latex \emph{filename}.tex.
\index{page range|)textit}%
-%\setindex{b1}\index{page range!risky at this $\vert$is$\vert$ complicated|texttt}
+
\sindex[b1]{page range!risky at this $\vert$is$\vert$ complicated|texttt}
%
@@ -204,59 +204,8 @@
%
\index{simpler!page range|)}%
\index{simplest page range|)}%
-% Let us pretend this page explains $\mathrm{Ext}^i_B(M,N)$.
-\glossary{$\mathrm{Ext}^i_B(M,N)$&Ext group in the category $\mathcal C_B$}
-% Let us pretend this page explains $H^0(X,\mathcal L)$.
-\glossary{$H^0(X,\mathcal L)$&the sections of the vector bundle
-$\mathcal L|_X$ over $X$}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%
-% Our glossary entries are given in the format
-% \glossaryentry{$B$&Borel subgroup}{page number}
-% which would be generated by \glossary{$B$&Borel subgroup}
-% and written into the filename.glo file.
-% So the & separates the formula from its explanation.
-% We assume the explanation fits on the line.
-%
-% Our implementation:
-
-\def\itemamp#1{%
- \mbox{%
- \hbox to 10em{%
- #1% the formula
- \hss
- }%
- }%
- #2% its explanation
-}%
-
-\def\glossaryentry#1#2{%
- {\itemamp #1{\unskip, #2}%
- }\par
-}%
-
-\newenvironment{theglossary}{\parindent0pt\parskip0pt}{}
-
-\chapter*{Glossary of Notations}
-
-\begin{theglossary}\addcontentsline{toc}{chapter}{Glossary of Notations}
-
-% Now we copy from filename.glo, making changes as appropriate.
-% In this example we just changed the order of the entries.
-
-\glossaryentry{$H^0(X,\mathcal L)$&the sections of the vector bundle $\mathcal
-L
-|_X$ over $X$}{\glopageref{4}}
-
-\glossaryentry{$\mathrm{Ext}^i_B(M,N)$&Ext group in the category $\mathcal
-C_B$}
-{\glopageref{2}}
-
-\end{theglossary}
-
% If you want the index in the table of contents, you may do
%
% \clearpage
@@ -267,10 +216,9 @@
\indexincontents % before \printindex
-\let\oldpage\newpage
-%\def\newpage{\relax}
+
\renewcommand{\indexname}{Index}
\setindex{main}
\printindex
@@ -283,65 +231,14 @@
\setindex{a1}
\printindex
+
\renewcommand{\indexname}{Index with tag b1}
\setindex{b1}
\printindex
-\chapter*{Indexes get plain layout}\addcontentsline{toc}{chapter}{Indexes get plain layout}
-Our option \verb!multind! breaks yet another mechanisms of makeindex.
-Recall that \verb!robustindex! breaks automatic page ranges. The option \verb!multind! prevents
-makeindex from inserting
- \verb!\indexspace! commands at appropriate points in the index file.
-This makes the layout of an index more plain.
-Let us compare the index produced by \verb!\robustmanual.tex! with the same index produced
-after the package
-\verb!robustindex! is called with the option \verb!multind!.
-Curiously the order changes a little too.
-To get them in the same order replace \verb!\index{Wilberd}! with \verb!\index{wilberd at Wilberd}!.
-\renewcommand{\indexname}{First without option }
-\begin{theindex}
-
- \item alpha, 1
- \subitem see also gamma
- \subitem see beta, 2
- \item \&, {\textbf2}
-
- \indexspace
-
- \item discussion, 1--2
-
- \indexspace
-
- \item gamma, {\textbf2}
-
- \indexspace
-
- \item Wilberd, 1
-
-\end{theindex}
-
-\renewcommand{\indexname}{Next with option \texttt {multind} }
+\renewcommand{\indexcapstyle}[1]{\indexspace\textsc{#1}\par}
+\renewcommand{\indexname}{Index with headings}
\setindex{main}
-\begin{theindex}
-
-\item Wilberd, 1
-
-
- \item alpha, 1
- \subitem see also gamma
- \subitem see beta, 2
- \item \&, {\textbf2}
-
-
- \item discussion, 1--2
-
-
-
- \item gamma, {\textbf2}
-
-
-
-\end{theindex}
-
+\printindex
\end{document}
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 2017-10-02 21:58:12 UTC (rev 45451)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/robustmanual.tex 2017-10-02 21:58:27 UTC (rev 45452)
@@ -1,12 +1,12 @@
-% robustmanual.tex
+% robustmanual.tex 2017/09/29
\documentclass{article}
\usepackage{makeidx}
-\usepackage{robustindex}
+\usepackage[multind]{robustindex}
\usepackage[hyperindex=false]{hyperref}
\title {Manual of robustindex package}
-\author{Wilberd van der Kallen\index{Wilberd}}
+\author{Wilberd van der Kallen\index{wilberd at Wilberd}}
\date{2017}
\makeindex % obligatory with robustindex
@@ -84,13 +84,9 @@
the \emph{explicit} page range mechanism of makeindex as in
$$\verb!\index{discussion|(}!$$% used above
-%\index{discussion}% inside range, hence would be suppressed.
-%\index{discussion|blah}% inside range, hence would be suppressed.
-
-
on the first page of the range, followed by
$$\verb!\index{discussion|)}!$$\index{discussion|)}on the last page of the range.\\
@@ -101,11 +97,21 @@
\index{alpha!see beta}
Before discussing the \verb|multind| option we now use $\verb!\printindex!$ to get an index (on a new page).
+
\printindex
\section*{The \texttt{multind} option}
The \verb!multind! option provides
-support for multiple indexes, albeit in a plain index style.
+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}!.
+
+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.
@@ -119,13 +125,22 @@
If a tag has not been encountered
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.
-This is all you need to know about option \verb!multind!.\\
+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.
+If you wish you may use \verb!\sindex[bis]{!\emph{entry}\verb!}! as shorthand for\\
-To see how option \verb!multind! may be used, you may also compare the file
-\verb|multisample.tex| with the output after
+\hspace{5em} \verb!\setindex{bis}\index{!\emph{entry}\verb!}!\\
+
+and \verb!\sindex{!\emph{entry}\verb!}! as shorthand for\\
+ \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
+
latex multisample.tex
makeindex multisample
@@ -134,7 +149,26 @@
latex multisample.tex
+\subsection*{Embellishment}
+One may embellish an index with headings, like this.
+\verb!\setindex{main}!
+\verb!\renewcommand{\indexname}{Embellished Index}!
+\verb!\renewcommand{\indexcapstyle}[1]{\indexspace\textsc{#1}\par}!%
+
+\verb!\printindex! \\
+
+\noindent This gives
+
+\setindex{main}
+
+\renewcommand{\indexname}{Embellished Index}
+
+\renewcommand{\indexcapstyle}[1]{\indexspace\textsc{#1}\par}%
+
+\printindex
+
+
\end{document}
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 2017-10-02 21:58:12 UTC (rev 45451)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/robustsample.tex 2017-10-02 21:58:27 UTC (rev 45452)
@@ -1,4 +1,4 @@
-% robustsample.tex
+% robustsample.tex 2017/09/29
\documentclass{book}
\usepackage{makeidx}
@@ -59,11 +59,6 @@
\glossary{$H^0(X,\mathcal L)$&the sections of the vector bundle
$\mathcal L|_X$ over $X$}
-Of course the index file {\it filename}.\texttt{ind}
-may be edited to remedy such flaws. Such editing will actually be the
-recommended way to achieve more complicated effects like the page ranges on
-page \pageref{range}, which also use several fonts in their page numbers.
-That is actually bad style, but this file just illustrates features.
Traditionally page ranges and fonts for page numbers could be done with the
encapsulating construction of makeindex, but that construction is broken by our
@@ -73,6 +68,11 @@
We have restored encapsulating to some extent, sufficient for common practice,
but our rules are more naive than those of makeindex.
+Thus it becomes possible
+to have a page range as on
+page \pageref{range}, which has several fonts in its page numbers.
+That is actually bad style, but this file just illustrates features.
+
See the file \verb|robustsample.tex| for details.
Subentries are still supported. We illustrate this in
@@ -153,6 +153,7 @@
\usepackage{makeidx}
\usepackage{robustindex}
+\usepackage[plainpages=false,hyperindex=false]{hyperref}
...
...\author{Wilberd van der Kallen\index{Wilberd}}
...
Modified: trunk/Master/texmf-dist/doc/latex/robustindex/stind.html
===================================================================
--- trunk/Master/texmf-dist/doc/latex/robustindex/stind.html 2017-10-02 21:58:12 UTC (rev 45451)
+++ trunk/Master/texmf-dist/doc/latex/robustindex/stind.html 2017-10-02 21:58:27 UTC (rev 45452)
@@ -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>
+<A HREF="robustindex.sty">robustindex.sty</A> (version 2017/09/28)
achieves this with the \pageref mechanism.
<P>
Here is our <A HREF="robustmanual.pdf">Manual for the robustindex package</A>.
Modified: trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty 2017-10-02 21:58:12 UTC (rev 45451)
+++ trunk/Master/texmf-dist/tex/latex/robustindex/robustindex.sty 2017-10-02 21:58:27 UTC (rev 45452)
@@ -30,9 +30,9 @@
% adding the \usepackage{robustindex} to the preamble. Do not exclude any
% relevant files, as in \includeonly.
%
-% The option multind provides support for several indexes with pagerefs,
-% albeit with a simple layout. There is just one index file,
-% and the usual compilation cycle (latex, makeindex, latex) suffices.
+% The option multind provides support for several indexes with pagerefs.
+% There is just one index file, and the usual compilation cycle
+% (latex, makeindex, latex) suffices.
% With the command \setindex in the LaTeX file one arranges which index is
% the active one at any given moment.
% This steers the behaviour of \index and \printindex.
@@ -41,8 +41,12 @@
%
% While robustindex.sty broke the automatic page range feature of
% makeindex, the multind option also breaks the insertions
-% of \indexspace in the index file.
-% This makes that the layout of an index gets more plain.
+% 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.
+%
% The various hacks make the index file pretty unreadable
% and style files of makeindex will probably fail.
%
@@ -62,7 +66,7 @@
% version 1999/12/01 or later.
\ProvidesPackage{robustindex}
- [2017/09/12
+ [2017/09/28
index entries with pagerefs]
\DeclareOption{multind}{
@@ -181,9 +185,7 @@
\PackageWarning{robustindex}{%
Index not up to date, run makeindex. Detected%
}\else
- \PackageWarning{robustindex}{%
- Print each index or run makeindex. Detected%
- }%
+ \PackageWarning{robustindex}{Print each index or run makeindex. Detected}%
\fi
\fi
\fi
@@ -209,8 +211,9 @@
% 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}, where towrap is a sequence
-% of letters and \towrap is to be wrapped around \indpageref{countervalue}.
+% \index{entry|towrap}, \index{entry|(towrap}, \index{entry|)towrap}, where
+% towrap is a sequence of letters and \towrap is to be wrapped around
+% \indpageref{countervalue}.
\newcommand{\findencap}{}%
@@ -281,9 +284,54 @@
\ignorespaces
}%
+
+
% 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.
+% 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.
+\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{\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}}%
+
+\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}%
+
+\def\find at capitals#1#2\relax{% To deal with 26 letters.
+\indexcapitalhead #1%
+\ifx\relax#2\relax
+\else\find at capitals#2\relax
+\fi}%
+
+\newcommand{\letretst}{\relax}% To test if entry starts with new letter.
+
+\long\def\letretst#1{\ifx#1\nxtletre\else\procletter{#1}\fi}%
+
+\newcommand{\procletter}{\relax}% To process a new letter.
+
+\def\procletter#1{\long\def\item{\olditem}\indexcapstyle{\nwletre}\ifx#1\indnr
+\expandafter\ja@\else #1\fi}%
+
+\newcommand{\olditem}{\relax}%
+
+\def\ja@#1s{\fi}% 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
@@ -293,33 +341,33 @@
\fi
\@esphack}%
+\ifx\robust at mult\undefined\def\setindex{\relax}\fi
-
-\newcounter{multindctr}
+\newcounter{multindctr}%
\newcommand{\robustcutpoint}{\relax}%
\newcommand{\untilrobustcutpoint}{\relax}%
\newcommand{\newindex}{\relax}%
\newcommand{\robustchoice}{\relax}%
-\newcommand{\indnr}{\relax}
+\newcommand{\indnr}{\relax}%
-\setcounter{multindctr}{999}
+\setcounter{multindctr}{999}%
\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{\@bsphack\@esphack}%
-% The \indnr#1s part is not for output, but for Makeindex sorting, separating the
-% different indexes.
+\def\indnr#1s{}%
\newcommand{\gobbletillnine}{\relax}
\def\gobbletillnine#1 9{\relax}
-\def\newindex#1{\@bsphack\ifnum\c at multindctr=999%
+\def\newindex#1{\@bsphack
+\ifnum\c at multindctr=999%
\protected at write
\@indexfile {}{\string \indexentry
- {\string\indnr 999bs @\string\robustcutpoint\string\gobbletillnine}{9}}%
+ {\string\indnr 999bs @\string\nxtletre
+ \string\robustcutpoint\string\gobbletillnine}{9}}%
\@esphack
\fi
\addtocounter{multindctr}{-1}%
@@ -329,8 +377,10 @@
\@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\untilrobustcutpoint\string\fi\string\gobbletillnine
-}{9}}%
+\string\else\string\nxtletre\string\untilrobustcutpoint
+\string\fi\string\gobbletillnine
+}{9}}%
+\capitalsinindex{abcdefghijklmnopqrstuvwxyz}%
\@esphack
}%
More information about the tex-live-commits
mailing list