Update docs (mostly), fixes, etc
Some checks failed
Update docs / build_docs (push) Has been cancelled
Update helpers / build_helpers (push) Successful in 25s

This commit is contained in:
2026-02-21 16:24:21 +01:00
parent 2a592753bf
commit baebaa99d0
45 changed files with 1038 additions and 691 deletions

View File

@@ -5,9 +5,7 @@ You can type \texttt{latex-prepare} and press tab, if you have installed the VSC
\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
\input{~/path/to/helpers/janishutz-helpers.tex} % TODO: Change your path here
\setup{Type your title here}
@@ -19,30 +17,26 @@ 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
You can set a global config in the config files in the helper files directory. They are located at
\texttt{/<path to helpers>/config/}.
All config options are documented there.
After changing them, run \texttt{build.sh} in the main directory.
Each of the options can also be overridden directly on a per-document
(see \ref{sec:perFileConf}) basis using
\mint{latex}|\renewcommand{\<command>}{<value>}|
\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}
\input{~/path/to/helper/letter.tex} % TODO: Change your path here
\setkomavar{subject}{} % type your subject here
\begin{document}\raggedright