[Docs] Complete restructure
This commit is contained in:
74
docs/parts/reference/style/descriptors.tex
Normal file
74
docs/parts/reference/style/descriptors.tex
Normal file
@@ -0,0 +1,74 @@
|
||||
\newpage
|
||||
\subsubsection{Inline \& Shortened descriptors}
|
||||
\textit{Included in \texttt{most} and up}
|
||||
|
||||
See \ref{sec:counters} for a guide on how to change the current number.
|
||||
|
||||
\fhlc{Aquamarine}{Inline}
|
||||
\begin{tables}{ll}{Command & Output}
|
||||
\verb|\inlineex| & \inlineex \\
|
||||
\verb|\inlinedef| & \inlinedef \\
|
||||
\verb|\inlinetheorem| & \inlinetheorem \\
|
||||
\verb|\inlinelemma| & \inlinelemma \\
|
||||
\verb|\inlinecorollary| & \inlinecorollary \\
|
||||
\verb|\inlineproposition| & \inlineproposition \\
|
||||
\verb|\inlinefact| & \inlinefact \\
|
||||
\verb|\inlineaxiom| & \inlineaxiom \\
|
||||
\verb|\inlineremark| & \inlineremark \\
|
||||
\verb|\inlineproof| & \inlineproof \\
|
||||
\end{tables}
|
||||
|
||||
\fhlc{Aquamarine}{Shortened}
|
||||
\begin{tables}{ll}{Command & Output}
|
||||
\verb|\shortex| & \shortex \\
|
||||
\verb|\shortdef| & \shortdef \\
|
||||
\verb|\shorttheorem| & \shorttheorem \\
|
||||
\verb|\shortlemma| & \shortlemma \\
|
||||
\verb|\shortcorollary| & \shortcorollary \\
|
||||
\verb|\shortproposition| & \shortproposition \\
|
||||
\verb|\shortfact| & \shortfact \\
|
||||
\verb|\shortaxiom| & \shortaxiom \\
|
||||
\verb|\shortremark| & \shortremark \\
|
||||
\verb|\shortproof| & \shortproof \\
|
||||
\end{tables}
|
||||
\newpage
|
||||
|
||||
\fhlc{Aquamarine}{Inline (Named)}
|
||||
\begin{tables}{ll}{Command & Output}
|
||||
\verb|\fancyex|\{\textit{string}\} & \fancyex{Exercise} \\
|
||||
\verb|\fancydef|\{\textit{string}\} & \fancydef{Definition} \\
|
||||
\verb|\fancytheorem|\{\textit{string}\} & \fancytheorem{Theorem} \\
|
||||
\verb|\fancylemma|\{\textit{string}\} & \fancylemma{Lemma} \\
|
||||
\verb|\fancycorollary|\{\textit{string}\} & \fancycorollary{Corollary} \\
|
||||
\verb|\fancyproposition|\{\textit{string}\} & \fancyproposition{Proposition} \\
|
||||
\verb|\fancyfact|\{\textit{string}\} & \fancyfact{Fact} \\
|
||||
\verb|\fancyaxiom|\{\textit{string}\} & \fancyaxiom{Axiom} \\
|
||||
\verb|\fancyremark|\{\textit{string}\} & \fancyremark{Remark} \\
|
||||
\verb|\fancyproof|\{\textit{string}\} & \fancyproof{Proof} \\
|
||||
\end{tables}
|
||||
|
||||
\fhlc{Aquamarine}{Shortened (Named)}
|
||||
\begin{tables}{ll}{Command & Output}
|
||||
\verb|\compactex|\{\textit{string}\} & \compactex{Exercise} \\
|
||||
\verb|\compactdef|\{\textit{string}\} & \compactdef{Definition} \\
|
||||
\verb|\compacttheorem|\{\textit{string}\} & \compacttheorem{Theorem} \\
|
||||
\verb|\compactlemma|\{\textit{string}\} & \compactlemma{Lemma} \\
|
||||
\verb|\compactcorollary|\{\textit{string}\} & \compactcorollary{Corollary} \\
|
||||
\verb|\compactproposition|\{\textit{string}\} & \compactproposition{Proposition} \\
|
||||
\verb|\compactfact|\{\textit{string}\} & \compactfact{Fact} \\
|
||||
\verb|\compactaxiom|\{\textit{string}\} & \compactaxiom{Axiom} \\
|
||||
\verb|\compactremark|\{\textit{string}\} & \compactremark{Remark} \\
|
||||
\verb|\compactproof|\{\textit{string}\} & \compactproof{Proof} \\
|
||||
\end{tables}
|
||||
|
||||
|
||||
\subsubsection{Changing the counters}
|
||||
\label{sec:counters}
|
||||
\textit{Included in \texttt{most} and up}
|
||||
|
||||
You may set the current number for the elements by setting their corresponding counter to the selected number.
|
||||
You can do this using \verb|\setcounter|\{\textit{name of the counter}\}\{\textit{number}\}, where you replace \textit{name of the counter} with one of the following:
|
||||
\texttt{definitions}, \texttt{lemmas}, \texttt{theorems}, \texttt{corollaries}, \texttt{propositions}, \texttt{facts}, \texttt{axioms}, \texttt{examples}, \texttt{remarks}
|
||||
|
||||
This only applies if you have set numberingConfig to $1$ (for all of them) and $2$ (only for \texttt{definitions}).
|
||||
To change the combined numbering, set \texttt{all} to your desired number.
|
||||
15
docs/parts/reference/style/intro.tex
Normal file
15
docs/parts/reference/style/intro.tex
Normal file
@@ -0,0 +1,15 @@
|
||||
\newpage
|
||||
\subsection{Style}
|
||||
General styling commands. All other commands, except these ones require at least \texttt{most} to be the selected \textit{scope}
|
||||
\begin{itemize}
|
||||
\item \verb|\TODO| Print a highlighted \TODO
|
||||
\item \verb|\background|\{\textit{color}\}\{\textit{number}\}\{\textit{string}\} Print \background{ForestGreen}{50}{shaded text, with colour saturation}
|
||||
\item \verb|\shade|\{\textit{color}\}\{\textit{string}\} Print \shade{ForestGreen}{shaded text}
|
||||
\item \verb|\backdrop|\{\textit{string}\} Print \backdrop{text with gray backdrop}
|
||||
\item \verb|\fhlc|\{\textit{color}\}\{\textit{string}\} Print \fhlc{ForestGreen}{bold, underlined text in a coloured box}
|
||||
\item \verb|\fhl|\{\textit{string}\} Print \fhl{bold, underlined text in a white box}
|
||||
\item \verb|\printtoc|\{\textit{color}\} Print the table of contents (as seen on the first page). The normal \verb|\tableofcontents| still works as expected
|
||||
\item \verb|\smallhspace| Prints a 2mm hspace
|
||||
\item \verb|\mediumhspace| Prints a 5mm hspace
|
||||
\item \verb|\largehspace| Prints a 10mm = 1cm hspace
|
||||
\end{itemize}
|
||||
79
docs/parts/reference/style/tcolorbox/counter.tex
Normal file
79
docs/parts/reference/style/tcolorbox/counter.tex
Normal file
@@ -0,0 +1,79 @@
|
||||
\vspace{1cm}
|
||||
\fhlc{Aquamarine}{Counter-enabled}
|
||||
|
||||
These ones also have two settings, namely, you can change the counter behaviour and the inclusion of subsections in the numbering. See \ref{sec:perFileConf}.
|
||||
|
||||
See \ref{sec:counters} for a guide on how to change the current number.
|
||||
|
||||
\begin{definition}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{definition}[]{Title here}
|
||||
|
||||
\end{definition}
|
||||
\end{minted}
|
||||
\end{definition}
|
||||
|
||||
\begin{theorem}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{theorem}[]{Title here}
|
||||
|
||||
\end{theorem}
|
||||
\end{minted}
|
||||
\end{theorem}
|
||||
|
||||
\begin{lemma}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{lemma}[]{Title here}
|
||||
|
||||
\end{lemma}
|
||||
\end{minted}
|
||||
\end{lemma}
|
||||
|
||||
\begin{corollary}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{corollary}[]{Title here}
|
||||
|
||||
\end{corollary}
|
||||
\end{minted}
|
||||
\end{corollary}
|
||||
|
||||
\begin{proposition}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{proposition}[]{Title here}
|
||||
|
||||
\end{proposition}
|
||||
\end{minted}
|
||||
\end{proposition}
|
||||
|
||||
\newpage
|
||||
\begin{fact}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{fact}[]{Title here}
|
||||
|
||||
\end{fact}
|
||||
\end{minted}
|
||||
\end{fact}
|
||||
|
||||
\begin{axiom}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{axiom}[]{Title here}
|
||||
|
||||
\end{axiom}
|
||||
\end{minted}
|
||||
\end{axiom}
|
||||
|
||||
\begin{example}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{example}[]{Title here}
|
||||
|
||||
\end{example}
|
||||
\end{minted}
|
||||
\end{example}
|
||||
|
||||
\begin{remark}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{remark}[]{Title here}
|
||||
|
||||
\end{remark}
|
||||
\end{minted}
|
||||
\end{remark}
|
||||
90
docs/parts/reference/style/tcolorbox/default.tex
Normal file
90
docs/parts/reference/style/tcolorbox/default.tex
Normal file
@@ -0,0 +1,90 @@
|
||||
\newpage
|
||||
\subsubsection{Tcolorboxes}
|
||||
\textit{Included in \texttt{most} and up}
|
||||
|
||||
Put \verb|\usetcolorboxes| right after \verb|\startDocument| (right after \verb|\begin{document}|) if you plan to use them.
|
||||
|
||||
\fhlc{Aquamarine}{General}
|
||||
\begin{terms}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{terms}[]{Title here}
|
||||
|
||||
\end{terms}
|
||||
\end{minted}
|
||||
\end{terms}
|
||||
|
||||
\begin{notation}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{notation}[]{Title here}
|
||||
|
||||
\end{notation}
|
||||
\end{minted}
|
||||
\end{notation}
|
||||
|
||||
\begin{recall}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{recall}[]{Title here}
|
||||
|
||||
\end{recall}
|
||||
\end{minted}
|
||||
\end{recall}
|
||||
|
||||
\begin{remarks}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{remarks}[]{Title here}
|
||||
|
||||
\end{remarks}
|
||||
\end{minted}
|
||||
\end{remarks}
|
||||
|
||||
\begin{usage}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{usage}[]{Title here}
|
||||
|
||||
\end{usage}
|
||||
\end{minted}
|
||||
\end{usage}
|
||||
|
||||
\begin{guides}[]{Title here}{Tutorial}
|
||||
\begin{minted}{latex}
|
||||
\begin{guides}[]{Title here}{Tutorial}
|
||||
% You can also change the right title on this one
|
||||
|
||||
\end{guides}
|
||||
\end{minted}
|
||||
\end{guides}
|
||||
|
||||
\begin{properties}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{properties}[]{Title here}
|
||||
|
||||
\end{properties}
|
||||
\end{minted}
|
||||
\end{properties}
|
||||
|
||||
\begin{restrictions}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{restrictions}[]{Title here}
|
||||
|
||||
\end{restrictions}
|
||||
\end{minted}
|
||||
\end{restrictions}
|
||||
|
||||
\begin{limitations}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{limitations}[]{Title here}
|
||||
|
||||
\end{limitations}
|
||||
\end{minted}
|
||||
\end{limitations}
|
||||
|
||||
|
||||
|
||||
\fhlc{Aquamarine}{Math-Specific}
|
||||
\begin{formula}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{formula}[]{Title here}
|
||||
|
||||
\end{formula}
|
||||
\end{minted}
|
||||
\end{formula}
|
||||
32
docs/parts/reference/style/tcolorbox/other.tex
Normal file
32
docs/parts/reference/style/tcolorbox/other.tex
Normal file
@@ -0,0 +1,32 @@
|
||||
\newpage
|
||||
\fhlc{Aquamarine}{Language-Specific}
|
||||
\begin{conjugation}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{conjugation}[]{Title here}
|
||||
|
||||
\end{conjugation}
|
||||
\end{minted}
|
||||
\end{conjugation}
|
||||
|
||||
\begin{forms}[]{Title here}
|
||||
\begin{minted}{latex}
|
||||
\begin{forms}[]{Title here}
|
||||
|
||||
\end{forms}
|
||||
\end{minted}
|
||||
\end{forms}
|
||||
|
||||
|
||||
\fhlc{Aquamarine}{CS-Specific}
|
||||
\textit{Coming soon!}
|
||||
|
||||
|
||||
\fhlc{Aquamarine}{Flexible}
|
||||
\begin{general}[]{title}{second title}{red}
|
||||
This Tcolorbox is flexible and can take any main and secondary title, as well as any colour.\\
|
||||
\begin{minted}{latex}
|
||||
\begin{general}[]{title}{second title}{red}
|
||||
|
||||
\end{general}
|
||||
\end{minted}
|
||||
\end{general}
|
||||
Reference in New Issue
Block a user