summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/showlabels
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/showlabels')
-rw-r--r--macros/latex/contrib/showlabels/README22
-rw-r--r--macros/latex/contrib/showlabels/VERSION2
-rw-r--r--macros/latex/contrib/showlabels/showlabels.dtx341
-rw-r--r--macros/latex/contrib/showlabels/showlabels.html278
-rw-r--r--macros/latex/contrib/showlabels/showlabels.pdfbin156657 -> 236692 bytes
-rw-r--r--macros/latex/contrib/showlabels/style.css39
6 files changed, 536 insertions, 146 deletions
diff --git a/macros/latex/contrib/showlabels/README b/macros/latex/contrib/showlabels/README
index 73daacd6bb..915e7f5308 100644
--- a/macros/latex/contrib/showlabels/README
+++ b/macros/latex/contrib/showlabels/README
@@ -4,7 +4,8 @@ Showlabels
Put the names of `\labels` and other commands into the margins of a draft
document.
-Version 1.8, 2016 June 9, http://purl.org/nxg/dist/showlabels.
+Version 1.9, 2021 October 9;
+<http://purl.org/nxg/dist/showlabels>.
This class option helps you keep track of all the labels in your
documents, by putting the name of the new label into the margin
@@ -23,11 +24,20 @@ As well, you can have the arguments to other commands besides `\label`
displayed. This is fairly obviously useful for the `\cite` command, but
it can be useful for `\ref` or `\begin` as well.
-The source code for the package is maintained at
-[bitbucket.org](https://bitbucket.org/nxg/showlabels). This site
-includes an issue tracker, where you can report bugs (or just mail me).
+Links:
-This work is Copyright 1999, 2001-09, 2013-16, Norman Gray, and may be
+ * Canonical software home page: <http://purl.org/nxg/dist/showlabels>
+ (use this rather than the URL it redirects to).
+
+ * On CTAN: <https://www.ctan.org/pkg/showlabels>
+
+ * The source code for the package is maintained
+ [at sourcehut](https://hg.sr.ht/~nxg/showlabels).
+
+ * There's also an [issue tracker](https://todo.sr.ht/~nxg/showlabels)
+ at sourcehut. Or you can just mail me.
+
+This work is Copyright 1999, 2001-09, 2013-21, Norman Gray, and may be
distributed and/or modified under the conditions of the LaTeX Project
Public Licence, either version 1.3 of this licence or (at your option)
any later version. See the distributed file lppl.txt for details.
@@ -35,4 +45,4 @@ any later version. See the distributed file lppl.txt for details.
For more information, see showlabels.html in the distribution.
Norman Gray
-http://nxg.me.uk
+https://nxg.me.uk
diff --git a/macros/latex/contrib/showlabels/VERSION b/macros/latex/contrib/showlabels/VERSION
index 6259340971..2e0e38c63a 100644
--- a/macros/latex/contrib/showlabels/VERSION
+++ b/macros/latex/contrib/showlabels/VERSION
@@ -1 +1 @@
-1.8
+1.9
diff --git a/macros/latex/contrib/showlabels/showlabels.dtx b/macros/latex/contrib/showlabels/showlabels.dtx
index 3a2c457965..c1a72a27ff 100644
--- a/macros/latex/contrib/showlabels/showlabels.dtx
+++ b/macros/latex/contrib/showlabels/showlabels.dtx
@@ -2,7 +2,7 @@
%
%% This is the showlabels package
%%
-%%%% Copyright 1999, 2001-09, 2013-16, Norman Gray
+%%%% Copyright 1999, 2001-09, 2013-21, Norman Gray
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public Licence, either version 1.3
@@ -14,23 +14,18 @@
%%
%% This work has the LPPL maintenance status `maintained'.
%%
-%% The Current Maintainer of this work is Norman Gray <http://nxg.me.uk>
+%% The Current Maintainer of this work is Norman Gray <https://nxg.me.uk>
%%
%% This work consists of the files showlabels.dtx and showlabels.ins,
%% and the derived file showlabels.sty.
%%%% File: showlabels.dtx
-%%%% Source: 95a544e6b41b, 2016-06-09T16:51:03+01:00
+%%%% Source: 5b2959804f35, 2021-10-09T20:59:45+01:00
-\def\filename{showlabels}
-\def\fileversion{1.8}
-\def\filedate{2016/06/09}
-\def\docdate{2016 June 9}
-\def\filemaintainer{norman@astro.gla.ac.uk}
-% This is revision 95a544e6b41b, 2016-06-09T16:51:03+01:00.
+% This is revision 5b2959804f35, 2021-10-09T20:59:45+01:00.
%<+package>\NeedsTeXFormat{LaTeX2e}
-%<+package>\ProvidesPackage{showlabels}[\filedate\space v\fileversion]
-%<+package>\typeout{Package: `showlabels' v\fileversion\space<\filedate>}
+%<+package>\ProvidesPackage{showlabels}[2021-10-09\space v1.9]
+%<+package>\typeout{Package: `showlabels' v1.9\space<2021-10-09>}
%
%<*driver>
\documentclass{ltxdoc}
@@ -67,9 +62,9 @@
% \fi
%
%
-% \title{The \texttt{\filename} package}
-% \author{Norman Gray\\|norman@astro.gla.ac.uk|}
-% \date{Version \fileversion, \docdate}
+% \title{The \texttt{showlabels} package}
+% \author{Norman Gray\\|gray@nxg.name|}
+% \date{Version 1.9, 2021 October 9}
%
% \maketitle
%
@@ -126,6 +121,17 @@
% then give the option \Lopt{nolabel} to the |\usepackage| command:
% |\usepackage[nolabel]{showlabels}|.
%
+% You can do this |\showlabels| step even with commands that you
+% invoke only implicitly. If, for example, you want to label each of the
+% entries in your bibliography, then |\showlabels{bibitem}|
+% will do this for each of the items that appear in the
+% \Lenv{thebibliography} environment, whether it is writen by you or
+% by \BibTeX\ (if you use the `biblatex' package, then the
+% corresponding command would be
+% |\makeatletter\showlabels{blx@bibitem}\makeatother|, but notice that
+% this is in principle an undocumented internal of the `biblatex'
+% package, so may change).
+%
% By default, the package displays labels in the margin of the
% document, but as an alternative, labels can be kept inline as much
% as possible; this is much more legible when there are multiple
@@ -139,7 +145,7 @@
% temporarily, within a block or environment. Use the
% |\showlabelsinline| macro to do that.
%
-% \subsection*{Formatting}
+% \section{Formatting}
%
% If you want to change the font the labels appear in, redefine the
% |\showlabelfont| command, which by default expands to
@@ -148,8 +154,8 @@
% \begin{quote}
% |\renewcommand{\showlabelfont}{\small\slshape\color{green}}|
% \end{quote}
-% in the preamble of your document, as long as you have loaded the
-% \Lpackage{color} package.
+% in the preamble of your document (as long as you have loaded the
+% \Lpackage{color} package, of course).
%
% Alternatively, the |\showlabels| command has an optional argument containing
% formatting commands, which allows you to format |\cite| labels, for
@@ -157,6 +163,12 @@
% \begin{quote}
% |\showlabels[\color{green}]{cite}|
% \end{quote}
+% The optional formatting command can be either a font-changing
+% command, as illustrated here, \emph{or} a command which takes a
+% single argument, such as
+% \begin{quote}
+% |\showlabels[\fbox]{cite}|
+% \end{quote}
%
% If, finally, you want complete control over the labels, you can
% instead override |\showlabelsetlabel|, which initially expands to
@@ -168,16 +180,28 @@
% \null\qquad |{\begin{turn}{60}\showlabelfont #1\end{turn}}|\\
% \end{quote}
% then you end up with your labels at a jaunty angle in the margin.
-% Finally, you can change the definition of the
-% |\showlabelrefline| rule from its default,
-% in order to change how the inline rule (see below) is displayed.
+%
+% The command |\showlabeltype| will expand to the current label type
+% (ie, `label' or `cite', etc), so it would be possible for
+% |\showlabelsetlabel| to conditionalise on that, if you felt that
+% were necessary.\footnote{The support for an one-argument command in
+% $\backslash$\texttt{showlabels}, and the presence of the
+% $\backslash$\texttt{showlabeltype} macro, were added in version 1.9.}
+%
+% If instead you want to adjust how inline markings are displayed, you
+% can change the definition of the
+% |\showlabelrefline| rule from its default.
% For example, defining this to be
+% \begin{quote}
% |\color{red}\hrule width 0.1em height 1.5ex depth 0pt |
+% \end{quote}
% produces a fattish red line, and defining it to be
+% \begin{quote}
% |\hrule width 0pt height 1.5ex depth 0pt|
+% \end{quote}
% suppresses the line but still positions the text between the lines.
%
-% \subsection*{Compatibility with other packages, and other problems}
+% \section{Compatibility with other packages, and other problems}
%
% The \Lpackage{showlabels} package works by redefining the |\label|
% command, along with a few internal \LaTeX\ commands. All the other commands it
@@ -252,18 +276,18 @@
% The canonical home page of the package is
% \url{http://purl.org/nxg/dist/showlabels}, and it is on CTAN at
% \url{https://www.ctan.org/pkg/showlabels}. The source is in
-% a repository at Bitbucket: \url{https://bitbucket.org/nxg/showlabels/}.
+% a repository online: \url{https://hg.sr.ht/~nxg/showlabels}.
%
-% \subsection*{Other packages}
+% \section{Other packages}
%
% The \Lpackage{showlabels} package has a large overlap in
% functionality with David Carlisle's \Lpackage{showkeys}, although
% the latter will only handle |\label| and |\cite| keys. If
% \Lpackage{showlabels} fails in some particular situation, you might
% want to try using \Lpackage{showkeys}, but please do mention the
-% problem, either by email to me, or via the Bitbucket issues list.
+% problem, typically by email to me.
%
-% \subsection*{History and Credits}
+% \section{History and Credits}
%
% I've received bug reports, fixes, or implementable suggestions from many
% people, including
@@ -303,6 +327,234 @@
% \url{hank@ducvax.auburn.edu}, made the update to NFSS, and
% changed the name to `showlabel.sty'.
%
+% \subsection{Release notes}
+% \begingroup
+% \iffalse the following are variously unsatisfactory
+% \def~{\texttt{\textasciitilde}}
+% \def~{$\sim$}
+% \fi
+% \catcode`\~=12
+% \iffalse @RELEASENOTES@ \fi
+% \begin{description}
+%
+% \item[1.9, 2021 October 9]\relax
+% \begin{itemize}
+% \item Robustness fix: macros in arguments are now handled, so that
+% (after |\showlabel{index}|),
+% |\index{Poincar\'e}| doesn't cause an error.
+% \item The |\showlabel[optarg]{command}| optional argument
+% can now take a one-argument command.
+% \item The macro |\showlabeltype| expands to the current
+% label type, for possible use in |\showlabelsetlabel|.
+% \item The code has moved from Bitbucket to
+% Sourcehut\footnote{\url{https://sourcehut.org}}: the new repository is
+% https://hg.sr.ht/~nxg/showlabels\footnote{\url{https://hg.sr.ht/~nxg/showlabels}}.
+% The issues links in the list below are therefore broken.
+% \end{itemize}
+%
+%
+% \item[1.8, 2016 June 9]\relax
+% The |ntheorem| package exposed an apparently
+% long-standing incompleteness in the handling of |amsmath|
+% documents.
+% Fixes issue 9\footnote{\url{https://bitbucket.org/nxg/showlabels/issues/9/}}.
+%
+%
+%
+% \item[1.7, 2015 December 8]\relax
+% Release v1.7.
+%
+%
+%
+% \item[1.7b2, 2015 December 7]\relax
+% Make the combination of amsmath and [inline] mode work
+% (fixes issue 8\footnote{\url{https://bitbucket.org/nxg/showlabels/issue/8/}}
+% – thanks to A L Dukeman for the report;
+% what is it about showlabels and 6 December?!).
+%
+%
+%
+% \item[1.7b1, 2014 December 6]\relax
+% This is a much-delayed bugfix release (by coincidence
+% \emph{exactly} a year after the previous release!).
+%
+% \begin{itemize}
+% \item Give |\showlabels| an optional formatting argument
+% (implements issue 1\footnote{\url{https://bitbucket.org/nxg/showlabels/issue/1/}}
+% – thanks to Francesco Biccari for the suggestion).
+% \item Special-case the IEEEtrantools package
+% (fixes issue 2\footnote{\url{https://bitbucket.org/nxg/showlabels/issue/2/}}
+% – thanks to Boris Kheyfets for the report and test case, and to
+% Ben William Carabelli for additional analysis and a draft fix).
+% \item The |[final]| option now works with the
+% |{amsmath}| package
+% (fixes issue 3\footnote{\url{https://bitbucket.org/nxg/showlabels/issue/3/}}
+% – thanks to Guillermo Garza and Enno Nagel for the report, and to
+% Guillermo for the test case).
+% \item Handle the hyperref package's |\ref*{label}| variant
+% (fixes issue 4\footnote{\url{https://bitbucket.org/nxg/showlabels/issue/4/}}
+% – thanks to Alex Watson for the report and test case).
+% \item Handle the case where a label is in a display, but not in maths mode
+% (fixes issue 5\footnote{\url{https://bitbucket.org/nxg/showlabels/issue/5/}}
+% – thanks to ‘bartgol’ on Stackexchange for the report and test case).
+% \end{itemize}
+%
+%
+% \item[1.6.6, 2013 December 6]\relax
+% \begin{itemize}
+% \item Add configuration interface |\showlabelrefline| and
+% ensure that |\color| works in
+% |\showlabelfont|.
+% \item Various documentation tweaks
+% \item Change licence from GPL to LPPL
+% \item Fix link to repository
+% \end{itemize}
+%
+%
+% \item[1.6.5, 2009 May 27]\relax
+% Fixed a bug in the way that labels including underscores (and
+% other ‘exotic’ characters) were displayed.
+%
+%
+%
+% \item[1.6.4, 2008 October 10]\relax
+% Fixed another poor interaction between eqnarray and amsart. Now
+% we get equation labels in eqnarray, and we don't get marginal notes
+% about |\eqref| (which is good; might this finally be fixed?).
+%
+%
+%
+% \item[1.6.3, 2008 July 24]\relax
+% Release 1.6.2 broke compatibility with the \emph{rest} of
+% amsmath (|eqnarray| became the only thing that worked
+% within amsmath)! Fixed. Doh!
+%
+%
+%
+% \item[1.6.2, 2008 June 27]\relax
+% The reimplementation of eqnarray within amsart was such that
+% equation labels disappeared in that case. Fixed.
+%
+%
+%
+% \item[1.6.1, 2007 June 17]\relax
+% Fix an errant test, which mangled equation labels starting
+% with two identical letters.
+%
+%
+%
+% \item[1.6, 2006 May 26]\relax
+% The |\showlabels| command will now work with commands
+% (such as |\cite| or |\includegraphics|) which
+% take an optional argument.
+%
+%
+%
+% \item[1.5a, 2005 March 17]\relax
+% Defined |\showlabelfont| using
+% |\ttfamily| rather than |\tt| (I'd
+% avoided doing this before to avoid a seemingly pointless
+% incompatibility with LaTeX 2.09, but (a) I imagine the
+% package is incompatible with that for other reasons, and (b)
+% it's really not worth the hassle...).
+%
+%
+%
+% \item[1.5, 2004 October 8]\relax
+% Added |\showlabelfont| and
+% |\showlabelsetlabel| commands, allowing
+% customisation of the printed labels. Added and documented
+% options [final], [draft] (the former makes this package do
+% nothing; the latter is the default behaviour).
+%
+%
+%
+% \item[1.4a, 2003 January 28]\relax
+% Acquired the |[left]| and
+% |[right]| options, and fixed a bug which affected
+% |\label| commands in captions.
+%
+%
+%
+% \item[1.4, 2001 July 24]\relax
+% Became (more) compatible with the
+% wrapfig package. Also, I added the
+% |\showlabels| command, to have the package display
+% references to commands other than |\label|
+% (|\cite| and |\ref| are obvious ones),
+% and an |[inline]| option to have labels (etc.)
+% displayed inline where possible, rather than always in the
+% margin.
+%
+%
+%
+% \item[1.3e, 2001 May 30]\relax
+% Became compatible with the hyperref package in
+% particular, and in general with other packages which
+% themselves modify the |\label| command. This will
+% work, however, only if the showlabels package is loaded after
+% other packages which do this. Notwithstanding Sebastian
+% Rahtz's excellent general advice on this, showlabels should
+% indeed be loaded after hyperref.
+%
+%
+%
+% \item[1.3e, 2001 May 31]\relax
+% After a long delay, here is an updated version of my showlabels
+% package. It corrects all the reported bugs which I could reproduce,
+% namely:
+%
+% \begin{itemize}
+% \item The package now formats labels correctly when the
+% |\label| command appears outside either an equation or a
+% |\caption| (silly of me).
+%
+% \item A couple of people reported problems in the interaction with the
+% amsmath package. Either these were confined to that package's earlier
+% incarnations as AMS-LaTeX or the amstex package, or else there's some
+% arcane circumstance I can't reproduce, so I haven't found anything to
+% fix on this matter. Note that the
+% |\usepackage{showlabels}| command must come \emph{after}
+% the |\usepackage{amsmath}| command. Bug-sightings here
+% will be warmly appreciated.
+%
+% \item I haven't worried too much about the precise formatting of the
+% labels – this is, after all, supposed to be a draft-only
+% package.
+% \end{itemize}
+%
+%
+% \item[1.1, 2001 January 1]\relax
+% Modified to conform to the slightly
+% different mechanism that |amsmath| uses to produce equation
+% numbers. I don't habitually use |amsmath|, so I won't
+% discover any bugs or weaknesses with its support here, and I'd
+% consequently be glad to be informed of any that appear. Do note that
+% the |\usepackage{showlabels}| command \emph{must} appear
+% after the |\usepackage{amsmath}| if it is to detect that
+% you are using the amsmath package. Note also that, since these
+% additions appeared, AMS-LaTeX and the |amstex| package seem
+% to have been declared ‘obsolete’ in favour of the |amsmath|
+% package. This package now claims conformance with the
+% |amsmath| package alone, though it will probably work with
+% older versions in fact.
+%
+%
+%
+% \item[Updated, 1992 January 29]\relax
+% On 1992 January 29, Darrel Hankerson
+% (|hank@ducvax.auburn.edu|), made the update to NFSS, and
+% changed the name to |showlabel.sty|.
+%
+%
+%
+% \item[Original, 1991 September 21]\relax
+% The package was originally released by me on 1991 September 21, under the name
+% |labels.sty|.
+%
+%
+%
+% \end{description}% \endgroup
%
% \StopEventually{}
%
@@ -312,7 +564,7 @@
% \end{macrocode}%
% \iffalse
% Update history:
-% October 94: Norman Gray (norman@astro.gla.ac.uk). Modified to be a
+% October 94: Norman Gray (gray@nxg.name). Modified to be a
% \LaTeX2e package.
% 29-Jan-92 Darrel Hankerson (hank@ducvax.auburn.edu)
% Update to NFSS. Change name to `showlabel.sty'. Substitute
@@ -462,7 +714,7 @@
% If you want slightly more general control over the labels, you can
% instead override |\showlabelsetlabel|.
% \begin{macrocode}
-\providecommand{\showlabelsetlabel}[1]{{\normalfont\showlabelfont\SL@fmt@ #1}}
+\providecommand{\showlabelsetlabel}[1]{{\normalfont\showlabelfont\SL@fmt@{#1}}}
% \end{macrocode}
%
% For the benefit of |\SL@prlabelname|, define |\SL@gobblethree| to do nothing
@@ -473,8 +725,14 @@
%
% \begin{macro}{\SL@prlabelname}
% Expansion is label name with all catcodes `other' (Appendix~D trickery
-% abounds!). Use |\r@#1|, rather then just |\#1| to avoid defining any new
-% control sequences.
+% abounds!). Use |\r@#1| (defined by |\ref|), rather then just |\#1|
+% to avoid defining any new control sequences.
+%
+% Note that this catcode magic, and the |\@sanitize| in
+% |\SL@showlabels| below, are doing much the same job, and indeed are
+% almost redundant with each other. But this |\SL@prlabelname|
+% doesn't cope with eg |\index{Poincar\'e}|, and the |\@sanitize|
+% below doesn't cope with |\section{\label{a_b}Foo}| (see tests t4 and t19).
% \begin{macrocode}
\def\SL@prlabelname#1{%
\expandafter\expandafter\expandafter\SL@gobblethree
@@ -579,9 +837,28 @@
% We actually handle three distinct cases here, for |\foo{label}|,
% |\foo[opt]{label}| and |\foo*{label}| (the last is to handle the
% \Lpackage{hyperref} package's |\ref*{label}| variant; see test case t14).
+%
+% We open a group in order to call |\@sanitize|; we're able to close
+% it immediately, within the called macros. We call |\@sanitize| in
+% order to cope with eg |\index{Poincar\'e}| (see discussion of
+% |\SL@prlabelname| above).
+%
+% We declare |\showlabeltype| to be the `current' label type. It
+% would be good to put this inside a group, so that it's only visible
+% locally, but we would then have to be careful exactly when we closed
+% the group: if we put it inside the group that's opened for
+% |\@sanitize|, it would be closed too early to have an effect; if we
+% open another group for |\showlabeltype|, then we'd have to close it
+% \emph{after} |\SL@orig@@next|, where we risk colliding with whatever
+% comes after it (and see above). It might be possible to be cleverer
+% about this, but it's at least harmeless to have the command defined
+% globally.
% \begin{macrocode}
\DeclareRobustCommand\SL@showlabels[1]{%
+ \@bsphack
\expandafter\let\expandafter\SL@orig@@next\csname SL@orig#1\endcsname
+ \def\showlabeltype{#1}%
+ \begingroup\@sanitize
\@ifstar
{\SL@showlabelsplainstar}
{\@ifnextchar[
@@ -589,19 +866,19 @@
{\SL@showlabelsplain}}
}
\def\SL@showlabelsopt[#1]#2{%
- \@bsphack
+ \endgroup
\SL@setlabel{#2}\relax
\ifhmode \spacefactor\@savsf \ifdim\@savsk>\z@ \hskip1sp \fi\fi
\SL@orig@@next[#1]{#2}%
}
\def\SL@showlabelsplain#1{%
- \@bsphack
+ \endgroup
\SL@setlabel{#1}\relax
\ifhmode \spacefactor\@savsf \ifdim\@savsk>\z@ \hskip1sp \fi\fi
\SL@orig@@next{#1}%
}
\def\SL@showlabelsplainstar#1{%
- \@bsphack
+ \endgroup
\SL@setlabel{#1}\relax
\ifhmode \spacefactor\@savsf \ifdim\@savsk>\z@ \hskip1sp \fi\fi
\SL@orig@@next*{#1}%
diff --git a/macros/latex/contrib/showlabels/showlabels.html b/macros/latex/contrib/showlabels/showlabels.html
index f809112b5a..fbdf4164b0 100644
--- a/macros/latex/contrib/showlabels/showlabels.html
+++ b/macros/latex/contrib/showlabels/showlabels.html
@@ -3,9 +3,11 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Showlabels</title>
-<link href="http://nxg.me.uk" rev="author"/>
+<link href="https://nxg.me.uk" rev="author"/>
<!-- content of style file, to make this document standalone... -->
<style type='text/css'>
+/* Installed from repo: 2021-09-14T22:35:45+01:00, Hg:1d9954537983 */
+
body {
color: #333;
background: white;
@@ -61,15 +63,32 @@ body {
}
*/
-div.topsidebar {
+/* The class='topsidebar' is formatting, typically div or ul,
+ for auxiliary stuff, placed at the top of the right-hand column.
+ The element with this class should go just _after_ the <h1> heading. */
+.topsidebar {
float: right;
width: 50%; /* ...of the body width (ie, 50% x 50% of screen) */
font-size: smaller;
+ line-height: 140%; /* ...of the font size*/
margin-left: 1em;
padding-left: 1em;
border-left: solid thin #AAA;
}
+/*
+I have in the past styled `.topsidebar li` like this,
+but I think this is too much detail for this location:
+I should restrict the styling here to the location and general appearance of the sidebar
+and I should leave such details to more local stylesheets
+(and in any case I think it's only my blog that actually uses this class)
+.topsidebar li {
+ list-style-type: none;
+ text-align: right;
+ line-height: 150%;
+}
+*/
+
/* On wider screens, move the sidebar out to the right hand side */
/* This uses CSS3 media queries: http://www.w3.org/TR/css3-mediaqueries/ */
@media screen and (min-width: 700pt) and (max-width: 850pt) {
@@ -78,7 +97,7 @@ div.topsidebar {
width: 350pt; /* 50% of 700pt */
margin-right: auto;
}
- div.topsidebar {
+ .topsidebar {
position: absolute;
/* I feel this size should be 595pt (350 + 210 + 0.05*700),
but that's clearly not right -- I don't think I understand what the -5%
@@ -89,6 +108,7 @@ div.topsidebar {
padding-left: 0pt;
border: none;
}
+ /* .topsidebar li { text-align: center; } */
}
/* On still-wider screens, expand the left-margin, keeping the sidebar attached to the right-hand edge.
When the screen is 850pt wide (expanding from the @media case above),
@@ -99,7 +119,7 @@ div.topsidebar {
width: 350pt;
margin-left: auto; /* ...takes up the slack */
}
- div.topsidebar {
+ .topsidebar {
position: absolute;
width: 290pt; /* same 290pt as above */
left: auto;
@@ -107,6 +127,7 @@ div.topsidebar {
padding-left: 0pt;
border: none;
}
+ /* .topsidebar li { text-align: center; } */
}
@@ -130,11 +151,17 @@ div.abstract code {
font-size: 80%;
}
+/* a span/div style for attracting attention */
+.attention {
+ color: #822;
+}
+
h1, h2, h3, h4, h5, h6 {
color: #822;
font-weight: 100; /* few fonts have ultra-light weights */
line-height: 100%; /* no need to spread out titles */
}
+
h1 {
margin-left: -40%;
margin-right: -5%;
@@ -142,6 +169,7 @@ h1 {
border: solid thin #666;
text-align: right;
}
+
h2 {
margin-left: -40%;
margin-right: -5%;
@@ -154,6 +182,7 @@ h2.appendices {
margin-top: 10ex;
border-top: double medium #666;
}
+
h3 {
margin-left: -30%;
float: left;
@@ -201,8 +230,8 @@ div.signature {
margin-right: -5%;
margin-top: 4ex;
text-align: right;
- border: solid thin #666;
- padding: 0.3em;
+ border-top: solid thin #666;
+ padding-top: 0.3em;
clear: both;
}
@@ -280,8 +309,8 @@ div#toc li li:after {
<div class="abstract">
<p>Put the names of <code>\label</code>s and other commands into
the margins of a draft document.</p>
-<!-- This is revision 95a544e6b41b, 2016-06-09T16:51:03+01:00 -->
-<p>Version 1.8, 2016 June 9,
+<!-- This is revision 5b2959804f35, 2021-10-09T20:59:45+01:00 -->
+<p>Version 1.9, 2021 October 9,
<a href='http://purl.org/nxg/dist/showlabels'
><code>http://purl.org/nxg/dist/showlabels</code></a>.</p>
</div>
@@ -292,8 +321,6 @@ whenever either the <code>\label</code> command is used, or an
equation is automatically numbered. It is compatible with the
<code>amsmath</code> and <code>hyperref</code> packages.</p>
-<p>It is similar to, but does a little more than, the showkeys package.</p>
-
<p>You invoke this package with the command
<code>\usepackage{showlabels}</code> in the preamble. You can control
where the labels appear &#x2013; in the margins or in the interline gaps &#x2013;
@@ -320,13 +347,20 @@ conflict in either case). The package can occasionally place labels
in the wrong margins, near the top of a page &#x2013; see the documentation
for a discussion of this.</p>
+<p>The <code>{showlabels}</code> package has a large overlap in
+functionality with David Carlisle's <code>{showkeys}</code>, although
+the latter will only handle <code>\label</code> and <code>\cite</code> keys. If
+<code>{showlabels}</code> fails in some particular situation, you might
+want to try using <code>{showkeys}</code>, but please do mention the
+problem, typically by email to me.</p>
+
<h3>Download and installation</h3>
<ol>
<li>Download the file
-<a href="showlabels-1.8.tar.gz" >showlabels-1.8.tar.gz</a>
+<a href="showlabels-1.9.tar.gz" >showlabels-1.9.tar.gz</a>
or
-<a href="showlabels-1.8.zip" >showlabels-1.8.zip</a>
+<a href="showlabels-1.9.zip" >showlabels-1.9.zip</a>
and unpack it.</li>
<li>Run LaTeX on the file <code>showlabels.ins</code> &#x2013; this will
@@ -347,61 +381,87 @@ documentation.</li>
<a href='https://www.ctan.org/pkg/showlabels'
>macros/latex/contrib/showlabels</a></li>
-<li>The source code for the package is maintained at
-<a href='http://bitbucket.org/nxg/showlabels/'>bitbucket.org</a>,
-which also includes an
-<a href='https://bitbucket.org/nxg/showlabels/issues' >issue tracker</a>,
-where you can report bugs (or you can just mail me).</li>
+<li>The source code for the package is maintained
+<a href='https://hg.sr.ht/~nxg/showlabels'>online</a>
+at <a href='https://sourcehut.org'>Sourcehut</a>.</li>
+
+<li>There's an <a href='https://todo.sr.ht/~nxg/showlabels'>issue
+tracker</a> there (the issues which had accumulated on the bitbucket
+tracker were effectively lost when Bitbucket dropped support for
+Mercurial; there were few outstanding ones anyway). Or you can just
+mail me.</li>
</ul>
-<p>This work is Copyright 1999, 2001-09, 2013-16, Norman Gray, and may be distributed and/or modified under the
+<p>This work is Copyright 1999, 2001-09, 2013-21, Norman Gray, and may be distributed and/or modified under the
conditions of the <a href='http://www.latex-project.org/lppl.txt'>LaTeX Project Public Licence</a>,
either version 1.3 of this licence or (at your option) any later version.</p>
-<h3>History</h3>
-<dl>
-<dt><span class='attention'><strong>1.8, 2016 June 9</strong></span></dt>
-<dd>The <code>ntheorem</code> package exposed an apparently
+<h2>History</h2>
+<!-- @RELEASENOTES@ -->
+<h:dl xmlns:h="http://www.w3.org/1999/xhtml">
+
+<h:dt><h:span class="attention">1.9, 2021 October 9</h:span></h:dt><h:dd>
+<ul xmlns="http://www.w3.org/1999/xhtml">
+ <li>Robustness fix: macros in arguments are now handled, so that
+ (after <code>\showlabel{index}</code>),
+ <code>\index{Poincar\'e}</code> doesn't cause an error.</li>
+ <li>The <code>\showlabel[optarg]{command}</code> optional argument
+ can now take a one-argument command.</li>
+ <li>The macro <code>\showlabeltype</code> expands to the current
+ label type, for possible use in <code>\showlabelsetlabel</code>.</li>
+ <li>The code has moved from Bitbucket to
+ <a>Sourcehut</a>: the new repository is
+ <a>https://hg.sr.ht/~nxg/showlabels</a>.
+ The issues links in the list below are therefore broken.</li>
+</ul>
+</h:dd>
+
+<h:dt>1.8, 2016 June 9</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">The <code>ntheorem</code> package exposed an apparently
long-standing incompleteness in the handling of <code>amsmath</code>
documents.
-Fixes <a href='https://bitbucket.org/nxg/showlabels/issues/9/'>issue 9</a>.</dd>
-
-<dt><strong>1.7, 2015 December 8</strong></dt>
-<dd>Release v1.7.</dd>
-
-<dt>1.7b2, 2015 December 7</dt>
-<dd>Make the combination of amsmath and [inline] mode work
-(fixes <a href='https://bitbucket.org/nxg/showlabels/issue/8/'>issue 8</a>
-&#x2013; thanks to A L Dukeman for the report;
-what is it about showlabels and 6 December?!).</dd>
-
-<dt>1.7b1, 2014 December 6</dt>
-<dd>This is a much-delayed bugfix release (by coincidence
-<em>exactly</em> a year after the previous release!).
-<ul>
+Fixes <a>issue 9</a>.</p>
+</h:dd>
+
+<h:dt>1.7, 2015 December 8</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Release v1.7.</p>
+</h:dd>
+
+<h:dt>1.7b2, 2015 December 7</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Make the combination of amsmath and [inline] mode work
+(fixes <a>issue 8</a>
+– thanks to A L Dukeman for the report;
+what is it about showlabels and 6 December?!).</p>
+</h:dd>
+
+<h:dt>1.7b1, 2014 December 6</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">This is a much-delayed bugfix release (by coincidence
+<em>exactly</em> a year after the previous release!).</p>
+<ul xmlns="http://www.w3.org/1999/xhtml">
<li>Give <code>\showlabels</code> an optional formatting argument
-(implements <a href='https://bitbucket.org/nxg/showlabels/issue/1/'>issue 1</a>
-&#x2013; thanks to Francesco Biccari for the suggestion).</li>
+(implements <a>issue 1</a>
+– thanks to Francesco Biccari for the suggestion).</li>
<li>Special-case the IEEEtrantools package
-(fixes <a href='https://bitbucket.org/nxg/showlabels/issue/2/'>issue 2</a>
-&#x2013; thanks to Boris Kheyfets for the report and test case, and to
+(fixes <a>issue 2</a>
+– thanks to Boris Kheyfets for the report and test case, and to
Ben William Carabelli for additional analysis and a draft fix).</li>
<li>The <code>[final]</code> option now works with the
<code>{amsmath}</code> package
-(fixes <a href='https://bitbucket.org/nxg/showlabels/issue/3/'>issue 3</a>
-&#x2013; thanks to Guillermo Garza and Enno Nagel for the report, and to
+(fixes <a>issue 3</a>
+– thanks to Guillermo Garza and Enno Nagel for the report, and to
Guillermo for the test case).</li>
<li>Handle the hyperref package's <code>\ref*{label}</code> variant
-(fixes <a href='https://bitbucket.org/nxg/showlabels/issue/4/'>issue 4</a>
-&#x2013; thanks to Alex Watson for the report and test case).</li>
+(fixes <a>issue 4</a>
+– thanks to Alex Watson for the report and test case).</li>
<li>Handle the case where a label is in a display, but not in maths mode
-(fixes <a href='https://bitbucket.org/nxg/showlabels/issue/5/'>issue 5</a>
-&#x2013; thanks to &#x2018;bartgol&#x2019; on Stackexchange for the report and test case).</li>
-</ul></dd>
+(fixes <a>issue 5</a>
+– thanks to ‘bartgol’ on Stackexchange for the report and test case).</li>
+</ul>
+</h:dd>
-<dt>1.6.6, 2013 December 6</dt>
-<dd><ul>
+<h:dt>1.6.6, 2013 December 6</h:dt><h:dd>
+<ul xmlns="http://www.w3.org/1999/xhtml">
<li>Add configuration interface <code>\showlabelrefline</code> and
ensure that <code>\color</code> works in
<code>\showlabelfont</code>.</li>
@@ -409,80 +469,90 @@ ensure that <code>\color</code> works in
<li>Change licence from GPL to LPPL</li>
<li>Fix link to repository</li>
</ul>
-</dd>
+</h:dd>
-<dt>1.6.5, 2009 May 27</dt>
-<dd>Fixed a bug in the way that labels including underscores (and
-other &#x2018;exotic&#x2019; characters) were displayed.</dd>
+<h:dt>1.6.5, 2009 May 27</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Fixed a bug in the way that labels including underscores (and
+other ‘exotic’ characters) were displayed.</p>
+</h:dd>
-<dt>1.6.4, 2008 October 10</dt>
-<dd>Fixed another poor interaction between eqnarray and amsart. Now
+<h:dt>1.6.4, 2008 October 10</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Fixed another poor interaction between eqnarray and amsart. Now
we get equation labels in eqnarray, and we don't get marginal notes
-about <code>\eqref</code> (which is good; might this finally be fixed?).</dd>
+about <code>\eqref</code> (which is good; might this finally be fixed?).</p>
+</h:dd>
-<dt>1.6.3, 2008 July 24</dt>
-<dd>Release 1.6.2 broke compatibility with the <em>rest</em> of
+<h:dt>1.6.3, 2008 July 24</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Release 1.6.2 broke compatibility with the <em>rest</em> of
amsmath (<code>eqnarray</code> became the only thing that worked
-within amsmath)! Fixed. Doh!</dd>
+within amsmath)! Fixed. Doh!</p>
+</h:dd>
-<dt>1.6.2, 2008 June 27</dt>
-<dd>The reimplementation of eqnarray within amsart was such that
-equation labels disappeared in that case. Fixed.</dd>
+<h:dt>1.6.2, 2008 June 27</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">The reimplementation of eqnarray within amsart was such that
+equation labels disappeared in that case. Fixed.</p>
+</h:dd>
-<dt>1.6.1, 2007 June 17</dt>
-<dd>Fix an errant test, which mangled equation labels starting
-with two identical letters.</dd>
+<h:dt>1.6.1, 2007 June 17</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Fix an errant test, which mangled equation labels starting
+with two identical letters.</p>
+</h:dd>
-<dt><strong>1.6, 2006 May 26</strong></dt>
-<dd>The <code>\showlabels</code> command will now work with commands
+<h:dt>1.6, 2006 May 26</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">The <code>\showlabels</code> command will now work with commands
(such as <code>\cite</code> or <code>\includegraphics</code>) which
- take an optional argument.</dd>
+ take an optional argument.</p>
+</h:dd>
-<dt>1.5a, 2005 March 17</dt>
-<dd>Defined <code>\showlabelfont</code> using
+<h:dt>1.5a, 2005 March 17</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Defined <code>\showlabelfont</code> using
<code>\ttfamily</code> rather than <code>\tt</code> (I'd
avoided doing this before to avoid a seemingly pointless
incompatibility with LaTeX 2.09, but (a) I imagine the
package is incompatible with that for other reasons, and (b)
-it's really not worth the hassle...).</dd>
+it's really not worth the hassle...).</p>
+</h:dd>
-<dt><strong>1.5, 2004 October 8</strong></dt>
-<dd>Added <code>\showlabelfont</code> and
+<h:dt>1.5, 2004 October 8</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Added <code>\showlabelfont</code> and
<code>\showlabelsetlabel</code> commands, allowing
customisation of the printed labels. Added and documented
options [final], [draft] (the former makes this package do
-nothing; the latter is the default behaviour).
-</dd>
+nothing; the latter is the default behaviour).</p>
+</h:dd>
-<dt>1.4a, 2003 January 28</dt>
-<dd>Acquired the <code>[left]</code> and
+<h:dt>1.4a, 2003 January 28</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Acquired the <code>[left]</code> and
<code>[right]</code> options, and fixed a bug which affected
-<code>\label</code> commands in captions.</dd>
+<code>\label</code> commands in captions.</p>
+</h:dd>
-<dt><strong>1.4, 2001 July 24</strong></dt>
-<dd>Became (more) compatible with the
+<h:dt>1.4, 2001 July 24</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Became (more) compatible with the
wrapfig package. Also, I added the
<code>\showlabels</code> command, to have the package display
references to commands other than <code>\label</code>
(<code>\cite</code> and <code>\ref</code> are obvious ones),
and an <code>[inline]</code> option to have labels (etc.)
displayed inline where possible, rather than always in the
-margin.</dd>
+margin.</p>
+</h:dd>
-<dt>1.3e, 2001 May 30</dt>
-<dd>Became compatible with the hyperref package in
+<h:dt>1.3e, 2001 May 30</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Became compatible with the hyperref package in
particular, and in general with other packages which
themselves modify the <code>\label</code> command. This will
work, however, only if the showlabels package is loaded after
other packages which do this. Notwithstanding Sebastian
Rahtz's excellent general advice on this, showlabels should
-indeed be loaded after hyperref.</dd>
+indeed be loaded after hyperref.</p>
+</h:dd>
-<dt><strong>1.3</strong></dt>
-<dd><p>After a long delay, here is an updated version of my showlabels
+<h:dt>1.3e, 2001 May 31</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">After a long delay, here is an updated version of my showlabels
package. It corrects all the reported bugs which I could reproduce,
namely:</p>
-<ul>
+<ul xmlns="http://www.w3.org/1999/xhtml">
<li>The package now formats labels correctly when the
<code>\label</code> command appears outside either an equation or a
<code>\caption</code> (silly of me).</li>
@@ -497,13 +567,13 @@ the <code>\usepackage{amsmath}</code> command. Bug-sightings here
will be warmly appreciated.</li>
<li>I haven't worried too much about the precise formatting of the
-labels &#x2013; this is, after all, supposed to be a draft-only
+labels – this is, after all, supposed to be a draft-only
package.</li>
</ul>
-</dd>
+</h:dd>
-<dt><strong>1.1, 2001?</strong></dt>
-<dd>Modified to conform to the slightly
+<h:dt>1.1, 2001 January 1</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">Modified to conform to the slightly
different mechanism that <code>amsmath</code> uses to produce equation
numbers. I don't habitually use <code>amsmath</code>, so I won't
discover any bugs or weaknesses with its support here, and I'd
@@ -512,25 +582,29 @@ the <code>\usepackage{showlabels}</code> command <em>must</em> appear
after the <code>\usepackage{amsmath}</code> if it is to detect that
you are using the amsmath package. Note also that, since these
additions appeared, AMS-LaTeX and the <code>amstex</code> package seem
-to have been declared &#x2018;obsolete&#x2019; in favour of the <code>amsmath</code>
+to have been declared ‘obsolete’ in favour of the <code>amsmath</code>
package. This package now claims conformance with the
<code>amsmath</code> package alone, though it will probably work with
-older versions in fact.
-</dd>
+older versions in fact.</p>
+</h:dd>
-<dt>Original release</dt>
-<dd>The package was originally released by me on 1991 September 21, under the name
-<code>labels.sty</code>.
-On 1992 January 29, Darrel Hankerson
+<h:dt>Updated, 1992 January 29</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">On 1992 January 29, Darrel Hankerson
(<code>hank@ducvax.auburn.edu</code>), made the update to NFSS, and
-changed the name to <code>showlabel.sty</code>.</dd>
+changed the name to <code>showlabel.sty</code>.</p>
+ </h:dd>
+
+<h:dt>Original, 1991 September 21</h:dt><h:dd>
+<p xmlns="http://www.w3.org/1999/xhtml">The package was originally released by me on 1991 September 21, under the name
+<code>labels.sty</code>.</p>
+</h:dd>
-</dl>
+</h:dl>
<div class="signature">
<a href="http://www.astro.gla.ac.uk/users/norman/"
>Norman Gray</a><br/>
-2016 June 9
+2021 October 9
</div>
</body>
diff --git a/macros/latex/contrib/showlabels/showlabels.pdf b/macros/latex/contrib/showlabels/showlabels.pdf
index 71be316ed3..2ede44d9d1 100644
--- a/macros/latex/contrib/showlabels/showlabels.pdf
+++ b/macros/latex/contrib/showlabels/showlabels.pdf
Binary files differ
diff --git a/macros/latex/contrib/showlabels/style.css b/macros/latex/contrib/showlabels/style.css
index 946d11a6a5..f2e25ff6ea 100644
--- a/macros/latex/contrib/showlabels/style.css
+++ b/macros/latex/contrib/showlabels/style.css
@@ -1,3 +1,5 @@
+/* Installed from repo: 2021-09-14T22:35:45+01:00, Hg:1d9954537983 */
+
body {
color: #333;
background: white;
@@ -53,15 +55,32 @@ body {
}
*/
-div.topsidebar {
+/* The class='topsidebar' is formatting, typically div or ul,
+ for auxiliary stuff, placed at the top of the right-hand column.
+ The element with this class should go just _after_ the <h1> heading. */
+.topsidebar {
float: right;
width: 50%; /* ...of the body width (ie, 50% x 50% of screen) */
font-size: smaller;
+ line-height: 140%; /* ...of the font size*/
margin-left: 1em;
padding-left: 1em;
border-left: solid thin #AAA;
}
+/*
+I have in the past styled `.topsidebar li` like this,
+but I think this is too much detail for this location:
+I should restrict the styling here to the location and general appearance of the sidebar
+and I should leave such details to more local stylesheets
+(and in any case I think it's only my blog that actually uses this class)
+.topsidebar li {
+ list-style-type: none;
+ text-align: right;
+ line-height: 150%;
+}
+*/
+
/* On wider screens, move the sidebar out to the right hand side */
/* This uses CSS3 media queries: http://www.w3.org/TR/css3-mediaqueries/ */
@media screen and (min-width: 700pt) and (max-width: 850pt) {
@@ -70,7 +89,7 @@ div.topsidebar {
width: 350pt; /* 50% of 700pt */
margin-right: auto;
}
- div.topsidebar {
+ .topsidebar {
position: absolute;
/* I feel this size should be 595pt (350 + 210 + 0.05*700),
but that's clearly not right -- I don't think I understand what the -5%
@@ -81,6 +100,7 @@ div.topsidebar {
padding-left: 0pt;
border: none;
}
+ /* .topsidebar li { text-align: center; } */
}
/* On still-wider screens, expand the left-margin, keeping the sidebar attached to the right-hand edge.
When the screen is 850pt wide (expanding from the @media case above),
@@ -91,7 +111,7 @@ div.topsidebar {
width: 350pt;
margin-left: auto; /* ...takes up the slack */
}
- div.topsidebar {
+ .topsidebar {
position: absolute;
width: 290pt; /* same 290pt as above */
left: auto;
@@ -99,6 +119,7 @@ div.topsidebar {
padding-left: 0pt;
border: none;
}
+ /* .topsidebar li { text-align: center; } */
}
@@ -122,11 +143,17 @@ div.abstract code {
font-size: 80%;
}
+/* a span/div style for attracting attention */
+.attention {
+ color: #822;
+}
+
h1, h2, h3, h4, h5, h6 {
color: #822;
font-weight: 100; /* few fonts have ultra-light weights */
line-height: 100%; /* no need to spread out titles */
}
+
h1 {
margin-left: -40%;
margin-right: -5%;
@@ -134,6 +161,7 @@ h1 {
border: solid thin #666;
text-align: right;
}
+
h2 {
margin-left: -40%;
margin-right: -5%;
@@ -146,6 +174,7 @@ h2.appendices {
margin-top: 10ex;
border-top: double medium #666;
}
+
h3 {
margin-left: -30%;
float: left;
@@ -193,8 +222,8 @@ div.signature {
margin-right: -5%;
margin-top: 4ex;
text-align: right;
- border: solid thin #666;
- padding: 0.3em;
+ border-top: solid thin #666;
+ padding-top: 0.3em;
clear: both;
}