diff options
author | Karl Berry <karl@freefriends.org> | 2008-07-01 00:56:16 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2008-07-01 00:56:16 +0000 |
commit | 32177855a92f374d4d0ca22d403dd2c9d6cccf25 (patch) | |
tree | 591082d597a689fa0868a6cea48b61a3c3024724 /Master/texmf-dist/doc/latex | |
parent | 767674bba9388c657eb685ef4a48aa2254f258d2 (diff) |
showlabels update (30jun08)
git-svn-id: svn://tug.org/texlive/trunk@9128 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r-- | Master/texmf-dist/doc/latex/showlabels/README | 247 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/showlabels/VERSION | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/showlabels/showlabels.html | 36 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/showlabels/showlabels.pdf | bin | 89577 -> 87162 bytes |
4 files changed, 156 insertions, 129 deletions
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, <norman@astro.gla.ac.uk> -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 @@ <div class="abstract"> <p>Put the names of <code>\label</code>s and other commands into the margins of a draft document.</p> -<p>Version 1.6.1, 2007 June 17, +<p>Version 1.6.2, 2008 June 27, <a href='http://purl.org/nxg/dist/showlabels' ><code>http://purl.org/nxg/dist/showlabels</code></a>.</p> </div> @@ -35,6 +35,10 @@ label will be placed in the nearer margin.</p> <dl> +<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> + <dt>1.6.1, 2007 June 17</dt> <dd>Fix an errant test, which mangled equation labels starting with two identical letters.</dd> @@ -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.</dd> +<dt>1.3</dt> +<dd><p>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> +<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> + +<li>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 +<code>\usepackage{showlabels}</code> command must come <em>after</em> +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 -- this is, after all, supposed to be a draft-only +package.</li> +</ul> +</dd> + <dt>1.1, 2001?</dt> <dd>Modified to conform to the slightly different mechanism that <code>amsmath</code> uses to produce equation @@ -116,9 +144,9 @@ for a discussion of this.</p> <ol> <li>Download the file -<a href="showlabels-1.6.1.tar.gz" >showlabels-1.6.1.tar.gz</a> +<a href="showlabels-1.6.2.tar.gz" >showlabels-1.6.2.tar.gz</a> or -<a href="showlabels-1.6.1.zip" >showlabels-1.6.1.zip</a> +<a href="showlabels-1.6.2.zip" >showlabels-1.6.2.zip</a> and unpack it.</li> <li>Run LaTeX on the file <code>showlabels.ins</code> -- this will @@ -140,7 +168,7 @@ documentation.</li> <div class="signature"> <a href="http://www.astro.gla.ac.uk/users/norman/" >Norman Gray</a><br/> -2007 June 17 +2008 June 27 </div> </body> diff --git a/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf b/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf Binary files differindex 8f1416ffb23..f73695afbcf 100644 --- a/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf +++ b/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf |