Skip to content

Commit cfa6769

Browse files
committed
docs(zref-clever): fix docs about clever references
Signed-off-by: Jonas Dujava <[email protected]>
1 parent 95bb694 commit cfa6769

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

chapters/Features.tex

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -306,13 +306,15 @@ \subsection{References and Links}%
306306
By default, \package{hyperref} provides frames around links, but they are not that pretty, and the PDF viewer must support them.
307307
Using just colors can sometimes look better, but I still wasn't satisfied.
308308

309-
Sometimes it is nice to know the precise location of the reference, especially when printed, where you can't click on them.
310-
% Additionally, it is sometimes good to have an idea where the links point, especially when printed, where you can't click on them.
311-
Therefore, the page number is (by default) included with \custommacro{\Cref} --- use starred variant \custommacro{\Cref*} to omit it.
309+
Sometimes it is nice to know the precise location of the reference, especially when the document is printed and you cannot simply click on them.
310+
Therefore, the page number is (by default) included with \custommacro{\Cref}, see \Cref{rem:zref-clever}.
311+
Use the starred variant \custommacro{\Cref*} to omit it.
312312
\end{remark}
313-
\begin{remark}[Automatic Reference Type Detection]
314-
Package \package{cleveref} provides \macro{\Cref} command, which automatically detects the type of reference, and formats it accordingly.
315-
This behavior is adapted in \TeXtured{} with the macro of the same name \custommacro{\Cref}.
313+
\begin{remark}[Automatic Reference Type Detection] \label{rem:zref-clever}
314+
Package \package{zref-clever} provides \macro{\zcref} command --- similarly to the older, no longer maintained, \package{cleveref} package --- which automatically detects the type of reference, and formats it accordingly.
315+
This behavior is adapted in \TeXtured{} with the macro \custommacro{\Cref}, which wraps the link in nice box, and also shows a corresponding page number of the target.
316+
317+
If you want the link to show the reference title, use \custommacro{\Nref} --- or the starred variant \custommacro{\Nref*} to omit the page number --- which utilizes \package{zref-titleref}.
316318
\end{remark}
317319

318320
\subsection{Table of Contents and Outline/Index}%

chapters/Tips.tex

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,13 @@ \subsection{Structure Environments}%
3838
\end{Todo}
3939
\item Try to motivate every definition/theorem with \enquote{normal} text, do not let the document degenerate just into a listing of definitions/theorems/proofs/...
4040
\item Use references to other remarks/definitions/sections to make the document more interconnected, which can help the reader to look at a bigger picture, recollect necessary information to proceed further, or to understand the context better.
41-
\begin{Todo}
42-
Describe \custommacro{\Cref}, \custommacro{\Nref}.
43-
\end{Todo}
44-
\begin{Todo}
45-
Show using \macro{\autocite{TODO}} in the text \autocite{TODO}.
46-
Helps to not forget to add the citation later.
47-
\end{Todo}
4841
\end{itemize}
4942

43+
\begin{Todo}
44+
Show using \macro{\autocite{TODO}} in the text \autocite{TODO}.
45+
Helps to not forget to add the citation later.
46+
\end{Todo}
47+
5048

5149
\section{Typography}%
5250
\label{sec:Typography}

0 commit comments

Comments
 (0)