janishutz/latex
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[skip ci] Build helpers on push

Browse Source
This commit is contained in:
Helpers compiler [bot]
2026-02-23 08:04:17 +00:00
parent 6c8f20336c
commit 9856f13f76
23 changed files with 2069 additions and 2150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/parts/reference/style/descriptors.tex
View File

@@ -9,30 +9,30 @@ Alternatively, you can use \verb|\inline[desc]{definition}|.
\paragraph{Inline}
\begin{tables}{ll}{Command & Output}
\verb|\inlineexample| & \inlineexample \\
\verb|\inlinedefinition| & \inlinedefinition \\
\verb|\inlinetheorem| & \inlinetheorem \\
\verb|\inlinelemma| & \inlinelemma \\
\verb|\inlinecorollary| & \inlinecorollary \\
\verb|\inlineproposition| & \inlineproposition \\
\verb|\inlinefact| & \inlinefact \\
\verb|\inlineaxiom| & \inlineaxiom \\
\verb|\inlineremark| & \inlineremark \\
\verb|\inlineproof| & \inlineproof \\
\verb|\inlineexample| & \inlineexample \\
\verb|\inlinedefinition| & \inlinedefinition \\
\verb|\inlinetheorem| & \inlinetheorem \\
\verb|\inlinelemma| & \inlinelemma \\
\verb|\inlinecorollary| & \inlinecorollary \\
\verb|\inlineproposition| & \inlineproposition \\
\verb|\inlinefact| & \inlinefact \\
\verb|\inlineaxiom| & \inlineaxiom \\
\verb|\inlineremark| & \inlineremark \\
\verb|\inlineproof| & \inlineproof \\
\end{tables}
\paragraph{Shortened}
\begin{tables}{ll}{Command & Output}
\verb|\shortexample| & \shortexample \\
\verb|\shortdefinition| & \shortdefinition \\
\verb|\shorttheorem| & \shorttheorem \\
\verb|\shortlemma| & \shortlemma \\
\verb|\shortcorollary| & \shortcorollary \\
\verb|\shortproposition| & \shortproposition \\
\verb|\shortfact| & \shortfact \\
\verb|\shortaxiom| & \shortaxiom \\
\verb|\shortremark| & \shortremark \\
\verb|\shortproof| & \shortproof \\
\verb|\shortexample| & \shortexample \\
\verb|\shortdefinition| & \shortdefinition \\
\verb|\shorttheorem| & \shorttheorem \\
\verb|\shortlemma| & \shortlemma \\
\verb|\shortcorollary| & \shortcorollary \\
\verb|\shortproposition| & \shortproposition \\
\verb|\shortfact| & \shortfact \\
\verb|\shortaxiom| & \shortaxiom \\
\verb|\shortremark| & \shortremark \\
\verb|\shortproof| & \shortproof \\
\end{tables}
\newpage

10
docs/parts/reference/style/intro.tex
View File

@@ -1,9 +1,9 @@
\newpage
\subsection{Style}
\begin{itemize}
\item \verb|\TODO| Print a highlighted \TODO
\item \verb|\background|\{\textit{color}\}\{\textit{number}\}\{\textit{string}\} Print \background{ForestGreen}{50}{shaded text, with colour saturation}
\item \verb|\shade|\{\textit{color}\}\{\textit{string}\} Print \shade{ForestGreen}{shaded text}
\item \verb|\backdrop|\{\textit{string}\} Print \backdrop{text with gray backdrop}
\item \verb|\printtoc|\{\textit{color}\} Print the table of contents (as seen on the first page). The normal \verb|\tableofcontents| still works as expected
\item \verb|\TODO| Print a highlighted \TODO
\item \verb|\background|\{\textit{color}\}\{\textit{number}\}\{\textit{string}\} Print \background{ForestGreen}{50}{shaded text, with colour saturation}
\item \verb|\shade|\{\textit{color}\}\{\textit{string}\} Print \shade{ForestGreen}{shaded text}
\item \verb|\backdrop|\{\textit{string}\} Print \backdrop{text with gray backdrop}
\item \verb|\printtoc|\{\textit{color}\} Print the table of contents (as seen on the first page). The normal \verb|\tableofcontents| still works as expected
\end{itemize}

34
docs/parts/reference/style/spacing.tex
View File

@@ -2,24 +2,24 @@
For spacing in math mode, prefer using the methods described \hlhref{https://www.overleaf.com/learn/latex/Spacing_in_math_mode}{here},
for vertical spacing prefer the commands described below
\begin{itemize}
\item \verb|\smallhspace| Prints a 2mm hspace
\item \verb|\mediumhspace| Prints a 5mm hspace
\item \verb|\largehspace| Prints a 10mm = 1cm hspace
\item \verb|\rmvspace|[\textit{number}] Removes an amount of vertical space. Should not be used unless can be avoided with general settings. Defaults to 0.5
\item \verb|\smallhspace| Prints a 2mm hspace
\item \verb|\mediumhspace| Prints a 5mm hspace
\item \verb|\largehspace| Prints a 10mm = 1cm hspace
\item \verb|\rmvspace|[\textit{number}] Removes an amount of vertical space. Should not be used unless can be avoided with general settings. Defaults to 0.5
\end{itemize}
Vertical spacing config for the entire document. By default, the \LaTeX\ defaults are used.
\begin{itemize}
\item \verb|\noverticalspacing|
\item \verb|\smallverticalspacing|
\item \verb|\mediumverticalspacing| (approximately the same as the \LaTeX defaults)
\item \verb|\largeverticalspacing|
\item \verb|\noverticalspacing|
\item \verb|\smallverticalspacing|
\item \verb|\mediumverticalspacing| (approximately the same as the \LaTeX defaults)
\item \verb|\largeverticalspacing|
\end{itemize}
You are of course free to redefine commands like \verb|\parskip|, etc to your liking, these commands are just provided for your convenience.
See \hlhref{https://www.overleaf.com/learn/latex/\%5Cabovedisplayskip_and_related_commands}{here}\ for more details
and \hlhref{https://latex-tutorial.com/latex-space/}{here for a good guide on spacing}.
To control paragraph spacing, see \hlhref{https://mirror.ox.ac.uk/sites/ctan.org/macros/latex/contrib/parskip/parskip.pdf}{here}\
To control paragraph spacing, see \hlhref{https://mirror.ox.ac.uk/sites/ctan.org/macros/latex/contrib/parskip/parskip.pdf}{here}\
and \hlhref{https://www.overleaf.com/learn/latex/Articles/How_to_change_paragraph_spacing_in_LaTeX}{here}.
Do make sure to put the \texttt{usepackage} \textit{before} loading the helpers.
Alternatively, you can use \verb|\PassOptionsToPackage{options}{package}|
@@ -34,11 +34,11 @@ Below a demonstration on the effects of the different settings:
This is text:
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
This is very long introductory text that exceeds the limit (same applies to long equations)
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
Text following the equation (no paragraph break!)
@@ -47,11 +47,11 @@ Text following the equation (no paragraph break!)
This is text:
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
This is very long introductory text that exceeds the limit (same applies to long equations)
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
Text following the equation (no paragraph break!)
@@ -60,11 +60,11 @@ Text following the equation (no paragraph break!)
This is text:
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
This is very long introductory text that exceeds the limit (same applies to long equations)
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
Text following the equation (no paragraph break!)
@@ -73,10 +73,10 @@ Text following the equation (no paragraph break!)
This is text:
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
This is very long introductory text that exceeds the limit (same applies to long equations)
\[
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\int_{0}^{10} 4x^2 + 3x \cdot \frac{3 \ln(10)}{x^3} \dx x
\]
Text following the equation (no paragraph break!)

20
docs/parts/reference/style/tcolorbox/counter.tex
View File

@@ -5,7 +5,7 @@ These ones also have two settings, namely, you can change the counter behaviour
See \ref{sec:counters} for a guide on how to change the current number and how to reference them.
\begin{definition}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{definition}[]{Title here}
\end{definition}
@@ -13,7 +13,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{definition}
\begin{theorem}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{theorem}[]{Title here}
\end{theorem}
@@ -21,7 +21,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{theorem}
\begin{lemma}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{lemma}[]{Title here}
\end{lemma}
@@ -29,7 +29,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{lemma}
\begin{corollary}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{corollary}[]{Title here}
\end{corollary}
@@ -37,7 +37,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{corollary}
\begin{proposition}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{proposition}[]{Title here}
\end{proposition}
@@ -45,7 +45,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{proposition}
\begin{fact}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{fact}[]{Title here}
\end{fact}
@@ -53,7 +53,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{fact}
\begin{axiom}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{axiom}[]{Title here}
\end{axiom}
@@ -61,7 +61,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{axiom}
\begin{example}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{example}[]{Title here}
\end{example}
@@ -69,7 +69,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{example}
\begin{remark}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{remark}[]{Title here}
\end{remark}
@@ -77,7 +77,7 @@ See \ref{sec:counters} for a guide on how to change the current number and how t
\end{remark}
\begin{formula}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{formula}[]{Title here}
\end{formula}

16
docs/parts/reference/style/tcolorbox/default.tex
View File

@@ -4,7 +4,7 @@
These tcolorboxes can be created using the code displayed inside them.
\begin{terms}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{terms}[]{Title here}
\end{terms}
@@ -12,7 +12,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{terms}
\begin{notation}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{notation}[]{Title here}
\end{notation}
@@ -20,7 +20,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{notation}
\begin{recall}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{recall}[]{Title here}
\end{recall}
@@ -28,7 +28,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{recall}
\begin{usage}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{usage}[]{Title here}
\end{usage}
@@ -36,7 +36,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{usage}
\begin{properties}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{properties}[]{Title here}
\end{properties}
@@ -44,7 +44,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{properties}
\begin{restrictions}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{restrictions}[]{Title here}
\end{restrictions}
@@ -52,7 +52,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{restrictions}
\begin{limitations}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{limitations}[]{Title here}
\end{limitations}
@@ -60,7 +60,7 @@ These tcolorboxes can be created using the code displayed inside them.
\end{limitations}
\begin{intuition}[]{Title here}
\begin{minted}{latex}
\begin{minted}{latex}
\begin{intuition}[]{Title here}
\end{intuition}

4
docs/parts/reference/style/tcolorbox/other.tex
View File

@@ -2,9 +2,9 @@
This tcolorbox has all the styles applied, but allows configuring the colour and both title boxes
\begin{general}[]{title}{second title}{red}
This Tcolorbox is flexible and can take any main and secondary title, as well as any colour.
This Tcolorbox is flexible and can take any main and secondary title, as well as any colour.
\begin{minted}{latex}
\begin{minted}{latex}
\begin{general}[]{title}{second title}{red}
\end{general}