Directory macros/latex/contrib/hrefhide

README for hrefhide package, 2025-01-27, v1.1b


TABLE OF CONTENTS
=================

1 Introduction
2 Download
3 Installation
4 Additional Packages
5 Package Compatibility
6 Author/Maintainer
7 Bug Reports
8 Known Problems


1 INTRODUCTION
==============

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 the hyperref package on and off.
This package is probably 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:
https://www.ctan.org/pkg/pagecolor

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
==============

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 https://www.ctan.org/TDS-guidelines for an explanation
of TDS.
Example:
  cd /...somewhere.../texmf
  unzip /...downloadpath.../hrefhide.tds.zip
Do not forget to refresh the file name database of this
TDS tree.
Example:
  texhash /...somewhere.../texmf

Manual installation
-------------------
a) Download the hrefhide files from CTAN.
   If necessary, unpack them.
b) Generate the package and driver files:
     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) 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.


4 ADDITIONAL PACKAGES
=====================

hrefhide loads other packages:
- xcolor
- hyperref
which again load other packages
(see the result of the \listfiles command in the log-file
 of the example).


5 PACKAGE COMPATIBILITY
=======================

hrefhide must be loaded AFTER package hyperref:

  Package loading order:

  \usepackage[ocgcolorlinks]{hyperref}
  \usepackage{hrefhide}


6 AUTHOR/MAINTAINER
===================

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 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" 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.
* Please .zip or .tar.gz your file(s) before sending them!

Bug address
-----------
Bug reports can be send to the maintainer:
  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. The ocgx2 package
  fixes that and therefore probably should be used
  instead of hrefhide.