29 lines
2.6 KiB
TeX
29 lines
2.6 KiB
TeX
\newpage
|
|
\section{Migration from janishutz-helpers V1.X}
|
|
\label{sec:migration}
|
|
The updated helpers do not feature scopes anymore.
|
|
You can continue using the old helpers, simply check out the \texttt{v1} branch, using \texttt{git checkout v1}.
|
|
To switch back to the latest version, run \texttt{git checkout main}
|
|
|
|
\begin{enumerate}
|
|
\item Update the import path to \texttt{/path/to/helpers/janishutz-helpers.tex}
|
|
\item If you don't plan to change the design of your cheat sheet, then replace \verb|\setupCheatSheet|\{\textit{string}\} with \verb|\setupCheatSheet[false]|\{\textit{string}\}
|
|
\item Remove \verb|\usetcolorboxes| if it was used (now integrated into \verb|\startDocument|)
|
|
\item Replace any \verb|\setNumberingStyle|\{\textit{number}\} with \verb|\setnumberingpreset|\{\textit{preset}\} (see \ref{sec:perFileConf})
|
|
\item Replace any \verb|\setSubsectionNumbering|\{\textit{number}\} with \verb|\setsubsectionnumbering|\{\textit{preset}\}
|
|
\item Remove any \verb|\drmvspace| and the like, they have been deprecated. \verb|\rmvspace|[\textit{number}] is still around, but only for edge cases,
|
|
where the \texttt{Xverticalspacing} (\texttt{X} can be replaced with \texttt{no}, \texttt{small}, \texttt{medium} or \texttt{large}) commands don't do a good enough job.
|
|
\item \verb|\fhlc| and \verb|\fhl| have been removed. The closes replacement is \verb|\shade|.
|
|
\item Environments \texttt{remarks}, \texttt{conjugation}, \texttt{forms} and \texttt{guides} have been removed
|
|
\item All descriptors no longer automatically have a label attached to them.
|
|
If you want to make a label \texttt{ref}able, then use \verb|\labeledShort|, or \verb|\labeledInline|, respectively (see \ref{sec:counter-ref}).
|
|
\item The descriptors \verb|\shortdef| and \verb|\shortex| have been renamed to \verb|\shortdefinition| and \verb|\shortexample| (same for the inline versions)
|
|
\item The descriptors \verb|\fancyY| and \verb|\compactY| (where Y is a type like \texttt{definition}) have been removed
|
|
and you can now use an optional argument on the descriptors. See \ref{sec:descriptors}
|
|
\item The deprecated \verb|\tc| and \verb|\timecomplexity| commands have been removed.
|
|
\item Was not mentioned, but was already possible, is to import code from a source code file. See \ref{sec:minted}
|
|
\item \verb|\der|, \verb|\parder|, etc. have been renamed to \verb|\diff|, \verb|\pardiff|, etc
|
|
\item \verb|\divides| has been renamed \verb|\divider|
|
|
\item \verb|\seq| and \verb|\ser| have been renamed \verb|\sequence| and \verb|\series| resepctively
|
|
\end{enumerate}
|