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

[Docs] Update

Browse Source
This commit is contained in:
Janis Hutz
2026-02-21 16:57:56 +01:00
parent 96739ec7eb
commit 14e3825368
5 changed files with 8 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/docs.pdf
View File

Binary file not shown.

6
docs/docs.tex
View File

@@ -50,9 +50,7 @@
\input{./parts/reference/style/tcolorbox/other.tex}
\input{./parts/reference/style/descriptors.tex}
\input{./parts/reference/tables-index.tex}
% \input{./parts/reference/extras.tex}
%
%
% \input{./parts/troubleshooting.tex}
\input{./parts/reference/extras.tex}
\input{./parts/troubleshooting.tex}
\end{document}

5
docs/parts/reference/extras.tex
View File

@@ -1,10 +1,9 @@
\newpage
\section{BibTeX}
\subsection{BibTeX}
Use \verb|\setupBiber|\{\textit{/path/to/your/bib/sources.bib file}\} in the preamble to prepare, then use \verb|\printbib| to print your bibliography.
To add more sources, simply use bibter's built-in macro \verb|\addbibresource|\textit{\{filepath\}}, which will load your \texttt{.bib} file.
You need to use that inside the preamble as well.
\section{Glossary}
\subsection{Glossary}
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|.

4
docs/parts/reference/style/spacing.tex
View File

@@ -20,7 +20,9 @@ See \hlhref{https://www.overleaf.com/learn/latex/\%5Cabovedisplayskip_and_relate
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}\
and \hlhref{https://www.overleaf.com/learn/latex/Articles/How_to_change_paragraph_spacing_in_LaTeX}{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}|
To make use of \TeX's automatic wrapping of short alignment environments, use the \texttt{aligned}
(or, if no alignment is needed, use the normal \verb|\[ <math> \]|) instead of the \texttt{align} environment for short equations.

16
docs/parts/troubleshooting.tex
View File

@@ -3,27 +3,13 @@
\subsection{Visual Errors}
\subsubsection{Missing headers \& footers}
You have most likely forgotten about \verb|\startDocument| after \verb|\begin{document}|, or you are using \verb|\setupbarebones| or \verb|\setupexams|.
You have most likely forgotten about \verb|\startDocument| after \verb|\begin{document}|, or you are using \verb|\setupBarebones| or \verb|\setupexams|.
You can easily distinguish from simply looking at the PDF. If the title is missing too, it's the first one, if it is there, it is most likely the second.
\subsubsection{Right box of guides tcolorbox is a weird title}
You have most likely forgotten about the second argument. Then, the first letter is removed from the body and used as the title.
\subsection{pgfkeys: Don't know mainboxstyle}
You have most likely forgotten about \verb|\usetcolorboxes| after \verb|\startDocument|.
\subsection{Numbering incorrect after numberingOn}
Check the start of the document and make sure you have used \verb|\setNumberingStyle| to set the numbering style and not
\verb|\setcounter{numberingConfig}|
\subsection{Undefined commands}
You have most likely loaded a too small \textit{scope}
\subsection{Lots of errors and no compile}
You have most likely selected a non-existant \textit{scope} in the \verb|\load| function. You can verify by searching the \texttt{<document name>.log} file for any mention of \texttt{INVALID CONFIG SPECIFIED, NOTHING LOADED!}
\subsection{Minted}
\texttt{minted} is a syntax highlighting library. It can cause issues when running, as it needs extra configuration for the compiler.