From 89dc3e461477d72d8e064e98b6326823c7b027fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Sun, 30 Jan 2022 19:22:48 +0100 Subject: [PATCH] document hypersetup package --- doc/wrappers/hypersetup/.latexmkrc | 4 ++ doc/wrappers/hypersetup/Makefile | 8 ++++ doc/wrappers/hypersetup/hypersetup.tex | 52 ++++++++++++++++++++++++++ 3 files changed, 64 insertions(+) create mode 100644 doc/wrappers/hypersetup/.latexmkrc create mode 100644 doc/wrappers/hypersetup/Makefile create mode 100644 doc/wrappers/hypersetup/hypersetup.tex diff --git a/doc/wrappers/hypersetup/.latexmkrc b/doc/wrappers/hypersetup/.latexmkrc new file mode 100644 index 0000000..4c81cd6 --- /dev/null +++ b/doc/wrappers/hypersetup/.latexmkrc @@ -0,0 +1,4 @@ +$makeindex = "makeindex -s gind.ist %O -o %D %S"; +$clean_ext .= ' glo'; +$clean_ext .= ' hd'; +$clean_ext .= ' ins'; diff --git a/doc/wrappers/hypersetup/Makefile b/doc/wrappers/hypersetup/Makefile new file mode 100644 index 0000000..e174370 --- /dev/null +++ b/doc/wrappers/hypersetup/Makefile @@ -0,0 +1,8 @@ +doc: + latexmk + +full: + latexmk -gg + +clean: + latexmk -C diff --git a/doc/wrappers/hypersetup/hypersetup.tex b/doc/wrappers/hypersetup/hypersetup.tex new file mode 100644 index 0000000..19223b1 --- /dev/null +++ b/doc/wrappers/hypersetup/hypersetup.tex @@ -0,0 +1,52 @@ +\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}