summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/parnotes/README.md
blob: 6041f64a23f02258f9ebd292cdafc986f6f43e82 (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
49
50
parnotes
========
rev.3b (see notes below)

The parnotes package adds a new note type, `\parnote`. Parnotes are set as normal, running paragraphs and may be placed two ways: (1) automatically, at the end of the paragraph, or (2) manually, using the `\parnotes` command.

To place parnotes automatically after every paragraph, use the `autopn` environment:

    \begin{autopn}
    Text\parnote{parnote}
    
    Text
    \end{autopn}
    
If environments are used within `autopn`, another `autopn` environment must be nested within them. To place notes elsewhere, use the `\parnotes` command.

For more details, read the project documentation in `parnotes.pdf`.

Contributing
------------
The development repository and the bug tracker for this package are hosted [on GitHub](https://github.com/chelh/LaTeX-parnotes) but see notes below.

License
-------
Copyright © 2012, 2016 Chelsea Hughes

This work is distributed under the LaTeX Project Public License, version 1.3 or later, available at http://www.latex-project.org/lppl.txt

I currently maintain this project (comprising `parnotes.sty`, `parnotes.tex`, `README.md`, and the derived file `parnotes.pdf`) and will receive error reports at the project GitHub page (see **Contributing** above).

This package was started due to a question at the TeX Stack Exchange: http://tex.stackexchange.com/questions/34746/

Thanks to Stack Exchange users Ahmed Musa, Bruno Le Floch, and David Carlisle.

Current Status
--------------

The package appears to to be unmainted, i.e. the above address exists
but is not monitored and the original author is not reachable.


Small extensions in 2019 by Frank Mittelbach:

 - option `reset`  (alias for restart to match other packages)
 - option `alph`   (for alph style notes instead of arabic)
 - option `symbol` (for fnsymbol style notes)

The documentation has been changed use freely available fonts so that it
can be typeset by everybody (the previsous release used commercial fonts).