path: root/macros/latex/contrib/keytheorems/doc/keytheorems-doc.tex

% !TeX program = txs:///pdflatex/[--shell-escape] | txs:///makeindex | txs:///pdflatex/[--shell-escape] | txs:///view-pdf
\PassOptionsToPackage{hyperindex}{hyperref}
\PassOptionsToPackage{dvipsnames}{xcolor}
\documentclass{ltxdoc}
\usepackage{geometry}
\geometry{margin=1in}
\usepackage{tcolorbox}
\tcbuselibrary{documentation,minted}
\tcbset{
  listing engine=minted,
  minted language=latex,
  }
\ifTUTeX\else
\usepackage{lmodern}
\usepackage[T1]{fontenc}
\fi
\usetikzlibrary{cd}
\usepackage{booktabs}
\usepackage{keytheorems}
\usepackage{cleveref}
\usepackage{amssymb}

\def\version{0.1.4}

\title{%
  \pkg{keytheorems} package \\[1ex]
  \large version \version \\[1ex]
  \href{https://github.com/mbertucci47/keytheorems}
    {\texttt{github.com/mbertucci47/keytheorems}}
  }
\author{Matthew Bertucci}

\newkeytheoremstyle{breaksty}{break}
\newkeytheorem{theorem}
\newkeytheorem{mythm}[name=Some Name]
\newkeytheorem{theorem*}[name=Theorem,numbered=false]
\newkeytheorem{conjecture}[parent=section]
\newkeytheorem{lemma}[sibling=theorem]
\newkeytheorem{test}[
  preheadhook=PREHEAD,
  postheadhook=POSTHEAD,
  prefoothook=PREFOOT,
  postfoothook=POSTFOOT
]
\newkeytheorem{prop}[
  name=Proposition,
  refname={proposition,propositions},
  Refname={Proposition,Propositions}
  ]
\newkeytheorem{example}[qed]
\newkeytheorem{solution}[qed=$\clubsuit$]
\newkeytheorem{remark}[style=remark]
\tcbset{
  defstyle/.style={arc=0mm,colback=blue!5!white,colframe=blue!75!black},
  thmstyle/.style={colback=green!5,colframe=green!35!black},
  }
\newkeytheoremstyle{tcb-standard}{
  tcolorbox=thmstyle,
  headpunct={},
  notebraces={}{},
  noteseparator={: },
  notefont=\bfseries,
  bodyfont=\normalfont,
  }
\newkeytheorem{mytheo}[name=My Theorem,style=tcb-standard]
\newkeytheorem{corollary}[tcolorbox]
\newkeytheorem{definition}[
  style=definition,
  tcolorbox={defstyle}
  ]
\newkeytheorem{boxcor}[
  tcolorbox-no-titlebar={colback=red!10},
  name=Corollary,
  sibling=corollary,
  ]
\newkeytheorem{observation}[style=breaksty]

\MakeShortVerb{\|}
\newcommand{\env}{\texttt}
\newcommand{\hook}{\texttt}
\NewCommandCopy{\braces}{\brackets}
\newcommand{\bracks}[1]{\texttt{[#1]}}
\newcommand{\ttbraces}[1]{\braces{\texttt{#1}}}
%\tcbset{index gather commands=false}
\tcbset{
  color command=BrickRed,
  color key=Fuchsia,
  color value=teal,
  before doc body={%
    \setlength{\parindent}{15pt}
    \noindent
    },
  }
\tcbset{
  withpreamble/.style = {
    before upper = {%
      {\ttfamily\itshape \% preamble}%
      \vspace{-0.7\baselineskip}%
      \tcbusetemplisting%
      {\ttfamily\itshape \% document}%
      \vspace{-0.7\baselineskip}%
      }
    }
  }

\NewTCBListing{keythmscode}{ O{} }
  {
    colback=yellow!10!white,
    colframe=blue!50!black,
    boxrule=0.4pt,
    listing side text,
    #1
  }

\NewTCBListing{keycode}{ }
  {
    colback=yellow!10!white,
    colframe=blue!50!black,
    boxrule=0.4pt,
    listing side text,
  }
\newtcolorbox{notebox}[1][]{enhanced,
  before skip balanced=2mm,after skip balanced=4mm,
  boxrule=0.4pt,left=5mm,right=2mm,top=1mm,bottom=1mm,
  colback=red!20,
  colframe=red!40!black,
  sharp corners,rounded corners=southeast,arc is angular,arc=3mm,
  underlay={%
    \path[fill=tcbcolback!80!black] ([yshift=3mm]interior.south east)--++(-0.4,-0.1)--++(0.1,-0.2);
    \path[draw=tcbcolframe,shorten <=-0.05mm,shorten >=-0.05mm] ([yshift=3mm]interior.south east)--++(-0.4,-0.1)--++(0.1,-0.2);
    \path[fill=red!40!black,draw=none] (interior.south west) rectangle node[white]{\LARGE\bfseries !} ([xshift=4mm]interior.north west);
    },
  drop fuzzy shadow,#1}
\makeatletter
% allow for optional argument specifying printed text, mostly for starred keys
\RenewDocumentCommand\tcb@ref@doc{msom}{%
  \hyperref[{#1:#4}]{%
  \IfValueTF{#3}{\texttt{#3}}{\texttt{\ref*{#1:#4}}}%
  \IfBooleanTF{#2}{}{%
    \ifnum\getpagerefnumber{#1:#4}=\thepage\relax%
    \else%
      \kvtcb@doc@format@page{{\fontfamily{pzd}\fontencoding{U}\fontseries{m}\fontshape{n}\selectfont\char213}%
      \,\kvtcb@text@pageshort\,\pageref*{#1:#4}}%
    \fi}}%
}
\makeatother
\makeindex

\begin{document}

\maketitle

\begin{abstract}
An \pkg{expl3}-implementation of a key-value interface to \pkg{amsthm}, implementing most of the functionality provided by \pkg{thmtools}.
Several issues encountered with \pkg{thmtools} are avoided (see the README for a list) and a few new features are added.
\end{abstract}

\tableofcontents

\section{Dependencies}

Without using the \refKey{tcolorbox} or \refKey{tcolorbox-no-titlebar} options, the package loads the \pkg{aliascnt}, \pkg{amsthm}, \pkg{refcount}, \pkg{translations}, and \pkg{unique} packages.
A \LaTeX{} kernel no older than 2023-06-01 is required; if older than 2024-06-01, \pkg{nameref} is required.
    
\section{Global options}

\begin{docCommand}{keytheoremset}
  {\marg{options}}
Every key in this section can be given as a package option with \cs{usepackage}\bracks{\meta{options}}\ttbraces{keytheorems} or in \cs{keytheoremset}\marg{options}, with the exception that \refKey{continues-code} can only be used in the latter.
\end{docCommand}

\begin{docKey}{overload}
  {}
  {initially unset}
Redefines \cs{newtheorem} to internally use the \pkg{keytheorems} machinery. The syntax remains the same.
This is automatically set by \refKey{thmtools-compat}.
\end{docKey}

\begin{docKey}{thmtools-compat}
  {}
  {initially unset}
For compatibility with \pkg{thmtools} syntax.
Currently defines the commands in the left column below.
The right column lists the corresponding \pkg{keytheorems} replacement that should be used in new documents.
\begin{center}
\begin{tabular}{cc}
\pkg{thmtools} command & \pkg{keytheorems} replacement \\
\toprule
\docAuxCommand*{declaretheorem} & \refCom{newkeytheorem} \\
\docAuxCommand*{declaretheoremstyle} & \refCom{newkeytheoremstyle} \\
\docAuxCommand*{listoftheorems} & \refCom{listofkeytheorems} \\
\begin{tabular}{c}
\docAuxCommand*{addtotheorempreheadhook}\\
\docAuxCommand*{addtotheorempostheadhook}\\
\docAuxCommand*{addtotheoremprefoothook}\\
\docAuxCommand*{addtotheorempostfoothook}\\
\end{tabular} & \refCom{addtotheoremhook} \\
\docAuxEnvironment*{restatable} environment & \refKey{store} key \\
\docAuxEnvironment*{restatable*} environment & \refKey[store*]{store} key
\end{tabular}
\end{center}
Also defined are the \docAuxKey*{shaded} and \docAuxKey*{thmbox} keys, implemented internally with \pkg{tcolorbox} rather than the \pkg{shadethm} and \pkg{thmbox} packages, respectively.
\end{docKey}

\begin{docKey}{store-all}
  {}
  {initially unset}
Tells \pkg{keytheorems} to grab the body of each theorem so it can later be printed with the \refKey{print-body} option of \refCom{listofkeytheorems}.
Note that this means a theorem body \emph{cannot} contain verbatim material.
\end{docKey}

\begin{docKey}{restate-counters}
  {=\marg{comma-list of counters}}
  {initially \ttbraces{equation}}
Additional counters whose values are preserved when a theorem is restated.
This key does not reset the list, so you don't need to include |equation| in \meta{comma-list}.
\end{docKey}

\begin{docKey}{continues-code}
  {=\meta{code with \textup{\texttt{\#1}}}}
  {initially \cs{GetTranslation}\ttbraces{keythms\string_continues}\cs{pageref}\ttbraces{\#1}}
The code used to typeset the note produced by the \refKey{continues} key.
If English or an unknown language is used, defaults to \texttt{continuing from p.}\cs{,}\cs{pageref}\ttbraces{\#1}.
Currently (likely inaccurate!) translations exist for French, German, Italian, Portuguese, and Spanish.
\end{docKey}

\begin{docKey}{qed-symbol}
  {=\meta{symbol}}
  {initially \cs{openbox}}
Redefines \cs{qedsymbol} to be \meta{symbol}.
\end{docKey}

\begin{docKey}{auto-translate}
  {\colOpt{=true\textbar false}}
  {default |true|, initially |true|}
If |false|, \pkg{keytheorems} does not automatically translate the title text for \refCom{listofkeytheorems} and the note produced by the \refKey{continues} key.
These texts can be manually customized with the \refKey{title} and \refKey{continues-code} keys, respectively.
\end{docKey}

\begin{docKey}{store-sets-translate}
  {}
  {initially unset}
Defines the \refKey{store} key to also set \refKey{label}, i.e. it makes |store=|\meta{tag} equivalent to |store=|\meta{tag}|,label=|\meta{tag}. Similarly for \refKey[store*]{store}.
\end{docKey}

\section{Defining theorems}

\begin{docCommand}{newkeytheorem}
  {\marg{env name}\oarg{options}}
Defines a theorem environment \meta{env name} which itself takes a few options (see \autoref{in-doc-keys}).
You can also declare multiple theorems at once by replacing \meta{env name} with a comma-list of names, e.g. \cs{newkeytheorem}\ttbraces{theorem,lemma,proposition}\bracks{\meta{options}}.

By default, the theorem's printed name is a title-cased \meta{env name}.
This can be changed with the \refKey{thm/name} key.
All \meta{options} are described in subsections \ref{thm-thmtools-keys} and \ref{thm-added-keys}.
\end{docCommand}

\begin{tcbwritetemp}
\newkeytheorem{theorem}
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{theorem}
Some text
\end{theorem}
\end{keythmscode}

\subsection{Keys available to theorem environments} \label{in-doc-keys}

As in \pkg{amsthm}, theorems can take an optional argument that contains a note or heading.

\begin{keythmscode}[]
\begin{theorem}[some heading]
Some text
\end{theorem}
\end{keythmscode}

Alternatively, the optional argument may contain any of the following keys.

\begin{docKey}{note}
  {=\meta{text}}
  {initially unset}
Alias \docAuxKey[][doc label=thmuse/name]{name}.
This is the key-value equivalent of the optional argument described above.
This syntax, however, allows the argument to contain other keys.

\begin{keythmscode}[]
\begin{theorem}[some heading]
Some text
\end{theorem}
\begin{theorem}[note=another heading]
Some more text
\end{theorem}
\end{keythmscode}

\end{docKey}

\begin{docKey}{short-note}
  {=\meta{text}}
  {initially unset}
Alias \docAuxKey{short-name}.
This replaces the value of \refKey{note} when displayed in \refCom{listofkeytheorems}.
\end{docKey}

\begin{docKey}{label}
  {=\meta{label name}}
  {initially unset}
This is the key-value equivalent of |\begin{theorem}| \cs{label}\marg{label name}.

\begin{keythmscode}[]
\begin{theorem}[label=foo]
Some text
\end{theorem}
\ref{foo}
\end{keythmscode}

\end{docKey}

\begin{docKey}{continues}
  {\sarg=\meta{label name}}
  {initially unset}
Pick up a theorem where you left off.
The theorem number remains the same.
The printed text can be customized with the \refKey{continues-code} option.
The starred version also copies the theorem note, if it exists.

\begin{keythmscode}[]
\begin{theorem}[continues=foo]
\dots and some more text.
\end{theorem}
\end{keythmscode}

\end{docKey}

\begin{docKey}{store}
  {\sarg=\meta{tag}}
  {initially unset}
Alias \docAuxKey{restate}\sarg.
Stores the the theorem to be restated at any point in the document with \refCom{getkeytheorem}.
With the starred version, counters and labels are taken from the copy called with \cs{getkeytheorem}, so in this case can only be restated once.
This allows you, for example, to write all theorems and proofs in the appendix and call \cs{getkeytheorem} at the appropriate time mid-document.
For the numbering to be correct, the unstarred key will need at most two runs and the starred key at most three runs.

\begin{keythmscode}[]
\begin{theorem}[store=blub]
A theorem worth restating.
\end{theorem}
More brilliant mathematics.
\getkeytheorem{blub}
\end{keythmscode}

A theorem given this key \emph{cannot} contain verbatim material or other unexpected catcodes, such as a \pkg{tikz-cd} diagram.
The latter issue can be averted with the \texttt{ampersand-replacement} key.

\begin{tcbwritetemp}
\usepackage{tikz}
\usetikzlibrary{cd}
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{lemma}[store=diagram]
Some commutative diagram:
\[\begin{tikzcd}[ampersand replacement=\&]
X\times_S Y \ar[r] \ar[d] \& X \ar[d] \\
Y \ar[r] \& S
\end{tikzcd}\]
\end{lemma}
\dots
\getkeytheorem{diagram}
\end{keythmscode}

\end{docKey}

\begin{docKey}{restate-keys}
  {=\marg{list of keys}}
  {initially unset}
Allows passing different keys to the restated theorem.
At the moment this is only useful with the \refKey{note} key.

\begin{keythmscode}[]
\begin{theorem}[
  store=rktest,
  note=ORIGINAL,
  restate-keys={note=RESTATED}]
Wow, yet another theorem.
\end{theorem}
\getkeytheorem{rktest}
\end{keythmscode}

\end{docKey}

\begin{docKey}{listhack}
  {=\docValue*{true}\textbar\docValue*{false}}
  {initially |false|}
Meant only to be used with the \refKey{break} style key for a theorem starting with a list.
Compare:

\begin{tcbwritetemp}
\newkeytheoremstyle{breaksty}{break}
\newkeytheorem{observation}[style=breaksty]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{observation}
\begin{enumerate}
\item First item
\end{enumerate}
\end{observation}

\begin{observation}[listhack=true]
\begin{enumerate}
\item First item
\end{enumerate}
\end{observation}
\end{keythmscode}

Note that the value |true| must be explicitly set so that |listhack| is not interpreted as the note text.
\end{docKey}

\begin{docKey}[][doc label=thm/seq]{seq}
  {=\meta{name}}
  {initially unset}
Adds the theorem to a custom sequence \meta{name} that can then be listed with \cs{listofkeytheorems}\bracks{seq=\meta{name}}.
See \refKey{listof/seq} for more details.
\end{docKey}

\subsection{Keys inherited from \pkg{thmtools}} \label{thm-thmtools-keys}

These are the \oarg{options} available to \cs{newkeytheorem}.
Except for \refKey{thm/name} and \refKey{style}, each key below can also be used in \refCom{newkeytheoremstyle}.
For more description, see the \href{https://ctan.org/pkg/thmtools}{\pkg{thmtools}} package.

\begin{docKey}[][doc label=thm/name]{name}
  {=\meta{display name}}
  {initially title-cased \meta{env name}}
Aliases \docAuxKey{title} and \docAuxKey{heading}.

\begin{tcbwritetemp}
\newkeytheorem{mythm}[name=Some Name]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{mythm}
Some text
\end{mythm}
\end{keythmscode}

\end{docKey}

\begin{docKey}{numbered}
  {=\docValue*{true}\textbar\docValue*{false}\textbar \docValue{unless-unique}}
  {default |true|, initially |true|}
For compatibility with \pkg{thmtools}, also accepts the values \docValue*{yes}, \docValue*{no}, and \docValue*{unless unique}.

\begin{tcbwritetemp}
\newkeytheorem{theorem*}[
  name=Theorem, numbered=false
  ]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{theorem*}
An unnumbered theorem.
\end{theorem*}
\end{keythmscode}

\end{docKey}

\begin{docKey}{parent}
  {=\meta{counter}}
  {initially unset}
Aliases \docAuxKey{numberwithin} and \docAuxKey{within}.

\begin{tcbwritetemp}
\newkeytheorem{conjecture}[parent=section]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{conjecture}
The first number is the section.
\end{conjecture}
\end{keythmscode}

\end{docKey}

\begin{docKey}{sibling}{=\meta{counter}}{initially unset}
Aliases \docAuxKey{numberlike} and \docAuxKey{sharenumber}.

\begin{tcbwritetemp}
\newkeytheorem{lemma}[sibling=theorem]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{lemma}
This shares its counter with
\texttt{theorem}.
\end{lemma}
\end{keythmscode}

\end{docKey}

\begin{docKey}{style}
  {=\meta{style name}}
  {initially unset}
Accepts any \meta{style name} defined by \refCom{newkeytheoremstyle}, as well as any of the predefined \pkg{amsthm} styles: \docValue{plain}, \docValue{definition}, and \docValue{remark}.

\begin{tcbwritetemp}
\newkeytheorem{remark}[style=remark]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{remark}
Some text
\end{remark}
\end{keythmscode}

\end{docKey}

\begin{docKeys}[
  doc parameter = {=\meta{code}},
  doc description = initially unset,
  ]
  {
    { doc name = preheadhook },
    { doc name = postheadhook },
    { doc name = prefoothook },
    { doc name = postfoothook },
  }
Details in \autoref{keythms-hooks}.

\begin{tcbwritetemp}
\newkeytheorem{test}[
  preheadhook=PREHEAD,
  postheadhook=POSTHEAD,
  prefoothook=PREFOOT,
  postfoothook=POSTFOOT
]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{test}
Some text
\end{test}
\end{keythmscode}

\end{docKeys}

\begin{docKey}{refname}
  {=\meta{ref name} \textrm{or} \brackets{\meta{singular name},\meta{plural name}}}
  {initially \meta{display name}}
If a single string, then the name used by \pkg{hyperref}'s \cs{autoref} and \pkg{cleveref}'s \cs{cref}.
If two strings separated by a comma, then the second string is the plural form used by \cs{cref}.
\end{docKey}

\begin{docKey}{Refname}
  {=\meta{ref name} \textrm{or} \brackets{\meta{singular name},\meta{plural name}}}
  {initially \meta{display name}}
Same as \refKey{refname} but for \docAuxCommand{Autoref} and \cs{Cref}.
Note that \cs{Autoref} is defined by \pkg{keytheorems}, but requires \pkg{hyperref} to work.
As with \cs{autoref}, there is also a starred version \docAuxCommand{Autoref*} that suppresses the hyperlink.

\begin{tcbwritetemp}
\newkeytheorem{prop}[
  name=Proposition,
  refname={proposition,propositions},
  Refname={Proposition,Propositions}
  ]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{prop}[label=abc]
Some text
\end{prop}
\begin{prop}[label=def]
Some more text
\end{prop}
\begin{theorem}
Consider \cref{abc,def}.
\Autoref{abc} \dots
\end{theorem}
\end{keythmscode}

\end{docKey}

\begin{docKey}{qed}
  {\colOpt{=\meta{symbol}}}
  {default \cs{openbox}, initially unset}
Adds \colOpt{\meta{symbol}} to the end of the theorem body.
If no value is given, the symbol \openbox\ is used.

\begin{tcbwritetemp}
\newkeytheorem{example}[qed]
\newkeytheorem{solution}[qed=$\clubsuit$]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{example}
Some text
\end{example}
\begin{solution}
Some more text
\end{solution}
\end{keythmscode}

\end{docKey}

\subsection{Keys added by \pkg{keytheorems}} \label{thm-added-keys}

\begin{docKey}{tcolorbox}
  {\colOpt{=\marg{tcolorbox options}}}
  {initially unset}
This key specifies that the theorem be placed inside a tcolorbox environment with \colOpt{\meta{options}}.
The theorem head is typeset as a tcolorbox title; to avoid this see \refKey{tcolorbox-no-titlebar}.

\begin{tcbwritetemp}
\tcbset{
  defstyle/.style={
    arc=0mm,
    colback=blue!5!white,
    colframe=blue!75!black
    },
  }
\newkeytheorem{corollary}[tcolorbox]
\newkeytheorem{definition}[
  style=definition,
  tcolorbox={defstyle}
  ]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{corollary}
Some text
\end{corollary}
\begin{definition}
Some more text
\end{definition}
\end{keythmscode}

\end{docKey}

\begin{docKey}{tcolorbox-no-titlebar}
  {\colOpt{=\marg{tcolorbox options}}}
  {initially unset}
Same usage as \refKey{tcolorbox} but the theorem head is typeset as usual, not as a tcolorbox title.

\begin{tcbwritetemp}
\newkeytheorem{boxcor}[
  tcolorbox-no-titlebar={
    colback=red!10
    },
  name=Corollary,sibling=corollary
  ]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{boxcor}
Some text
\end{boxcor}
\end{keythmscode}

\end{docKey}

\pkg{tcolorbox} offers its own comprehensive \texttt{theorems} library. If all of your theorems are to be tcolorboxes, I highly recommend using it instead of this package! However, if only some of your theorems will use a tcolorbox, you may want to replicate the styles of \cs{NewTcbTheorem}. Here is an example that emulates \pkg{tcolorbox}'s \texttt{standard} theorem style.

\begin{tcbwritetemp}
\tcbset{
  thmstyle/.style={
    colback=green!5,
    colframe=green!35!black},
  }
\newkeytheoremstyle{tcb-standard}{
  tcolorbox=thmstyle,
  headpunct={},
  notebraces={}{},
  noteseparator={: },
  notefont=\bfseries,
  bodyfont=\normalfont,
  }
\newkeytheorem{mytheo}[
  name=My Theorem,
  style=tcb-standard]
\end{tcbwritetemp}

\begin{keythmscode}[withpreamble]
\begin{mytheo}[This is my title]
Some theorem text
\end{mytheo}
\end{keythmscode}

\section{Theorem styles}

\begin{docCommand}{newkeytheoremstyle}
  {\marg{name}\marg{options}}
This is \pkg{keytheorems}' version of \pkg{thmtools}' \cs{declaretheoremstyle}\bracks{\meta{options}}\marg{name}.
Since it makes little sense to define a style with no keys, we've made the \meta{options} argument mandatory.
Note that unlike \pkg{amsthm}'s \cs{newtheoremstyle}, this command will error if a style has already been defined.
To overwrite an existing style, there is the analogous \docAuxCommand{renewkeytheoremstyle}.
For completeness, there is also \docAuxCommand{declarekeytheoremstyle} and \docAuxCommand{providekeytheoremstyle}.

The defined style can be used with either the \refKey{style} key or the traditional \cs{theoremstyle}.
\end{docCommand}

\begin{notebox}
For the AMS classes \cls{amsart}, \cls{amsbook}, and \cls{amsproc}, as well as the \cls{amsart}-based \cls{acmart}, the initial key values are slightly different than what's below in order to match those class's defaults.
\end{notebox}

\subsection{Keys inherited from \pkg{thmtools}}

The following keys have the same meaning and syntax as the corresponding \pkg{thmtools} keys.
In addition to the list below, most of the keys available to \refCom{newkeytheorem} can be used in \cs{newkeytheoremstyle}.

\begin{docKey}{spaceabove}
  {=\meta{length}}
  {initially \cs{topsep}}

\end{docKey}

\begin{docKey}{spacebelow}
  {=\meta{length}}
  {initially \cs{topsep}}

\end{docKey}

\begin{docKey}{bodyfont}
  {=\meta{font declarations}}
  {initially \cs{itshape}}

\end{docKey}

\begin{docKey}{headindent}
  {=\meta{length}}
  {initially |0pt|}

\end{docKey}

\begin{docKey}{headfont}
  {=\meta{font declarations}}
  {initially \cs{bfseries}}

\end{docKey}

\begin{docKey}{headpunct}
  {=\meta{code}}
  {initially \ttbraces{.}}

\end{docKey}

\begin{docKey}{postheadspace}
  {=\meta{length}}
  {initially |5pt plus 1pt minus 1pt|}
Do not use this with the \refKey{break} key.
\end{docKey}

\begin{docKey}{break}
  {}
  {initially unset}
Do not use this with the \refKey{postheadspace} key.
\end{docKey}

\begin{docKey}{notefont}
  {=\meta{font declarations}}
  {initially \cs{fontseries}\cs{mddefault}\cs{upshape}}

\end{docKey}

\begin{docKey}{notebraces}
  {=\marg{left brace}\marg{right brace}}
  {initially \ttbraces{(}\ttbraces{)}}

\end{docKey}

\begin{docKey}{headformat}
  {=\docValue{margin}\textbar\docValue{swapnumber}\textbar\meta{code using \cs{NAME}, \cs{NUMBER}, and \cs{NOTE}}}
  {}
Alias \docAuxKey{headstyle}. Within \meta{code}, the commands \docAuxCommand{NAME}, \docAuxCommand{NUMBER}, and \docAuxCommand{NOTE} correspond to the formatted parts of the theorem head.
\end{docKey}

\subsection{Keys added by \pkg{keytheorems}}

\begin{docKey}{noteseparator}
  {=\meta{code}}
  {initially \textvisiblespace}
The code inserted before the note, and printed only if there is a note. This is executed \emph{before} the font commands set by \refKey{notefont} take effect.
\end{docKey}

\begin{docKey}{numberfont}
  {=\meta{font declarations}}
  {initially |\upshape|}
For almost all theorem styles, it is recommended that you \emph{do not} change this setting.
\end{docKey}

\begin{docKey}{inherit-style}
  {=\meta{style name}}
  {initially unset}
Inherit the keys of any style declared with \refCom{newkeytheoremstyle}.
Additionally, the three styles predefined by \pkg{amsthm} are possible values: \docValue{plain}, \docValue{definition}, and \docValue{remark}.
\end{docKey}

\section{Restating theorems}

When a theorem is given the \refKey{store} key, the contents of the theorem are saved and written to a |.thlist| file.
At the start of the next run, this file is input at the beginning of the document and allows you to retrieve the stored theorems at any point, before or after the original theorem.

\begin{docCommand}{getkeytheorem}
  {\oarg{property}\marg{tag}}
Retrieves the theorem given the key |store=|\meta{tag} or |store*=|\meta{tag}.
An optional \meta{property} can be given to retrieve only the corresponding part of the theorem.
Currently only the property |body| is implemented, which retrieves the (unformatted) body of the theorem.

\begin{keythmscode}[]
\getkeytheorem{mytag}

\begin{example}[store=mytag]
Fascinating example.
\end{example}

\getkeytheorem[body]{mytag}
\end{keythmscode}

\end{docCommand}

\begin{docCommands}
  {
    {
      doc name = IfRestatingTF,
      doc parameter=\marg{true code}\marg{false code}
    },
    {
      doc name = IfRestatingT,
      doc parameter=\marg{true code}
    },
    {
      doc name = IfRestatingF,
      doc parameter=\marg{false code}
    }
  }
Executes \meta{true code} if being retrieved with \refCom{getkeytheorem} and \meta{false code} if in the original theorem. This is reversed if \texttt{store*} is used.

\begin{keythmscode}[]
\begin{example}[store=hmm]
I am the
\IfRestatingTF{restated}{original}
example!
\end{example}

\getkeytheorem{hmm}
\end{keythmscode}

\end{docCommands}

\section{Listing theorems}

\begin{docCommand}{listofkeytheorems}
  {\oarg{options}}
Similar to \cs{listoffigures} or \cs{listoftables} but for theorems.
For \cls{memoir} and the AMS classes, \pkg{keytheorems} tries to copy the formatting of these commands as defined by the class.
For other classes, manual adjustments to \refKey{numwidth} and \refKey{indent} may be necessary.
\end{docCommand}

\begin{docCommand}{keytheoremlistset}
  {\marg{options}}

\end{docCommand}

\begin{keythmscode}[]
\listofkeytheorems
\end{keythmscode}

\subsection{Keys inherited from \pkg{thmtools}}

\begin{docKey}{numwidth}
  {=\meta{length}}
  {initially |2.3em|}
For the AMS classes, this is initially |1.5pc|.
\end{docKey}

\begin{docKey}{ignore}
  {=\marg{comma-list of env names}}
  {initially unset}

\end{docKey}

\begin{docKey}{show}
  {=\marg{comma-list of env names}}
  {initially all theorems}

\end{docKey}

\begin{docKey}{onlynamed}
  {\colOpt{=\marg{comma-list of env names}}}
  {initially unset}

\end{docKey}

\begin{docKey}{ignoreall}
  {}
  {initially unset}
  
\begin{keythmscode}[]
\listofkeytheorems[ignoreall,show=theorem]
\listofkeytheorems[
  ignoreall, show=conjecture,
  title=List of Conjectures
  ]
\end{keythmscode}

\end{docKey}

\begin{docKey}{showall}
  {}
  {initially set}

\end{docKey}

\begin{docKey}{title}
  {=\meta{text}}
  {initially \cs{GetTranslation}\ttbraces{keythms\string_listof\string_title}}
Defaults to ``List of Theorems'' if English or an unknown language is used.
Currently French, German, Italian, Portuguese, and Spanish have (likely inaccurate!) translations.
A translation can be added with a GitHub pull request or manually with \cs{DeclareTranslation}\marg{lang}\ttbraces{keythms\string_listof\string_title}\marg{text}.
\end{docKey}

\begin{docKey}{swapnumber}
  {\colOpt{=true\textbar false}}
  {initially |false|}

\end{docKey}

\subsection{Keys added by \pkg{keytheorems}}

\begin{docKey}{indent}
  {=\meta{length}}
  {initially |1.5em|}
Sets the left indent of items in the list of theorems.
For \cls{memoir} and the AMS classes, the indent is initially |0pt|.
It is not recommended to change this unless your class has different defaults not already covered.
\end{docKey}

\begin{docKey}{onlynumbered}
  {\colOpt{=\marg{comma-list of env names}}}
  {initially unset}
Similar to \refKey{onlynamed}, but lists only those theorems which are numbered.
This is useful if you'd like to exclude things like unnumbered definitions and remarks from the list of theorems.
\end{docKey}

\begin{docKey}[][doc label=listof/seq]{seq}
  {=\meta{name}}
  {initially unset}
Used to list only the theorems added to the custom sequence \meta{name} with the \refKey{thm/seq} theorem key.
This is the only way to fully customize which theorems appear in the list of theorems.
Unlike with \refKey{show}, you do not need to use \refKey{ignoreall} to prevent theorems not in \meta{name} from being printed.
\end{docKey}

\begin{docKey}{title-code}
  {=\meta{code with \textup{\texttt{\#1}}}}
  {initially \cs{section*}\ttbraces{\#1}}
If \cs{chapter} is defined, then initially this is instead \cs{chapter*}\ttbraces{\#1}. This key has no effect if used with an AMS class because these classes hard-code the section heading into \cs{@starttoc}.
\end{docKey}

\begin{docKey}{no-title}
  {\colOpt{=true\textbar false}}
  {initially |false|}
Suppresses the title of the list of theorems.
Useful for custom ordering of the list.

\begin{keythmscode}[]
\keytheoremlistset{ignoreall}
\listofkeytheorems[show=example]
\listofkeytheorems[show=solution,no-title]
\end{keythmscode}

\end{docKey}

\begin{docKey}{note-code}
  {=\meta{code with \textup{\texttt{\#1}}}}
  {initially \ttbraces{ (\#1)}}
Formats the optional note in the list of theorems.
\end{docKey}

\begin{docKey}{print-body}
  {}
  {initially unset}
Instead of listing the theorem headings, the theorems are restated with their body text.
Not very useful without the \refKey{store-all} load-time option.
\end{docKey}

\begin{docKey}{no-continues}
  {\colOpt{=true\textbar false}}
  {initially |false|}
Suppresses the printing of theorems given the \refKey{continues} key in the list of theorems.
\end{docKey}

\begin{docKey}{no-chapter-skip}
  {\colOpt{=true\textbar false}}
  {initially |false|}
By default a small vertical space is inserted between each chapter's chunk of theorems.
Setting this key to |true| removes this space.
\end{docKey}

\begin{docKey}{chapter-skip-length}
  {=\meta{dimension}}
  {initially |10pt|}
Controls the amount of space inserted between chunks.
\end{docKey}

\begin{docKey}{no-toc}
  {\colOpt{=true\textbar false}}
  {initially false}
With the standard classes, lists of figures/tables are not added to the table of contents by default. The same is true for \cs{listofkeytheorems}, and with those classes this key does nothing. However some classes, notably \cls{memoir} and the AMS classes, do add lists to the table of contents. With these classes, this key suppresses the addition of the list of theorems to the table of contents.
\end{docKey}

\subsection{Adding code to list of theorems}

There are analogous commands to \cs{addcontentsline} and \cs{addtocontents} for adding entries or arbitrary code to the list of theorems.

\begin{notebox}
You \emph{must} use these commands rather than the aforementioned because the |.thlist| file is also used to define restated theorems and cannot contain unexpected code.
\end{notebox}

\begin{docCommand}{addtheoremcontentsline}
  {\marg{level}\marg{text}}

\end{docCommand}

\begin{docCommand}{addtotheoremcontents}
  {\marg{code}}

\end{docCommand}

\section{Theorem hooks} \label{keythms-hooks}

\begin{docCommand}{addtotheoremhook}
  {\oarg{env name}\marg{hook name}\marg{code}}
\meta{hook name} can be \hook{prehead}, \hook{posthead}, \hook{prefoot}, \hook{postfoot}, or \hook{restated}.
If no \meta{env name} is given, the \meta{code} is added to the ``generic'' hook, i.e. applied to all theorems.
As in \pkg{thmtools}, the order of hooks is as follows:

\begin{center}
  \tcbset{
    nobeforeafter,
    tikznode,
    tcbox width=forced center,
    width=2cm,
    tcbox raise=-0.4cm,
    size=fbox,
    after=\;$\rightarrow$
    }
  \tcbox{\meta{env name}\\ \hook{prehead}}
  \tcbox{generic\\ \hook{prehead}}
  \tcbox[width=3.5cm,tcbox raise=-0.2cm]{\cs{begin}\brackets{\meta{env name}}}
  \tcbox{\meta{env name}\\ \hook{posthead}}
  \tcbox[after={}]{generic\\ \hook{posthead}}
  \\[2ex]
  \tcbset{before=$\rightarrow$\;}
  \tcbox[width=2.5cm,tcbox raise=-0.2cm]{\meta{theorem body}}
  \\[2ex]
  \tcbset{after={}}
  \tcbox[before={}]{generic\\ \hook{prefoot}}
  \tcbox{\meta{env name}\\ \hook{prefoot}}
  \tcbox[width=3.5cm,tcbox raise=-0.2cm]{\cs{end}\brackets{\meta{env name}}}
  \tcbox{generic\\ \hook{postfoot}}
  \tcbox{\meta{env name}\\ \hook{postfoot}}
\end{center}
The \hook{restated} hook is applied at the start of theorems retrieved with \cs{getkeytheorem}, before the \hook{prehead} hook. 
This can be useful for disabling commands such as \cs{footnote} in the restated theorems, e.g.
\begin{dispListing}
\addtotheoremhook{restated}{%
  \renewcommand\footnote[2][]{}%
  }
\end{dispListing}
By default, \pkg{keytheorems} disables the \cs{label} and \cs{RecordProperties} commands in restated theorems.

In \pkg{thmtools}, the \hook{prefoot} and \hook{postfoot} hooks always prepend code, i.e. the code
\begin{dispListing}
\addtotheorempostfoothook{A}
\addtotheorempostfoothook{B}
\end{dispListing}
results in |BA| after the theorem.
With \pkg{keytheorems}, code is added in the order declared, meaning
\begin{dispListing}
\addtotheoremhook{postfoot}{A}
\addtotheoremhook{postfoot}{B}
\end{dispListing}
results in |AB| after the theorem.
This is the behavior of the \LaTeX{} kernel hooks that \pkg{keytheorems} uses under the hood.

Right now, code added using the hook keys \refKey{preheadhook}, etc. is outermost, meaning executed first in \hook{prehead} and \hook{posthead} and last in \hook{prefoot} and \hook{postfoot}.
This may change if I think of good reasons to do so\dots
\end{docCommand}

\section{Miscellaneous notes for the ambitious}

Inside theorem environments, as well as in all of the theorem hooks, you have access to the theorem's environment and counter name in the token list variable |\l_keythms_thmuse_envname_tl|.

\section{Further examples}

More examples will be added soon -- rather, eventually\dots{}
For now, you can find a \pkg{keytheorems} adaptation of \pkg{amsthm}'s classic file \href{https://mirrors.ctan.org/macros/latex/required/amscls/doc/thmtest.tex}{\texttt{thmtest.tex}} in the Github \texttt{tests} folder: \href{https://github.com/mbertucci47/keytheorems/blob/main/tests/keytheorems-amsthmtest.tex}{\texttt{keytheorems-amsthmtest.tex}}.

%\section{Implementation}
%\inputminted[linenos,style=bw]{latex}{../keytheorems.sty}

\printindex

\end{document}