summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ulem/ulem.ltx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/ulem/ulem.ltx')
-rw-r--r--macros/latex/contrib/ulem/ulem.ltx34
1 files changed, 17 insertions, 17 deletions
diff --git a/macros/latex/contrib/ulem/ulem.ltx b/macros/latex/contrib/ulem/ulem.ltx
index 2979659c30..4d46a2f9e9 100644
--- a/macros/latex/contrib/ulem/ulem.ltx
+++ b/macros/latex/contrib/ulem/ulem.ltx
@@ -2,9 +2,9 @@
% ulem.ltx Manual for ulem.sty
%
%
-% Copyright (c) 1989-2011 by Donald Arseneau
+% Copyright (c) 1989-2019 by Donald Arseneau
%
-% Version date 2011/03/18
+% Version date 2019/11/18
%
\documentclass[12pt]{ltxdoc}
\addtolength{\textwidth}{1cm}
@@ -15,7 +15,7 @@
\hyphenation{normalem uwforbf ulforem}
\title{The ulem package:\\ underlining for emphasis}
\author{Donald Arseneau\\ asnd@triumf.ca}
-\date{2011/03/18}
+\date{2019/11/18}
\begin{document}
\maketitle
@@ -46,7 +46,7 @@
\begin{footnotesize}
-\noindent The ulem package is Copyright \copyright\ 1989--2011 by
+\noindent The ulem package is Copyright \copyright\ 1989--2019 by
Donald Arseneau (Vancouver, Canada).\\
The package (ulem.sty) and this documentation (ulem.ltx, ulem.pdf) may be
freely transmitted, reproduced, or modified for any purpose provided that the
@@ -104,9 +104,8 @@ Alternative package: soul.
You can define your own styles of overprinting or underlining by using
the \cs{markoverwith} command in the definition of your new command.
-The definition should be something like:\\[3pt]
-\indent
- \cs{newcommand}\cs{cmd}|{|\cs{bgroup} \cs{markoverwith}|{|\meta{something}|}|\cs{ULon}|}|\\[3pt]
+The definition should be something like:\\[6pt]
+ \cs{newcommand}\cs{cmd}|{|\cs{bgroup} \meta{settings}\cs{markoverwith}|{|\meta{something}|}|\cs{ULon}|}|\\[8pt]
The `\meta{something}' can be as simple as a single character, or as complex as
you can keep track of; it will likely contain some repositioning commands, perhaps
\cs{raisebox}.
@@ -127,26 +126,27 @@ Any type of underlining can be substituted for any font-selection command
by issuing a proper \cs{useunder} declaration:\\[3pt]
\cs{useunder}|{|\meta{underlinecommand}|}{|\meta{fontdeclaration}|}{|\meta{fontcommand}|}|\\[3pt]
e.g., |\useunder{\uuline}{\bfseries}{\textbf}| gives a double underline
-instead of bold face in \LaTeX.
+instead of bold face in \LaTeX\ (but note the problem explained next).
The commands \cs{normalem} and \cs{ULforem} respectively disable and enable
underlining for \cs{em}/\cs{emph}, and so do the \cs{usepackage}
options [normalem] and [ULforem]. There is also the \cs{usepackage}
-option [UWforbf] to replace boldface with a wavey underline. These features
-use the \cs{useunder} command internally. UWforbf does handle bold in
-math mode, in a limited way, but it doesn't work in section titles,
-unfortunately, because the titles are not delimited by explicit braces when
-printed by the \cs{section} command. Currently under UWforbf the \cs{bfseries}
+option [UWforbf] to replace boldface from \cs{textbf} with a wavey underline.
+These features use the \cs{useunder} command internally.
+UWforbf specifically employs
+\cs{useunder}|{|\cs{uwave}|}|\allowbreak|{|\cs{bf}|}|\allowbreak|{|\cs{textbf}|}|,
+so the \cs{bfseries}
command still produces bold face, but \cs{bf} makes an
-under-wave\footnote{%% no verbatim in footnotes
+under-wave (if \cs{bf} is defined at all). That is
+because section title formatting typically uses \cs{bfseries} not delimited by
+braces, which would give errors for \cs{uwave}.\footnote{%% no verbatim in footnotes
To get under-waved section titles (in ordinary \LaTeX\ classes) you could define:\\
\texttt{\string\renewcommand\string\@seccntformat[1]\string{\string\uwave
\string{\string\csname\ the\#1\string\endcsname\string}\string\hskip 1em\string}}\\
and later specify
\texttt{\string\section[...]\string{\string\uwave\string{...\string}\string}}.
But you don't want to enter that swamp.}
-(if |\bf| is defined at all).
-In plain \TeX\ there is |\bf| but no \cs{textbf} so you could say |\useunder{\UWave}{\bf}{}|.
+In plain \TeX\ there is \cs{bf} but no \cs{textbf} so you could say |\useunder{\uwave}{\bf}{}|.
Some commands, such as |\\| and \cs{hskip} are given special treatment to
work within uline, but others are not. Support for others can sometimes
@@ -157,7 +157,7 @@ versions of commands should be modelled on |\UL@hskip| or |\UL@cr|, and
should include the test `|\ifx\ \LA@space|'. For example, support for
\cs{marginpar} is added through the hook mechanism.
-All the underlining commands are robust (self-protecting) in \LaTeX.
+All the underlining commands are robust in \LaTeX.
\section{Complications}