diff options
author | Karl Berry <karl@freefriends.org> | 2022-02-10 21:19:07 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-02-10 21:19:07 +0000 |
commit | 2328328e473107d8bfe42ef7f2fcff96ce50c6f4 (patch) | |
tree | 7b21688bcb36c1342ba2f42b5bdd124933118d0e /Master/texmf-dist/doc | |
parent | 1d69ba3a31952647ab48fdc693b18fcffd388cd8 (diff) |
crefthe (10feb22)
git-svn-id: svn://tug.org/texlive/trunk@61970 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/crefthe/crefthe-doc.pdf | bin | 110051 -> 111955 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex | 34 |
2 files changed, 17 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.pdf b/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.pdf Binary files differindex 7175c64abc7..5cf5715d5c1 100644 --- a/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.pdf +++ b/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.pdf diff --git a/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex b/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex index 39d53e76b00..718672f8968 100644 --- a/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex +++ b/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex @@ -64,10 +64,10 @@ fonttitle = \sffamily, attach boxed title to top left = {yshift=-\tcboxedtitleheight/2, xshift=.5cm}, boxed title style = {boxrule=0pt, colframe=paper}, - before skip = 0.3cm, - after skip = 0.3cm, - top = 3mm, - bottom = 3mm, + before skip = 3mm, + after skip = 3mm, + top = 2.5mm, + bottom = 1.5mm, title={\scshape\sffamily #1}]% }{\end{tcolorbox}\ResumeLineNumbers} @@ -89,7 +89,7 @@ \title{\crefthepackage{} - cross referencing with proper definite articles} \author{Jinwen XU} -\thanks{Corresponding to: \texttt{\crefthepackage{} 2022/02/04}} +\thanks{Corresponding to: \texttt{\crefthepackage{} 2022/02/10}} \date{February 2022, in Paris} \maketitle @@ -156,9 +156,9 @@ Before everything, you need to define the names, which can be done with \lstinli \crefthename{theorem}[le]{théorème}[les]{théorèmes} \end{code} -% \begin{tip} -% The \lstinline|\crefthename|s should be placed in your preamble. -% \end{tip} +\begin{tip} + The \lstinline|\crefthename|s should be placed in your preamble, otherwise the \lstinline|\cref| formats will not be set. These names can, however, be reset within the document body. +\end{tip} Then you can use the command \lstinline|\crefthe| as follows: \begin{itemize} @@ -207,7 +207,7 @@ which would result in (provided that you have done \lstinline|\selectlanguage{fr Voilà ! -\section{Regarding the cases} +\section{Regarding the upper and lower cases} The commands also have correspoding uppercased version: \lstinline|\Crefthename| and \lstinline|\Crefthe|, similar to \textsf{cleveref}'s \lstinline|\Crefname| and \lstinline|\Cref|, reserved for use at the beginning of a sentence. \lstinline|\Crefthe| can handle case changing automatically: for example, with \lstinline|\Crefthe[À]{thm1,thm2,prop3}|, you will get something like @@ -222,22 +222,22 @@ Of course you will have to define the \lstinline|\Crefthename|s separately, for \Crefthename{proposition}[La]{proposition}[Les]{propositions} \end{code} -\section{Relationship with \textsf{cleveref}} +\section{For writing multi-language documents} -\crefthepackage{} loads \textsf{cleveref} automatically and pass all the options to it. All its commands, used without optional arguments, degenerate to those in \textsf{cleveref}. For example, \lstinline|\crefthe{...}| is the same as \lstinline|\cref{...}|, and \lstinline|\crefthename| is the same as \lstinline|\crefname| if the definite articles are not specified. That said, you can safely use the command \lstinline|\crefthe| everywhere in your document without causing extra trouble. +To place hyperlinks at the right place, \lstinline|\crefthename| touches the corresponding \lstinline|\crefformat| internally, which makes the format language-dependent. If you are writing multi-language documents, you may consider putting \lstinline|\crefthename| inside your language configuration so as to reset it each time you select a new language. -With the option \texttt{overwrite}, user commands in \textsf{cleveref} will be replaced by those offered here, thus you can simply write \lstinline|\cref| for \lstinline|\crefthe| -- and similarly for \lstinline|\Cref|, \lstinline|\crefname| and \lstinline|\Crefname|. -\section{For multi-language documents} +\section{The relationship with \textsf{cleveref}} + +\crefthepackage{} loads \textsf{cleveref} automatically and pass all the options to it. All its commands, used without optional arguments, degenerate to those in \textsf{cleveref}. For example, \lstinline|\crefthe{...}| is the same as \lstinline|\cref{...}|, and \lstinline|\crefthename| is the same as \lstinline|\crefname| if the definite articles are not specified. That said, you can safely use the command \lstinline|\crefthe| everywhere in your document without causing extra trouble. + +With the option \texttt{overwrite}, user commands in \textsf{cleveref} will be replaced by those offered here, thus you can simply write \lstinline|\cref| for \lstinline|\crefthe| -- and similarly with \lstinline|\Cref|, \lstinline|\crefname| and \lstinline|\Crefname|. -To place hyperlinks at the right place, \lstinline|\crefthename| touches the corresponding \lstinline|\crefformat| internally, which makes the format language-dependent. If you are writing multi-language documents, you may consider putting \lstinline|\crefthename| inside your language configuration so as to reset it each time you select a new language. \section{Known issues} \begin{itemize} \item \crefthepackage{} currently works for French, Italian, Portuguese (European and Brazilian) and Spanish, certainly more would be added to this list. - \item The current mechanism does not work for German. The author plans to adopt a more refined approach in later versions in order to support the various situations in German. - \item For now, the automatic case changing mechanism only works properly under Unicode based engines. If you are using pdf\LaTeX{} or typing accented letters with text commands, \lstinline|\Crefthe| may not work as expected. - % \item In case that the initial letter of \meta{prep} is capitalized, \crefthepackage{} cannot yet handle the case changes automatically. However, this should be a rare occurrence. + \item The current mechanism does not work for German. The author plans to adopt a more refined approach in later versions in order to support the various situations in German. Meanwhile, you may consider the package \textsf{zref-clever}, which has a much more powerful and sophisticated interface for configure cross referencing. \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} |