summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/crefthe/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-07-22 20:19:27 +0000
committerKarl Berry <karl@freefriends.org>2023-07-22 20:19:27 +0000
commit41b4083c4760c1aa464faa675e3bf1832f71ab6a (patch)
tree4e2d7e5e242abb33e73bbcfd41aeecfc0272775f /Master/texmf-dist/doc/latex/crefthe/README.md
parent4c5778f024115953ee66abaf048fe7bfc5b1beb7 (diff)
crefthe (22jul23)
git-svn-id: svn://tug.org/texlive/trunk@67706 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/crefthe/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/crefthe/README.md45
1 files changed, 43 insertions, 2 deletions
diff --git a/Master/texmf-dist/doc/latex/crefthe/README.md b/Master/texmf-dist/doc/latex/crefthe/README.md
index db578d078f4..44a00effb63 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-2022 by Jinwen XU -->
+<!-- Copyright (C) 2021-2023 by Jinwen XU -->
# crefthe - cross referencing with proper definite articles
@@ -45,6 +45,7 @@ Before everything, you need to define the names, which can be done with `\crefth
```latex
\crefthename{theorem}[le]{théorème}[les]{théorèmes}
```
+(*In French*)
Then you can use the command `\crefthe` as follows:
- `\crefthe[<prep>]{<labels>}`
@@ -54,7 +55,47 @@ Then you can use the command `\crefthe` as follows:
> There is also a stared version `\crefthe*` for generating the same text but without hyperlinks.
-*For more information, please refer to its documentation.*
+## Regarding German
+
+In German, there are four declensions: nominative (`Nominativ`), genitive (`Genitiv`), dative (`Dativ`) and accusative (`Akkusativ`). For such situation, we introduce the command `\crefthevariantname` to specify the referencing name for the correspond environment. Below is an example of usage:
+```latex
+\crefthevariantname{theorem}
+ {
+ {Satz}{Sätze}
+ , Nominativ = [der]{Satz}[die]{Sätze}
+ , Genitiv = [des]{Satzes}[der]{Sätze}
+ , Dativ = [dem]{Satz}[den]{Sätzen}
+ , Akkusativ = [den]{Satz}[die]{Sätze}
+ }
+```
+The first line in the configuration is the default set of names when no variant is specified. It is recommended, though not required.
+
+After this, you may refer to a theorem via
+
+```latex
+\crefthe[<prep>,variant=<declension>]{<label>}
+```
+
+You may also use the shortcuts (`nom.`, `gen.`, `dat.` and `akk.`), such as:
+
+```latex
+\crefthe[<prep>,Nom]{<label>} \crefthe[<prep>,Nom.]{<label>}
+\crefthe[<prep>,nom]{<label>} \crefthe[<prep>,nom.]{<label>}
+```
+
+These four are all equivalent and you may choose one to use according to your preference.
+
+> *For more information, please refer to the documentation.*
+
+# Acknowledgement
+
+There are so many people I wish to express my gratitude to during the development of this package, including:
+
+- Patrick Bideault, without whose advice and careful explanation, this package probably would never have been born. Merci !
+
+- Enrico Gregorio, Phelype Oleinik and Joseph Wright (in alphabetical order). They made valuable suggestions in the early development of this package and even edited some of the code themselves.
+
+- Jonathan P. Spratte, without whose help the German support would probably take much longer to complete.
# License