[Docs] Finish migration guide

This commit is contained in:
2026-02-22 10:16:09 +01:00
parent 2f12f17c4e
commit d0541b4ce7
7 changed files with 41 additions and 13 deletions

View File

@@ -31,6 +31,7 @@ These commands have to be executed inside math environment
\subsubsection{Code}
\label{sec:minted}
If you get compilation errors, be sure to enable \texttt{-shell-escape} for your compiler.
\textit{(Note: Some newer versions of LaTeX do no longer require this and it is better to keep it turned off for security reasons, if it works without)}!

View File

@@ -24,6 +24,8 @@ All these have to be executed in the math environment.
\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|\sequence|\{\textit{math}\} Sequence, $\sequence{x}$
\item \verb|\series|\{\textit{math}\}\{\textit{math}\} Series, prints \verb|\series{x}{2x}| as, $\series{x}{2x}$
\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}

View File

@@ -1,7 +1,12 @@
\newpage
\subsubsection{Inline \& Shortened descriptors}
\label{sec:descriptors}
See \ref{sec:counters} for a guide on how to change the current number.
The signature is \verb|\inlinedefinition|[\textit{description}], where the description is optional (and if you omit it, don't write the square brackets!)
Alternatively, you can use \verb|\inline[desc]{definition}|.
\paragraph{Inline}
\begin{tables}{ll}{Command & Output}
\verb|\inlineexample| & \inlineexample \\
@@ -48,10 +53,8 @@ You may also use \verb|\stepLabelNumber|\{\textit{name of the environment}\} to
\subsubsection{Referencing counters}
\hl{\textit{With recent overhaul has not been re-introduced yet, will be a feature again soon, with some changes}}
If you wish to reference a counter, you can do so by writing
\verb|\ref{<counter name>:<section>-<subsection>-<subsubsection>-<counter value>}|,
or of course, if you do not label subsections and / or subsubsection, dropping them.
\label{sec:counter-ref}
If you wish to reference a counter, you can do so by using the \verb|\labeledInline| and \verb|\labeledShort|,
which have the following signature
\mint{latex}|\labeledInline[description]{<descriptor name>}{<your label>}|
where you can replace \verb|<your label>| with a label like \texttt{def:your-def-name}

View File

@@ -22,15 +22,15 @@ This doesn't use the \texttt{table} environment, so no captions are possible, as
\end{fullTable}
\end{minted}
% TODO: Get it working again (generate new \thetable and \thefigure) for
This outputs as
\begin{fullTable}{ll}{Left & Right}{This is a caption}
Left content & Right Content\\
\end{fullTable}
\subsection{Index}
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
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,
whereas using \verb|\addIndexBI|\{\textit{string}\}, it is printed in bold and italics