57 lines
4.7 KiB
TeX
57 lines
4.7 KiB
TeX
\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.
|
|
\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
|
|
\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)
|
|
\end{itemize}
|