showlabels (10oct21)

git-svn-id: svn://tug.org/texlive/trunk@60722 c570f23f-e606-0410-a88d-b1316a301751
author: Karl Berry <karl@freefriends.org> 2021-10-10 20:37:42 +0000
committer: Karl Berry <karl@freefriends.org> 2021-10-10 20:37:42 +0000
commit: ec195fcb5da10972bf17269ba6505f6b173395b3 (patch)
tree: e1225955fd355eeb7c8260a776a4b8ab9fa67d79 /Master/texmf-dist/doc/latex/showlabels/showlabels.html
parent: c6c7cf1cf9b605c8e3fea08c6bf965128a55a54d (diff)
1 files changed, 176 insertions, 102 deletions
diff --git a/Master/texmf-dist/doc/latex/showlabels/showlabels.html b/Master/texmf-dist/doc/latex/showlabels/showlabels.html
index f809112b5a7..fbdf4164b0b 100644
--- a/Master/texmf-dist/doc/latex/showlabels/showlabels.html
+++ b/Master/texmf-dist/doc/latex/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>
author	Karl Berry <karl@freefriends.org>	2021-10-10 20:37:42 +0000
committer	Karl Berry <karl@freefriends.org>	2021-10-10 20:37:42 +0000
commit	ec195fcb5da10972bf17269ba6505f6b173395b3 (patch)
tree	e1225955fd355eeb7c8260a776a4b8ab9fa67d79 /Master/texmf-dist/doc/latex/showlabels/showlabels.html
parent	c6c7cf1cf9b605c8e3fea08c6bf965128a55a54d (diff)