latex-packages/doc/wrappers/hypersetup/hypersetup.tex

53 lines
1.1 KiB
TeX

\documentclass[full]{l3doc}
\usepackage{mkessler-hypersetup}
\title{The \pkg{mkessler-hypersetup} package}
\author{Maximilian Ke\ss ler}
\begin{document}
\maketitle
\begin{abstract}
This is just a quick wrapper around the \pkg{hyperref} package
and - optionally - the cleveref package.
\end{abstract}
\begin{documentation}
\section{Usage}
The package provides one option: \texttt{cleveref}.
When given, \pkg{cleveref} is also loaded.
The package loads \pkg{hyperref} at the end of the preamble,
and (optionally), \pkg{cleveref} afterwards.
This ensures proper loading order of these packages.
Additionally, we provide some default settings
that are shown in \autoref{tab:hyperref-values}.
\begin{table}[htpb]
\centering
\begin{tabular}{c | c}
Key & Value \\
\hline
colorlinks & none \\
citecolor & violet \\
urlcolor & blue!80!black \\
linkcolor & red!50!black \\
pdftitle & \cs{@course} if defined, else \cs{@title} \\
pdfauthor & \cs{@author}
\end{tabular}
\caption{Hyperref values set by \pkg{mkessler-hypersetup}}
\label{tab:hyperref-values}
\end{table}
\end{documentation}
\end{document}