summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/xcpdftips/README.md
blob: 90612c97be6e00fe2b6a155af9ab977fc3a0c76a (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
51
52
53
54
55
56
57
58
59
60
61
62
#  xcpdftips 

This is a LaTeX package for natbib citations with PDF tooltips.

## Manifest

The xcpdftips package contains the following files:

### `xcpdftips.dtx`
 
Documented source file that may be LaTeXed to get the 
detailed description and/or coding documentation.

May be docstripped with option "package,all" to get the 
`xcpdftips.sty` package file, or processed with `xcpdftips.ins`.  

### `xcpdftips.ins`  
 
A docstrip batch job to extract `xcpdftips.sty` from the source file 
`xcpdftips.dtx`.  Simply TeX or LaTeX this file.

This file is embedded in `xcpdftips.dtx`. If it is missing, then 
LaTeXing `xcpdftips.dtx` will extract it.
                  
## Generation

Simply run TeX or LaTeX on `xcpdftips.ins`, which extracts
`xcpdftips.sty` from the documented source `xcpdftips.dtx`. If 
`xcpdftips.ins` has been lost, it may be regenerated by 
running LaTeX on `xcpdftips.dtx`.

## Documentation   

Run LaTeX on `xcpdftips.dtx` or `xcpdftips.ltx`. The latter may be edited 
as needed to conform to local requirements (paper size, duplex or not, 
with or without entire coding).  Alternatively, a `ltxdoc.cfg` file can 
contain local configurations.

For full details, print out the documentation in `xcpdftips.dtx` 
by LaTeXing it.

## List of changes

v1.0 2019/03/10 Initial release
v1.1 2019/03/10 Added support for tooltips on PDF layers (using OCG)

## License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.