summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/zref-check/zref-check-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/zref-check/zref-check-doc.tex')
-rw-r--r--macros/latex/contrib/zref-check/zref-check-doc.tex18
1 files changed, 12 insertions, 6 deletions
diff --git a/macros/latex/contrib/zref-check/zref-check-doc.tex b/macros/latex/contrib/zref-check/zref-check-doc.tex
index 420ec0f900..9d0205c571 100644
--- a/macros/latex/contrib/zref-check/zref-check-doc.tex
+++ b/macros/latex/contrib/zref-check/zref-check-doc.tex
@@ -49,6 +49,10 @@
\NewDocumentCommand\opt{m}{\texttt{#1}}
+\makeatletter
+\newcommand{\zcrequiredkernel}{\zrefcheck@required@kernel}
+\makeatother
+
\begin{document}
\GetFileInfo{zref-check.sty}
@@ -165,10 +169,9 @@ using \cs{zrefchecksetup} (see Section~\ref{sec:user-interface}).
\pkg{zref} is required, of course, but in particular, its modules
\pkg{zref-user} and \pkg{zref-abspage} are loaded by default. \pkg{ifdraft}
(from the \pkg{oberdiek} bundle) is also loaded by default. A \LaTeX{} kernel
-later than 2021-06-01 is required, since we rely on the new hook system from
-\pkg{ltcmdhooks} for the sectioning checks. If \pkg{hyperref} is loaded and
-option \pkg{hyperref} is given, \pkg{zref-check} makes use of it, but it does
-not load the package for you.
+later than \zcrequiredkernel{} is required as well. If \pkg{hyperref} is
+loaded and option \pkg{hyperref} is given, \pkg{zref-check} makes use of it,
+but it does not load the package for you.
\section{User interface}
@@ -329,6 +332,9 @@ The available checks are the following:
\item[far] Not \opt{close}.
+\item[manual] A check which always fails. Can be used to keep track of
+ relations not covered by the other regular checks.
+
\end{description}
@@ -363,9 +369,9 @@ terminal and to the log file, \opt{info} issues messages to the log file only,
\opt{info} if option \opt{draft} is passed to \cs{documentclass}, and to
\opt{warn} otherwise. \opt{warniffinal} corresponds to \opt{warn} if option
\opt{final} is (explicitly) passed to \cs{documentclass} and \opt{info}
-otherwise. \opt{ignore} is provided as convenience alias for
+otherwise. \opt{ignore} and \opt{ok} are provided as convenience aliases for
\opt{msglevel=none} for local use only. This option only affects the messages
-issued by the checks in \cs{zcheck}, not other messages or warnings of the
+related to the checks in \cs{zcheck}, not other messages or warnings of the
package. In particular, it does not affect warnings issued for undefined
labels, which just use \cs{zref@refused} and thus are the same as standard
\LaTeX{} ones for this purpose.