summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-06-11 00:40:54 +0000
committerKarl Berry <karl@freefriends.org>2010-06-11 00:40:54 +0000
commit8e5e9bbf8afd30acf79e6efd665b94f96e697a2c (patch)
tree9aff24dd8b7590720074f63c7e71dbcb777afd10 /Master/texmf-dist/doc
parent244448534b4d3c120613c54a49e271c396913e79 (diff)
new latex pkg hrefhide 1.0b (10jun10)
git-svn-id: svn://tug.org/texlive/trunk@18882 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/hrefhide/README152
-rw-r--r--Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.pdfbin0 -> 135496 bytes
-rw-r--r--Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.tex172
-rw-r--r--Master/texmf-dist/doc/latex/hrefhide/hrefhide.pdfbin0 -> 362030 bytes
-rw-r--r--Master/texmf-dist/doc/latex/hrefhide/ltxdoc.cfg103
5 files changed, 427 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/hrefhide/README b/Master/texmf-dist/doc/latex/hrefhide/README
new file mode 100644
index 00000000000..f7b39c5a9c7
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hrefhide/README
@@ -0,0 +1,152 @@
+README for hrefhide package, 2010/06/03, v1.0b
+
+
+TABLE OF CONTENTS
+=================
+
+1 Introduction
+2 Download
+3 Installation
+4 Additional Packages
+5 New Features
+6 Package Compatibility
+7 Authors/Maintainers
+8 Bug Reports
+9 Known Problems
+
+
+1 INTRODUCTION
+==============
+
+This package provides the command \hrefdisplayonly (instead
+of \href). 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 colour as the background
+(default: white). Therefore the layout is not changed when
+printing the document.
+
+
+2 DOWNLOAD
+==========
+
+`hrefhide' should become available on CTAN soon:
+ CTAN:macros/latex/contrib/muench/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/muench/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
+
+The CTAN stuff will be mirrored automatically from the
+ftp server, so
+ ftp://ftp.tug.org/pub/tex/muench/pagesLTS/
+corresponds to
+ CTAN:macros/latex/contrib/muench/pagesLTS/
+
+
+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 CTAN:tds.zip 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 or the TUG server.
+ If necessary, unpack them.
+b) If directory `beta' exists, replace the files by the
+ counterparts in this directory, if you want to use the
+ latest versions.
+c) Generate the package and driver files:
+ tex hrefhide.ins
+d) Install the files `*.sty', and `*.cfg' in your TDS tree:
+ cp *.sty *.cfg TDS:tex/latex/muench/hrefhide/
+ Replace `TDS:' by the prefix of your TDS tree
+ (texmf directory).
+e) Copy the documentation files to
+ "TDS:doc/latex/muench/hrefhide/":
+ README, hrefhide.pdf, hrefhide-example.tex,
+ hrefhide-example.pdf.
+f) 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:
+* color.sty (part of the graphics package bundle):
+ CTAN:macros/latex/required/graphics/color.dtx
+* hyperref.sty:
+ CTAN:macros/latex/contrib/hyperref/hyperref.dtx
+* kvoptions.sty:
+ CTAN:macros/latex/contrib/oberdiek/kvoptions.pdf
+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
+=====================
+
+* Hans-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.
+* 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.
+* 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:
+ Hans-Martin Münch
+ <Martin [dot] Muench [at] Uni-Bonn [dot] de>
+
+
+8 KNOWN PROBLEMS
+=================
+
+* as yet: none... \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.pdf b/Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.pdf
new file mode 100644
index 00000000000..38f811d910e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.tex b/Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.tex
new file mode 100644
index 00000000000..c5f9d7b2638
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hrefhide/hrefhide-example.tex
@@ -0,0 +1,172 @@
+%%
+%% This is file `hrefhide-example.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% hrefhide.dtx (with options: `example')
+%%
+%% This is a generated file.
+%%
+%% IMPORTANT NOTICE:
+%% The package takes options.
+%%
+%% The usual disclaimers apply:
+%% If it doesn't work right that's your problem.
+%% (Nevertheless, send an e-mail to the maintainer
+%% when you find an error in this package.)
+%%
+%% 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
+%% http://www.latex-project.org/lppl/lppl-1-3c.txt
+%% and the latest version of this license is in
+%% http://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.
+%%
+%% This work has the LPPL maintenance status "maintained".
+%%
+%% The Current Maintainer of this work is H.-Martin Muench
+%% (Martin dot Muench at Uni-Bonn dot de).
+%%
+%% This work consists of the main source file hrefhide.dtx
+%% and the derived files
+%% hrefhide.sty, hrefhide.pdf, hrefhide.ins, hrefhide.drv,
+%% hrefhide-example.tex.
+%%
+\documentclass[british]{article}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\usepackage{lipsum}[2005/01/26]% v1.0
+\usepackage[ocgcolorlinks]{hyperref}[2010/05/13]% v6.81e
+\hypersetup{extension=pdf,%
+ plainpages=false,%
+ pdfpagelabels=true,%
+ hyperindex=false,%
+ pdflang={en},%
+ pdftitle={hrefhide package example},%
+ pdfauthor={Hans-Martin Muench},%
+ pdfsubject={Example for the hrefhide package},%
+ pdfkeywords={LaTeX, hrefhide, Hans-Martin Muench},%
+ pdfview=Fit,pdfstartview=Fit,%
+ pdfpagelayout=SinglePage,%
+ bookmarksopen=true%
+}
+\usepackage[linktextcolour=black,backgroundcolour=white,pdfborder={0 0 1}]{hrefhide}[2010/06/03]% v1.0b
+%% This are the default options. %%
+\makeatletter
+%% Code from tcilatex.tex, Macros for Scientific Word and Scientific WorkPlace 5.5 <06 Oct 2005> %%
+%% Copyright (C) 2005 Mackichan Software, Inc. %%
+%% That macro file is NOT proprietary and may be freely copied and distributed. %%
+ \def\unit#1{\mathord{\thinspace\rm #1}}%
+%% End of code from tcilatex.tex %%
+\makeatother
+\listfiles
+\begin{document}
+\pagenumbering{arabic}
+\section*{Example for hrefhide}
+
+This example demonstrates the use of package\newline
+\textsf{hrefhide}, v1.0b as of 2010/06/03 (HMM).\newline
+The used options were \texttt{linktextcolour=black},
+\texttt{backgroundcolour=white}, and \texttt{pdfborder={0 0 1}}
+(the default ones).\newline
+For more details please see the documentation!\newline
+
+\textit{Print-\textbf{preview} the first page of this document
+and compare it with the page as displayed in your pdf reader.}\newline
+
+\noindent {\color{green} Save per page about $200\unit{ml}$ water,
+$2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\newline
+Therefore please print only if this is really necessary.\newline
+Maybe already the print-preview or just printing
+the first page are sufficient?}\newline
+
+\bigskip
+Lorem ipsum dolor sit amet \href{\#target}{link to target} consectetuer
+adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet
+dolore magna aliquam erat volutpat.
+
+Ut wisi enim ad minim
+veniam \hrefdisplayonly{\#target}{hidden link to target} quis nostrud
+exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea
+commodo consequat.
+
+Duis autem vel eum iriure dolor \href{\#target}{link to target} in
+hendrerit in vulputate velit esse molestie consequat, vel illum dolore
+eu feugiat nulla facilisis at vero eros et accumsan et iusto odio
+dignissim qui blandit praesent luptatum zzril delenit augue
+duis dolore te feugait nulla facilisi.\newline
+
+\noindent \textbf{\textsf{%
+\hrefdisplayonly{\#RefA}{A}
+\hrefdisplayonly{\#RefB}{B}
+\hrefdisplayonly{\#RefC}{C}
+\hrefdisplayonly{\#RefD}{D}
+\hrefdisplayonly{\#RefE}{E}
+\hrefdisplayonly{\#RefF}{F}
+\hrefdisplayonly{\#RefG}{G}
+\hrefdisplayonly{\#RefH}{H}
+\hrefdisplayonly{\#RefI}{I}
+\hrefdisplayonly{\#RefJ}{J}
+\hrefdisplayonly{\#RefK}{K}
+\hrefdisplayonly{\#RefL}{L}
+\hrefdisplayonly{\#RefM}{M}
+\hrefdisplayonly{\#RefN}{N}
+\hrefdisplayonly{\#RefO}{O}
+\hrefdisplayonly{\#RefP}{P}
+\hrefdisplayonly{\#RefQ}{Q}
+\hrefdisplayonly{\#RefR}{R}
+\hrefdisplayonly{\#RefS}{S}
+\hrefdisplayonly{\#RefT}{T}
+\hrefdisplayonly{\#RefU}{U}
+\hrefdisplayonly{\#RefV}{V}
+\hrefdisplayonly{\#RefW}{W}
+\hrefdisplayonly{\#RefX}{X}
+\hrefdisplayonly{\#RefY}{Y}
+\hrefdisplayonly{\#RefZ}{Z}}} \linebreak
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit,
+vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum gravida
+mauris. Nam arcu libero, nonummy eget, consectetuer id, vulputate a, magna.
+
+\pagebreak
+{\Large \textbf{Targets}}\\
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam
+nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat
+volutpat. \hypertarget{target}{target text} Ut wisi enim ad minim
+veniam, quis nostrud exerci tation ullamcorper suscipit lobortis
+nisl ut aliquip ex ea commodo consequat.
+
+\section[A]{\hypertarget{RefA}{A}} \lipsum[1]
+\section[B]{\hypertarget{RefB}{B}} \lipsum[1]
+\section[C]{\hypertarget{RefC}{C}} \lipsum[1]
+\section[D]{\hypertarget{RefD}{D}} \lipsum[1]
+\section[E]{\hypertarget{RefE}{E}} \lipsum[1]
+\section[F]{\hypertarget{RefF}{F}} \lipsum[1]
+\section[G]{\hypertarget{RefG}{G}} \lipsum[1]
+\section[H]{\hypertarget{RefH}{H}} \lipsum[1]
+\section[I]{\hypertarget{RefI}{I}} \lipsum[1]
+\section[J]{\hypertarget{RefJ}{J}} \lipsum[1]
+\section[K]{\hypertarget{RefK}{K}} \lipsum[1]
+\section[L]{\hypertarget{RefL}{L}} \lipsum[1]
+\section[M]{\hypertarget{RefM}{M}} \lipsum[1]
+\section[N]{\hypertarget{RefN}{N}} \lipsum[1]
+\section[O]{\hypertarget{RefO}{O}} \lipsum[1]
+\section[P]{\hypertarget{RefP}{P}} \lipsum[1]
+\section[Q]{\hypertarget{RefQ}{Q}} \lipsum[1]
+\section[R]{\hypertarget{RefR}{R}} \lipsum[1]
+\section[S]{\hypertarget{RefS}{S}} \lipsum[1]
+\section[T]{\hypertarget{RefT}{T}} \lipsum[1]
+\section[U]{\hypertarget{RefU}{U}} \lipsum[1]
+\section[V]{\hypertarget{RefV}{V}} \lipsum[1]
+\section[W]{\hypertarget{RefW}{W}} \lipsum[1]
+\section[X]{\hypertarget{RefX}{X}} \lipsum[1]
+\section[Y]{\hypertarget{RefY}{Y}} \lipsum[1]
+\section[Z]{\hypertarget{RefZ}{Z}} \lipsum[1]
+
+\end{document}
+\endinput
+%%
+%% End of file `hrefhide-example.tex'.
diff --git a/Master/texmf-dist/doc/latex/hrefhide/hrefhide.pdf b/Master/texmf-dist/doc/latex/hrefhide/hrefhide.pdf
new file mode 100644
index 00000000000..72d3be11104
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hrefhide/hrefhide.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/hrefhide/ltxdoc.cfg b/Master/texmf-dist/doc/latex/hrefhide/ltxdoc.cfg
new file mode 100644
index 00000000000..3ee1f5363d4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hrefhide/ltxdoc.cfg
@@ -0,0 +1,103 @@
+%%
+%% This is file `ltxdoc.cfg',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% hrefhide.dtx (with options: `ltxdoc')
+%%
+%% This is a generated file.
+%%
+%% IMPORTANT NOTICE:
+%% The package takes options.
+%%
+%% The usual disclaimers apply:
+%% If it doesn't work right that's your problem.
+%% (Nevertheless, send an e-mail to the maintainer
+%% when you find an error in this package.)
+%%
+%% 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
+%% http://www.latex-project.org/lppl/lppl-1-3c.txt
+%% and the latest version of this license is in
+%% http://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.
+%%
+%% This work has the LPPL maintenance status "maintained".
+%%
+%% The Current Maintainer of this work is H.-Martin Muench
+%% (Martin dot Muench at Uni-Bonn dot de).
+%%
+%% This work consists of the main source file hrefhide.dtx
+%% and the derived files
+%% hrefhide.sty, hrefhide.pdf, hrefhide.ins, hrefhide.drv,
+%% hrefhide-example.tex.
+%%
+\NeedsTeXFormat{LaTeX2e}[1994/06/01]
+\ProvidesFile{ltxdoc.cfg}[2010/06/01 v1.0 configuration file for hrefhide (HMM)]
+ %% Code from original ltxdoc.cfg [2007/01/08 latex-tds: ltxdoc.cls configuration (HO)], %%
+ % copyrighted 2006, 2007 Heiko Oberdiek, part of project `latex-tds'.
+ % That file may be distributed and/or modified under the
+ % conditions of the LaTeX Project Public License, either version 1.3
+ % of this license or (at your option) any later version.
+ % The latest version of this license is in
+ % http://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.
+ % That work has the LPPL maintenance status `maintained'.
+ % The Current Maintainer of that work is Heiko Oberdiek.
+ %
+ \PassOptionsToClass{a4paper}{article}
+ \AtEndOfClass{%
+ \RequirePackage[numbered]{hypdoc}[2010/03/26]% v1.9
+ \pdfstringdefDisableCommands{%
+ \let\env\relax % longtable.dtx
+ \let\mytt\relax % tabularx.dtx
+ }%
+ \addtolength{\topmargin}{-10mm}%
+ \addtolength{\textheight}{20mm}%
+ % Depending on the page style, the head or foot area
+ % are put into the text area.
+ % Usually the page style is the default "plain".
+ % tools/verbatim.dtx uses "myheadings".
+ \def\string@plain{plain}%
+ \def\string@myheadings{myheadings}%
+ \def\current@pagestyle{plain}%
+ \let\ltxdoc@cfg@pagestyle\pagestyle
+ \def\pagestyle#1{%
+ \def\current@pagestyle{#1}%
+ \ltxdoc@cfg@pagestyle{#1}%
+ }%
+ \edef\ltxdoc@cfg@jobname{\jobname}%
+ \def\ltxdoc@cfg@longtable{longtable}%
+ \@onelevel@sanitize\ltxdoc@cfg@longtable
+ \ifx\ltxdoc@cfg@jobname\ltxdoc@cfg@longtable
+ \def\current@pagestyle{both}%
+ \fi
+ \let\ltxdoc@cfg@document\document
+ \def\document{%
+ \ifx\current@pagestyle\string@plain
+ \addtolength{\textheight}{\headheight}%
+ \addtolength{\textheight}{\headsep}%
+ \setlength{\headheight}{0pt}%
+ \setlength{\headsep}{0pt}%
+ \global\textheight\textheight
+ \global\headheight\headheight
+ \global\headsep\headsep
+ \fi
+ \ifx\current@pagestyle\string@myheadings
+ \addtolength{\textheight}{\footskip}%
+ \global\textheight\textheight
+ \fi
+ \ltxdoc@cfg@document
+ }%
+ %% End of code from original ltxdoc.cfg [2007/01/08 latex-tds: ltxdoc.cls configuration (HO)] %%
+ %% Place additional code here. %%
+ }
+
+\endinput
+%%
+%% End of file `ltxdoc.cfg'.