diff options
author | Norbert Preining <norbert@preining.info> | 2023-02-27 03:05:21 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2023-02-27 03:05:21 +0000 |
commit | 86d5a04282aa958addab4585c4df899ec9a92e50 (patch) | |
tree | 7736ac0fb49348cb6ae88770b4b72ed5ee9d8081 /macros/latex/contrib/hrefhide/README | |
parent | e7ae872926eddb0de09ecfe1c578e0680033955a (diff) |
CTAN sync 202302270305
Diffstat (limited to 'macros/latex/contrib/hrefhide/README')
-rw-r--r-- | macros/latex/contrib/hrefhide/README | 136 |
1 files changed, 75 insertions, 61 deletions
diff --git a/macros/latex/contrib/hrefhide/README b/macros/latex/contrib/hrefhide/README index 79b2538d5a..bd65799b5d 100644 --- a/macros/latex/contrib/hrefhide/README +++ b/macros/latex/contrib/hrefhide/README @@ -1,4 +1,4 @@ -README for hrefhide package, 2011/04/29, v1.0f +README for hrefhide package, 2023-02-26, v1.1a TABLE OF CONTENTS @@ -8,45 +8,52 @@ TABLE OF CONTENTS 2 Download 3 Installation 4 Additional Packages -5 New Features -6 Package Compatibility -7 Authors/Maintainers -8 Bug Reports -9 Known Problems +5 Package Compatibility +6 Author/Maintainer +7 Bug Reports +8 Known Problems 1 INTRODUCTION ============== -This package provides the command \hrefdisplayonly (additionally to \href of -the hyperref package by Heiko Oberdiek). While the (hyperlinked) text appears -like an ordinary nhref in the compiled pdf-file, the same text will be "hidden" -when printing the text. It is not really invisible, but just has the same colour -as the background (default: white). Therefore the layout is not changed when -printing the document. +This LaTeX package provides the command \hrefdisplayonly (additionally to +\href of the hyperref package). While the (hyperlinked) text appears like an +ordinary \href in the compiled pdf-file, the same text will be "hidden" when +printing the text. It is not really invisible, but just has the same color as the +background (default: white). Therefore the layout is not changed when printing +the document. + Further the commands \hycon and \hycoff (hyper-colour-on/off) can be used -to simulate switching option ocgcolorlinks of hyperref package on and off. +to simulate switching option ocgcolorlinks of the hyperref package on and off. +This package is possibly obsolete, see section 3: "Alternatives" +in the documentation. + +This material is published under the LPPL 1.3c: This work may be +distributed and/or modified under the conditions of the LaTeX Project +Public License, either version 1.3c of this license or (at your option) +any later version. This version of this license is in +https://www.latex-project.org/lppl/lppl-1-3c.txt +and the latest version of this license is in +https://www.latex-project.org/lppl.txt +and version 1.3c or later is part of all distributions of +LaTeX version 2005-12-01 or later. 2 DOWNLOAD ========== -`hrefhide' is available on CTAN: - CTAN:macros/latex/contrib/hrefhide/ - -Also a ZIP file is provided that contains the files, already -sorted in a TDS tree (should become available on CTAN soon): - CTAN:install/macros/latex/contrib/hrefhide.tds.zip - -`CTAN:' means one of the `Comprehensive TeX Archive Network' -nodes or one of its mirrors. This is explained in - http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives +"hrefhide" is available on CTAN: +https://www.ctan.org/pkg/pagecolor -The CTAN stuff will be mirrored automatically from the -ftp server, so - ftp://ftp.tug.org/pub/tex/pagesLTS/ -corresponds to - CTAN:macros/latex/contrib/pagesLTS/ +Also a ZIP file is provided that contains the files: +the manual (hrefhide.pdf), the example (hrefhide-example.tex), +the compiled example (hrefhide-example.pdf), +driver (hrefhide.drv), hrefhide.dtx, +installation file (hrefhide.ins), +the style file (hrefhide.sty), +and this README, already sorted in a TDS tree: +https://mirror.ctan.org/install/macros/latex/contrib/pagecolor.tds.zip 3 INSTALLATION @@ -54,10 +61,11 @@ corresponds to Installation with ZIP file in TDS format ---------------------------------------- -The ZIP file `hrefhide.tds.zip' contains the files sorted -in a TDS tree. Thus you can directly unpack the ZIP file -inside a TDS tree. -(See CTAN:tds.zip for an explanation of TDS.) +The ZIP file "hrefhide.tds.zip" contains the files +sorted in a TDS tree. Thus you can directly unpack the +ZIP file inside a TDS tree. +See https://www.ctan.org/TDS-guidelines for an explanation +of TDS. Example: cd /...somewhere.../texmf unzip /...downloadpath.../hrefhide.tds.zip @@ -68,33 +76,39 @@ Example: Manual installation ------------------- -a) Download the hrefhide files from CTAN or the TUG server. +a) Download the hrefhide files from CTAN. If necessary, unpack them. b) Generate the package and driver files: - tex hrefhide.ins -c) Install the files `*.sty', and `*.cfg' in your TDS tree: - cp *.sty *.cfg TDS:tex/latex/hrefhide/ - Replace `TDS:' by the prefix of your TDS tree + tex hrefhide.dtx +c) Install the file "*.sty" in your TDS tree: + cp hrefhide.sty TDS:tex/latex/hrefhide/ + Replace "TDS:" by the prefix of your TDS tree (texmf directory). -d) Copy the documentation files to +d) Create the documentation, if necessary, e.g. + pdflatex hrefhide.dtx + makeindex -s gind.ist hrefhide.idx + pdflatex hrefhide.dtx + makeindex -s gind.ist hrefhide.idx + pdflatex hrefhide.dtx +e) Update the databases if necessary, e.g. for TeXLive + texhash or mktexlsr. +f) Create the hrefhide-example.pdf, if necessary, e.g. + pdflatex hrefhide-example.tex + pdflatex hrefhide-example.tex + pdflatex hrefhide-example.tex +g) Copy the documentation files to "TDS:doc/latex/hrefhide/": README, hrefhide.pdf, hrefhide-example.tex, hrefhide-example.pdf. -e) Update the databases if necessary, e.g. for teTeX: - mktexlsr .../texmf 4 ADDITIONAL PACKAGES ===================== -Depending on the driver and option settings, hrefhide loads -other packages: -* hyperref.sty: - CTAN:macros/latex/contrib/hyperref/hyperref.dtx -* kvoptions.sty: - CTAN:macros/latex/contrib/oberdiek/kvoptions.dtx -* xcolor.sty: - CTAN:/macros/latex/contrib/xcolor/xcolor.dtx +hrefhide loads other packages: +- xcolor +- hyperref +- kvoptions which again load other packages (see the result of the \listfiles command in the log-file of the example). @@ -112,26 +126,26 @@ hrefhide must be loaded AFTER package hyperref: 6 AUTHOR/MAINTAINER -===================== +=================== -* Hans-Martin Münch +H.-Martin Münch 7 BUG REPORTS -============== +============= A bug report should contain: * Comprehensive problem description. This includes error or warning messages. - * \errorcontextlines=\maxdimen can be added in the - TeX code to get more informations in TeX error messages. -* Minimal test file that shows the problem, but does not - contain any unnecessary packages and code. +* \errorcontextlines=\maxdimen can be added in the + TeX code to get more information in TeX error messages. +* Minimal test file that shows the problem, + but does not contain any unnecessary packages and code. * Used drivers/programs. * Version information about used packages and programs. - * If you are using LaTeX, then add "\listfiles". Then - a list of version informations is printed at the end - of the LaTeX run. +* If you are using LaTeX, then add "\listfiles" to the document. + Then a list of version information is printed at the end + of the LaTeX run. * Please no other files than the minimal test file. The other files .log, .dvi, .ps, .pdf are seldom necessary, so send them only on request. @@ -140,13 +154,13 @@ A bug report should contain: Bug address ----------- Bug reports can be send to the maintainer: - Hans-Martin Münch + H.-Martin Münch <Martin [dot] Muench [at] Uni-Bonn [dot] de> 8 KNOWN PROBLEMS -================= +================ * as yet: none... - Well, of course there are all issues of the hyperref package with ocgcolorlinks option, - e.g. no linebreaks inside links. + e.g. no linebreaks inside links.
\ No newline at end of file |