janishutz/latex
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Counters] Finish up, add docs for them

Browse Source
This commit is contained in:
Janis Hutz
2025-10-18 13:27:45 +02:00
parent 94884a3646
commit c8a2209999
5 changed files with 45 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/docs.tex
View File

@@ -13,7 +13,7 @@
\vspace{4cm}
\begin{center}
\includegraphics[width=0.5\linewidth]{../assets/logo.jpg}
\includegraphics[width=0.5\linewidth]{../assets/logo.jpg}
\end{center}
\newpage
@@ -26,10 +26,26 @@ This set of \LaTeX files is designed to give you a good looking, pre-configured
It has some configuration options already, but more are to come soon. If you have any suggestions as to what should be added, don't hesitate to open a support ticket at \url{https://support.janishutz.com?a=add} or contacting me via email to \texttt{development@janishutz.com}.
\begin{Large}
\shade{red}{Breaking Changes}: The timecomplexity commands have been updated to require math environment. You can use the following regex to fix them
\verb|:%s/ \\tc\([olt]\){\(.*)}\([, .\n]\)/ \$\\tc\1{\2}\$\3/g| (execute first) and \verb|:%s/\\text{\\tc\([olt]\){\(.*\)}}/\\tc\1{\2}/g|
\end{Large}
\section{Breaking Changes}
Please note that the regex provided below are for NeoVim and you may need to replace \verb|\(\)| with \verb|()|
\subsection{Time complexity}
The timecomplexity commands have been updated to require math environment. You can use the following regex to fix them
\verb|/ \\tc\([olt]\){\(.*)}\([, .\n]\)/ \$\\tc\1{\2}\$\3/g| (execute first)\\
and \verb|/\\text{\\tc\([olt]\){\(.*\)}}/\\tc\1{\2}/g|
\subsection{Labels \& Environments}
The counter environments can now be referenced (see \ref{sec:counters}).
Due to the new requirements set out by that addition, it is now no longer possible to manually update the counters using
\verb|\setcounter|.
Use the below regex to replace all occurrences of \verb|\setcounter| with the new format.
Please note that this will overwrite \textit{all} occurrences of \verb|\setcounter| with the specific old format with \verb|\setLabelNumber|:
\verb|/\\setcounter{\(.*\)s}/\\setLabelNumber{\1}/g| and \verb|/\\setcounter{all}/\\setLabelNumber{all}/g|
and for the \verb|\stepcounter| as well
\verb|/\\stepcounter{\(.*\)s}/\\stepLabelNumber{\1}| and \verb|/\\stepcounter{all}/\\stepLabelNumber{all}/g|.
\section{Installation}