Skip to content

Commit

Permalink
Add comment about compat module settings to User manual
Browse files Browse the repository at this point in the history
  • Loading branch information
gusbrs committed Sep 10, 2024
1 parent 9cb1082 commit 59de7c7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions zref-clever-doc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2332,6 +2332,13 @@ \section{Compatibility modules}
required. Of course, this effort is bound to be incomplete (see
\zcref{sec:limitations}).

Note that settings performed by the compatibility modules require special care
if they are to be changed by users. Since the modules depend on what has been
loaded or not in the document, the settings are done at
\texttt{begindocument}. Hence, to override a setting performed by a
compatibility module, the user must ensure their change comes after that,
e.g.\ by adding their setting to the \texttt{begindocument} hook.

The purpose of outlining to some extend what the compatibility modules do is
twofold. First, some of them require usage adjustments for label setting,
which must be somehow conveyed in this documentation. Second, the kind and
Expand Down

0 comments on commit 59de7c7

Please sign in to comment.