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

Add docs, finish up errors

Browse Source
This commit is contained in:
Admin
2025-01-07 10:38:36 +01:00
parent 9217ace0af
commit 0644caf2b2
28 changed files with 1010 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/main/docs.pdf Normal file
View File

Binary file not shown.

35
docs/main/docs.tex
View File

@@ -0,0 +1,35 @@
\documentclass{article}
\newcommand{\dir}{~/projects/latex}
\input{\dir/include.tex}
\load{full}
\setup{Docs - \LaTeX \hspace{0mm} helpers}
\setLang{en}
\begin{document}
\startDocument
\usetcolorboxes
\printtoc{Aquamarine}
\newpage
\section{Introduction}
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.
It has some configuration options already, but more are to come soon. If you have any suggestions as to what should be added, don't hesitate to open a support ticket at \url{https://support.janishutz.com?a=add} or contacting me via email to \texttt{development@janishutz.com}.
\section{Installation}
You can install these helper files by downloading this repo and storing it to any location on your PC, remembering where that location is.
You may also install the VSCode snippets found in the vscode-snippets folder. These snippets provide autocompletion for many of the commands that this helper file provides.
\input{./parts/usage.tex}
\input{./parts/custom-loader.tex}
\input{./parts/reference.tex}
\end{document}

6
docs/main/parts/custom-loader.tex Normal file
View File

@@ -0,0 +1,6 @@
\newsection
\section{Custom Loader}
You can create a custom loader by defining a \verb|load|\{\textit{string}\} macro (or any other, if you are aware you need to change that in your main file for it to work) that uses the \verb|\dir| command to resolve the custom parts.
Take a look at the \texttt{/include.tex} file for inspiration on how to do it, if you also want it to do case distinction.
You can also include some the pre-built configs from the \texttt{dist/} folder.

321
docs/main/parts/reference.tex Normal file
View File

@@ -0,0 +1,321 @@
\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!

60
docs/main/parts/usage.tex Normal file
View File

@@ -0,0 +1,60 @@
\newsection
\section{Usage}
You can type \texttt{latex-prepare} and press tab, if you have installed the VSCode snippets, or copy over this code snippet:
\begin{minted}{latex}
\documentclass{article}
\newcommand{\dir}{~/path/to/helper} % TODO: Change your path here! No trailing slashes!
\input{\dir/include.tex}
\load{recommended} % TODO: Change the inclusion level (if necessary), see below
\setup{Type your title here}
\begin{document}
\startDocument
Type your \LaTeX here
\end{document}
\end{minted}
The \verb|\load| command takes one parameter, which can be one of the following:
\begin{itemize}
\item \texttt{minimal} Just the core styling and core functionality.
\item \texttt{most} Includes Math, CS, Language and all styling.
\item \texttt{recommended} The recommended setup. Includes BibTeX in addition to what is in most
\item \texttt{all} If you want to also include glossaries or code with highlighting
\item \texttt{letter} If you want to typeset a letter (see \ref{sec:letters})
\end{itemize}
\subsection{Configuration}
You can set a global config in config file in helper files directory. The file is located at
\texttt{/<path to helpers>/config/config.tex}. All configs are documented there. Simply open that file using any text editor and edit your config.
\subsection{Letters}
\label{sec:letters}
Letters require a different setup compared to a normal \LaTeX document:
\begin{minted}{latex}
\documentclass[12pt,a4paper]{scrlttr2}
\newcommand{\dir}{~/path/to/helper} % TODO: Change your path here! No trailing slashes!
\input{\dir/include.tex}
\load{letter}
\setkomavar{subject}{} % type your subject here
\begin{document}\raggedright
% below, type the address, being careful not to remove the backslashes
\begin{letter}{Company \\ Name \\ Address \\ CH-Place}
\opening{Intro}
Your text
\closing{Kind regards} % Your closing sentence
\end{letter}
\end{document}
\end{minted}
If you are using the snippets, you can type \texttt{latex-letter} and press tab.