321 lines
11 KiB
TeX
321 lines
11 KiB
TeX
\newsection
|
|
\section{Full Command Reference}
|
|
\subsection{Variables}
|
|
\begin{itemize}
|
|
\item \textit{scope}: \texttt{minimal}, \texttt{most}, \texttt{recommended}, \texttt{all} or \texttt{letter}
|
|
\item \textit{string}: Any normal text
|
|
\item \textit{number}: Any non-negative integer, i.e. no commas
|
|
\item \textit{color}: Any of the \texttt{dvipsnames} colours of \texttt{xcolor}
|
|
\end{itemize}
|
|
|
|
\subsection{Per-File config}
|
|
\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{\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|\setcounter{numberingConfig}|\{\textit{number}\} Change the numbering of definitions, lemmas, etc for this document. 1 = Separately, 2 = Combined (except for definition), 3 = Combined, 4 = Off
|
|
\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|\setLang|\{\textit{language}\} Change the language. Will automatically load babel in German. Can only be used once and only at the start of the document or in the preamble, as repeated usage leads to undefined behaviour
|
|
\end{itemize}
|
|
|
|
\subsection{Setup, Loading \& Translation}
|
|
\begin{itemize}
|
|
\item \verb|\load|\{\textit{scope}\} Load the selected \textit{scope}
|
|
\item \verb|\setup|\{\textit{string}\} Prepare the document with the \textit{string} being the title
|
|
\item \verb|\setupExam|\{\textit{string}\} Prepare the document with smaller borders and no headers / footers. \textit{string} is the title
|
|
\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|\usetcolorboxes| Initialize tcolorboxes. In main body, if you want to use fancy boxes. (requires \texttt{most} or up)
|
|
\item \verb|\translate|\{\textit{string}\}\{\textit{string}\} First \textit{string} is English, second \textit{string} is German. Switches automatically based on language selected
|
|
\end{itemize}
|
|
|
|
\newpage
|
|
\subsection{Style}
|
|
General styling commands. All other commands, except these ones require at least \texttt{most} to be the selected \textit{scope}
|
|
\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|\fhlc|\{\textit{color}\}\{\textit{string}\} Print \fhlc{ForestGreen}{bold, underlined text in a coloured box}
|
|
\item \verb|\fhl|\{\textit{string}\} Print \fhl{bold, underlined text in a white box}
|
|
\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}
|
|
|
|
\newpage
|
|
\subsubsection{Tcolorboxes}
|
|
\textit{Included in \texttt{most} and up}
|
|
|
|
Put \verb|\usetcolorboxes| right after \verb|\startDocument| (right after \verb|\begin{document}|) if you plan to use them.
|
|
|
|
\fhlc{Aquamarine}{General}
|
|
\begin{terms}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{terms}[]{Title here}
|
|
|
|
\end{terms}
|
|
\end{minted}
|
|
\end{terms}
|
|
|
|
\begin{notation}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{notation}[]{Title here}
|
|
|
|
\end{notation}
|
|
\end{minted}
|
|
\end{notation}
|
|
|
|
\begin{recall}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{recall}[]{Title here}
|
|
|
|
\end{recall}
|
|
\end{minted}
|
|
\end{recall}
|
|
|
|
\begin{remarks}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{remarks}[]{Title here}
|
|
|
|
\end{remarks}
|
|
\end{minted}
|
|
\end{remarks}
|
|
|
|
\begin{usage}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{usage}[]{Title here}
|
|
|
|
\end{usage}
|
|
\end{minted}
|
|
\end{usage}
|
|
|
|
\begin{guides}[]{Title here}{Tutorial}
|
|
\begin{minted}{latex}
|
|
\begin{guides}[]{Title here}{Tutorial}
|
|
% You can also change the right title on this one
|
|
|
|
\end{guides}
|
|
\end{minted}
|
|
\end{guides}
|
|
|
|
\begin{properties}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{properties}[]{Title here}
|
|
|
|
\end{properties}
|
|
\end{minted}
|
|
\end{properties}
|
|
|
|
\begin{restrictions}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{restrictions}[]{Title here}
|
|
|
|
\end{restrictions}
|
|
\end{minted}
|
|
\end{restrictions}
|
|
|
|
\begin{limitations}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{limitations}[]{Title here}
|
|
|
|
\end{limitations}
|
|
\end{minted}
|
|
\end{limitations}
|
|
|
|
|
|
|
|
\fhlc{Aquamarine}{Math-Specific}
|
|
\begin{formula}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{formula}[]{Title here}
|
|
|
|
\end{formula}
|
|
\end{minted}
|
|
\end{formula}
|
|
|
|
|
|
\newpage
|
|
\fhlc{Aquamarine}{Counter-enabled}
|
|
|
|
These ones also have a setting, namely, you can change the counter behaviour:\\
|
|
\verb|\setcounter{numberingConfig}|\{\textit{number}\}: Change the numbering of definitions, lemmas, etc for this document. 1 = Separately, 2 = Combined (except for definition), 3 = Combined, 4 = Off
|
|
|
|
Here, it is shown with the default setting, $1$, meaning they are numbered separately. See \ref{sec:counters} for a guide on how to change the current number.
|
|
|
|
\begin{definition}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{definition}[]{Title here}
|
|
|
|
\end{definition}
|
|
\end{minted}
|
|
\end{definition}
|
|
|
|
\begin{theorem}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{theorem}[]{Title here}
|
|
|
|
\end{theorem}
|
|
\end{minted}
|
|
\end{theorem}
|
|
|
|
\begin{lemma}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{lemma}[]{Title here}
|
|
|
|
\end{lemma}
|
|
\end{minted}
|
|
\end{lemma}
|
|
|
|
\begin{corollary}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{corollary}[]{Title here}
|
|
|
|
\end{corollary}
|
|
\end{minted}
|
|
\end{corollary}
|
|
|
|
\begin{axiom}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{axiom}[]{Title here}
|
|
|
|
\end{axiom}
|
|
\end{minted}
|
|
\end{axiom}
|
|
|
|
\begin{example}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{example}[]{Title here}
|
|
|
|
\end{example}
|
|
\end{minted}
|
|
\end{example}
|
|
|
|
|
|
\newpage
|
|
\fhlc{Aquamarine}{Language-Specific}
|
|
\begin{conjugation}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{conjugation}[]{Title here}
|
|
|
|
\end{conjugation}
|
|
\end{minted}
|
|
\end{conjugation}
|
|
|
|
\begin{forms}[]{Title here}
|
|
\begin{minted}{latex}
|
|
\begin{forms}[]{Title here}
|
|
|
|
\end{forms}
|
|
\end{minted}
|
|
\end{forms}
|
|
|
|
|
|
\fhlc{Aquamarine}{CS-Specific}
|
|
\textit{Coming soon!}
|
|
|
|
|
|
\fhlc{Aquamarine}{Flexible}
|
|
\begin{general}[]{title}{second title}{red}
|
|
This Tcolorbox is flexible and can take any main and secondary title, as well as any colour.\\
|
|
\begin{minted}{latex}
|
|
\begin{general}[]{title}{second title}{red}
|
|
|
|
\end{general}
|
|
\end{minted}
|
|
\end{general}
|
|
|
|
|
|
\newpage
|
|
\subsubsection{Inline \& Shortened descriptors}
|
|
\textit{Included in \texttt{most} and up}
|
|
|
|
See \ref{sec:counters} for a guide on how to change the current number.
|
|
|
|
\fhlc{Aquamarine}{Inline}
|
|
\begin{tables}{ll}{Command & Output}
|
|
\verb|\inlineex| & \inlineex\\
|
|
\verb|\inlinedef| & \inlinedef\\
|
|
\verb|\inlinetheorem| & \inlinetheorem\\
|
|
\verb|\inlinelemma| & \inlinelemma\\
|
|
\verb|\inlinecorollary| & \inlinecorollary\\
|
|
\verb|\inlineaxiom| & \inlineaxiom\\
|
|
\verb|\inlineproof| & \inlineproof\\
|
|
\end{tables}
|
|
|
|
\fhlc{Aquamarine}{Shortened}
|
|
\begin{tables}{ll}{Command & Output}
|
|
\verb|\shortex| & \shortex\\
|
|
\verb|\shortdef| & \shortdef\\
|
|
\verb|\shorttheorem| & \shorttheorem\\
|
|
\verb|\shortlemma| & \shortlemma\\
|
|
\verb|\shortcorollary| & \shortcorollary\\
|
|
\verb|\shortaxiom| & \shortaxiom\\
|
|
\verb|\shortproof| & \shortproof\\
|
|
\end{tables}
|
|
|
|
|
|
\subsubsection{Changing the counters}
|
|
\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.
|
|
|
|
|
|
\newpage
|
|
\subsection{Tables}
|
|
\textit{Included in \texttt{most} and up}
|
|
|
|
You can set up nice looking tables using the \texttt{booktab} and \texttt{tabulary} environments.
|
|
|
|
\begin{minted}{latex}
|
|
\begin{tables}{ll}{Left & Right}
|
|
Left content & Right Content\\
|
|
\end{tables}
|
|
\end{minted}
|
|
|
|
This outputs as
|
|
\begin{tables}{ll}{Left & Right}
|
|
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
|
|
\begin{minted}{latex}
|
|
\begin{fullTable}{ll}{Left & Right}{This is a caption}
|
|
Left content & Right Content\\
|
|
\end{fullTable}
|
|
\end{minted}
|
|
|
|
This outputs as
|
|
|
|
\begin{fullTable}{ll}{Left & Right}{This is a caption}
|
|
Left content & Right Content\\
|
|
\end{fullTable}
|
|
|
|
|
|
\subsection{Index}
|
|
\textit{Included in \texttt{most} and up}
|
|
|
|
If you want to use index, add \verb|\prepareIndex| to the preamble. Using \verb|\addIndexBold|\{\textit{string}\}, you can add entries to the index. They are printed in bold typeface in your document.
|
|
Using \verb|\addIndex|\{\textit{string}\}, you can do the same, but the text remains normal and using \verb|\addIndexItalic|\{\textit{string}\}, it is printed in italics
|
|
|
|
|
|
\subsection{Extras}
|
|
\subsubsection{BibTeX}
|
|
\textit{Included in \texttt{recommended} and up}
|
|
|
|
Use \verb|\setupBiber|\{\textit{/path/to/your/bib/sources.bib file}\} in the preamble to prepare, then use \verb|\printbib| to print your bibliography.
|
|
|
|
\subsubsection{Glossary}
|
|
\textit{Included in \texttt{recommended} and up}
|
|
|
|
Use \verb|\setupGlossary| in the preamble to prepare, then use the normal glossary commands to add entries to the glossary. When you want to print it, use \verb|\printGlossary|.
|
|
|
|
\subsubsection{Minted}
|
|
\textit{Included in \texttt{full}}
|
|
|
|
No extra configs or commands provided by this one, simply an import for minted. Be sure to enable \texttt{shell-escape} for your compiler! |