summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/showlabels
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-12-11 23:19:23 +0000
committerKarl Berry <karl@freefriends.org>2015-12-11 23:19:23 +0000
commita6451a5b29813f32c1fb91745c853c23fc2722a3 (patch)
tree01da36c3e1ee540a5e1699912dbb39b77eadba20 /Master/texmf-dist/doc/latex/showlabels
parente9d6d57d90449717e3a5a70e914275379a3dee6b (diff)
showlabels (11dec15)
git-svn-id: svn://tug.org/texlive/trunk@39083 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/showlabels')
-rw-r--r--Master/texmf-dist/doc/latex/showlabels/README178
-rw-r--r--Master/texmf-dist/doc/latex/showlabels/VERSION2
-rw-r--r--Master/texmf-dist/doc/latex/showlabels/showlabels.html56
-rw-r--r--Master/texmf-dist/doc/latex/showlabels/showlabels.pdfbin147155 -> 156501 bytes
4 files changed, 71 insertions, 165 deletions
diff --git a/Master/texmf-dist/doc/latex/showlabels/README b/Master/texmf-dist/doc/latex/showlabels/README
index 02c6fe579e0..5043b5ecde0 100644
--- a/Master/texmf-dist/doc/latex/showlabels/README
+++ b/Master/texmf-dist/doc/latex/showlabels/README
@@ -1,162 +1,34 @@
- Showlabels
+Showlabels
+==========
- Put the names of \labels and other commands into the margins of a draft
- document.
+Put the names of `\labels` and other commands into the margins of a draft
+document.
- Version 1.6.6, 2013 December 6, http://purl.org/nxg/dist/showlabels.
+Version 1.7, 2015 December 8, 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
- whenever either the \label command is used, or an equation is
- automatically numbered. It is compatible with the amsmath and hyperref
- packages.
+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
+whenever either the `\label` command is used, or an equation is
+automatically numbered. It is compatible with the amsmath and hyperref
+packages.
- It is similar to, but does a little more than, the showkeys package.
+It is similar to, but does a little more than, the showkeys package.
- You invoke this package with the command \usepackage{showlabels} in the
- preamble. You can control where the labels appear -- in the margins or
- in the interline gaps -- and you can change the appearance of the
- formatted labels to some extent.
+You invoke this package with the command `\usepackage{showlabels}` in the
+preamble. You can control where the labels appear -- in the margins or
+in the interline gaps -- and you can change the appearance of the
+formatted labels to some extent.
- 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.
+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 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.
+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).
- The source code for the package is maintained at bitbucket.org, which
- also includes an issue tracker, where you can report bugs (or just mail
- me).
+For more information, see showlabels.html in the distribution.
- 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.6.tar.gz or showlabels-1.6.6.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/showlabels/
-
- On the web http://purl.org/nxg/dist/showlabels
-
- The sources are in a Mercurial repository at bitbucket.org.
-
- History
-
- 1.6.6, 2013 December 6
-
- + Add configuration interface \showlabelrefline and ensure that
- \color works in \showlabelfont.
- + Various documentation tweaks
- + Change licence from GPL to LPPL
- + Fix link to repository
-
- 1.6.5, 2009 May 27
- Fixed a bug in the way that labels including underscores (and
- other 'exotic' characters) were displayed.
-
- 1.6.4, 2008 October 10
- 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?).
-
- 1.6.3, 2008 July 24
- Release 1.6.2 broke compatibility with the rest of amsmath
- (eqnarray became the only thing that worked within amsmath)!
- Fixed. Doh!
-
- 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.
-
- Norman Gray
- 2013 December 6
+Norman Gray
+http://nxg.me.uk
diff --git a/Master/texmf-dist/doc/latex/showlabels/VERSION b/Master/texmf-dist/doc/latex/showlabels/VERSION
index b5c429a2530..4d9033d7ddc 100644
--- a/Master/texmf-dist/doc/latex/showlabels/VERSION
+++ b/Master/texmf-dist/doc/latex/showlabels/VERSION
@@ -1 +1 @@
-showlabels-1.6.6
+showlabels-1.7
diff --git a/Master/texmf-dist/doc/latex/showlabels/showlabels.html b/Master/texmf-dist/doc/latex/showlabels/showlabels.html
index f40186baf89..896a35fd7d3 100644
--- a/Master/texmf-dist/doc/latex/showlabels/showlabels.html
+++ b/Master/texmf-dist/doc/latex/showlabels/showlabels.html
@@ -19,7 +19,8 @@
<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.6, 2013 December 6,
+<!-- This is revision aa6f5b4db751, 2015-12-08 -->
+<p>Version 1.7, 2015 December 8,
<a href='http://purl.org/nxg/dist/showlabels'
><code>http://purl.org/nxg/dist/showlabels</code></a>.</p>
</div>
@@ -48,10 +49,11 @@ the <code>\cite</code> command, but it can be useful for
<code>[inner]</code> and <code>[outer]</code> will be ignored, and the
label will be placed in the nearer margin.</p>
-<p>The source code for the package is maintained at
-<a href='http://bitbucket.org/nxg/showlabels/'>bitbucket.org</a>,
-which also includes an issue tracker, where you can report bugs (or
-just mail me).</p>
+<p>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).</p>
<h3>Compatibility and problems</h3>
@@ -67,9 +69,9 @@ for a discussion of this.</p>
<ol>
<li>Download the file
-<a href="showlabels-1.6.6.tar.gz" >showlabels-1.6.6.tar.gz</a>
+<a href="showlabels-1.7.tar.gz" >showlabels-1.7.tar.gz</a>
or
-<a href="showlabels-1.6.6.zip" >showlabels-1.6.6.zip</a>
+<a href="showlabels-1.7.zip" >showlabels-1.7.zip</a>
and unpack it.</li>
<li>Run LaTeX on the file <code>showlabels.ins</code> -- this will
@@ -85,7 +87,7 @@ documentation.</li>
>/tex-archive/macros/latex/contrib/showlabels/</a></p>
<p>On the web
-<a href="http://purl.org/nxg/dist/showlabels"
+<a href="http://purl.org/nxg/dist/showlabels"
><code>http://purl.org/nxg/dist/showlabels</code></a></p>
<p>The sources are in a Mercurial repository at
@@ -93,8 +95,40 @@ documentation.</li>
<h3>History</h3>
<dl>
-
-<dt><span class='attention'>1.6.6, 2013 December 6</span></dt>
+<dt><span class='attention'><strong>1.7, 2015 December 8</strong></span></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>
+– 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>
+<li>Give <code>\showlabels</code> an optional formatting argument
+(implements <a href='https://bitbucket.org/nxg/showlabels/issue/1/'>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>
+– 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>
+– 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>
+– 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>
+– thanks to ‘bartgol’ on Stackexchange for the report and test case).</li>
+</ul></dd>
+
+<dt>1.6.6, 2013 December 6</dt>
<dd><ul>
<li>Add configuration interface <code>\showlabelrefline</code> and
ensure that <code>\color</code> works in
@@ -217,7 +251,7 @@ older versions in fact.
<div class="signature">
<a href="http://www.astro.gla.ac.uk/users/norman/"
>Norman Gray</a><br/>
-2013 December 6
+2015 December 8
</div>
</body>
diff --git a/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf b/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf
index 47c277e504e..f7a4f6a7bec 100644
--- a/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf
+++ b/Master/texmf-dist/doc/latex/showlabels/showlabels.pdf
Binary files differ