summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/proof-at-the-end/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/proof-at-the-end/README.md')
-rw-r--r--macros/latex/contrib/proof-at-the-end/README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/macros/latex/contrib/proof-at-the-end/README.md b/macros/latex/contrib/proof-at-the-end/README.md
index c111036875..5e7a2f9b95 100644
--- a/macros/latex/contrib/proof-at-the-end/README.md
+++ b/macros/latex/contrib/proof-at-the-end/README.md
@@ -48,7 +48,7 @@ If `proof-at-the-end` it's not installed in your CTAN distribution, copy the [`p
And I am a proof.
\end{proofE}
```
-The options (here `restate` and `end`) tells what should go in appendix, how to configure the links... Here the proof should go in appendix, and the `restate` options states that the theorem should be restated before the proof.
+The options (here `restate` and `end`) tells what should go in appendix, how to configure the links... Here the proof should go in appendix, and the `restate` options states that the theorem should be restated before the proof. Note that in case you don't want any title but do want to add options, make sure to insert an empty pair of brackets like in `\begin{thmE}[][end, text link=]` (the option `text link` is used to choose the text of the link to the proof, writting `text link=` is used to display no link at all).
You can find below a full example to compile which should produce this output (sorry, this is a screenshot, that way I can export it easily in the github page). Just make sure to compile twice to get references.
@@ -69,14 +69,15 @@ You can directly copy them (with a more complete demo) in the github page here h
\newcommand{\thmautorefname}{Theorem}
%% Load the library. createShortEnv automatically creates the shortcuts
-%% thmE, theoremE, lemmaE, corrolaryE, proofE. See \newEndThm for more details.
+%% thmE, theoremE, lemmaE, propositionE, corollaryE, proofE. See \newEndThm for more details.
\usepackage[createShortEnv]{proof-at-the-end}
\begin{document}
\section{Theorems}
-\begin{thmE}[My title][end]
+%% If you don't have any title, leave an empty bracket like \begin{thmE}[][end]
+\begin{thmE}[My title][end, restate]
I am a theorem
\end{thmE}
\begin{proofE}
@@ -184,7 +185,7 @@ For example:
\end{proofEnd}
```
-Since `theoremEnd` may be a bit verbose to use, we provide since the version 2022/01/28, an option: if you load the program using `\usepackage[createShortEnv]{proof-at-the-end}`, you will automatically have the shortcut environments `proofE` (to replace `proof`), `thmE` (to replace `thm`), `theoremE` (to replace... ok you got the pattern), `lemmaE` and `corollaryE`. Note that it is your role to define the initial commands `thm`..., but you don't need to define them all, only those that you use. Then, you can use them like:
+Since `theoremEnd` may be a bit verbose to use, we provide since the version 2022/01/28, an option: if you load the program using `\usepackage[createShortEnv]{proof-at-the-end}`, you will automatically have the shortcut environments `proofE` (to replace `proof`), `thmE` (to replace `thm`), `theoremE` (to replace... ok you got the pattern), `lemmaE`, `propositionE` and `corollaryE`. Note that it is your role to define the initial commands `thm`..., but you don't need to define them all, only those that you use. Then, you can use them like:
```latex
\begin{thmE}[My title][end, restate]
@@ -527,6 +528,10 @@ In anycase, there exists some workarounds, some of the are for instance give in
## Changelog
+- 2022/02/01:
+ 1. Fix a typo when defining the shortcut for lemma
+ 2. Add a shortcut for proposition
+ 3. Fix a small spacing issue in the text before the proof in Appendix
- 2022/01/28:
1. Fix the issue when using sharps in a proof https://github.com/leo-colisson/proof-at-the-end/issues/7.
2. Provide `\newEndThm`, `\newEndProof` and the option `createShortEnv` to quickly create environments.