[Docs] Add nicer title page, document new functions

This commit is contained in:
2025-09-22 15:31:59 +02:00
parent f228cae9f5
commit 696118c824
3 changed files with 29 additions and 6 deletions

View File

@@ -60,7 +60,7 @@ All these have to be executed in the math environment.
\item \verb|\divides| Divider or divides symbol, e.g. $a \divides b$
\item \verb|\lcm| Least common multiple, $\lcm$
\item \verb|\arcsinh| Inverse of hyperbolic sine, $\arcsinh$
\item \verb|\arcosh| Inverse of hyperbolic cosine, $\arcosh$
\item \verb|\arccosh| Inverse of hyperbolic cosine, $\arccosh$
\item \verb|\arctanh| Inverse of hyperbolic tangent, $\arctanh$
\item \verb|\limit|\{\textit{math}\}\{\textit{math}\} Shortened limit notation, $\displaystyle \limit{x}{x_0}$
\item \verb|\limni| Shortened limit notation for $n \rightarrow \infty$, $\displaystyle \limni$
@@ -203,7 +203,7 @@ Put \verb|\usetcolorboxes| right after \verb|\startDocument| (right after \verb|
\end{formula}
\newpage
\vspace{1cm}
\fhlc{Aquamarine}{Counter-enabled}
These ones also have two settings, namely, you can change the counter behaviour and the inclusion of subsections in the numbering. See \ref{sec:perFileConf}.
@@ -250,6 +250,7 @@ See \ref{sec:counters} for a guide on how to change the current number.
\end{minted}
\end{proposition}
\newpage
\begin{fact}[]{Title here}
\begin{minted}{latex}
\begin{fact}[]{Title here}
@@ -274,6 +275,14 @@ See \ref{sec:counters} for a guide on how to change the current number.
\end{minted}
\end{example}
\begin{remark}[]{Title here}
\begin{minted}{latex}
\begin{remark}[]{Title here}
\end{remark}
\end{minted}
\end{remark}
\newpage
\fhlc{Aquamarine}{Language-Specific}
@@ -325,6 +334,7 @@ See \ref{sec:counters} for a guide on how to change the current number.
\verb|\inlineproposition| & \inlineproposition \\
\verb|\inlinefact| & \inlinefact \\
\verb|\inlineaxiom| & \inlineaxiom \\
\verb|\inlineremark| & \inlineremark \\
\verb|\inlineproof| & \inlineproof \\
\end{tables}
@@ -338,6 +348,7 @@ See \ref{sec:counters} for a guide on how to change the current number.
\verb|\shortproposition| & \shortproposition \\
\verb|\shortfact| & \shortfact \\
\verb|\shortaxiom| & \shortaxiom \\
\verb|\shortremark| & \shortremark \\
\verb|\shortproof| & \shortproof \\
\end{tables}
\newpage
@@ -349,9 +360,10 @@ See \ref{sec:counters} for a guide on how to change the current number.
\verb|\fancytheorem|\{\textit{string}\} & \fancytheorem{Theorem} \\
\verb|\fancylemma|\{\textit{string}\} & \fancylemma{Lemma} \\
\verb|\fancycorollary|\{\textit{string}\} & \fancycorollary{Corollary} \\
\verb|\fancyproposition|\{\textit{string}\} & \fancyproposition{Corollary} \\
\verb|\fancyproposition|\{\textit{string}\} & \fancyproposition{Proposition} \\
\verb|\fancyfact|\{\textit{string}\} & \fancyfact{Fact} \\
\verb|\fancyaxiom|\{\textit{string}\} & \fancyaxiom{Axiom} \\
\verb|\fancyremark|\{\textit{string}\} & \fancyremark{Remark} \\
\verb|\fancyproof|\{\textit{string}\} & \fancyproof{Proof} \\
\end{tables}
@@ -362,9 +374,10 @@ See \ref{sec:counters} for a guide on how to change the current number.
\verb|\compacttheorem|\{\textit{string}\} & \compacttheorem{Theorem} \\
\verb|\compactlemma|\{\textit{string}\} & \compactlemma{Lemma} \\
\verb|\compactcorollary|\{\textit{string}\} & \compactcorollary{Corollary} \\
\verb|\compactproposition|\{\textit{string}\} & \compactproposition{Corollary} \\
\verb|\compactproposition|\{\textit{string}\} & \compactproposition{Proposition} \\
\verb|\compactfact|\{\textit{string}\} & \compactfact{Fact} \\
\verb|\compactaxiom|\{\textit{string}\} & \compactaxiom{Axiom} \\
\verb|\compactremark|\{\textit{string}\} & \compactremark{Remark} \\
\verb|\compactproof|\{\textit{string}\} & \compactproof{Proof} \\
\end{tables}
@@ -373,8 +386,12 @@ See \ref{sec:counters} for a guide on how to change the current number.
\label{sec:counters}
\textit{Included in \texttt{most} and up}
You may set the current number for the elements by setting their corresponding counter to the selected number. You can do this using \verb|\setcounter|\{\textit{name of the counter}\}\{\textit{number}\}, where you replace \textit{name of the counter} with one of the following:
\texttt{definitions}, \texttt{lemmas}, \texttt{theorems}, \texttt{corollaries}, \texttt{axioms}, \texttt{examples}. This only applies if you have set numberingConfig to $1$ (for all of them) and $2$ (only for \texttt{definitions}). To change the combined numbering, set \texttt{all} to your desired number.
You may set the current number for the elements by setting their corresponding counter to the selected number.
You can do this using \verb|\setcounter|\{\textit{name of the counter}\}\{\textit{number}\}, where you replace \textit{name of the counter} with one of the following:
\texttt{definitions}, \texttt{lemmas}, \texttt{theorems}, \texttt{corollaries}, \texttt{propositions}, \texttt{facts}, \texttt{axioms}, \texttt{examples}, \texttt{remarks}
This only applies if you have set numberingConfig to $1$ (for all of them) and $2$ (only for \texttt{definitions}).
To change the combined numbering, set \texttt{all} to your desired number.
\newpage