summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex76
1 files changed, 68 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex b/Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex
index 06b4159ed19..2f5f3908456 100644
--- a/Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex
+++ b/Master/texmf-dist/doc/latex/crossreftools/crossreftools_doc.tex
@@ -1,4 +1,4 @@
-%% LaTeX package crossreftools - version 0.5 (2018/02/23 -- 13:46:13)
+%% LaTeX package crossreftools - version 0.6 (2018/03/18 -- 16:34:57)
%% Documentation file for crossreftools.sty
%%
%%
@@ -97,6 +97,8 @@
\@namedef{crossreftoolsversion0.5}{v0.5 2018-02-23}
+\@namedef{crossreftoolsversion0.6}{v0.6 2018-03-18}
+
\newcommand{\authorname}{Autor}
@@ -325,7 +327,7 @@
-\def\packageversion{0.5}
+\def\packageversion{0.6}
\def\hyperrefversionwithfifthargument{v6.85a}
@@ -710,6 +712,59 @@ This generates a linked reference to a given label like \cs{Cref} would do. If \
For the lower case version see \refCom{crthypercref}.
\end{docCommand}
+\section{Lower and upper case references}
+
+\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.6}]
+{crtlnameref}{\marg{label name}}
+
+This generates a linked reference to the name like \cs{nameref} would do, but the first character is used in lower case mode. % given label like \cs{Cref} would do.
+If \CHDocPackage{hyperref} is not loaded, no link but only the reference text is displayed.
+For the upper case version see \refCom{crtunameref}.
+\end{docCommand}
+
+\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.6}]
+{crtlnameref*}{\marg{label name}}
+
+This generates a reference like \cs{nameref*} would do, but the first character is used in lower case mode -- no links are generated.
+For the upper case version see \refCom{crtlnameref*}.
+\end{docCommand}
+
+
+\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.6}]
+{crtunameref}{\marg{label name}}
+
+This generates a linked reference to the name like \cs{nameref} would do, but the first character is used in upper case mode. % given label like \cs{Cref} would do.
+If \CHDocPackage{hyperref} is not loaded, no link but only the reference text is displayed.
+For the lower case version see \refCom{crtlnameref}.
+\end{docCommand}
+
+\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.6}]
+{crtunameref*}{\marg{label name}}
+
+This generates a reference like \cs{nameref*} would do, but the first character is used in upper case mode -- no links are generated.
+For the lower case version see \refCom{crtlnameref*}.
+\end{docCommand}
+
+
+\section{Convenience macros}
+
+In case \CHDocPackage{hyperref} shouldn't be loaded, \CHDocPackage{crossreftools} provides some convenience wrapper macros
+
+\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.6}]
+{crtnameref}{\marg{label name}}
+
+This generates a reference like \cs{nameref*} would do.
+If \CHDocPackage{hyperref} is not loaded but \CHDocPackage{nameref} is used, no link is generated, so \refCom{crtnameref} acts like \refCom{crtnameref*}
+For the unlinked version see \refCom{crtnameref*}.
+\end{docCommand}
+
+\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.6}]
+{crtnameref*}{\marg{label name}}
+
+This generates a reference like \cs{nameref*} would do and does not generate a link. If neither \CHDocPackage{nameref} nor \CHDocPackage{hyperref} is used no output is generated from this macro.
+For the linked version see \refCom{crtnameref}.
+\end{docCommand}
+
\section{Placing more generic labels}\label{section::placing-generic-labels}
@@ -760,7 +815,7 @@ This behaves like \refCom{crtcrossreflabel} but suppresses the output of the 2nd
Sometimes it is necessary to check whether some label exists in order to refer to it. The macros
\begin{itemize}
- \item \refCom{crtrefifdefinedlabel}
+ \item \refCom{crtifdefinedlabel}
\item \refCom{crtcrefifdefinedlabel}
\end{itemize}
@@ -769,17 +824,17 @@ check for the label existence and execute the relevant true or false conditions
Those macros have related commands that revert the test, i.e. they check for the non-existence of a label:
\begin{itemize}
- \item \refCom{crtrefifundefinedlabel}
+ \item \refCom{crtifundefinedlabel}
\item \refCom{crtcrefifundefinedlabel}
\end{itemize}
-\begin{docCommand}[doc new={\chdocextractversion{crossreftoolsversion0.5}}]{crtrefifdefinedlabel}{\marg{label name}\marg{true branch}\marg{false branch}}
+\begin{docCommand}[doc new={\chdocextractversion{crossreftoolsversion0.5}}]{crtifdefinedlabel}{\marg{label name}\marg{true branch}\marg{false branch}}
This checks whether the label 'label name' is defined and executes the true branch, otherwise the false branch.
\end{docCommand}
-\begin{docCommand}[doc new={\chdocextractversion{crossreftoolsversion0.5}}]{crtrefifundefinedlabel}{\marg{label name}\marg{true branch}\marg{false branch}}
+\begin{docCommand}[doc new={\chdocextractversion{crossreftoolsversion0.5}}]{crtifundefinedlabel}{\marg{label name}\marg{true branch}\marg{false branch}}
This checks whether the label 'label name' is undefined and executes the true branch, otherwise the false branch.
\end{docCommand}
@@ -916,14 +971,19 @@ By default, this macro expands to nothing, but can be redefined with \cs{renewco
\begin{itemize}[itemsep=15pt]
+\item \CHDocFullVersion{0.6}
+ \begin{itemize}
+ \item Corrected the typo in this manual about \refCom{crtifdefinedlabel} and \refCom{crtifundefinedlabel}
+ \item Added the macros \refCom{crtlnameref} and \refCom{crtunameref} for providing a lower and upper case version of the first character in a \cs{nameref} - like usage.
+ \item Provided the convenience wrappers \refCom{crtnameref} and \refCom{crtnameref*} in order to make code compilable if \CHDocPackage{hyperref} is not loaded.
+ \end{itemize}
+
\item \CHDocFullVersion{0.5}
\begin{itemize}
\item Added the \texttt{cleverefcompat} option.
\item Changed the internal code of \refCom{crtcrefpage} which was necessary after the update of \CHDocPackage{cleveref} to version 0.21
\item Added some macros that check for label existence, see \cref{sec:checkinglabelexistence} about this.
\end{itemize}
-\item \CHDocFullVersion{0.3}
-
\item \CHDocFullVersion{0.4}
\begin{itemize}