diff --git a/docs/docs.tex b/docs/docs.tex index 3aeebd7..2352e47 100644 --- a/docs/docs.tex +++ b/docs/docs.tex @@ -11,17 +11,17 @@ \vspace{2cm} \begin{center} - \includegraphics[width=0.5\linewidth]{../assets/logo.jpg} + \includegraphics[width=0.5\linewidth]{../assets/logo.jpg} \end{center} \vspace{5cm} \begin{center} - \begin{Large} - \textsc{Usage guide for Version 2.0.0} - \end{Large} + \begin{Large} + \textsc{Usage guide for Version 2.0.0} + \end{Large} - \hlurl{https://git.janishutz.com/janishutz/latex} + \hlurl{https://git.janishutz.com/janishutz/latex} \end{center} diff --git a/docs/parts/intro.tex b/docs/parts/intro.tex index 268bba4..7d724e4 100644 --- a/docs/parts/intro.tex +++ b/docs/parts/intro.tex @@ -3,7 +3,7 @@ This set of \LaTeX files is designed to give you a good looking, pre-configured \LaTeX setup, which helps you get started much more quickly. There are quite a lot of configuration options, but it is likely that more are to come in the future. -If you have any suggestions as to what should be added, don't hesitate to open a \hlhref{https://support.janishutz.com?a=add}{support ticket}\ +If you have any suggestions as to what should be added, don't hesitate to open a \hlhref{https://support.janishutz.com?a=add}{support ticket}\ or contacting me via email to \texttt{development@janishutz.com}. diff --git a/docs/parts/reference/cs.tex b/docs/parts/reference/cs.tex index a2bf0e6..199046a 100644 --- a/docs/parts/reference/cs.tex +++ b/docs/parts/reference/cs.tex @@ -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} @@ -47,19 +47,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} diff --git a/docs/parts/reference/intro.tex b/docs/parts/reference/intro.tex index 0d02ae9..560869f 100644 --- a/docs/parts/reference/intro.tex +++ b/docs/parts/reference/intro.tex @@ -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} diff --git a/docs/parts/reference/loading.tex b/docs/parts/reference/loading.tex index fbeb125..8194cf3 100644 --- a/docs/parts/reference/loading.tex +++ b/docs/parts/reference/loading.tex @@ -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{\NamingDE}|\{\textit{string}\} Configure translations for descriptors on the fly (for DE) - \item \verb|\renewcommand{\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{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{\NamingDE}|\{\textit{string}\} Configure translations for descriptors on the fly (for DE) + \item \verb|\renewcommand{\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{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} diff --git a/docs/parts/reference/math.tex b/docs/parts/reference/math.tex index 62aa5bb..5f1bebe 100644 --- a/docs/parts/reference/math.tex +++ b/docs/parts/reference/math.tex @@ -2,29 +2,29 @@ \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|\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|\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} diff --git a/docs/parts/reference/style/descriptors.tex b/docs/parts/reference/style/descriptors.tex index 83b0eb3..9d65323 100644 --- a/docs/parts/reference/style/descriptors.tex +++ b/docs/parts/reference/style/descriptors.tex @@ -4,30 +4,30 @@ See \ref{sec:counters} for a guide on how to change the current number. \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 diff --git a/docs/parts/reference/style/intro.tex b/docs/parts/reference/style/intro.tex index 8425d00..b177714 100644 --- a/docs/parts/reference/style/intro.tex +++ b/docs/parts/reference/style/intro.tex @@ -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} diff --git a/docs/parts/reference/style/spacing.tex b/docs/parts/reference/style/spacing.tex index 5a589d1..8e766df 100644 --- a/docs/parts/reference/style/spacing.tex +++ b/docs/parts/reference/style/spacing.tex @@ -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} To make use of \TeX's automatic wrapping of short alignment environments, use the \texttt{aligned} @@ -32,11 +32,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!) @@ -45,11 +45,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!) @@ -58,11 +58,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!) @@ -71,10 +71,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!) diff --git a/docs/parts/reference/style/tcolorbox/counter.tex b/docs/parts/reference/style/tcolorbox/counter.tex index 9655378..6837c7f 100644 --- a/docs/parts/reference/style/tcolorbox/counter.tex +++ b/docs/parts/reference/style/tcolorbox/counter.tex @@ -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} diff --git a/docs/parts/reference/style/tcolorbox/default.tex b/docs/parts/reference/style/tcolorbox/default.tex index 32eab31..9b3c24d 100644 --- a/docs/parts/reference/style/tcolorbox/default.tex +++ b/docs/parts/reference/style/tcolorbox/default.tex @@ -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} diff --git a/docs/parts/reference/style/tcolorbox/other.tex b/docs/parts/reference/style/tcolorbox/other.tex index 0ce3010..9e32437 100644 --- a/docs/parts/reference/style/tcolorbox/other.tex +++ b/docs/parts/reference/style/tcolorbox/other.tex @@ -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} diff --git a/docs/parts/reference/tables-index.tex b/docs/parts/reference/tables-index.tex index 627167b..9bb0283 100644 --- a/docs/parts/reference/tables-index.tex +++ b/docs/parts/reference/tables-index.tex @@ -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 @@ -27,7 +27,7 @@ This outputs as \begin{fullTable}{ll}{Left & Right}{This is a caption} - Left content & Right Content\\ + Left content & Right Content\\ \end{fullTable} diff --git a/examples/letter/letter.tex b/examples/letter/letter.tex index 9e96b2f..d462192 100644 --- a/examples/letter/letter.tex +++ b/examples/letter/letter.tex @@ -6,10 +6,10 @@ \setkomavar{subject}{Test} \begin{document}\raggedright \begin{letter}{Company \\ Name \\ Address \\ CH-Place} - \opening{Intro} + \opening{Intro} - Test + Test - \closing{Kind regards} + \closing{Kind regards} \end{letter} \end{document} diff --git a/janishutz-helpers.tex b/janishutz-helpers.tex index 13db9f0..cedfbaa 100644 --- a/janishutz-helpers.tex +++ b/janishutz-helpers.tex @@ -92,72 +92,6 @@ \colorlet{propertiescolor}{purple} -% ┌ ┐ -% │ General config │ -% └ ┘ -% Configure your author name here -\newcommand{\authorTitle}{Janis Hutz\\\url{https://janishutz.com}} -\newcommand{\authorHeaders}{Janis Hutz} - - -% ┌ ┐ -% │ Rendering │ -% └ ┘ -% Specify how the inline and short descriptors (e.g. Lemma, etc) are rendered. -% - #1 is the name of the descriptor -% - #2 is the number (correctly rendered according to settings and preceded with space if not disabled) -% - #3 is the name passed (non-empty asserted) -\newcommand{\shortDescriptorTemplate}[3]{\bg{#1color}{\shortNamingTranslate{#1} #2} \textit{(#3)}} -\newcommand{\inlineDescriptorTemplate}[3]{\bg{#1color}{\namingTranslate{#1} #2}: \textit{(#3)}} - -% These are used if no name is provided and argument #4 from above is the missing argument -\newcommand{\anonymousShortDescriptorTemplate}[2]{\bg{#1color}{\shortNamingTranslate{#1} #2}} -\newcommand{\anonymousInlineDescriptorTemplate}[2]{\bg{#1color}{\namingTranslate{#1} #2}} - -% background command config (draws a small box around the content) -\newcommand{\backgroundPadding}{2pt} -\newcommand{\backgroundRounding}{1pt} - - -% ┌ ┐ -% │ Numbering │ -% └ ┘ -% Set a preset, can be combined, separate or off. -% If set to custom, all type specific commands need to be set below. -\newcommand{\numberingpreset}{combined} - -% Specify how elements are to be numbered. Can be (X is the current number of the element): -% - none (X) -% - section (section.X) -% - subsection (section.subsection.X) -% - subsubsection (section.subsection.subsubsection.X) -% - paragraph (section.subsection.subsubsection.paragraph.X) -\newcommand{\subsectionnumbering}{subsection} - - -% Set for a specific type. Can each be combined, separate, default or off: -% If set to anything but 'default', it will override the overarching style -% set by \numberingpreset -\newcommand{\definitionnumbering}{default} -\newcommand{\theoremnumbering}{default} -\newcommand{\lemmanumbering}{default} -\newcommand{\corollarynumbering}{default} -\newcommand{\axiomnumbering}{default} -\newcommand{\factnumbering}{default} -\newcommand{\propositionnumbering}{default} -\newcommand{\examplenumbering}{default} -\newcommand{\formulanumbering}{default} -\newcommand{\remarknumbering}{default} -\newcommand{\proofnumbering}{default} -\newcommand{\intuitionnumbering}{default} -\newcommand{\termnumbering}{default} -\newcommand{\notationnumbering}{default} -\newcommand{\tasknumbering}{default} -\newcommand{\usagenumbering}{default} -\newcommand{\recallnumbering}{default} -\newcommand{\propertiesnumbering}{default} - - % ┌ ┐ % │ Naming │ % └ ┘ @@ -241,6 +175,72 @@ \newcommand{\propertiesShortNamingDE}{Eig.} +% ┌ ┐ +% │ Numbering │ +% └ ┘ +% Set a preset, can be combined, separate or off. +% If set to custom, all type specific commands need to be set below. +\newcommand{\numberingpreset}{combined} + +% Specify how elements are to be numbered. Can be (X is the current number of the element): +% - none (X) +% - section (section.X) +% - subsection (section.subsection.X) +% - subsubsection (section.subsection.subsubsection.X) +% - paragraph (section.subsection.subsubsection.paragraph.X) +\newcommand{\subsectionnumbering}{subsection} + + +% Set for a specific type. Can each be combined, separate, default or off: +% If set to anything but 'default', it will override the overarching style +% set by \numberingpreset +\newcommand{\definitionnumbering}{default} +\newcommand{\theoremnumbering}{default} +\newcommand{\lemmanumbering}{default} +\newcommand{\corollarynumbering}{default} +\newcommand{\axiomnumbering}{default} +\newcommand{\factnumbering}{default} +\newcommand{\propositionnumbering}{default} +\newcommand{\examplenumbering}{default} +\newcommand{\formulanumbering}{default} +\newcommand{\remarknumbering}{default} +\newcommand{\proofnumbering}{default} +\newcommand{\intuitionnumbering}{default} +\newcommand{\termnumbering}{default} +\newcommand{\notationnumbering}{default} +\newcommand{\tasknumbering}{default} +\newcommand{\usagenumbering}{default} +\newcommand{\recallnumbering}{default} +\newcommand{\propertiesnumbering}{default} + + +% ┌ ┐ +% │ General config │ +% └ ┘ +% Configure your author name here +\newcommand{\authorTitle}{Janis Hutz\\\url{https://janishutz.com}} +\newcommand{\authorHeaders}{Janis Hutz} + + +% ┌ ┐ +% │ Rendering │ +% └ ┘ +% Specify how the inline and short descriptors (e.g. Lemma, etc) are rendered. +% - #1 is the name of the descriptor +% - #2 is the number (correctly rendered according to settings and preceded with space if not disabled) +% - #3 is the name passed (non-empty asserted) +\newcommand{\shortDescriptorTemplate}[3]{\bg{#1color}{\shortNamingTranslate{#1} #2} \textit{(#3)}} +\newcommand{\inlineDescriptorTemplate}[3]{\bg{#1color}{\namingTranslate{#1} #2}: \textit{(#3)}} + +% These are used if no name is provided and argument #4 from above is the missing argument +\newcommand{\anonymousShortDescriptorTemplate}[2]{\bg{#1color}{\shortNamingTranslate{#1} #2}} +\newcommand{\anonymousInlineDescriptorTemplate}[2]{\bg{#1color}{\namingTranslate{#1} #2}} + +% background command config (draws a small box around the content) +\newcommand{\backgroundPadding}{2pt} +\newcommand{\backgroundRounding}{1pt} + + \newcounter{definitionnone} \newcounter{definitionsection}[section] \renewcommand{\thedefinitionsection}{\thesection.\arabic{definitionsection}} @@ -687,6 +687,20 @@ } +% Add glossaries functionality + +\newcommand{\setupGlossary}{ + \usepackage[nonumberlist, toc]{glossaries} + \usepackage[nottoc, numbib]{tocbibind} + \makenoidxglossaries +} + +\newcommand{\printGlossary}{ + \glsaddall + \printnoidxglossaries +} + + % ┌ ┐ % │ Math │ % └ ┘ @@ -828,93 +842,6 @@ } -% ┌ ┐ -% │ Index │ -% └ ┘ - -% For using index package -\newcommand{\prepareIndex}{ - \usepackage[T1]{fontenc} - \usepackage{imakeidx} - \makeindex -} - -\newcommand{\addIndexBold}[1]{\textbf{\index{\MakeLowercase{#1}} #1}} -\newcommand{\addIndexItalic}[1]{\textit{\index{\MakeLowercase{#1}} #1}} -\newcommand{\addIndex}[1]{\index{\MakeLowercase{#1}} #1} - - - -% ┌ ┐ -% │ Tables │ -% └ ┘ - -\usepackage{booktabs} -\usepackage{tabulary} - -% Create new table. #1 Layout, #2 title row -\newenvironment{tables}[2]{ - \begin{center} - \begin{tabular}{#1} - \toprule - #2 \\ - \midrule - }{ - \bottomrule - \end{tabular} - \end{center} -} - -% Create new table in table env. #1 layout, #2 title row, #3 caption -\newenvironment{fullTable}[3]{ - \edef\tableCaption{#3} - \begin{table}[h!] - \begin{tables}{#1}{#2} - }{ - \end{tables} - \caption{\tableCaption} - \end{table} -} - - -% Add glossaries functionality - -\newcommand{\setupGlossary}{ - \usepackage[nonumberlist, toc]{glossaries} - \usepackage[nottoc, numbib]{tocbibind} - \makenoidxglossaries -} - -\newcommand{\printGlossary}{ - \glsaddall - \printnoidxglossaries -} - - -% ┌ ┐ -% │ Translation │ -% └ ┘ -\newcommand{\translate}[2]{% - \ifthenelse{\equal{\currentLanguage}{en}}{#1}{#2}% -} -\newcommand{\tr}[2]{\translate{#1}{#2}} -\newcommand{\namingTranslate}[1]{\translate{\printTranslationOptionEN{#1}}{\printTranslationOptionEN{#1}}} -\newcommand{\shortNamingTranslate}[1]{\translate{\printShortTranslationOptionEN{#1}}{\printShortTranslationOptionEN{#1}}} - -% Translation aids (commonly used) -\newcommand{\trif}{\translate{if }{falls }} -\newcommand{\trIf}{\translate{If }{Falls }} -\newcommand{\trLet}{\translate{Let }{Sei }} -\newcommand{\trLets}{\translate{Let }{Seien }} -\newcommand{\trFor}{\translate{For }{Für }} -\newcommand{\trfor}{\translate{for }{für }} -\newcommand{\trand}{\translate{and }{und }} -\newcommand{\tror}{\translate{or }{oder }} -\newcommand{\trst}{\translate{s.t. }{s.d. }} -\newcommand{\trsuchthat}{\translate{such that }{so dass }} -\newcommand{\trwith}{\translate{with }{mit }} - - % ┌ ┐ % │ Setup │ % └ ┘ @@ -1008,6 +935,47 @@ } +% ┌ ┐ +% │ Translation │ +% └ ┘ +\newcommand{\translate}[2]{% + \ifthenelse{\equal{\currentLanguage}{en}}{#1}{#2}% +} +\newcommand{\tr}[2]{\translate{#1}{#2}} +\newcommand{\namingTranslate}[1]{\translate{\printTranslationOptionEN{#1}}{\printTranslationOptionEN{#1}}} +\newcommand{\shortNamingTranslate}[1]{\translate{\printShortTranslationOptionEN{#1}}{\printShortTranslationOptionEN{#1}}} + +% Translation aids (commonly used) +\newcommand{\trif}{\translate{if }{falls }} +\newcommand{\trIf}{\translate{If }{Falls }} +\newcommand{\trLet}{\translate{Let }{Sei }} +\newcommand{\trLets}{\translate{Let }{Seien }} +\newcommand{\trFor}{\translate{For }{Für }} +\newcommand{\trfor}{\translate{for }{für }} +\newcommand{\trand}{\translate{and }{und }} +\newcommand{\tror}{\translate{or }{oder }} +\newcommand{\trst}{\translate{s.t. }{s.d. }} +\newcommand{\trsuchthat}{\translate{such that }{so dass }} +\newcommand{\trwith}{\translate{with }{mit }} + + +% ┌ ┐ +% │ Index │ +% └ ┘ + +% For using index package +\newcommand{\prepareIndex}{ + \usepackage[T1]{fontenc} + \usepackage{imakeidx} + \makeindex +} + +\newcommand{\addIndexBold}[1]{\textbf{\index{\MakeLowercase{#1}} #1}} +\newcommand{\addIndexItalic}[1]{\textit{\index{\MakeLowercase{#1}} #1}} +\newcommand{\addIndex}[1]{\index{\MakeLowercase{#1}} #1} + + + % ░▒█▀▀▄░▄▀▀▄░█▀▄▀█░▄▀▀▄░█░▒█░▀█▀░█▀▀░█▀▀▄░░░▒█▀▀▀█░█▀▄░░▀░░█▀▀░█▀▀▄░█▀▄░█▀▀ % ░▒█░░░░█░░█░█░▀░█░█▄▄█░█░▒█░░█░░█▀▀░█▄▄▀░░░░▀▀▀▄▄░█░░░░█▀░█▀▀░█░▒█░█░░░█▀▀ @@ -1040,6 +1008,109 @@ \newcommand{\class}{\text{\tr{Cl}{Kl}}} +% ┌ ┐ +% │ Tables │ +% └ ┘ + +\usepackage{booktabs} +\usepackage{tabulary} + +% Create new table. #1 Layout, #2 title row +\newenvironment{tables}[2]{ + \begin{center} + \begin{tabular}{#1} + \toprule + #2 \\ + \midrule + }{ + \bottomrule + \end{tabular} + \end{center} +} + +% Create new table in table env. #1 layout, #2 title row, #3 caption +\newenvironment{fullTable}[3]{ + \edef\tableCaption{#3} + \begin{table}[h!] + \begin{tables}{#1}{#2} + }{ + \end{tables} + \caption{\tableCaption} + \end{table} +} + + +% ┌ ┐ +% │ Counter numbering │ +% └ ┘ +\newcommand{\preEnvHook}[1]{% + \stepLabelNumber{combined}% + \ifthenelse{\equal{\numberingpreset}{combined}}{% + \ifthenelse{\equal{\printNumberingConfigForDescriptor{#1}}{default}}{ + \stepLabelNumber{combined}% + }{}% + }{% + \ifthenelse{\equal{\printNumberingConfigForDescriptor{#1}}{combined}}{% + \stepLabelNumber{combined}% + }{}% + }% +} + +% Decides on the numbering to use (combined or not) +\newcommand{\loadNumberingConfiguration}{% + \ifthenelse{\boolean{numberingDisabled}}{% + \renewcommand{\thetable}{\arabic{table}} + \renewcommand{\thefigure}{\arabic{figure}} + }{ + \ifthenelse{\equal{\numberingpreset}{combined}}{% + \ifthenelse{\equal{\subsectionnumbering}{none}}{ + \renewcommand{\thetable}{\arabic{combinednone}} + \renewcommand{\thefigure}{\arabic{combinednone}} + }{% + \renewcommand{\thetable}{\ssprinter.\arabic{combined\subsectionnumbering}} + \renewcommand{\thefigure}{\ssprinter.\arabic{combined\subsectionnumbering}} + }% + }{% + \ifthenelse{\equal{\numberingpreset}{separate}}{ + \ifthenelse{\equal{\subsectionnumbering}{none}}{}{ + \renewcommand{\thetable}{\ssprinter.\arabic{table}} + \renewcommand{\thefigure}{\ssprinter.\arabic{figure}} + } + }{% + \renewcommand{\thetable}{\arabic{table}} + \renewcommand{\thefigure}{\arabic{figure}} + }% + }% + }% +} + +% Prints the preceding subsection numbers +\newcommand{\ssprinter}{\thesection} +\newcommand{\generateSubsection}{% + \ifthenelse{\equal{\subsectionnumbering}{section}}{% + \renewcommand{\ssprinter}{\thesection} + }{% + \ifthenelse{\equal{\subsectionnumbering}{subsection}}{% + \renewcommand{\ssprinter}{\thesubsection} + }{% + \ifthenelse{\equal{\subsectionnumbering}{subsubsection}}{% + \renewcommand{\ssprinter}{\thesubsubsection} + }{% + \ifthenelse{\equal{\subsectionnumbering}{paragraph}}{% + \renewcommand{\ssprinter}{\theparagraph} + }{ + \renewcommand{\ssprinter}{} + }% + }% + }% + }% +} +\loadNumberingConfiguration + +\AtBeginEnvironment{table}{\preEnvHook{table}} +\AtBeginEnvironment{figure}{\preEnvHook{figure}} + + % ── Set the current number of a label ─────────────────────────────── \newcommand{\setLabelNumber}[2]{% \setcounter{#1none}{#2}% @@ -1147,88 +1218,6 @@ } -% ┌ ┐ -% │ Counter numbering │ -% └ ┘ -\newcommand{\preEnvHook}[1]{% - \stepLabelNumber{combined}% - \ifthenelse{\equal{\numberingpreset}{combined}}{% - \ifthenelse{\equal{\printNumberingConfigForDescriptor{#1}}{default}}{ - \stepLabelNumber{combined}% - }{}% - }{% - \ifthenelse{\equal{\printNumberingConfigForDescriptor{#1}}{combined}}{% - \stepLabelNumber{combined}% - }{}% - }% -} - -% Decides on the numbering to use (combined or not) -\newcommand{\loadNumberingConfiguration}{% - \ifthenelse{\boolean{numberingDisabled}}{% - \renewcommand{\thetable}{\arabic{table}} - \renewcommand{\thefigure}{\arabic{figure}} - }{ - \ifthenelse{\equal{\numberingpreset}{combined}}{% - \ifthenelse{\equal{\subsectionnumbering}{none}}{ - \renewcommand{\thetable}{\arabic{combinednone}} - \renewcommand{\thefigure}{\arabic{combinednone}} - }{% - \renewcommand{\thetable}{\ssprinter.\arabic{combined\subsectionnumbering}} - \renewcommand{\thefigure}{\ssprinter.\arabic{combined\subsectionnumbering}} - }% - }{% - \ifthenelse{\equal{\numberingpreset}{separate}}{ - \ifthenelse{\equal{\subsectionnumbering}{none}}{}{ - \renewcommand{\thetable}{\ssprinter.\arabic{table}} - \renewcommand{\thefigure}{\ssprinter.\arabic{figure}} - } - }{% - \renewcommand{\thetable}{\arabic{table}} - \renewcommand{\thefigure}{\arabic{figure}} - }% - }% - }% -} - -% Prints the preceding subsection numbers -\newcommand{\ssprinter}{\thesection} -\newcommand{\generateSubsection}{% - \ifthenelse{\equal{\subsectionnumbering}{section}}{% - \renewcommand{\ssprinter}{\thesection} - }{% - \ifthenelse{\equal{\subsectionnumbering}{subsection}}{% - \renewcommand{\ssprinter}{\thesubsection} - }{% - \ifthenelse{\equal{\subsectionnumbering}{subsubsection}}{% - \renewcommand{\ssprinter}{\thesubsubsection} - }{% - \ifthenelse{\equal{\subsectionnumbering}{paragraph}}{% - \renewcommand{\ssprinter}{\theparagraph} - }{ - \renewcommand{\ssprinter}{} - }% - }% - }% - }% -} -\loadNumberingConfiguration - -\AtBeginEnvironment{table}{\preEnvHook{table}} -\AtBeginEnvironment{figure}{\preEnvHook{figure}} - - -% ┌ ┐ -% │ STYLE: Math │ -% └ ┘ - -% Add shortcuts to commonly used commands -\newcommand{\vect}[1]{\overrightarrow{#1}} -\renewcommand{\hat}[1]{\widehat{#1}} -\renewcommand{\tilde}[1]{\widetilde{#1}} -\newcommand{\proven}{$\hspace{17cm}\square$} - - \newcommand{\noverticalspacing}{ \abovedisplayskip 1pt plus 2pt minus 1pt \belowdisplayskip 1pt plus 2pt minus 1pt @@ -1255,40 +1244,6 @@ } -% ── Inline environments ───────────────────────────────────────────── -% TODO: ref label generation -\newcommand{\inline}[2][NONAME]{% - \ifthenelse{\equal{NONAME}{#1}}{% - \anonymousInlineDescriptorTemplate{#2}{\printLabel{#2}}% - }{% - \inlineDescriptorTemplate{#2}{\printLabel{#2}}{#1}% - }% -} - -\newcommand{\labeledInline}[3][NONAME]{% - \edef{\tempLabel}{#3} - \label{\tempLabel} - \inline[#1]{#2} -} - -\newcommand{\short}[2][NONAME]{% - \ifthenelse{\equal{NONAME}{#1}}{% - \anonymousShortDescriptorTemplate{#2}{\printLabel{#2}}% - }{% - \shortDescriptorTemplate{#2}{\printLabel{#2}}{#1}% - }% -} - -\newcommand{\labeledShort}[3][NONAME]{% - \edef{\tempLabel}{#3} - \label{\tempLabel} - \short[#1]{#2} -} - -\newcommand{\inlineproof}{\anonymousInlineDescriptorTemplate{proof}{}} -\newcommand{\shortproof}{\anonymousShortDescriptorTemplate{proof}{}} - - % ┌ ┐ % │ STYLE: Common tcolorboxes │ % └ ┘ @@ -1340,6 +1295,51 @@ \newtcolorbox{simplebox}[2][]{colback=#2!5!white,colframe=#2!75!black,#1} +% ── Inline environments ───────────────────────────────────────────── +% TODO: ref label generation +\newcommand{\inline}[2][NONAME]{% + \ifthenelse{\equal{NONAME}{#1}}{% + \anonymousInlineDescriptorTemplate{#2}{\printLabel{#2}}% + }{% + \inlineDescriptorTemplate{#2}{\printLabel{#2}}{#1}% + }% +} + +\newcommand{\labeledInline}[3][NONAME]{% + \edef{\tempLabel}{#3} + \label{\tempLabel} + \inline[#1]{#2} +} + +\newcommand{\short}[2][NONAME]{% + \ifthenelse{\equal{NONAME}{#1}}{% + \anonymousShortDescriptorTemplate{#2}{\printLabel{#2}}% + }{% + \shortDescriptorTemplate{#2}{\printLabel{#2}}{#1}% + }% +} + +\newcommand{\labeledShort}[3][NONAME]{% + \edef{\tempLabel}{#3} + \label{\tempLabel} + \short[#1]{#2} +} + +\newcommand{\inlineproof}{\anonymousInlineDescriptorTemplate{proof}{}} +\newcommand{\shortproof}{\anonymousShortDescriptorTemplate{proof}{}} + + +% ┌ ┐ +% │ STYLE: Math │ +% └ ┘ + +% Add shortcuts to commonly used commands +\newcommand{\vect}[1]{\overrightarrow{#1}} +\renewcommand{\hat}[1]{\widehat{#1}} +\renewcommand{\tilde}[1]{\widetilde{#1}} +\newcommand{\proven}{$\hspace{17cm}\square$} + + % ┌ ┐ % │ STYLE: Computer Science │ % └ ┘ diff --git a/letter.tex b/letter.tex index 15c9a21..c387b12 100644 --- a/letter.tex +++ b/letter.tex @@ -30,12 +30,12 @@ % Define new letter header \setkomavar{firsthead}{ - \null\hfill - \parbox[t][\headheight][t]{4cm}{% - \vspace*{2cm} + \null\hfill + \parbox[t][\headheight][t]{4cm}{% + \vspace*{2cm} - \usekomavar{fromname} \newline - \usekomavar{fromaddress} \newline - \usekomavar{fromplace} - } + \usekomavar{fromname} \newline + \usekomavar{fromaddress} \newline + \usekomavar{fromplace} + } }%