%% LaTeX package crossreftools - version 0.3 (2017/10/31 -- 08:23:52)
%% Documentation file for crossreftools.sty
%%
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2017 by Dr. Christian Hupfer <typography dot with dot latex at gmail dot com>
%% -------------------------------------------------------------------------------------------
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%   http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%%
%% This work has the LPPL maintenance status `author-maintained`
%%
%%

\documentclass[12pt,a4paper,oneside]{article}




\usepackage[lmargin=2cm,rmargin=2cm,headheight=15pt]{geometry}
\usepackage{savesym}
\usepackage{bbding}
\savesymbol{Cross}

\usepackage{graphicx}
\usepackage{blindtext}
\usepackage[x11names]{xcolor}
\usepackage{imakeidx}
\usepackage{fontawesome}
\usepackage[most,documentation]{tcolorbox}
\usepackage[tikz]{bclogo}
\usepackage{marginnote}
\usepackage{fancyhdr}
\usepackage{datetime}
\usepackage{array}
\usepackage{xkeyval}
\usepackage{xparse}
\usepackage{totcount}
\usepackage{enumitem}
\usepackage{microtype}
\usepackage{caption}
\usepackage[T1]{fontenc}
\usepackage[scaled=0.92]{helvet}

\newlist{codeoptionsenum}{enumerate}{1}
\setlist[codeoptionsenum,1]{label={\textcolor{blue}{\#\arabic*}}}

\renewcommand{\rmdefault}{\sfdefault}

\newcolumntype{C}[1]{>{\centering\arraybackslash}p{#1}}

\makeatletter
\define@key{chdoc}{packageauthor}{%
  \def\KVchdocpackageauthor{#1}%
}

\define@key{chdoc}{packageauthormail}{%
  \def\KVchdocpackageauthormail{#1}%
}

\define@key{chdoc}{filepurpose}{%
  \def\KVchdocfilepurpose{#1}%
}


\newcommand{\chdocextractversion}[1]{%
  \@nameuse{#1}%
}


\@namedef{crossreftoolsversion0.1}{v0.1 2017-10-08}

\@namedef{crossreftoolsversion0.2}{v0.2 2017-10-25}

\@namedef{crossreftoolsversion0.3}{v0.3 2017-10-29}

\newcommand{\authorname}{Autor}


\makeatother






\fancypagestyle{plain}{%
\fancyfoot[L]{\begin{tabular}[t]{l}\PackageDocName\ \packageversion \tabularnewline \textcopyright\ Dr. Christian Hupfer\end{tabular}}%
\fancyfoot[C]{\thepage}%
\fancyfoot[R]{\today}%
\renewcommand{\headrule}{{\color{blue}%
\hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}}
\renewcommand{\footrule}{{\color{blue}\vskip-\footruleskip\vskip-\footrulewidth
\hrule width\headwidth height\footrulewidth\vskip\footruleskip}}
\renewcommand{\footrulewidth}{2pt}
\renewcommand{\headrulewidth}{2pt}
}



\newtcolorbox{CHPackageTitleBox}[1][]{%
  enhanced jigsaw,
  drop lifted shadow,
  colback=yellow!30!white,
  width=0.8\textwidth,
  #1
}

\presetkeys{chdoc}{packageauthor={Christian Hupfer}}{}%
\NewDocumentCommand{\CHPackageTitlePage}{O{}mO{}}{%
  \setkeys{chdoc}{packageauthor={Christian Hupfer},filepurpose={Documentation},#1}%
  \begin{center}
    \begin{CHPackageTitleBox}[#3]
      \large \bfseries%
      \begin{center}%
        \begin{tabular}{C{0.9\textwidth}}%
          \scshape \PackageDocName \tabularnewline
          \tabularnewline
          #2 \tabularnewline
          \tabularnewline
          \KVchdocfilepurpose \tabularnewline
          \tabularnewline
          Version \packageversion \tabularnewline
          \tabularnewline
          \today \tabularnewline
          \tabularnewline
          \addtocounter{footnote}{2}
          \authorname: \KVchdocpackageauthor\(^\mathrm{\fnsymbol{footnote}}\)
          \tabularnewline
        \end{tabular}
      \end{center}
    \end{CHPackageTitleBox}
    \renewcommand{\thefootnote}{\fnsymbol{footnote}}%
    \footnotetext{\mymailtoaddress}%
  \end{center}
}

\newtcolorbox{docCommandArgs}[1]{colbacktitle={blue},coltitle={white},title={Description of arguments of command \cs{#1}}}


\newcommand{\tcolorboxdoclink}{http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf}

% 'Stolen' from tcolorbox documentation ;-)

\newtcolorbox{marker}[1][]{enhanced,
  before skip=2mm,after skip=3mm,
  boxrule=0.4pt,left=5mm,right=2mm,top=1mm,bottom=1mm,
  colback=yellow!50,
  colframe=yellow!20!black,
  sharp corners,rounded corners=southeast,arc is angular,arc=3mm,
  underlay={%
    \path[fill=tcbcol@back!80!black] ([yshift=3mm]interior.south east)--++(-0.4,-0.1)--++(0.1,-0.2);
    \path[draw=tcbcol@frame,shorten <=-0.05mm,shorten >=-0.05mm] ([yshift=3mm]interior.south east)--++(-0.4,-0.1)--++(0.1,-0.2);
    \path[fill=yellow!50!black,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries !} ([xshift=4mm]interior.north west);
    },
    drop fuzzy shadow,#1}


%%%% Documentation macros


\NewDocumentCommand{\packagename}{sm}{%
  \textcolor{blue}{\textbf{\faEnvelopeO~#2}}%
  \IfBooleanF{#1}{%
    \index{Package!#2}
  }%
}

\NewDocumentCommand{\classname}{sm}{%
  \textcolor{brown}{\textbf{\faBriefcase~#2}}%
  \IfBooleanF{#1}{%
    \index{Package!#2}%
  }%
}


\NewDocumentCommand{\CHDocPackage}{sm}{%
  \textcolor{blue}{\textbf{\faEnvelopeO~#2}}%
  \IfBooleanF{#1}{%
    \index{Package!#2}
  }%
}




\NewDocumentCommand{\CHDocClass}{sm}{%
  \textcolor{brown}{\textbf{\faBriefcase~#2}}%
  \IfBooleanF{#1}{%
    \index{Package!#2}%
  }%
}

\NewDocumentCommand{\CHDocKey}{sm}{%
  \textcolor{red}{\textbf{\faKey~#2}}%
  \IfBooleanF{#1}{%
      \index{Option!#2}%
  }%
}

\newcommand{\handrightnote}{\tcbdocmarginnote{\ding{43}}}


\NewDocumentCommand{\CHDocCounter}{sm}{%
  \textcolor{Green4}{\textbf{\faCalculator~#2}}%
  \IfBooleanF{#1}{%
    \index{Counter!#2}%
  }%	
}


\NewDocumentCommand{\CHDocTag}{sm}{%
  \textcolor{violet}{\faTag~#2}%
  \IfBooleanF{#1}{%
    \index{Feature!#2}%
  }%	
}


\NewDocumentCommand{\CHDocFileExt}{sm}{%
    \faFile~#2%
}

\NewDocumentCommand{\CHDocFiles}{sm}{%
    \faFilesO~#2%
}


\NewDocumentCommand{\CHDocConventions}{}{%
  \section*{\centering Typographical conventions}
  Throughout this documentation following symbols and conventions are used:
  \begin{itemize}
  \item \CHDocClass*{foo} means a the class \texttt{foo}
  \item \CHDocPackage*{foo} names a package \texttt{foo}
  \item \CHDocCounter*{foo} indicates a counter named \texttt{foo}
  \item \CHDocFileExt*{foo} will indicate either a file named \texttt{foo} or a file extension \texttt{foo}
  \item \CHDocFiles*{foo} will indicate some files 
  \item \CHDocTag*{foo} names a special feature or tag \texttt{foo}
  \item \CHDocKey*{foo} deals with a command or package option named \texttt{foo}
  \end{itemize}
}



\renewcommand{\tcbdocnew}[1]{#1}%
\renewcommand{\tcbdocupdated}[1]{#1}%

\newcommand{\CHDocNew}[1]{%
  \tcbdocmarginnote[doclang/new={N},
  colframe=blue,
  halign=left,
  colback={blue!20!white},
  fontupper={\tiny}
  ]{%
    \chdocextractversion{crossreftoolsversion#1}%
  }%
}



\newcommand{\CHDocUpdate}[1]{\tcbdocmarginnote[doclang/updated={},colback={yellow},colframe={yellow!50!red},  fontupper={\tiny}
]{%
  \tcbdocupdated{\chdocextractversion{crossreftoolsversion#1}}%
}%
}



\newcommand{\CHDocFullVersion}[1]{Version \chdocextractversion{crossreftoolsversion#1}}


\newcommand{\CHDocExpCommand}[1][Expandable]{%
  \tcbdocmarginnote[doclang/new={N},
  colframe=green!50!blue,
  halign=left,
  colback={green!90!blue},
  fontupper={\tiny}
  ]{%
    #1%
  }%
}


\newcommand{\CHDocExperimentalFeature}[1][Experimental]{%
  \tcbdocmarginnote[doclang/new={N},
  colframe=yellow!50!blue,
  halign=left,
  colback={blue!10!yellow},
  fontupper={\tiny}
  ]{%
    #1%
  }%
}


\usepackage[T1]{fontenc}
\usepackage{graphicx}%


\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{minitoc}
\usepackage{tocbibind}


\usepackage{bookmark}

\usepackage{cleveref}




\def\packageversion{0.3}

\def\hyperrefversionwithfifthargument{v6.85a}

\usepackage{url}

\setcounter{tocdepth}{3}
\newcommand{\PackageDocName}{crossreftools}%


\newcommand{\mymailtoaddress}{%
  typography.with.latex@gmail.com%
}

\doparttoc

\makeindex[intoc]


\renewcommand{\rmdefault}{\sfdefault}



\hypersetup{breaklinks=true,
  pdftitle={\jobname.pdf -- version \packageversion},
  pdfauthor={Dr. Christian Hupfer},
  pdfsubject={Documentation of \PackageDocName\ package},
  pdfkeywords={LaTeX, cross-referencing},
  bookmarksopen=true,
  bookmarksopenlevel=2,
  bookmarksnumbered=true,
  pdfcreator={LaTeX}
}

% Load here!

\AtEndPreamble{
  \usepackage{crossreftools}
}


\begin{document}

\yyyymmdddate


\setlength{\parindent}{0em}

\pagestyle{empty}%



\CHPackageTitlePage[packageauthor={Christian Hupfer}]{Expandable extraction of cleveref and other label data}


\clearpage
\tableofcontents
\clearpage

\CHDocConventions
\clearpage


\pagestyle{plain}


\setcounter{footnote}{0}

\part{Introduction}

\parttoc

\section*{Preface}

This package provides expandable extraction of information stored in labels generated with \CHDocPackage{cleveref} and regular labels written by the usual \cs{label} macro, regardless whether \CHDocPackage{hyperref} is loaded or not. For those regular cross-reference information \CHDocPackage{\PackageDocName} works in a \CHDocPackage{refcount} - like manner. 

Whereas \CHDocPackage{cleveref} provides \cs{labelcref} and other commands or \cs{ref} from standard \LaTeX2e kernel none of those are expandable and can not be used in an \cs{edef} - approach. 

\begin{marker}
Most times class and package authors will benefit of this package, but there might be usual documents that need the features of |\PackageDocName|
\end{marker}


\section{Requirements, loading and incompatibilities}%



\subsection{Required packages and \TeX\ engine}

The package does not require features from Xe\LaTeX\ or Lua\LaTeX\ but can be run with those features as well as with \LaTeX\ or pdf\LaTeX. The compilation documentation requires however pdf\LaTeX\ as of version \packageversion. 

No packages are loaded by \CHDocPackage{crossreftools}, this package does neither load \CHDocPackage{hyperref} nor \CHDocPackage{cleveref} itself. 


\subsection{Loading of the package}

Loading is done with

\begin{tcblisting}{listing only}
\usepackage[options]{crossreftools}
\end{tcblisting}

As of version \packageversion\ \CHDocPackage{\PackageDocName} does not have options.

There is no loading order required. The macros expand to \makeatletter\fbox{\crt@refundefined}\makeatother\ if \CHDocPackage{cleveref} is not loaded. 

\subsection{Incompatibilities}\label{subsection:incompatibilities}

As of \packageversion\ this package cannot be used with plain \TeX\ 

\clearpage

\part{Macro descriptions}

\parttoc

\section{Extracting information from regular labels}\label{section:extractingregularlabels}

Depending on loading of \CHDocPackage{hyperref} there is some more information (properties) stored with a \cs{label} command. Common properties are \texttt{reference} and \texttt{page}, additions of \CHDocPackage{hyperref} are \texttt{name}, \texttt{anchor} and the (yet) unused 5th argument of \cs{newlabel}, the property is called \texttt{unused} as of version \packageversion.

All properties are extracted with \refCom{crtextractref}. 



\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.3}}]{crtextractref}{\marg{property}\marg{label name}}

This command will extract one of the properties \texttt{reference}, \texttt{page}, \texttt{anchor}, \texttt{name} and \texttt{unused} from the label given as the 2nd mandatory argument. 
\end{docCommand}

For convenience, there are shortcuts to extract a specific property:

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.3}}]{crtcrefpage}{\marg{label name}}

This extracts the page number that would be printed by \cs{pageref}. 
\end{docCommand}


\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.3}}]{crtrefnumber}{\marg{label name}}

This extracts the reference value (or something that is stored by \cs{@currentlabel} belonging to a certain label name.
\end{docCommand}

With \CHDocPackage{hyperref} being loaded, following return non-empty label information, without \CHDocPackage{hyperref} they are available, but expand to nothing.

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.3}}]{crtrefname}{\marg{label name}}

This extracts the name of the sectioning unit or counter as being specified with \cs{nameref}. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.3}}]{crtrefanchor}{\marg{label name}}

This extracts the hyper target anchor of the reference in order to be used with \cs{hyperlink}.
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.3}}]{crtrefunused}{\marg{label name}}

This extracts the yet unused 5th argument of labels generated after \CHDocPackage{hyperref} is loaded. As of version \hyperrefversionwithfifthargument\ of \CHDocPackage{hyperref}, this argument has no meaning yet. If this is going to be change in future, \refCom{crtrefunused} will probably be removed and replaced by another macro that reflects the meaning of this 5th argument. 
\end{docCommand}



\section{Extracting information from cleveref}

The \CHDocPackage{cleveref} package redefines the \cs{label} macro and stores another label with the same basic name and a suffix \string @cref, so 

\begin{tcblisting}{listing only}
\label{foo}
\end{tcblisting}

would generate both the labels \verb!foo! and \verb!foo@cref!. The \CHDocPackage{cleveref} - version of a label saves basically five properties to the \CHDocFileExt{.aux} - file. 


\begin{itemize}
  \item \texttt{counter}

    This property holds the name of the counter that was used in \cs{refstepcounter}.


  \item \texttt{number}

    This property holds the value of label, this is usually the value of a counter
    \begin{marker}
      Please note that this property does not mean the reference value that is displayed with \cs{cref} or \cs{Cref}. 
    \end{marker}
  \item \texttt{result}
    
  \item \texttt{reference}
    This property holds the reference that is to be typeset, i.e. the content displayed with \cs{cref} or \cs{Cref}, however, without hyperlinks. 

  \item \texttt{page}
    This property stores the page number of the \cs{label} usage.
    
\end{itemize}

\clearpage
\CHDocPackage{\PackageDocName} extracts those properties with \refCom{crtextractcref}. 

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtextractcref}{\marg{property}\marg{label name}}

This command will extract one of the properties \texttt{counter}, \texttt{number}, \texttt{result}, \texttt{reference} and \texttt{page} from the label given as the 2nd mandatory argument. 
\end{docCommand}

For convenience, there are shortcuts to extract a specific property:

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefcounter}{\marg{label name}}

This extracts the counter belonging to a certain label name.
\end{docCommand}


\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefnumber}{\marg{label name}}

This extracts the counter value (or something that is stored by \cs{cref@currentlabel} belonging to a certain label name.
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefresult}{\marg{label name}}

This extracts the result of the splitting of a counter belonging to a certain label name.
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefreference}{\marg{label name}}

This extracts the reference that would be printed by \cs{cref} or \cs{Cref}, without hyperlinks.
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefpage}{\marg{label name}}

This extracts the page number that would be printed by \cs{pageref}. 
\end{docCommand}


\section{Additional macros and utilities}

\subsection{Expandable Commands}

\CHDocPackage{\PackageDocName} provides some expandable helper macros in order to query the cross reference names that are stored with \cs{crefname} and \cs{Crefname} from \CHDocPackage{cleveref}.

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefname}{\marg{counter name}}

This extracts the lower case cross reference name of a given counter. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtCrefname}{\marg{counter name}}

This extracts the upper case cross reference name of a given counter. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtcrefpluralname}{\marg{counter name}}

This extracts the lower case cross reference plural name of a given counter. 
\end{docCommand}


\begin{docCommand}[code={\CHDocExpCommand{}},
doc new={\chdocextractversion{crossreftoolsversion0.1}}]{crtCrefpluralname}{\marg{counter name}}

This extracts the upper case cross reference plural name of a given counter. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new and updated={\chdocextractversion{crossreftoolsversion0.1}}{\chdocextractversion{crossreftoolsversion0.2}}]
{crtcrefnamebylabel}{\marg{label name}}

This extracts the lower case cross reference name of a given label. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new and updated={\chdocextractversion{crossreftoolsversion0.1}}{\chdocextractversion{crossreftoolsversion0.2}}]
{crtCrefnamebylabel}{\marg{label name}}

This extracts the upper case cross reference name of a given label. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new=\chdocextractversion{crossreftoolsversion0.3}]
{crtcref}{\marg{label name}}

This displays the reference in the same way as \cs{cref} from \CHDocPackage{cleveref} would do in a setup without using \cs{crefformat} etc. The hyperlink is not displayed, however. This command is expandable. 

For the upper case version see \refCom{crtCref}. 
\end{docCommand}

\begin{docCommand}[code={\CHDocExpCommand{}},
doc new=\chdocextractversion{crossreftoolsversion0.3}]
{crtCref}{\marg{label name}}

This displays the reference in the same way as \cs{Cref} from \CHDocPackage{cleveref} would do in a setup without using \cs{Crefformat} etc. The hyperlink is not displayed, however. This command is expandable. 

For the lower case version see \refCom{crtcref}. 
\end{docCommand}

\subsection{Nonexpandable Commands}


\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.3}]
{crthyperlink}{\marg{anchor}\marg{link text}}

This is a wrapper to the \cs{hyperlink} macro from \CHDocPackage{hyperref} to the given \marg{anchor}, displaying the \marg{link text}. If \CHDocPackage{hyperref} is not loaded, only the link text is displayed. 
\end{docCommand}

\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.3}]
{crthypercref}{\marg{label name}}

This generates a linked reference to a 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{crtcref}. 
\end{docCommand}

\begin{docCommand}[doc new=\chdocextractversion{crossreftoolsversion0.3}]
{crthyperCref}{\marg{label name}}

This generates a linked reference to a 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{crtcref}. 
\end{docCommand}



\clearpage
\part{Examples}

\parttoc

\section{Driver example}

\tcbinputlisting{breakable,listing only,listing file=crossreftools_driver.tex}

\clearpage
\section{Version history}


\begin{itemize}[itemsep=15pt]
\item \CHDocFullVersion{0.3} Added the extraction macros for regular labels (i.e. not the \CHDocPackage{cleveref} - related ones) and convenience wrappers for generating links. 
\item \CHDocFullVersion{0.2} Introduced a check in \refCom{crtcrefnamebylabel} and \refCom{crtCrefnamebylabel} whether given label exists
\item   \CHDocFullVersion{0.1} First version
\end{itemize}


\printindex

\end{document}

