diff --git a/docs/docs.pdf b/docs/docs.pdf index 1732ecb..d8299f5 100644 Binary files a/docs/docs.pdf and b/docs/docs.pdf differ diff --git a/docs/docs.tex b/docs/docs.tex index 3aeebd7..586c611 100644 --- a/docs/docs.tex +++ b/docs/docs.tex @@ -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} diff --git a/docs/parts/reference/extras.tex b/docs/parts/reference/extras.tex index 34174a4..d0cef60 100644 --- a/docs/parts/reference/extras.tex +++ b/docs/parts/reference/extras.tex @@ -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|. diff --git a/docs/parts/reference/style/spacing.tex b/docs/parts/reference/style/spacing.tex index 5a589d1..fd4dba4 100644 --- a/docs/parts/reference/style/spacing.tex +++ b/docs/parts/reference/style/spacing.tex @@ -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|\[ \]|) instead of the \texttt{align} environment for short equations. diff --git a/docs/parts/troubleshooting.tex b/docs/parts/troubleshooting.tex index 06c9eb5..5697d1c 100644 --- a/docs/parts/troubleshooting.tex +++ b/docs/parts/troubleshooting.tex @@ -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{.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.