[Tex/LaTex] Cleveref: Change behaviour of \Cref to use the abbreviated form

cleverefcross-referencing

The journal International Journal of Solids and Structures uses always capitalised and abbreviated form of references, i.e. Fig. 1, Eq. 1, even at the beginning of a sentence.

I use the package cleveref to adjust this globally.
However, I have not figured it out how to abbreviate a reference at the beginning of a sentence using \Cref{}. I like to stick to \Cref{} to be able to change this style in case another journal uses a different style.

MWE

\documentclass{article}
\usepackage[capitalise]{cleveref}
\begin{document}
\begin{equation}
  c^2 = a^2 + b^2
  \label{eqn}
\end{equation}

\Cref{eqn} shows an interesting result.
\end{document}

Did I overlook an option in the documentation?

Current cleveref version as of 27.07.2015: 0.19.1, released May 2014, http://www.dr-qubit.org/cleveref.html

Update: no change in version 0.21 (June 2017)

Best Answer

From the (deleted) answer and comment by @Christian Hupfer and my own search, there are three possibilities:

\renewcommand{\Cref}[1]{\cref{#1}}
This does not work together with the poorman option
Replace Cref by cref, e.g. with
$ sed 's/\\Cref{/\\cref{/g' manuscript.tex > manuscript-new.tex

Defining the capital labels for figure, equation, tabular, etc. explicitly (my pick):

\Crefname{equation}{Eq.}{Eqs.}
\Crefname{figure}{Fig.}{Figs.}
\Crefname{tabular}{Tab.}{Tabs.}

Note, the package author of cleveref is not going to add this as a package option (e.g. abbrevall) since this is considered poor writing style (see comment by Toby Cubitt).

Related Solutions

[Tex/LaTex] cleveref — using both abbreviated and full form references

Here is another approach requiring less delving in to the innards of cleveref. The idea is to change the name locally using \crefname.

\documentclass{scrartcl}

\usepackage[demo]{graphicx}
\usepackage[noabbrev]{cleveref}

\DeclareRobustCommand{\abbrevcrefs}{%
\crefname{figure}{fig.}{figs.}%
\crefname{equation}{eqn.}{eqns.}%
}

\DeclareRobustCommand{\cshref}[1]{{\abbrevcrefs\cref{#1}}}

\begin{document}

\section{Geometric abstraction}

\begin{equation}
  \label{eq:x}
  x = 1.
\end{equation}
\Cref{myfig} shows a black square. For a black square, please refer to
\cref{myfig,eq:x}. Squares can be black (cf.\ \cshref{myfig,eq:x}).
Back to \cref{myfig,eq:x}.

\begin{figure}
    \centering
    \includegraphics[width=6cm,height=6cm]{fig1.pdf}
    \caption[asd]{Kazimir Malevich. \textit{Black Square.} 1915. Oil on canvas. State Russian Museum, St Petersburg.}
    \label{myfig}
\end{figure}

\end{document}

We load the cleveref package with the noabbrev option to get all the full name versions. We provide a list of abbreviated forms encapsulated in a command \abbrevcrefs and then define a new command \cshref for abbreviated references that calls \cref proceeded by \abbrevcrefs and enclosed in a group to make the effect local.

The same general approach could be used to make modified versions of other commands from the cleveref package.

I had hoped to be able just use the internal \@cref@abbrevtrue locally to turn on abbreviations, but it turns out that cleveref only uses this switch when initially defining the label names, not when typesetting them. The label defining process is hooked in to \AtBeginDocument code, and can not be easily reevaluated to extract the abbreviated versions, hence the need to set up the abbreviations oneself.

[Tex/LaTex] cleveref: customize the \cref output

The naming/numbering scheme is confusing, in my point of view, but using xassoccnt and its \RegisterPostLabelHook{\zlabel} macro automatically defines extra labels, storing the \thesubsection for the relevant appendix 'section', which is extracted with \parentCref later on.

\documentclass{article}
\usepackage{lipsum}
\usepackage{xassoccnt}
\usepackage{xpatch}
\usepackage{hyperref}
\usepackage[user,counter,hyperref]{zref}
\usepackage{cleveref}

\makeatletter
\AtEndPreamble{
  \newif\if@hyperrefloaded
  \@ifpackageloaded{hyperref}{
    \@hyperrefloadedtrue
  }{
    \@hyperrefloadedfalse
  }
}
\makeatother


\usepackage{xparse}

% Define a new property named 'appendix'

\makeatletter
\zref@newprop{appendix}{\thesubsection}

% Add the new property to the main property list stored with \zlabel, but for \appendix only
\g@addto@macro{\appendix}{%
  \zref@addprops{main}{appendix}%
}

% Command for uppercase output
\NewDocumentCommand{\parentCref}{m}{%
  \zref@ifrefundefined{#1}{%
    \Cref{#1}%
  }{%
    \if@hyperrefloaded
    \hyperlink{\zref@extract{#1}{anchor}}{\appendixname\ \zref@extract{#1}{appendix}, Section \zref@extract{#1}{default}}%
    \else
    \appendixname\ \zref@extract{#1}{appendix}, Section \zref@extract{#1}{default}%
    \fi
  }%
}
\makeatother


\AtBeginDocument{%
 \RegisterPostLabelHook{\zlabel}
}

\begin{document}


\section{Normal section} \label{firstsection}
Refer to \parentCref{append} for more details, but don't forget \parentCref{append:b}.

\appendix
\renewcommand{\thesection}{\Roman{section}}
\renewcommand{\thesubsection}{\Alph{subsection}}
\renewcommand{\thesubsubsection}{\Roman{subsubsection}}


\clearpage

\section{Appendix}
\subsection{Appendix A}
\subsubsection{Detailed Explanation} \label{append}
blah
\subsection{Appendix B} \label{appendix:B}
\subsubsection{Even more detailed explanations} \label{append:b}


\end{document}




%\crefname{subsubappendix}{\appendixname \Alph{subsection}, Section}{\appendixname \Alph{subsection}, Section}

\crefformat{subsubappendix}{#2\appendixname\ thesubappendix, Section  #1#3}
\Crefformat{subsubappendix}{#2\appendixname\ thesubappendix, Section  #1#3}

\begin{document}
\tableofcontents

\section{Section A} \label{firstsection}
Refer to \cref{append} for more details, but don't forget \Cref{append:b}.

\appendix
\renewcommand{\thesection}{\Roman{section}}
\renewcommand{\thesubsection}{\Alph{subsection}}
\renewcommand{\thesubsubsection}{\Roman{subsubsection}}



\section{Appendix}
\subsection{Appendix A}
\subsubsection{Detailed Explanation} \label{append}
blah
\subsection{Appendix B} \label{appendix:B}
\subsubsection{Even more detailed explanations} \label{append:b}

\end{document}

Best Answer

Related Solutions

[Tex/LaTex] cleveref — using both abbreviated and full form references

[Tex/LaTex] cleveref: customize the \cref output

Related Question