Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
Small tweaks and fixes; this is not intended to be substantial change of content.
- Use \hologo{xxx} in a few spots,
- Use \ifLuaTeX and \ifTUTeX in a few spots,
- Remove sentence about defunct package kvoptions-patch,
- Slightly shorten a confusing paragraph about colors,
- Fix typo "no" (not) and re-word sentence.

TODO: remove driver detection; hyperref does it's own driver detection.
  • Loading branch information
gaelicWizard authored Feb 14, 2021
1 parent 4f668f0 commit 482ad20
Showing 1 changed file with 19 additions and 24 deletions.
43 changes: 19 additions & 24 deletions doc/hyperref-doc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@
\def\mydate{January 2020}

\RequirePackage{iftex}
\ifpdf % We are running pdfTeX in pdf mode
\ifx\directlua\undefinded
\documentclass[pdftex]{article}
\else
\documentclass[luatex]{article}
\fi
\else
\documentclass{article}
\ifpdf % We are running in pdf mode
\ifLuaTeX
\documentclass[luatex]{article}
\else % what about others...
\documentclass[pdftex]{article}
\fi
\else % not-PDF
\documentclass{article}
\fi


Expand All @@ -33,7 +33,7 @@

\usepackage{hologo}

\def\OzTeX{O\kern-0.03em z\kern-0.15em \TeX}
\def\OzTeX{\hologo{OzTeX}}

\newcommand*{\cs}[1]{%
\texttt{\textbackslash #1}%
Expand Down Expand Up @@ -136,18 +136,18 @@
\makeatother

\usepackage{array,longtable}
\ifnum 0\ifluatex 1\else\ifxetex 1\fi\fi=0 %
\ifTUTeX%
\usepackage{fontspec}%
\renewcommand*{\ttdefault}{lmvtt}%
\else % not \XeTeX* nor \LuaTeX*
\usepackage[T1]{fontenc}%
\usepackage{lmodern}%
\renewcommand*{\ttdefault}{lmvtt}%
\else
\usepackage{fontspec}%
\renewcommand*{\ttdefault}{lmvtt}%
\fi

\newcommand*{\Quote}[1]{\textquotedblleft#1\textquotedblright}

\def\Hanh{H\`an Th\^e\llap{\raise 0.5ex\hbox{\'{}}} Th\`anh}
\def\Hanh{\hologo{HanTheThanh}}

\ifpdf
\usepackage[%
Expand Down Expand Up @@ -190,7 +190,7 @@
\section{Introduction}

The package derives from, and builds on, the work of the Hyper\hologo{TeX}
project, described at \texttt{http://xxx.lanl.gov/hypertex/}\footnote{Now: \url{https://ctan.org/tex-archive/support/hypertex/hypertex}}. It extends
project, described at \nolinkurl{http://xxx.lanl.gov/hypertex/}\footnote{Now: \url{https://ctan.org/tex-archive/support/hypertex/hypertex}}. It extends
the functionality of all the \hologo{LaTeX} cross-referencing commands
(including the table of contents, bibliographies etc) to produce
\cs{special} commands which a driver can turn into hypertext links;
Expand Down Expand Up @@ -379,9 +379,6 @@ \section{Package options}
\hypersetup{pdfborder=0 0 0}
\end{verbatim}

Package `kvoptions-patch' patches \LaTeX\ to make it aware
of key value options and to prevent premature value expansions.

Some options can be given at any time, but many are restricted: before
\verb|\begin{document}|, only in \verb|\usepackage[...]{hyperref}|,
before first use, etc.
Expand Down Expand Up @@ -710,10 +707,8 @@ \subsection{PDF-specific display options}
but the colorlinks option resets it to produce no border.
\end{longtable}

Note that the color of link borders can be specified \emph{only} as 3
numbers in the range 0..1, giving an RGB color. You cannot use colors
defined in \TeX. Since version 6.76a this is no longer true.
Especially with the help of package \xpackage{xcolor} the usual
The color of link borders used to be specified \emph{only} as 3
numbers in the range 0..1, giving an RGB color. Since version 6.76a, the usual
color specifications of package \xpackage{(x)color} can be used.
For further information see description of package \xpackage{hycolor}.

Expand Down Expand Up @@ -1636,7 +1631,7 @@ \subsection{\textbackslash ifpdfstringunicode}


As example we take a macro definition for the Vietnamese
name of Han The Thanh. Correctly written it needs some
name of \hologo{HanTheThanh}. Correctly written it needs some
accented characters, one character even with a double accent.
Class `tugboat.cls' defines a macro for the typesetted name:
\begin{verbatim}
Expand Down Expand Up @@ -1968,7 +1963,7 @@ \subsection{Option `pdfencoding'}
are used for most characters, surrogates need four bytes.
\item \xoption{auto} PDFDocEncoding if the string does not contain characters
outside the encoding (outside ascii if an unicode engine is used)
and Unicode otherwise. This option is normally no suited for the unicode engines.
and Unicode otherwise. This option is not intended for the unicode engines.
\end{itemize}

All drivers use \xoption{unicode} by default now. If another encoding should be forced,
Expand Down

0 comments on commit 482ad20

Please sign in to comment.