summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/showlabels/README
blob: 915e7f5308fcd52ec75e0d122d913d9ebdf7f4e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Showlabels
==========

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

Version 1.9, 2021 October  9;
<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.

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.

Links:

  * Canonical software home page: <http://purl.org/nxg/dist/showlabels>
    (use this rather than the URL it redirects to).

  * On CTAN: <https://www.ctan.org/pkg/showlabels>

  * The source code for the package is maintained
    [at sourcehut](https://hg.sr.ht/~nxg/showlabels).

  * There's also an [issue tracker](https://todo.sr.ht/~nxg/showlabels)
    at sourcehut.  Or you can just mail me.

This work is Copyright 1999, 2001-09, 2013-21, Norman Gray, and may be
distributed and/or modified under the conditions of the LaTeX Project
Public Licence, either version 1.3 of this licence or (at your option)
any later version.  See the distributed file lppl.txt for details.

For more information, see showlabels.html in the distribution.

Norman Gray  
https://nxg.me.uk