[skip ci] Build helpers on push
This commit is contained in:
Helpers compiler [bot]
@@ -2,16 +2,16 @@
|
||||
\subsection{CS-Commands}
|
||||
These commands have to be executed inside math environment
|
||||
\begin{itemize}
|
||||
\item \verb|\tct| Time complexity in $\tct{}$-notation (average case)
|
||||
\item \verb|\tco| Time complexity in $\tco{}$-notation (worst case / upper bound)
|
||||
\item \verb|\tcl| Time complexity in $\tcl{}$-notation (best case / lower bound)
|
||||
\item \verb|\t[R, C, N]| Simply prints a capital R, C or N in math mode as normal text. So e.g. use $\tR$ to print an R
|
||||
\item \verb|\wordbool| Prints $\wordbool$
|
||||
\item \verb|\words|\{\textit{string}\} Prints $\words{test}$
|
||||
\item \verb|\wordm|\{\textit{math}\} Prints $\wordm{1}$
|
||||
\item \verb|\word| Prints $\word$
|
||||
\item \verb|\alphabets|\{\textit{string}\} Prints $\alphabets{test}$
|
||||
\item \verb|\alphabetbool| Prints $\alphabetbool$
|
||||
\item \verb|\tct| Time complexity in $\tct{}$-notation (average case)
|
||||
\item \verb|\tco| Time complexity in $\tco{}$-notation (worst case / upper bound)
|
||||
\item \verb|\tcl| Time complexity in $\tcl{}$-notation (best case / lower bound)
|
||||
\item \verb|\t[R, C, N]| Simply prints a capital R, C or N in math mode as normal text. So e.g. use $\tR$ to print an R
|
||||
\item \verb|\wordbool| Prints $\wordbool$
|
||||
\item \verb|\words|\{\textit{string}\} Prints $\words{test}$
|
||||
\item \verb|\wordm|\{\textit{math}\} Prints $\wordm{1}$
|
||||
\item \verb|\word| Prints $\word$
|
||||
\item \verb|\alphabets|\{\textit{string}\} Prints $\alphabets{test}$
|
||||
\item \verb|\alphabetbool| Prints $\alphabetbool$
|
||||
\end{itemize}
|
||||
|
||||
\subsubsection{Algorithms}
|
||||
@@ -24,9 +24,9 @@ These commands have to be executed inside math environment
|
||||
\end{minted}
|
||||
|
||||
\begin{algo}{functionName(A)}
|
||||
\Procedure{functionName}{$(A)$}
|
||||
\State\Return "Hello World"
|
||||
\EndProcedure
|
||||
\Procedure{functionName}{$(A)$}
|
||||
\State\Return "Hello World"
|
||||
\EndProcedure
|
||||
\end{algo}
|
||||
|
||||
|
||||
@@ -48,19 +48,19 @@ This is nothing different than a wrapper for a minted environment with a box dra
|
||||
Example (in python):
|
||||
|
||||
\begin{code}{python}
|
||||
def hello_world():
|
||||
print("hello world!")
|
||||
def hello_world():
|
||||
print("hello world!")
|
||||
\end{code}
|
||||
|
||||
|
||||
\paragraph{Code in separate files}
|
||||
It is also possible to load code from a source file using the provided commands:
|
||||
\begin{itemize}
|
||||
\item \verb|\inputcode|\{\textit{language}\}\{\textit{file}\}, where \textit{language} is the programming language
|
||||
and \textit{file} is the file name of the file to be loaded, relative to the main tex file.
|
||||
\item \verb|\inputcodewithfilename|\{\textit{language}\}\{\textit{hidden-path}\}\{\textit{shown-path}\}, where \textit{language} is the programming language,
|
||||
\textit{hidden-path} is the part of the path you want to hide of the file to be loaded, relative to the main tex file
|
||||
and \textit{shown-path} is the displayed part.
|
||||
\item \verb|\inputcode|\{\textit{language}\}\{\textit{file}\}, where \textit{language} is the programming language
|
||||
and \textit{file} is the file name of the file to be loaded, relative to the main tex file.
|
||||
\item \verb|\inputcodewithfilename|\{\textit{language}\}\{\textit{hidden-path}\}\{\textit{shown-path}\}, where \textit{language} is the programming language,
|
||||
\textit{hidden-path} is the part of the path you want to hide of the file to be loaded, relative to the main tex file
|
||||
and \textit{shown-path} is the displayed part.
|
||||
\end{itemize}
|
||||
\inlineexample
|
||||
\begin{minted}{latex}
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
\section{Full Command Reference}
|
||||
\subsection{Variables}
|
||||
\begin{itemize}
|
||||
\item \textit{string}: Any normal text
|
||||
\item \textit{boolean}: \texttt{true} or \texttt{false}
|
||||
\item \textit{math}: Any math input
|
||||
\item \textit{number}: Any non-negative integer, i.e. no commas
|
||||
\item \textit{color}: Any of the \texttt{dvipsnames} colours of \texttt{xcolor} or as defined in the color config file
|
||||
\item \textit{string}: Any normal text
|
||||
\item \textit{boolean}: \texttt{true} or \texttt{false}
|
||||
\item \textit{math}: Any math input
|
||||
\item \textit{number}: Any non-negative integer, i.e. no commas
|
||||
\item \textit{color}: Any of the \texttt{dvipsnames} colours of \texttt{xcolor} or as defined in the color config file
|
||||
\end{itemize}
|
||||
|
||||
|
||||
@@ -1,56 +1,56 @@
|
||||
\subsection{Per-File config}
|
||||
\label{sec:perFileConf}
|
||||
\begin{itemize}
|
||||
\item \verb|\renewcommand{\authorTitle}|\{\textit{string}\} Change the author (in the title) for this document only
|
||||
\item \verb|\renewcommand{\authorHeaders}|\{\textit{string}\} Change the author (in the header) for this document only
|
||||
\item \verb|\renewcommand{\<descriptor>NamingDE}|\{\textit{string}\} Configure translations for descriptors on the fly (for DE)
|
||||
\item \verb|\renewcommand{\<descriptor>NamingEN}|\{\textit{string}\} Configure translations for descriptors on the fly (for EN)
|
||||
\item \verb|\setnumberingpreset|\{\textit{string}\}
|
||||
Change the numbering preset of definitions, lemmas, etc for this document.
|
||||
Value can be \texttt{off}, \texttt{separate}, \texttt{combined}.
|
||||
\item \verb|\renewcommand{<descriptor>numbering}|\{\textit{string}\}
|
||||
Change the numbering for an individual descriptor, passed as first argument.
|
||||
The second value can be \texttt{off}, \texttt{separate}, \texttt{combined} or \texttt{default}.
|
||||
If set to \texttt{default}, it will follow the \verb|\numberingpreset| setting.
|
||||
If you do not override it here, it will follow your global config as set in the config directory
|
||||
and if unset there, it will follow the \verb|\numberingpreset| setting.
|
||||
\item \verb|\renew|\{\textit{string}\} Change the format of the numbering of definitions, etc.
|
||||
The value can be set to any of the below
|
||||
\begin{itemize}[noitemsep]
|
||||
\item none = $<$section$>$.$<$number$>$
|
||||
\item section = $<$section$>$.$<$number$>$
|
||||
\item subsection = $<$section$>$.$<$subsection$>$.$<$number$>$
|
||||
\item subsubsection = $<$section$>$.$<$subsection$>$.$<$subsubsection$>$.$<$number$>$
|
||||
\item paragraph = $<$section$>$.$<$subsection$>$.$<$subsubsection$>$.$<$paragraph$>$.$<$number$>$
|
||||
\end{itemize}
|
||||
Changing this won't affect all of numbering prior to the command, only after. You can change this setting (and the ones above) at any point in the document
|
||||
\item \verb|\setcounter{descriptorShadeStrength}|\{\textit{number}\} Change the colour saturation of the inline descriptors
|
||||
\item \verb|\setcounter{shadeStrength}|\{\textit{number}\} Change the colour saturation of the \verb|\shade| command
|
||||
\item \verb|\loadGerman| Load german configuration. Needs to be in preamble and you may only use it once
|
||||
\item To change the font for the entire document, load the font package using \verb|\usepackage|, with the last occurrence of a font package determining the active one.
|
||||
Then select the type by using \verb|\setFontType|\textit{\{mono $|$ serif $|$ sans\}}.
|
||||
A list of fonts is available \color{Cyan}\href{https://www.overleaf.com/learn/latex/Font_typefaces#Reference_guide}{here}\color{black}.
|
||||
You may change the font only for a specific section, by enclosing \verb|\setFont| and the text that should be written in said typeface in curly braces.
|
||||
\item \verb|\renewcommand{\authorTitle}|\{\textit{string}\} Change the author (in the title) for this document only
|
||||
\item \verb|\renewcommand{\authorHeaders}|\{\textit{string}\} Change the author (in the header) for this document only
|
||||
\item \verb|\renewcommand{\<descriptor>NamingDE}|\{\textit{string}\} Configure translations for descriptors on the fly (for DE)
|
||||
\item \verb|\renewcommand{\<descriptor>NamingEN}|\{\textit{string}\} Configure translations for descriptors on the fly (for EN)
|
||||
\item \verb|\setnumberingpreset|\{\textit{string}\}
|
||||
Change the numbering preset of definitions, lemmas, etc for this document.
|
||||
Value can be \texttt{off}, \texttt{separate}, \texttt{combined}.
|
||||
\item \verb|\renewcommand{<descriptor>numbering}|\{\textit{string}\}
|
||||
Change the numbering for an individual descriptor, passed as first argument.
|
||||
The second value can be \texttt{off}, \texttt{separate}, \texttt{combined} or \texttt{default}.
|
||||
If set to \texttt{default}, it will follow the \verb|\numberingpreset| setting.
|
||||
If you do not override it here, it will follow your global config as set in the config directory
|
||||
and if unset there, it will follow the \verb|\numberingpreset| setting.
|
||||
\item \verb|\renew|\{\textit{string}\} Change the format of the numbering of definitions, etc.
|
||||
The value can be set to any of the below
|
||||
\begin{itemize}[noitemsep]
|
||||
\item none = $<$section$>$.$<$number$>$
|
||||
\item section = $<$section$>$.$<$number$>$
|
||||
\item subsection = $<$section$>$.$<$subsection$>$.$<$number$>$
|
||||
\item subsubsection = $<$section$>$.$<$subsection$>$.$<$subsubsection$>$.$<$number$>$
|
||||
\item paragraph = $<$section$>$.$<$subsection$>$.$<$subsubsection$>$.$<$paragraph$>$.$<$number$>$
|
||||
\end{itemize}
|
||||
Changing this won't affect all of numbering prior to the command, only after. You can change this setting (and the ones above) at any point in the document
|
||||
\item \verb|\setcounter{descriptorShadeStrength}|\{\textit{number}\} Change the colour saturation of the inline descriptors
|
||||
\item \verb|\setcounter{shadeStrength}|\{\textit{number}\} Change the colour saturation of the \verb|\shade| command
|
||||
\item \verb|\loadGerman| Load german configuration. Needs to be in preamble and you may only use it once
|
||||
\item To change the font for the entire document, load the font package using \verb|\usepackage|, with the last occurrence of a font package determining the active one.
|
||||
Then select the type by using \verb|\setFontType|\textit{\{mono $|$ serif $|$ sans\}}.
|
||||
A list of fonts is available \color{Cyan}\href{https://www.overleaf.com/learn/latex/Font_typefaces#Reference_guide}{here}\color{black}.
|
||||
You may change the font only for a specific section, by enclosing \verb|\setFont| and the text that should be written in said typeface in curly braces.
|
||||
\end{itemize}
|
||||
\subsubsection{Letters}
|
||||
\begin{itemize}
|
||||
\item \verb|\renewcommand{\name}|\{\textit{string}\} Change the name (for letters) for this document only
|
||||
\item \verb|\renewcommand{\street}|\{\textit{string}\} Change the street (for letters) for this document only
|
||||
\item \verb|\renewcommand{\city}|\{\textit{string}\} Change the city (for letters) for this document only
|
||||
\item \verb|\renewcommand{\countrycode}|\{\textit{string}\} Change the country-code (for letters) for this document only
|
||||
\item \verb|\renewcommand{\name}|\{\textit{string}\} Change the name (for letters) for this document only
|
||||
\item \verb|\renewcommand{\street}|\{\textit{string}\} Change the street (for letters) for this document only
|
||||
\item \verb|\renewcommand{\city}|\{\textit{string}\} Change the city (for letters) for this document only
|
||||
\item \verb|\renewcommand{\countrycode}|\{\textit{string}\} Change the country-code (for letters) for this document only
|
||||
\end{itemize}
|
||||
|
||||
\newpage
|
||||
\subsection{Setup, Loading \& Translation}
|
||||
\begin{itemize}
|
||||
\item \verb|\setup|\{\textit{string}\} Prepare the document with the \textit{string} being the title
|
||||
\item \verb|\setupCheatSheet|[\textit{boolean}]\{\textit{string}\} Prepare the document with smaller borders and no headers / footers.
|
||||
The mandatory argument is the title, the optional argument will, if set to \texttt{true} use a landscape layout (default)
|
||||
and a horizontal layout if set to \texttt{false}.
|
||||
\item \verb|\setupBarebones|\{\textit{string}\} Minimal setup, only borders and title set
|
||||
\item \verb|\startDocument| Initialize the document. Has to be called after \verb|\begin{document}|
|
||||
\item \verb|\translate|\{\textit{string}\}\{\textit{string}\} First \textit{string} is English, second \textit{string} is German. Switches automatically based on language selected
|
||||
\item \verb|\tr|\{\textit{string}\}\{\textit{string}\} Shorthand for \verb|\translate|
|
||||
\item \verb|\numberingOn| Turn on the numbering (if previously turned off using \verb|\numberingOff| or set in the config)
|
||||
\item \verb|\numberingOff| Turn off the numbering (useful to temporarily turn off numbering)
|
||||
\item \verb|\setup|\{\textit{string}\} Prepare the document with the \textit{string} being the title
|
||||
\item \verb|\setupCheatSheet|[\textit{boolean}]\{\textit{string}\} Prepare the document with smaller borders and no headers / footers.
|
||||
The mandatory argument is the title, the optional argument will, if set to \texttt{true} use a landscape layout (default)
|
||||
and a horizontal layout if set to \texttt{false}.
|
||||
\item \verb|\setupBarebones|\{\textit{string}\} Minimal setup, only borders and title set
|
||||
\item \verb|\startDocument| Initialize the document. Has to be called after \verb|\begin{document}|
|
||||
\item \verb|\translate|\{\textit{string}\}\{\textit{string}\} First \textit{string} is English, second \textit{string} is German. Switches automatically based on language selected
|
||||
\item \verb|\tr|\{\textit{string}\}\{\textit{string}\} Shorthand for \verb|\translate|
|
||||
\item \verb|\numberingOn| Turn on the numbering (if previously turned off using \verb|\numberingOff| or set in the config)
|
||||
\item \verb|\numberingOff| Turn off the numbering (useful to temporarily turn off numbering)
|
||||
\end{itemize}
|
||||
|
||||
@@ -2,31 +2,31 @@
|
||||
\subsection{Math-Commands}
|
||||
All these have to be executed in the math environment.
|
||||
\begin{itemize}
|
||||
\item \verb|\R| Prints $\R$. Same goes for \verb|\C| printing $\C$, etc.
|
||||
\item \verb|\floor|\{\textit{math}\} Round down symbol, e.g. $\floor{n}$
|
||||
\item \verb|\ceil|\{\textit{math}\} Round up symbol, e.g. $\ceil{n}$
|
||||
\item \verb|\Leftrightarrowequiv| Equivalence transformation symbol, $\Leftrightarrowequiv$.
|
||||
\item \verb|\Rightarrowequiv| Equivalence transformation symbol, $\Rightarrowequiv$.
|
||||
\item \verb|\Leftarrowequiv| Equivalence transformation symbol, $\Leftarrowequiv$.
|
||||
\item \verb|\defAs| Define as, i.e. $\defAs$
|
||||
\item \verb|\defEquiv| Define as, but with a two-sided implication instead of equality, i.e. $\defEquiv$
|
||||
\item \verb|\defImplies| Define as, but with one-sided implication, i.e. $\defImplies$
|
||||
\item \verb|\divider| Divider or divides symbol, e.g. $a \divider b$
|
||||
\item \verb|\lcm| Least common multiple, $\lcm$
|
||||
\item \verb|\arcsinh| Inverse of hyperbolic sine, $\arcsinh$
|
||||
\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$
|
||||
\item \verb|\liminfni| Shortened limit inferior notation for $n \rightarrow \infty$, $\displaystyle \liminfni$
|
||||
\item \verb|\limsupni| Shortened limit superior notation for $n \rightarrow \infty$, $\displaystyle \limsupni$
|
||||
\item \verb|\diff|\{\textit{math}\} Derivative, $\displaystyle \diff{x}$
|
||||
\item \verb|\diffn|\{\textit{math}\}\{\textit{math}\} Higher derivative, $\displaystyle \diffn{x}{2}$
|
||||
\item \verb|\pardiff|\{\textit{math}\} Partial derivative, $\displaystyle \pardiff{x}$
|
||||
\item \verb|\pardiffn|\{\textit{math}\}\{\textit{math}\} Higher partial derivative, $\displaystyle \pardiffn{x}{2}$
|
||||
\item \verb|\sequence|\{\textit{math}\} Sequence, $\sequence{x}$
|
||||
\item \verb|\series|\{\textit{math}\}\{\textit{math}\} Series, prints \verb|\series{x}{2x}| as, $\series{x}{2x}$
|
||||
\item \verb|\elementstack|\{\textit{math}\}\{\textit{math}\} Stack two elements on top of eachother. Uses \verb|\genfrac| under the hood.
|
||||
Can be used for example in limits as an alternative to \verb|\atop| or \verb|\substack|.
|
||||
\item \verb|\R| Prints $\R$. Same goes for \verb|\C| printing $\C$, etc.
|
||||
\item \verb|\floor|\{\textit{math}\} Round down symbol, e.g. $\floor{n}$
|
||||
\item \verb|\ceil|\{\textit{math}\} Round up symbol, e.g. $\ceil{n}$
|
||||
\item \verb|\Leftrightarrowequiv| Equivalence transformation symbol, $\Leftrightarrowequiv$.
|
||||
\item \verb|\Rightarrowequiv| Equivalence transformation symbol, $\Rightarrowequiv$.
|
||||
\item \verb|\Leftarrowequiv| Equivalence transformation symbol, $\Leftarrowequiv$.
|
||||
\item \verb|\defAs| Define as, i.e. $\defAs$
|
||||
\item \verb|\defEquiv| Define as, but with a two-sided implication instead of equality, i.e. $\defEquiv$
|
||||
\item \verb|\defImplies| Define as, but with one-sided implication, i.e. $\defImplies$
|
||||
\item \verb|\divider| Divider or divides symbol, e.g. $a \divider b$
|
||||
\item \verb|\lcm| Least common multiple, $\lcm$
|
||||
\item \verb|\arcsinh| Inverse of hyperbolic sine, $\arcsinh$
|
||||
\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$
|
||||
\item \verb|\liminfni| Shortened limit inferior notation for $n \rightarrow \infty$, $\displaystyle \liminfni$
|
||||
\item \verb|\limsupni| Shortened limit superior notation for $n \rightarrow \infty$, $\displaystyle \limsupni$
|
||||
\item \verb|\diff|\{\textit{math}\} Derivative, $\displaystyle \diff{x}$
|
||||
\item \verb|\diffn|\{\textit{math}\}\{\textit{math}\} Higher derivative, $\displaystyle \diffn{x}{2}$
|
||||
\item \verb|\pardiff|\{\textit{math}\} Partial derivative, $\displaystyle \pardiff{x}$
|
||||
\item \verb|\pardiffn|\{\textit{math}\}\{\textit{math}\} Higher partial derivative, $\displaystyle \pardiffn{x}{2}$
|
||||
\item \verb|\sequence|\{\textit{math}\} Sequence, $\sequence{x}$
|
||||
\item \verb|\series|\{\textit{math}\}\{\textit{math}\} Series, prints \verb|\series{x}{2x}| as, $\series{x}{2x}$
|
||||
\item \verb|\elementstack|\{\textit{math}\}\{\textit{math}\} Stack two elements on top of eachother. Uses \verb|\genfrac| under the hood.
|
||||
Can be used for example in limits as an alternative to \verb|\atop| or \verb|\substack|.
|
||||
\end{itemize}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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}
|
||||
|
||||
@@ -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!)
|
||||
|
||||
@@ -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}
|
||||
|
||||
@@ -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}
|
||||
|
||||
@@ -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}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
\newpage
|
||||
\subsection{Tables}
|
||||
You can set up nice looking tables using the \texttt{booktab} and \texttt{tabulary} environments.
|
||||
You can set up nice looking tables using the \texttt{booktab} and \texttt{tabulary} environments.
|
||||
|
||||
\textit{New as of October 28 2025:} Tables and figures are now also numbered according to your settings
|
||||
|
||||
@@ -12,7 +12,7 @@ You can set up nice looking tables using the \texttt{booktab} and \texttt{tabula
|
||||
|
||||
This outputs as
|
||||
\begin{tables}{ll}{Left & Right}
|
||||
Left content & Right Content \\
|
||||
Left content & Right Content \\
|
||||
\end{tables}
|
||||
|
||||
This doesn't use the \texttt{table} environment, so no captions are possible, as to why there is also
|
||||
@@ -25,7 +25,7 @@ This doesn't use the \texttt{table} environment, so no captions are possible, as
|
||||
This outputs as
|
||||
|
||||
\begin{fullTable}{ll}{Left & Right}{This is a caption}
|
||||
Left content & Right Content\\
|
||||
Left content & Right Content\\
|
||||
\end{fullTable}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user