summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex30
1 files changed, 28 insertions, 2 deletions
diff --git a/Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex b/Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex
index 37c4c56edf8..706d2e6eac1 100644
--- a/Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex
+++ b/Master/texmf-dist/doc/latex/create-theorem/create-theorem-doc.tex
@@ -97,7 +97,7 @@
\begin{document}
-\def\PackageVersion{2022/05/22}
+\def\PackageVersion{2022/05/31}
\title{\createtheorempackage{}\\\smallskip\itshape Initializing theorem-like environments with multilingual support}
\author{Jinwen XU}
@@ -210,7 +210,7 @@ Supported keys are:
\item The style of the \textquote{crefname}, you can specify the font, text style, color, etc.
\item Synonymous names: \commandoption{crefname-style} \,$|$\, \commandoption{crefnamestyle}
\end{itemize}
- \item \commandoption{Crefname}
+ \item \commandoption{Crefname}\lstinline| = |\meta{configuration}
\begin{itemize}
\item The name for \lstinline|\Cref| the environment, its syntax is the same as that of \commandoption{crefname}.
\item Also supports the syntax of \lstinline|\Crefthename|.
@@ -263,6 +263,12 @@ Supported keys are:
\item Specifying the \lstinline|\theoremstyle| for the current environment.
\item Synonymous names: \commandoption{apply style} \,$|$\, \commandoption{apply-style} \,$|$\, \commandoption{applystyle}
\end{itemize}
+ \item \commandoption{qed} or \commandoption{qed}\lstinline| = |\meta{Q.E.D. symbol}
+ \begin{itemize}
+ \item Specifying the Q.E.D. symbol for the current environment.
+ \item Note that the Q.E.D. symbol has already been put in math mode. If you want regular text such as \textquote{Q.E.D.}, you need to write \commandoption{qed}\lstinline| = \mathrm{Q.E.D.}|.
+ \item Synonymous names: \commandoption{qed symbol} \,$|$\, \commandoption{qed-symbol} \,$|$\, \commandoption{qedsymbol}
+ \end{itemize}
\item \commandoption{parent counter}\lstinline| = |\meta{parent counter}
\begin{itemize}
\item Specifying the \meta{parent counter} for the current environment, \emph{i.e.}, numbering will restart whenever that sectional level is encountered.
@@ -325,6 +331,12 @@ Supported keys are:
\item Note that this configuration can overwrite those already specified in \lstinline|\NameTheorem|.
\item Synonymous names: \commandoption{name-style} \,$|$\, \commandoption{namestyle}
\end{itemize}
+ \item \commandoption{qed}\lstinline| = |\meta{Q.E.D. symbol}
+ \begin{itemize}
+ \item Specifying the Q.E.D. symbol for the current environment.
+ \item Note that this configuration only works if you have already enabled the Q.E.D. symbol during the creating phase of the corresponding environment.
+ \item Synonymous names: \commandoption{qed symbol} \,$|$\, \commandoption{qed-symbol} \,$|$\, \commandoption{qedsymbol}
+ \end{itemize}
\item \commandoption{parent counter}\lstinline| = |\meta{parent counter}
\begin{itemize}
\item Specifying the \meta{parent counter} for the current environment, \emph{i.e.}, numbering will restart whenever that sectional level is encountered.
@@ -445,12 +457,26 @@ This is the combination of the first two cases --- we need to create \texttt{ide
\smallskip
In each case, the two environments \texttt{idea} and \texttt{idea*} share the same set of names.
+\subsection{The \emph{proofless} version -- theorems with a Q.E.D. symbol}
+
+Sometimes you may encounter a theorem without a proof, in which case you might want a Q.E.D. symbol when the theorem is finished. This can be easily achieved via:
+\begin{code}
+\CreateTheorem { theorem } { (*\commandoption{create starred version}*) }
+\CreateTheorem { theorem+ } { (*\commandoption{copy existed}*) = theorem, (*\commandoption{qed}*) }
+\CreateTheorem { theorem+* } { (*\commandoption{copy existed}*) = theorem*, (*\commandoption{qed}*) }
+\end{code}
+
+The code above defines two new environments \lstinline|theorem+| and \lstinline|theorem+*| in addition to \lstinline|theorem| and \lstinline|theorem*|. The \lstinline|+| version behaves exactly the same as the usual version, except it has a Q.E.D. symbol.
+
+
+\bigskip
\section{Known issues}
\begin{itemize}
\item The current mechanism does not work well for German, a problem originated in the package \textsf{crefthe}. The author plans to adopt a more refined approach in a later version so as to support the various grammatical situations in German.
\item \createtheorempackage{} modifies some undocumented internal macros of \textsf{cleveref}, so the behaviour might not be stable if \textsf{cleveref} gets updated.
+ \item \createtheorempackage{} is not fully compatible with \textsf{thmtools}, especially its \texttt{autoref} module.
\item There may be inaccuracies in the translation of those preset names.
\end{itemize}