diff --git a/docs/docs.pdf b/docs/docs.pdf index d8299f5..0404d52 100644 Binary files a/docs/docs.pdf and b/docs/docs.pdf differ diff --git a/docs/docs.tex b/docs/docs.tex index 586c611..f115a08 100644 --- a/docs/docs.tex +++ b/docs/docs.tex @@ -36,6 +36,7 @@ % └ ┘ \input{./parts/intro.tex} \input{./parts/usage.tex} +\input{./parts/migration.tex} % ── Reference ─────────────────────────────────────────────────────── diff --git a/docs/parts/migration.tex b/docs/parts/migration.tex index c3d257a..2591dfd 100644 --- a/docs/parts/migration.tex +++ b/docs/parts/migration.tex @@ -1,7 +1,28 @@ -\section{Migration von janishutz-helpers V1.X} -Please be aware that this section might be missing some details +\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} diff --git a/docs/parts/reference/cs.tex b/docs/parts/reference/cs.tex index a2bf0e6..3d225e6 100644 --- a/docs/parts/reference/cs.tex +++ b/docs/parts/reference/cs.tex @@ -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)}! diff --git a/docs/parts/reference/math.tex b/docs/parts/reference/math.tex index 62aa5bb..eaed251 100644 --- a/docs/parts/reference/math.tex +++ b/docs/parts/reference/math.tex @@ -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} diff --git a/docs/parts/reference/style/descriptors.tex b/docs/parts/reference/style/descriptors.tex index 83b0eb3..a01e3b5 100644 --- a/docs/parts/reference/style/descriptors.tex +++ b/docs/parts/reference/style/descriptors.tex @@ -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{:
---}|, - -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]{}{}| +where you can replace \verb|| with a label like \texttt{def:your-def-name} diff --git a/docs/parts/reference/tables-index.tex b/docs/parts/reference/tables-index.tex index 627167b..4ccbcfe 100644 --- a/docs/parts/reference/tables-index.tex +++ b/docs/parts/reference/tables-index.tex @@ -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