summaryrefslogtreecommitdiff
path: root/indexing/xindex/doc/xindex-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2023-07-13 03:01:48 +0000
committerNorbert Preining <norbert@preining.info>2023-07-13 03:01:48 +0000
commit09fc70b0ee7cb93f02510dd10df6b769b62c9d76 (patch)
tree2b31427a79c780325ede59c5a45c5e97bad0342a /indexing/xindex/doc/xindex-doc.tex
parent0a2934080da36226eca1cdccfd08d76f67dca95a (diff)
CTAN sync 202307130301
Diffstat (limited to 'indexing/xindex/doc/xindex-doc.tex')
-rw-r--r--indexing/xindex/doc/xindex-doc.tex79
1 files changed, 66 insertions, 13 deletions
diff --git a/indexing/xindex/doc/xindex-doc.tex b/indexing/xindex/doc/xindex-doc.tex
index bf2dd746da..0c5974e046 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.49}% can be automatically changed by perl
+\setVersion{version = 0.51}% can be automatically changed by perl
@@ -274,7 +274,7 @@ are alphabetized.
\makeatother
%StartVisiblePreamble
\usepackage{makeidx}\makeindex
-\usepackage{xindex}% for \left|\rightParen
+\usepackage{xindex}% for \barceLeft|Right
%StopVisiblePreamble
\pagestyle{empty}
\begin{document}
@@ -285,8 +285,8 @@ are alphabetized.
\item Doublequote \verb|"| \index{""}
\item Double doublequote \verb|""| \index{""""}
\item At character @ \index{At ("@)}\index{"@}
-\item Left paranthesis \{ \index{\parenLeft}
-\item Right paranthesis \} \index{\parenRight}
+\item Left paranthesis \{ \index{\braceLeft}
+\item Right paranthesis \} \index{\braceRight}
\end{itemize}
run \texttt{xindex -u <file.idx>}\index{file.idx@\texttt{<file.idx>}|textit}\index{123}
\index{Etage} \index{Ètagé}
@@ -295,8 +295,8 @@ run \texttt{xindex -u <file.idx>}\index{file.idx@\texttt{<file.idx>}|textit}\ind
\end{document}
\end{externalDocument}
-It is by design that the parentheses \{ and \} cannot be used as index entry. The \emph{package}
-xindex defines the two commands \Lcs{parenLeft} and \Lcs{parenRight} which can be used instead
+It is by design that the braces \{ and \} cannot be used as index entry. The \emph{package}
+xindex defines the two commands \Lcs{braceLeft} and \Lcs{braceRight} which can be used instead
(see examples above and and below).
The same example without using unicode sorting (no option \Loption{-u}):
@@ -325,7 +325,7 @@ The same example without using unicode sorting (no option \Loption{-u}):
\makeatother
%StartVisiblePreamble
\usepackage{makeidx}\makeindex
-\usepackage{xindex}% for \left|\rightParen
+\usepackage{xindex}% for \braceLeft|\braceRight
%StopVisiblePreamble
\pagestyle{empty}
\begin{document}
@@ -336,8 +336,8 @@ The same example without using unicode sorting (no option \Loption{-u}):
\item Doublequote \verb|"| \index{""}
\item Double doublequote \verb|""| \index{""""}
\item At character @ \index{At ("@)}\index{"@}
-\item Left paranthesis \{ \index{\parenLeft}
-\item Right paranthesis \} \index{\parenRight}
+\item Left paranthesis \{ \index{\braceLeft}
+\item Right paranthesis \} \index{\braceRight}
\end{itemize}
run \texttt{xindex -u <file.idx>}\index{file.idx@\texttt{<file.idx>}|textit}\index{123}
\index{Etage} \index{Ètagé}
@@ -371,8 +371,8 @@ The two characters \verb|{}| cannot be used as \verb|\{\}| inside the argument o
The package \Lpack{xindex} defines the two helper macros
\begin{verbatim}
-\providecommand\parenLeft{\{}
-\providecommand\parenRight{\}}
+\providecommand\braceLeft{\{}
+\providecommand\braceRight{\}}
\end{verbatim}
The following example shows how to use it:
@@ -410,8 +410,8 @@ The following example shows how to use it:
\item Doublequote \verb|"| \index{>"}
\item Double doublequote \verb|""| \index{>">"}
\item At character @ \index{At (>@)}
-\item Group start \{ \index{\parenLeft}
-\item Group end \{ \index{\parenRight}
+\item Group start \{ \index{\braceLeft}
+\item Group end \{ \index{\braceRight}
\end{itemize}
Run \texttt{xindex} with \texttt{xindex -e ">"}\index{<file.idx>}\index{123}
\newpage
@@ -2231,6 +2231,59 @@ Foo\index{foo!bar2!baz2}
\end{document}
\end{externalDocument}
+The following example fixes a problem with \Lpack{hyperref} and escaping the | character
+
+
+\begin{externalDocument}[
+% grfOptions={width=\dimexpr\linewidth-2\fboxsep-2\fboxrule},
+% mpwidth=0.55\linewidth,
+ pages={3},
+ frame=false,
+ compiler=lualatex,
+ crop,
+ force=true,
+ shellesc,
+% xindex,
+% xindexOptions=-,
+ runs=2,code,docType=latex,
+ showFilename,
+ align=\centering,
+% grfOptions={width=\linewidth},
+ lstOptions={columns=fixed}]{xindex}
+%! lualatex --shell-escape
+\documentclass{article}
+\usepackage{libertinus}
+\let\NewPage\newpage% only for demo
+\makeatletter
+\renewcommand\newpage{\NewPage\let\ps@plain\ps@empty}
+\makeatother
+%StartVisiblePreamble
+\usepackage[imakeidx]{xindex}
+\usepackage{hvindex}
+\makeindex[columns=4, columnsep=6pt, options=--fix_hyperref]
+\usepackage[unicode]{hyperref}
+%StopVisiblePreamble
+\pagestyle{empty}
+\begin{document}
+ Symbols:\\
+ ! \index{"!} " \index{""} \# \index{#@\#} \$ \index{$@\$}
+ \% \index{%@\%} \& \index{&@\&} ' \index{'} ) \index{)}
+ ( \index{(} * \index{*} + \index{+} , \index{,@,\,}
+ - \index{-} . \index{.} / \index{/} : \index{:}
+ ; \index{;} < \index{<} = \index{=} > \index{>}
+ ? \index{?} @ \index{"@} [ \index{[} ] \index{]}
+ \_ \index{_@\_} ` \index{`} | \index{\textbar}
+ \newpage\index{"|}\index{123}\Index{Post}
+ \{ \index{\braceLeft} \} \index{\braceRight}
+ \textbackslash \index{\@\textbackslash}
+ \textasciicircum \index{^@\textasciicircum}
+ \textasciitilde \index{~@\textasciitilde}
+ Alphabet: \Index{Z},\Index{Zeppelin}\Index{Foo}\dots
+ \Index{...@\ldots}
+ \printindex
+\end{document}
+\end{externalDocument}
+
\printindex
\end{document}