diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/crefthe/README.md | 19 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/crefthe/crefthe-doc.pdf | bin | 108754 -> 110051 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex | 14 |
3 files changed, 18 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/latex/crefthe/README.md b/Master/texmf-dist/doc/latex/crefthe/README.md index e8460c7ae9f..db578d078f4 100644 --- a/Master/texmf-dist/doc/latex/crefthe/README.md +++ b/Master/texmf-dist/doc/latex/crefthe/README.md @@ -1,4 +1,4 @@ -<!-- Copyright (C) 2021 by Jinwen XU --> +<!-- Copyright (C) 2021-2022 by Jinwen XU --> # crefthe - cross referencing with proper definite articles @@ -28,20 +28,25 @@ which is wrong, as the correct result should be: ## The solution Thus, it would be better to have a new command `\crefthe[<prep>]{<labels>}`, and to use it like -``` +```latex \crefthe[de]{thm1,thm2,prop3} ``` in order to get "*des théorèmes 1 et 2 et de la proposition 3*". # Usage -Just load the package with +Simply load the package with: ```latex \usepackage{crefthe} ``` > "crefthe" uses "cleveref" internally, thus it should usually be placed at the last of your preamble. -And then you can use the command `\crefthe` as follows: +Before everything, you need to define the names, which can be done with `\crefthename`. Its syntax is similar to `\crefname`, but now you can specify the definite articles, for example: +```latex +\crefthename{theorem}[le]{théorème}[les]{théorèmes} +``` + +Then you can use the command `\crefthe` as follows: - `\crefthe[<prep>]{<labels>}` - This will pass the preposition `<prep>` to the definite articles that follows. Its behavior depends on the current language (for example, in Spanish, `<prep>` is passed only to the first definite article, while in French it is passed to everyone). - `\crefthe-[<prep>]{<labels>}` and `\crefthe+[<prep>]{<labels>}` @@ -49,11 +54,7 @@ And then you can use the command `\crefthe` as follows: > There is also a stared version `\crefthe*` for generating the same text but without hyperlinks. -However, before using it, you should first define the `\crefname`s carefully. The definite article in `\crefname`s needs to be marked manually using `\crefthemark`, for example: -```latex -\crefname{theorem}{\crefthemark{le} théorème}{\crefthemark{les} théorèmes} -``` - +*For more information, please refer to its documentation.* # License 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 10ac58da25c..7175c64abc7 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 736f44876b7..39d53e76b00 100644 --- a/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex +++ b/Master/texmf-dist/doc/latex/crefthe/crefthe-doc.tex @@ -89,8 +89,8 @@ \title{\crefthepackage{} - cross referencing with proper definite articles} \author{Jinwen XU} -\thanks{Corresponding to: \texttt{\crefthepackage{} 2022/01/29}} -\date{January 2022, in Paris} +\thanks{Corresponding to: \texttt{\crefthepackage{} 2022/02/04}} +\date{February 2022, in Paris} \maketitle @@ -226,15 +226,17 @@ Of course you will have to define the \lstinline|\Crefthename|s separately, for \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 for \lstinline|\Cref|, \lstinline|\crefname| and \lstinline|\Crefname|. + \section{For multi-language documents} -To place hyperlinks at the right place, \lstinline|\crefthename| touches the corresponding \lstinline|\crefformat| internally, which makes it language-dependent. If you are writing multi-language documents, you may like to consider putting \lstinline|\crefthename| inside your language configuration so as to reset it each time you select a new language. +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 only 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. However, the author has planed 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| will not work as expected. + \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 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} |