From 7d4662184ed36e01faf1fbe7b6e19567a331da2f Mon Sep 17 00:00:00 2001
From: Norbert Preining <norbert@preining.info>
Date: Sun, 31 Oct 2021 03:00:46 +0000
Subject: CTAN sync 202110310300

---
 macros/latex/contrib/ccref/ccref-doc.tex | 70 ++++++++++++++++----------------
 1 file changed, 34 insertions(+), 36 deletions(-)

(limited to 'macros/latex/contrib/ccref/ccref-doc.tex')

diff --git a/macros/latex/contrib/ccref/ccref-doc.tex b/macros/latex/contrib/ccref/ccref-doc.tex
index 992ff0f181..368a4896ac 100644
--- a/macros/latex/contrib/ccref/ccref-doc.tex
+++ b/macros/latex/contrib/ccref/ccref-doc.tex
@@ -32,6 +32,7 @@
     {
         cref,crefname,
         ccref,ccmarkart,
+        selectlanguage,
     }
 }
 \lstnewenvironment{code}%
@@ -67,49 +68,52 @@
         title={\scshape\sffamily #1}]%
 }{\end{tcolorbox}\ResumeLineNumbers}
 
+%%================================
+%% demo
+%%================================
 \newenvironment{demo}{%
     \LocallyStopLineNumbers%
     \begin{tcolorbox}[enhanced jigsaw,pad at break*=1mm,breakable,
-        left=4mm,right=4mm,top=1mm,bottom=1mm,
+        left=4mm,right=4mm,top=0.5mm,bottom=0mm,
         colback=gray!5!paper,boxrule=0pt,frame hidden,
         borderline west={1.5mm}{0mm}{gray!55!paper},arc=.7mm]%
 }{\end{tcolorbox}\ResumeLineNumbers}
 
 
-
 \newcommand{\ccrefpackage}{\textsf{ccref}}
 
 \begin{document}
 
-\title{\ccrefpackage{} - cleveref with proper definite articles}
+\title{\ccrefpackage{} - cross referencing with proper definite articles}
 \author{Jinwen XU}
+\thanks{Corresponding to: \texttt{\ccrefpackage{} 2021/10/30}}
 \date{October 2021, in Paris}
 
 \maketitle
 
 \begin{abstract}
     \raggedleft
-    The package \ccrefpackage{} is aimed at helping \lstinline|\cref| addressing the definite articles properly (especially for the article contractions in many European languages).
+    The package \ccrefpackage{} provides a command \lstinline|\ccref| parallel to \textsf{cleveref}'s \lstinline|\cref| for handling definite articles properly (especially for the article contractions in some European languages).
 \end{abstract}
 
 \section{The motivation}
 
-By default, when using \textsf{cleveref}'s \lstinline|\cref| to reference theorem-like environments, the names do not contain definite articles. This may be acceptable for English, but certainly not good enough for languages such as French, Italian, Portuguese, Spanish, etc. -- in these cases there shall be grammatical errors and would give you a strong feeling that it is machine-generated.
+By default, with \textsf{cleveref}'s \lstinline|\cref| to reference theorem-like environments, the names do not contain definite articles. While this might be acceptable for English, it is certainly not good enough for languages such as French, Italian, Portuguese, Spanish, etc. -- in these cases there shall be grammatical errors and would give you a strong feeling that it is machine-generated.
 
-As an example, if we define the French names to be:
+However, even if we manually add the definite articles to the names, there would still be other problems. As an example, if we define the French names to be:
 
 \begin{code}
-\crefname{theorem}{le théorème}{les théorème}
+\crefname{theorem}{le théorème}{les théorèmes}
 \crefname{proposition}{la proposition}{les propositions}
 \end{code}
 
-then when one writes (which means ``\emph{We can deduce this from ...}'' in French)
+then when one writes (which means ``\emph{We can deduce this from ...}'')
 
 \begin{code}
 On peut le déduire de \cref{thm1,thm2,prop3}.
 \end{code}
 
-the result would be
+the result would be:
 
 \begin{demo}
     On peut le déduire \textbf{de les} théorèmes 1 et 2 et \textbf{la} proposition 3.
@@ -121,23 +125,23 @@ which is wrong, as the correct result should be:
     On peut le déduire \textbf{des} théorèmes 1 et 2 et \textbf{de la} proposition 3.
 \end{demo}
 
-\lstinline|\cref| cannot handle such cases correctly --- and that is when \lstinline|\ccref| comes into play.
+\lstinline|\cref| cannot handle such cases automatically --- and that is when \lstinline|\ccref| comes into play.
 
 
 \section{The usage}
 
 \subsection[How to load it]{How to load it\,?}
 
-Simply load the package with
+Simply load the package with:
 
 \begin{code}
 \usepackage{ccref}
 \end{code}
 
 \begin{tip}
-    \begin{itemize}\small
-        \item \ccrefpackage{} uses \textsf{cleveref} internally, thus it should usually be placed at the last of your preamble.
-        \item To handle article contractions correctly, \lstinline|\ccref| shall detect the current language, thus you need to use packages such as \textsf{babel} or \textsf{polyglossia} to set your languages appropriately.
+    \begin{itemize}
+        \item Since \ccrefpackage{} uses \textsf{cleveref} internally, it should usually be placed at the last of your preamble, and notably, after \textsf{varioref} and \textsf{hyperref}.
+        \item To handle article contractions correctly, \lstinline|\ccref| shall detect the current language, thus you need to use packages such as \textsf{babel} or \textsf{polyglossia} to set your languages, and use commands like \lstinline|\selectlanguage| to select them appropriately.
     \end{itemize}
 \end{tip}
 
@@ -147,18 +151,22 @@ Then you can use the command \lstinline|\ccref| as follows:
 \begin{itemize}
     \item \lstinline|\ccref[|\meta{prep}\lstinline|]{|\meta{labels}\lstinline|}|
     \begin{itemize}
-        \item This will pass the preposition \meta{prep} to the first definite article.
+        \item This will pass the preposition \meta{prep} to the definite articles that follows. Its behavior depends on the current language (for example, in Spanish, \meta{prep} is passed only to the first definite article, while in French it is passed to everyone).
     \end{itemize}
-    \item \lstinline|\ccref*[|\meta{prep}\lstinline|]{|\meta{labels}\lstinline|}|
+    \item \lstinline|\ccref-[|\meta{prep}\lstinline|]{|\meta{labels}\lstinline|}| and \lstinline|\ccref+[|\meta{prep}\lstinline|]{|\meta{labels}\lstinline|}|
     \begin{itemize}
-        \item This will pass the preposition \meta{prep} to every definite article.
+        \item In case the automatic version does not meet your needs, here are two manual ones. The \verb|-| version passes the preposition \meta{prep} only to the first definite article, while the \verb|+| version passes \meta{prep} to every definite article.
     \end{itemize}
 \end{itemize}
 
+\begin{tip}
+    There is also a stared version \lstinline|\ccref*| for generating the same referencing text but without creating hyperlinks.
+\end{tip}
+
 However, before using it, you should first define the \lstinline|\crefname|s carefully. The definite article in \lstinline|\crefname|s needs to be marked manually using \lstinline|\ccmarkart|, for example:
 
 \begin{code}
-\crefname{theorem}{\ccmarkart{le} théorème}{\ccmarkart{les} théorème}
+\crefname{theorem}{\ccmarkart{le} théorème}{\ccmarkart{les} théorèmes}
 \end{code}
 
 
@@ -168,41 +176,31 @@ Let us come back to the example at the beginning, now you can do this:
 
 \begin{code}
 \crefname{theorem}{\ccmarkart{le} théorème}
-                  {\ccmarkart{les} théorème}
-\crefname{proposition}{\ccmarkart{le} proposition}
+                  {\ccmarkart{les} théorèmes}
+\crefname{proposition}{\ccmarkart{la} proposition}
                       {\ccmarkart{les} propositions}
 \end{code}
 
-And the sentence shall be written as\footnote{Here the stared version is used because we want the preposition ``de'' to be passed to every definite article.}:
+And the sentence shall be written as:
 
 \begin{code}
-On peut le déduire \ccref*[de]{thm1,thm2,prop3}.
+On peut le déduire \ccref[de]{thm1,thm2,prop3}.
 \end{code}
 
-which would result in:
+which would result in (provided that you have done \lstinline|\selectlanguage{french}|):
 
 \begin{demo}
     On peut le déduire \textbf{des} théorèmes 1 et 2 et \textbf{de la} proposition 3.
 \end{demo}
 
-As another example, with
-
-\begin{code}
-Pensez \ccref*[à]{thm1,thm2,prop3}.
-\end{code}
-
-one would get something like:
-
-\begin{demo}
-    Pensez \textbf{aux} théorèmes 1 et 2 et \textbf{à la} proposition 3.
-\end{demo}
-
+Voilà !
 
 
 \section{Known issues}
 \begin{itemize}
     \item \ccrefpackage{} currently only works for French, Italian, Portuguese (both European and Brazilian) and Spanish, certainly more would be added to this list.
-    \item In the case that the initial letter of \meta{prep} is capitalized, \ccrefpackage{} cannot yet handle the case changes automatically. However, this should be a rare occurrence.
+    \item The current mechanism does not work for German. However, the author has planed to adopt a more refined approach in later versions in order to support the various situations in German.
+    \item In case that the initial letter of \meta{prep} is capitalized, \ccrefpackage{} cannot yet handle the case changes automatically. However, this should be a rare occurrence.
     \item The names of theorem-like environments are not provided --- for the moment you need to define them all by yourself. However, users are encouraged to use the \ProjLib{} toolkit, which already handles everything for you.
 \end{itemize}
 
-- 
cgit v1.2.3

