From 32177855a92f374d4d0ca22d403dd2c9d6cccf25 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 1 Jul 2008 00:56:16 +0000 Subject: showlabels update (30jun08) git-svn-id: svn://tug.org/texlive/trunk@9128 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/showlabels/README | 247 ++++++++++----------- Master/texmf-dist/doc/latex/showlabels/VERSION | 2 +- .../doc/latex/showlabels/showlabels.html | 36 ++- .../texmf-dist/doc/latex/showlabels/showlabels.pdf | Bin 89577 -> 87162 bytes .../source/latex/showlabels/showlabels.drv | 64 ------ .../source/latex/showlabels/showlabels.dtx | 26 +-- .../texmf-dist/tex/latex/showlabels/showlabels.sty | 16 +- 7 files changed, 176 insertions(+), 215 deletions(-) delete mode 100644 Master/texmf-dist/source/latex/showlabels/showlabels.drv diff --git a/Master/texmf-dist/doc/latex/showlabels/README b/Master/texmf-dist/doc/latex/showlabels/README index d07ac8cca4f..56b23c7ca52 100644 --- a/Master/texmf-dist/doc/latex/showlabels/README +++ b/Master/texmf-dist/doc/latex/showlabels/README @@ -1,124 +1,123 @@ - -Showlabels: put the names of \labels and other commands into margins --------------------------------------------------------------------- - -Version 1.6.1 - -This package helps you keep track of all the labels you define, by -putting the name of new labels into the margin whenever the -\label command is used. - -The package allows you to do the same thing for other commands. The -only one for which this is obviously useful is the \cite command, but -it's easy to do it for others, such as the \ref or \begin commands. - - -Changes in 1.6, 2006 May 26 ---------------------------- -The \showlabels command will now work with commands (such as \cite or -\includegraphics) which take an optional argument. - -Changes in v1.5a, 18 March 2005 -------------------------------- - -Changed definition of \showlabelfont to use \ttfamily rather than \tt -(I'd avoided doing so before, to avoid a pointless incompatibility -with LaTeX 2.09, but that seems barely worth the hassle). - -Changes in v1.5, 8 October 2004 -------------------------------- - -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). - -Changes in v1.4a, 28 January 2003 ---------------------------------- - -The [inline] package option now causes equation labels to be put -between lines also. [left] and [right] options added. - -Fixed bug which meant that [nolabel] stopped \label in \caption from -working. \caption handling now rather more robust. - -Changes in v1.4, 24 July 2001 ------------------------------- - -Significant alteration to the mechanism for displaying the labels, -which makes it easy to do the same trick for the \cite command. It's -also fairly easy to extend this to any other commands which might want -it, through the new \showlabels command, though \ref is the only one -which immediately springs to mind. - -Also, the package option [inline] was introduced, giving an -alternative format for displaying the labels. This route is ripe for -generalisation. - -Corrections to the code which places labels in the margin. This is -manifest in that the package is now (more) compatible with the wrapfig -package. - -Changes in v1.3e, 30 May 2001 ------------------------------ - -Alteration to the way \label is redefined. Should now be compatible -with packages such as hyperref, which override the \label command -themselves. - -Changes in v1.3d, 19 April 2001 -------------------------------- - -Slight formatting change -- removed question marks when a label is omitted. - -Changes in v1.3c, 22 July 1999 ------------------------------- - -Added an \expandafter to an \ifx test. Was this _really_ broken in -_all_ those previous versions?!?!? - -Changes in v1.3b ----------------- - -No functional changes, but the package's copyright and licence -conditions were clarified. - -Changes in v1.3 ---------------- - -After a long delay, here is an updated version of my showlabels -package. It corrects all the reported bugs which I could reproduce, -namely: - - * The package now formats labels correctly when the \label command - appears outside either an equation or a \caption (silly of me). - - * 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 _after_ the - \usepackage{amsmath} command. Bug-sightings here will be warmly - appreciated. - - * I haven't worried too much about the precise formatting of the - labels -- this is, after all, supposed to be a draft-only package. - -Thanks, for comments and bug reports, to many testers. See the -documentation for a full list. - - -Licence -------- - -This software is copyright, 1999, 2001-2005, Norman Gray. It is released under -the terms of the GNU General Public Licence. See the copyright -declaration at the top of file showlabels.dtx, and the file LICENCE for -the licence conditions. - - - -Norman Gray, -http://www.astro.gla.ac.uk/users/norman/ + Showlabels + + Put the names of \labels and other commands into the margins of a draft + document. + + Version 1.6.2, 2008 June 27, http://purl.org/nxg/dist/showlabels. + + This class option introduces no new commands, it just helps you keep + track of all the labels by putting the name of the new label into the + margin whenever either the \label command is used, or an equation is + automatically numbered (by replacing the internal \@eqnnum command). + There are therefore no usage instructions. You invoke this package with + the command \usepackage{showlabels} in the preamble, and you may give + the options [inner] or [outer] (the default) to have the labels placed + in the inner or outer margin of the text. + + The package will also work in the presence of the [twocolumn] option. + In this case, the options [inner] and [outer] will be ignored, and the + label will be placed in the nearer margin. + + 1.6.2, 2008 June 27 + The reimplementation of eqnarray within amsart was such that + equation labels disappeared in that case. Fixed. + + 1.6.1, 2007 June 17 + Fix an errant test, which mangled equation labels starting with + two identical letters. + + 1.6, 2006 May 26 + The \showlabels command will now work with commands (such as + \cite or \includegraphics) which take an optional argument. + + 1.5a, 2005 March 17 + 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...). + + 1.5, 2004 October 8 + 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). + + 1.4a, 2003 January 28 + Acquired the [left] and [right] options, and fixed a bug which + affected \label commands in captions. + + 1.4, 2001 July 24 + 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. + + 1.3e, 2001 May 30 + 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. + + 1.3 + After a long delay, here is an updated version of my showlabels + package. It corrects all the reported bugs which I could + reproduce, namely: + + + The package now formats labels correctly when the \label + command appears outside either an equation or a \caption + (silly of me). + + 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 after + the \usepackage{amsmath} command. Bug-sightings here will be + warmly appreciated. + + I haven't worried too much about the precise formatting of the + labels -- this is, after all, supposed to be a draft-only + package. + + 1.1, 2001? + 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 + 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. + + Compatibility and problems + + For reasonably obvious reasons, this package will not work at all well + with the multicol package, and for possibly less obvious reasons, it + won't work with the [leqno] option either (at some point it should be + modified to at least recognise and warn of the conflict in either + case). The package can occasionally place labels in the wrong margins, + near the top of a page -- see the documentation for a discussion of + this. + + Download and installation + + 1. Download the file showlabels-1.6.2.tar.gz or + showlabels-1.6.2.zip and unpack it. + 2. Run LaTeX on the file showlabels.ins -- this will unpack the style + file showlabels.sty amongst other files. Place this somewhere where + TeX can find it. + 3. Run LaTeX on the file showlabels.dtx to obtain the documentation. + + On CTAN: /tex-archive/macros/latex/contrib/supported/showlabels/ + + On the web http://purl.org/nxg/dist/showlabels + + Norman Gray + 2008 June 27 diff --git a/Master/texmf-dist/doc/latex/showlabels/VERSION b/Master/texmf-dist/doc/latex/showlabels/VERSION index f261b5cdb4f..98000fa1fe9 100644 --- a/Master/texmf-dist/doc/latex/showlabels/VERSION +++ b/Master/texmf-dist/doc/latex/showlabels/VERSION @@ -1 +1 @@ -showlabels-1.6.1 +showlabels-1.6.2 diff --git a/Master/texmf-dist/doc/latex/showlabels/showlabels.html b/Master/texmf-dist/doc/latex/showlabels/showlabels.html index 0a6a6d66fec..a03abeab166 100644 --- a/Master/texmf-dist/doc/latex/showlabels/showlabels.html +++ b/Master/texmf-dist/doc/latex/showlabels/showlabels.html @@ -13,7 +13,7 @@

Put the names of \labels and other commands into the margins of a draft document.

-

Version 1.6.1, 2007 June 17, +

Version 1.6.2, 2008 June 27, http://purl.org/nxg/dist/showlabels.

@@ -35,6 +35,10 @@ label will be placed in the nearer margin.

+
1.6.2, 2008 June 27
+
The reimplementation of eqnarray within amsart was such that +equation labels disappeared in that case. Fixed.
+
1.6.1, 2007 June 17
Fix an errant test, which mangled equation labels starting with two identical letters.
@@ -84,6 +88,30 @@ other packages which do this. Notwithstanding Sebastian Rahtz's excellent general advice on this, showlabels should indeed be loaded after hyperref. +
1.3
+

After a long delay, here is an updated version of my showlabels +package. It corrects all the reported bugs which I could reproduce, +namely:

+
    +
  • The package now formats labels correctly when the +\label command appears outside either an equation or a +\caption (silly of me).
  • + +
  • 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 after +the \usepackage{amsmath} command. Bug-sightings here +will be warmly appreciated.
  • + +
  • I haven't worried too much about the precise formatting of the +labels -- this is, after all, supposed to be a draft-only +package.
  • +
+
+
1.1, 2001?
Modified to conform to the slightly different mechanism that amsmath uses to produce equation @@ -116,9 +144,9 @@ for a discussion of this.

  1. Download the file -showlabels-1.6.1.tar.gz +showlabels-1.6.2.tar.gz or -showlabels-1.6.1.zip +showlabels-1.6.2.zip and unpack it.
  2. Run LaTeX on the file showlabels.ins -- this will @@ -140,7 +168,7 @@ documentation.
  3. Norman Gray
    -2007 June 17 +2008 June 27
    diff --git a/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf b/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf index 8f1416ffb23..f73695afbcf 100644 Binary files a/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf and b/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf differ diff --git a/Master/texmf-dist/source/latex/showlabels/showlabels.drv b/Master/texmf-dist/source/latex/showlabels/showlabels.drv deleted file mode 100644 index 83d038bf9de..00000000000 --- a/Master/texmf-dist/source/latex/showlabels/showlabels.drv +++ /dev/null @@ -1,64 +0,0 @@ -%% -%% This is file `showlabels.drv', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% showlabels.dtx (with options: `driver') -%% Showlabels: Style to display labels in the margin -%% This is the showlabels package -%% -%% This software is copyright, 1999, 2001--2007, Norman Gray. -%% -%% This program is free software; you can redistribute it and/or -%% modify it under the terms of the GNU General Public License -%% as published by the Free Software Foundation; either version 2 -%% of the License, or (at your option) any later version. -%% -%% This program is distributed in the hope that it will be useful, -%% but WITHOUT ANY WARRANTY; without even the implied warranty of -%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -%% GNU General Public License for more details. -%% -%% You should have received a copy of the GNU General Public License -%% along with this program; if not, write to the Free Software -%% Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -%% -%% Author: Norman Gray, norman@astro.gla.ac.uk. -%% Department of Physics and Astronomy, University of Glasgow, UK -%% -%% See the file LICENCE for a copy of the GPL. -%% You can also find an online copy at http://www.gnu.org/copyleft/gpl.html . -%% -%% $Id: showlabels.dtx,v 1.31 2007/06/17 15:34:32 norman Exp $ -%% -\def\filename{showlabels} -\def\fileversion{1.6.1} -\def\filedate{2007/06/17} -\def\docdate{2007 June 17} -\def\filemaintainer{norman@astro.gla.ac.uk} -\documentclass{ltxdoc} -\EnableCrossrefs -\newcommand\Lopt[1]{\textsf{#1}} % package options -\newcommand\file[1]{\texttt{#1}} % filename -\newcommand\pstyle[1]{\textsf{\{#1\}}} % packages -%% \url macro (url.sty does this better, but we don't want extra dependencies) -\def\setpathdots{\discretionary{.}{}{.}} -\def\setpathslash{\discretionary{/}{}{/}} -{\catcode`\.=\active - \catcode`\/=\active - \gdef\pathcats{% - \catcode`\%=12 \catcode`\~=12 - \catcode`\.=\active \let.\setpathdots - \catcode`\/=\active \let/\setpathslash - \catcode`\#=12 \catcode`\_=12}% - } -\def\setpath#1{\ttfamily <\nobreak #1\nobreak>\endgroup} -\def\url{\begingroup\pathcats\setpath} -\begin{document} -\DocInput{showlabels.dtx} -\PrintIndex -\end{document} -\endinput -%% -%% End of file `showlabels.drv'. diff --git a/Master/texmf-dist/source/latex/showlabels/showlabels.dtx b/Master/texmf-dist/source/latex/showlabels/showlabels.dtx index 1eafcf3fcf7..a094b911b61 100644 --- a/Master/texmf-dist/source/latex/showlabels/showlabels.dtx +++ b/Master/texmf-dist/source/latex/showlabels/showlabels.dtx @@ -24,13 +24,13 @@ %% See the file LICENCE for a copy of the GPL. %% You can also find an online copy at http://www.gnu.org/copyleft/gpl.html . %% -%% $Id: showlabels.dtx,v 1.31 2007/06/17 15:34:32 norman Exp $ +%% $Id: showlabels.dtx,v 1.32 2008/06/27 15:18:43 norman Exp $ %% % \def\filename{showlabels} -\def\fileversion{1.6.1} -\def\filedate{2007/06/17} -\def\docdate{2007 June 17} +\def\fileversion{1.6.2} +\def\filedate{2008/06/27} +\def\docdate{2008 June 27} \def\filemaintainer{norman@astro.gla.ac.uk} % \changes{v1.4}{2001/07/23}{Avoided defining RCSDate} %<+package>\NeedsTeXFormat{LaTeX2e} @@ -326,10 +326,10 @@ \let\SL@maketag@@@=\maketag@@@ \def\maketag@@@#1{% \SL@maketag@@@{#1}% - \ifx\df@label\@empty -% \SL@eqnlrtext{???}% + \ifx\SL@labelname\@empty +% \SL@eqnlrtext{???}% it's not clear to me when this would happen \else - \SL@eqnlrtext{\df@label}% + \SL@eqnlrtext{\SL@labelname}% \fi } \else @@ -521,14 +521,14 @@ \def\SL@margtext#1{% % \end{macrocode} % In maths mode, produce a label name alongside the equation number. -% If we're not using \pstyle{amsmath}, then save the label name in -% |\SL@labelname|. If we \emph{are} using \pstyle{amsmath}, then we don't -% have to worry, because it's saved in |\df@label| for us. +% Save the label name in |\SL@labelname|, so we can use it later +% (this is redundant in most \pstyle{amsmath} contexts, because that +% style generally saves this in |\df@label|, but sometimes -- for +% example when using eqnarray within \pstyle{amsart} -- it seems not +% to be; in any case, it's simpler just to use |\SL@labelname| all the time). % \begin{macrocode} \ifmmode - \ifSL@AMS\else - \xdef\SL@labelname{\SL@prlabelname{#1}}% - \fi + \xdef\SL@labelname{\SL@prlabelname{#1}}% % \end{macrocode} % Otherwise, create a box with zero height and depth, and the same width % as the page. Put all this in braces, to contain the setting of diff --git a/Master/texmf-dist/tex/latex/showlabels/showlabels.sty b/Master/texmf-dist/tex/latex/showlabels/showlabels.sty index e0a95811749..b15e3ce8bbb 100644 --- a/Master/texmf-dist/tex/latex/showlabels/showlabels.sty +++ b/Master/texmf-dist/tex/latex/showlabels/showlabels.sty @@ -30,12 +30,12 @@ %% See the file LICENCE for a copy of the GPL. %% You can also find an online copy at http://www.gnu.org/copyleft/gpl.html . %% -%% $Id: showlabels.dtx,v 1.31 2007/06/17 15:34:32 norman Exp $ +%% $Id: showlabels.dtx,v 1.32 2008/06/27 15:18:43 norman Exp $ %% \def\filename{showlabels} -\def\fileversion{1.6.1} -\def\filedate{2007/06/17} -\def\docdate{2007 June 17} +\def\fileversion{1.6.2} +\def\filedate{2008/06/27} +\def\docdate{2008 June 27} \def\filemaintainer{norman@astro.gla.ac.uk} \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{showlabels}[\filedate\space v\fileversion] @@ -51,9 +51,9 @@ \let\SL@maketag@@@=\maketag@@@ \def\maketag@@@#1{% \SL@maketag@@@{#1}% - \ifx\df@label\@empty + \ifx\SL@labelname\@empty \else - \SL@eqnlrtext{\df@label}% + \SL@eqnlrtext{\SL@labelname}% \fi } \else @@ -107,9 +107,7 @@ \AtBeginDocument{\SL@initmakecaption} \def\SL@margtext#1{% \ifmmode - \ifSL@AMS\else - \xdef\SL@labelname{\SL@prlabelname{#1}}% - \fi + \xdef\SL@labelname{\SL@prlabelname{#1}}% \else \setbox\@tempboxa=\vbox to 0pt{\vss \hbox to \hsize{\SL@lrtext{#1}}}% -- cgit v1.2.3