diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/showlabels/README')
-rw-r--r-- | Master/texmf-dist/doc/latex/showlabels/README | 82 |
1 files changed, 49 insertions, 33 deletions
diff --git a/Master/texmf-dist/doc/latex/showlabels/README b/Master/texmf-dist/doc/latex/showlabels/README index ccf99ddcdae..764533b88c9 100644 --- a/Master/texmf-dist/doc/latex/showlabels/README +++ b/Master/texmf-dist/doc/latex/showlabels/README @@ -3,21 +3,60 @@ Put the names of \labels and other commands into the margins of a draft document. - Version 1.6.3, 2008 July 24, http://purl.org/nxg/dist/showlabels. + Version 1.6.4, 2008 October 10, 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. + 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. + + 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. 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. + 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.4.tar.gz or + showlabels-1.6.4.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 + + History + + 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)! @@ -101,28 +140,5 @@ 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.3.tar.gz or - showlabels-1.6.3.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 - Norman Gray - 2008 July 24 + 2008 October 10 |