A LaTeX package to use amsthm
with a key-value interface.
Provides all of the functionality of thmtools (and a lot more!) but written in expl3.
If you find a bug please open an issue or pull request.
The package is maintained by Matthew Bertucci.
\documentclass{article}
\usepackage{amssymb,amsmath}
\usepackage{keytheorems}
\usepackage{hyperref}
\newkeytheoremstyle{mystyle}{
% <insert options>
}
\newkeytheorem{theorem}[
style=mystyle,
parent=section
]
\newkeytheorem{remark}[
style=remark,
numbered=no
]
\begin{document}
\section{Some theorems}
\begin{theorem}[
note=Strong Bertini over $\mathbb{C}$,
label=strongbertini
]
Let $X$ be a smooth complex variety and let $\mathfrak{D}$ be a positive
dimensional linear system on $X$. Then the general element of $\mathfrak{D}$ is
smooth away from the base locus $B_{\mathfrak{D}}$. That is, the set
\[\{H\in\mathfrak{D}\mid D_H \text{ is smooth away from } B_{\mathfrak{D}}\}\]
is a Zariski dense open subset of $\mathfrak{D}$.
\end{theorem}
\begin{remark}
In fact, \autoref{strongbertini} holds over any algebraically closed field of
characteristic zero.
\end{remark}
\begin{theorem}[Bertini over any field]
Let $X\subset\mathbb{P}_k^n$ be a smooth projective variety over a field $k$.
Then the set of hyperplanes $H\subseteq\mathbb{P}_k^n$ such that $X\cap H$ is
smooth is a Zariski dense open subset of $(\mathbb{P}_k^n)^*$.
\end{theorem}
\listofkeytheorems
%%% compare with
%\listofkeytheorems[ignoreall,show=theorem]
%\listofkeytheorems[swapnumber]
%\listofkeytheorems[title=BLUB]
%\listofkeytheorems[print-body] % needs 'store-all' package option
\end{document}There is a list of commands and keys offered by the package here. More of a reference document than documentation.
Some of the code is a direct translation from thmtools but a few things are changed:
-
The only backend supported is amsthm, and it is loaded by the package. As I understand it,
ntheoremhas quite a few bugs and no active development, and if you're just using the kernel\newtheoremthen you don't need a package like this. -
Theorem hooks use the kernel hooks. Thus unlike the
prefootandpostfoothooks of thmtools, all code chunks are added to hooks in the order declared (unless given a distinct label; then the chunks are reversed). The order of generic/specific hooks remains the same. Furthermore, the command for adding to theorem hooks is\addtotheoremhook{<hook name>}{<theorem name>}. -
thmtools changes some style settings to be default that are different from amsthm defaults, but only if a custom style is called. Example:
\declaretheoremstyle[spaceabove=20pt]{mythmsty} \declaretheorem[style=mythmsty]{mythm}
is different from just
\declaretheorem{mythm}as in the former,
bodyfontis\normalfont, not the default\itshape. This package keeps the defaults unless a key is specifically given. -
There is no
restatable(*)environment except with package optionthmtools-compat. Use thestore(aliasrestate) key. For counters and labels pointing to the restated theorem, usestore*(aliasrestate*). -
Rather than
restate=foodefining a command\foo*, theorems are retrieved with\getkeytheorem{foo}. For just the theorem body, use\getkeytheorem[body]{foo}. Also, this retrieval can happen even before the theorem is stated since keytheorems writes the contents to a file. -
The
shadedandthmboxkeys are only available with the package optionthmtools-compat, and they are emulated withtcolorbox. Instead there's an interface to tcolorbox with thetcolorbox={<options>}andtcolorbox-no-titlebar={<options>}key. Themdframedkey is not implemented. -
You can reuse styles with the
inherit-stylekey. -
With thmtools, the command
\newtheorem{<envname>}{<heading>}is changed to behave like\declaretheorem[name=<heading>]{<envname>}. This is not the default here. Instead either only use the new interface or load the package with optionoverload. -
Adds many new keys and commands — see the documentation for details.
Issues from the thmtools github page, with corresponding keytheorems code that shows the issue resolved.
keytheorems does not list restated theorems in the \listofkeytheorems.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{theorem}
\begin{document}
\begin{theorem}[store=foo]
text
\end{theorem}
\getkeytheorem{foo}
\listofkeytheorems
\end{document}keytheorems provides the no-title key.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{axiom}
\newkeytheorem{theorem}
\begin{document}
\listofkeytheorems[ignoreall,show=axiom]
\listofkeytheorems[ignoreall,show=theorem,no-title]
\begin{axiom}
some axiom
\end{axiom}
\begin{theorem}
some theorem
\end{theorem}
\begin{axiom}
another axiom
\end{axiom}
\begin{theorem}
another theorem
\end{theorem}
\end{document}keytheorems provides the tcolorbox and tcolorbox-no-titlebar keys.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{theorem}[
tcolorbox={
colback=blue!10,
colframe=blue!75
}
]
\newkeytheorem{corollary}[
tcolorbox-no-titlebar={colback=red!10}
]
\begin{document}
\begin{theorem}
some theorem
\end{theorem}
\begin{corollary}
some corollary
\end{corollary}
\end{document}keytheorems provides the note-code key for \listofkeytheorems and
\keytheoremlistset.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{theorem}
\begin{document}
\begin{theorem}[my heading]
some theorem
\end{theorem}
\listofkeytheorems[note-code={ [\textit{#1}]}]
\end{document}keytheorems provides the inherit-style key.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheoremstyle{mysty1}{notefont=\itshape}
\newkeytheoremstyle{mysty2}{inherit-style=mysty1,bodyfont=\normalfont}
\newkeytheorem{theorem}[style=mysty1]
\newkeytheorem{corollary}[style=mysty2]
\begin{document}
\begin{theorem}[my heading]
some theorem
\end{theorem}
\begin{corollary}[my heading]
some corollary
\end{corollary}
\end{document}Use \getkeytheorem[body]{foo}.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{theorem}
\begin{document}
\begin{theorem}[store=hello]
Hello!
\end{theorem}
\getkeytheorem{hello}
\section{\getkeytheorem[body]{hello}}
\end{document}Use the \externaltheorems command.
% mycoolpaper.tex
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{theorem}
\begin{document}
\begin{theorem}[store=cooltheorem]
My cool theorem.
\end{theorem}
\end{document}% myothercoolpaper.tex
\documentclass{article}
\usepackage{keytheorems}
\externaltheorems[orig:]{mycoolpaper}
\newkeytheorem{theorem}
\begin{document}
\getkeytheorem{orig:cooltheorem}
\end{document}Fixed with keytheorem's implementation of the thmbox key with thmtools-compat.
\documentclass{article}
\usepackage[thmtools-compat]{keytheorems}
\declaretheorem[numbered=no, name=TheoremA, ]{mytheo1}
\declaretheorem[ name=TheoremB, thmbox=M]{mytheo2}
\declaretheorem[numbered=no, name=TheoremC, thmbox=M]{mytheo3}
\begin{document}
\begin{mytheo1}
test1
\end{mytheo1}
\begin{mytheo2}
test2
\end{mytheo2}
\begin{mytheo3}
test3
\end{mytheo3}
\end{document}Fixed in keytheorems.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{Teorema}[name=Theorem]
\begin{document}
\begin{Teorema}
body
\end{Teorema}
\begin{Teorema}[]
body
\end{Teorema}
\begin{Teorema}[title]
body
\end{Teorema}
\end{document}See the predefined option of keytheorems.
\documentclass{article}
\usepackage[predefined]{keytheorems}
\begin{document}
\begin{lemma}
Some lemma.
\end{lemma}
\begin{theorem}
Some theorem.
\end{theorem}
\end{document}Fixed in keytheorems.
\documentclass{article}
\usepackage{keytheorems}
\usepackage{kantlipsum}
\newkeytheorem{theorem}
\begin{document}
\begin{theorem}
\kant[2][1]
\end{theorem}
\begin{theorem}[store=foo]
\kant[1][2]
\end{theorem}
\begin{theorem}
\kant[2][1]
\end{theorem}
\getkeytheorem{foo}
\end{document}Fixed in keytheorems.
\documentclass{article}
\usepackage{keytheorems}
\usepackage{kantlipsum}
\newkeytheorem{theorem}
\begin{document}
\begin{theorem}[restate=foo]
\kant[1][2]
\end{theorem}
\getkeytheorem{foo}
\begin{theorem}[restate=foobar,name=Heading]
\kant[2][1]
\end{theorem}
\getkeytheorem{foobar}
\end{document}Use the store-all load-time option with \listofkeytheorems[print-body].
\documentclass{article}
\usepackage[store-all]{keytheorems}
\newkeytheorem{theorem}
\newkeytheorem{lemma}
\begin{document}
\begin{theorem}
some theorem
\end{theorem}
\begin{lemma}
some lemma
\end{lemma}
\listofkeytheorems[print-body]
\end{document}Fixed in keytheorems.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheoremstyle{mythmsty}{qed}
\newkeytheorem{theorem}[style=mythmsty]
\begin{document}
\begin{theorem}
Text
\end{theorem}
\end{document}Fixed in keytheorems.
\documentclass{article}
\usepackage{keytheorems}
\newkeytheorem{theorem}
\addtotheoremhook{prehead}{PREHEAD}
\addtotheoremhook{posthead}{POSTHEAD}
\addtotheoremhook{prefoot}{PREFOOT}
\addtotheoremhook{postfoot}{POSTFOOT}
\begin{document}
\begin{theorem}
body text
\end{theorem}
\begin{theorem}[store=foo]
body text
\end{theorem}
\end{document}Fixed in keytheorems.
\documentclass{beamer}
\setbeamertemplate{theorems}[numbered]
\usepackage{keytheorems}
\newkeytheorem{MyTheorem}
\begin{document}
\begin{frame}
\begin{MyTheorem}[name=bla]
first text
\end{MyTheorem}
\begin{MyTheorem}<2->[name=bla]
second text
\end{MyTheorem}
\begin{MyTheorem}[name=bla]<3->
third text
\end{MyTheorem}
\end{frame}
% Compare:
\begin{frame}
\begin{theorem}[bla]
first text
\end{theorem}
\begin{theorem}<2->[bla]
second text
\end{theorem}
\begin{theorem}[bla]<3->
third text
\end{theorem}
\end{frame}
\end{document}\documentclass{beamer}
\setbeamertemplate{theorems}[numbered]
\usepackage{keytheorems}
\newkeytheorem{MyTheorem}
\begin{document}
\begin{frame}
\begin{MyTheorem}[restate=foo]
text
\end{MyTheorem}
\getkeytheorem{foo}
\end{frame}
\end{document}Should this be numbered or not?
\documentclass{article}
\usepackage{amsthm,thmtools}
\declaretheorem[numbered=unless unique]{theorem}
\begin{document}
\begin{theorem}[label=foo]
bla
\end{theorem}
\begin{theorem}[continues=foo]
bla
\end{theorem}
\end{document}It does the correct thing when a parent counter is given and is split across that counter.
\documentclass{article}
\usepackage{amsthm,thmtools}
\declaretheorem[numbered=unless unique,parent=section]{theorem}
\begin{document}
\begin{theorem}[label=foo]
bla
\end{theorem}
\section{bla}
\begin{theorem}[continues=foo]
bla
\end{theorem}
\end{document}Also adds a number if restated, which seems wrong.
\documentclass{article}
\usepackage{amsthm,thmtools}
\declaretheorem[numbered=unless unique]{theorem}
\begin{document}
\begin{restatable}{theorem}{foo}
bla
\end{restatable}
\foo*
\end{document}One would expect the one in \declaretheorem to overwrite, but because the code just adds to the hooks without checking,
it's additive.
\documentclass{article}
\usepackage{amsthm,thmtools}
\declaretheoremstyle[qed=$\clubsuit$]{mysty}
\declaretheorem[style=mysty,qed]{theorem}
\begin{document}
\begin{theorem}
bla
\end{theorem}
\end{document}\documentclass{article}
\usepackage{amsthm,thmtools}
\declaretheorem[thmbox]{theorem}
\begin{document}
\begin{theorem}[restate=foo]
bla
\end{theorem}
\foo*
\end{document}\documentclass{article}
\usepackage{amsthm,thmtools}
\declaretheorem{theorem}
\begin{document}
\begin{theorem}
bla
\end{theorem}
\addcontentsline{loe}{section}{some text}
\begin{theorem}
bla
\end{theorem}
\listoftheorems
\end{document}With keytheorems, this is handled only for the AMS classes, acmart, aomart, and jlreq.
\documentclass{amsbook}
\usepackage{thmtools}
\declaretheoremstyle[bodyfont=\upshape]{upsty}
\declaretheorem{theorem}
\declaretheorem[style=upsty]{lemma}
\begin{document}
\begin{theorem}
blub
\end{theorem}
\begin{lemma}
blub
\end{lemma}
\end{document}Released under the LaTeX Project Public License v1.3c or later. See https://www.latex-project.org/lppl.txt.