diff options
author | Karl Berry <karl@freefriends.org> | 2024-12-05 21:23:16 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-12-05 21:23:16 +0000 |
commit | 54b2e6fd5a5941cc11c66ea9523a537b57fd4952 (patch) | |
tree | ba31daff3410eb858e7dff7fb89598630af2f007 /Master | |
parent | 3afacda52e5f6b4534279c4441e08fc716b9fc20 (diff) |
tutodoc (5dec24)
git-svn-id: svn://tug.org/texlive/trunk@73047 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
33 files changed, 2214 insertions, 1438 deletions
diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf Binary files differindex e4bed6a6c11..531e5711e4d 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex index c35343b020e..de0b4f1732b 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex @@ -4,90 +4,128 @@ \begin{filecontents*}[overwrite]{gallery-showcase-bw.tex} -\documentclass[10pt, a4paper, theme = bw]{tutodoc} +\documentclass[theme = bw]{tutodoc} + +% -- FORDOC -- % + +\usepackage{multicol} \newcommand\thisstyle{bw} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} - In the flow of text, it's always useful to be able to include examples and comments that complement the main content. + \tdocversion{1.7.0}[2024-12-04] + In the flow of the text, it is always useful to be able to indicate examples and comments to supplement the main content. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] - Depending on the context of use, it is sometimes necessary to highlight content by indicating its degree of importance. + Depending on the context of use, it is sometimes necessary to be able to highlight content by indicating its degree of importance. } \newcommand\myhighlightedtext{ - What to say\,% + What to say \footnote{ Let's not forget the footnotes... }? - I don't know, but in any case, it seems like a nice idea to show what can be achieved with one layout or another. No ? + I don't know, but it's nice. No ? } + \begin{document} -{\Huge\bfseries The theme \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries The theme \texttt{"\thisstyle"}} -\section{Highlighting, versioning and dating} -\ExplSyntaxOn +\section{Links} + +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{A very large link}}, but at least you can see it. -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} - \myexrmktext +\section{Highlight, version and date} + +\subsection{tdocexa, tdocrem} + +\myexrmktext + +\ExplSyntaxOn + +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff -\section{\LaTeX\ codes} -It is essential to be able to demonstrate use cases in \LaTeX. +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{New demo section...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + +\section{LaTeX codes} + +Typing an inline code such as \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} is useful, as is demonstrating use cases such as the following one. \begin{tdoclatex} -It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Seeing \LaTeX\ code formatted is nice: $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} There's also a less intrusive side-by-side mode. Nice! No ? \begin{tdoclatex}[sbs] -It's nice to see some formatted \LaTeX\ code: +Seeing \LaTeX\ code formatted is nice: \\ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} @@ -96,90 +134,128 @@ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{filecontents*} \begin{filecontents*}[overwrite]{gallery-showcase-color.tex} -\documentclass[10pt, a4paper, theme = color]{tutodoc} +\documentclass[theme = color]{tutodoc} + +% -- FORDOC -- % + +\usepackage{multicol} \newcommand\thisstyle{color} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} - In the flow of text, it's always useful to be able to include examples and comments that complement the main content. + \tdocversion{1.7.0}[2024-12-04] + In the flow of the text, it is always useful to be able to indicate examples and comments to supplement the main content. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] - Depending on the context of use, it is sometimes necessary to highlight content by indicating its degree of importance. + Depending on the context of use, it is sometimes necessary to be able to highlight content by indicating its degree of importance. } \newcommand\myhighlightedtext{ - What to say\,% + What to say \footnote{ Let's not forget the footnotes... }? - I don't know, but in any case, it seems like a nice idea to show what can be achieved with one layout or another. No ? + I don't know, but it's nice. No ? } + \begin{document} -{\Huge\bfseries The theme \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries The theme \texttt{"\thisstyle"}} -\section{Highlighting, versioning and dating} -\ExplSyntaxOn +\section{Links} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{A very large link}}, but at least you can see it. - \myexrmktext + +\section{Highlight, version and date} + +\subsection{tdocexa, tdocrem} + +\myexrmktext + +\ExplSyntaxOn + +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff -\section{\LaTeX\ codes} -It is essential to be able to demonstrate use cases in \LaTeX. +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{New demo section...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + +\section{LaTeX codes} + +Typing an inline code such as \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} is useful, as is demonstrating use cases such as the following one. \begin{tdoclatex} -It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Seeing \LaTeX\ code formatted is nice: $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} There's also a less intrusive side-by-side mode. Nice! No ? \begin{tdoclatex}[sbs] -It's nice to see some formatted \LaTeX\ code: +Seeing \LaTeX\ code formatted is nice: \\ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} @@ -188,90 +264,128 @@ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{filecontents*} \begin{filecontents*}[overwrite]{gallery-showcase-dark.tex} -\documentclass[10pt, a4paper, theme = dark]{tutodoc} +\documentclass[theme = dark]{tutodoc} + +% -- FORDOC -- % + +\usepackage{multicol} \newcommand\thisstyle{dark} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} - In the flow of text, it's always useful to be able to include examples and comments that complement the main content. + \tdocversion{1.7.0}[2024-12-04] + In the flow of the text, it is always useful to be able to indicate examples and comments to supplement the main content. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] - Depending on the context of use, it is sometimes necessary to highlight content by indicating its degree of importance. + Depending on the context of use, it is sometimes necessary to be able to highlight content by indicating its degree of importance. } \newcommand\myhighlightedtext{ - What to say\,% + What to say \footnote{ Let's not forget the footnotes... }? - I don't know, but in any case, it seems like a nice idea to show what can be achieved with one layout or another. No ? + I don't know, but it's nice. No ? } + \begin{document} -{\Huge\bfseries The theme \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries The theme \texttt{"\thisstyle"}} -\section{Highlighting, versioning and dating} -\ExplSyntaxOn +\section{Links} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{A very large link}}, but at least you can see it. - \myexrmktext + +\section{Highlight, version and date} + +\subsection{tdocexa, tdocrem} + +\myexrmktext + +\ExplSyntaxOn + +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff -\section{\LaTeX\ codes} -It is essential to be able to demonstrate use cases in \LaTeX. +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{New demo section...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + +\section{LaTeX codes} + +Typing an inline code such as \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} is useful, as is demonstrating use cases such as the following one. \begin{tdoclatex} -It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Seeing \LaTeX\ code formatted is nice: $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} There's also a less intrusive side-by-side mode. Nice! No ? \begin{tdoclatex}[sbs] -It's nice to see some formatted \LaTeX\ code: +Seeing \LaTeX\ code formatted is nice: \\ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} @@ -280,90 +394,128 @@ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{filecontents*} \begin{filecontents*}[overwrite]{gallery-showcase-draft.tex} -\documentclass[10pt, a4paper, theme = draft]{tutodoc} +\documentclass[theme = draft]{tutodoc} + +% -- FORDOC -- % + +\usepackage{multicol} \newcommand\thisstyle{draft} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} - In the flow of text, it's always useful to be able to include examples and comments that complement the main content. + \tdocversion{1.7.0}[2024-12-04] + In the flow of the text, it is always useful to be able to indicate examples and comments to supplement the main content. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] - Depending on the context of use, it is sometimes necessary to highlight content by indicating its degree of importance. + Depending on the context of use, it is sometimes necessary to be able to highlight content by indicating its degree of importance. } \newcommand\myhighlightedtext{ - What to say\,% + What to say \footnote{ Let's not forget the footnotes... }? - I don't know, but in any case, it seems like a nice idea to show what can be achieved with one layout or another. No ? + I don't know, but it's nice. No ? } + \begin{document} -{\Huge\bfseries The theme \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries The theme \texttt{"\thisstyle"}} -\section{Highlighting, versioning and dating} -\ExplSyntaxOn +\section{Links} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{A very large link}}, but at least you can see it. - \myexrmktext + +\section{Highlight, version and date} + +\subsection{tdocexa, tdocrem} + +\myexrmktext + +\ExplSyntaxOn + +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff -\section{\LaTeX\ codes} -It is essential to be able to demonstrate use cases in \LaTeX. +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{New demo section...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + +\section{LaTeX codes} + +Typing an inline code such as \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} is useful, as is demonstrating use cases such as the following one. \begin{tdoclatex} -It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Seeing \LaTeX\ code formatted is nice: $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} There's also a less intrusive side-by-side mode. Nice! No ? \begin{tdoclatex}[sbs] -It's nice to see some formatted \LaTeX\ code: +Seeing \LaTeX\ code formatted is nice: \\ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{tdoclatex} @@ -372,19 +524,40 @@ $E = m c^2$ or $\pi \neq \frac{3}{14}$. \end{filecontents*} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-tech.tex} +\begin{tdoctech} + \item Info 1... + \item Info 2... +\end{tdoctech} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-para-title.tex} +\paragraph{A well-versioned title.} +\tdocversion{1.2.3}[2024-11-23] +Blah, blah, blah, blah, blah, blah, blah, blah, blah, blah, blah... +Stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay... + +Stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay, stay... +Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... + +\tdocdate{2024-11-23} +\paragraph{A badly versioned title.} +Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... +\end{filecontents*} + + \begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex} Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \medskip % CAUTION! This prevents overlapping. \tdocdate{2023-09-24} - Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \medskip % CAUTION! This prevents overlapping. \tdocdate[gray]{2020-05-08} - Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli... Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... @@ -393,7 +566,7 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice-icon.tex} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-user-choice-icon.tex} \begin{tdoctopic}{To hide}<\faEyeSlash> % An icon from fontawesome5. \item Info 1... @@ -402,7 +575,7 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice.tex} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-user-choice.tex} \begin{tdoctopic}{End of icons} \item Info 1... \item Info 2... @@ -410,23 +583,13 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-update.tex} -\begin{tdocupdate} - \item Info 1... - \item Info 2... -\end{tdocupdate} -\end{filecontents*} - - \begin{filecontents*}[overwrite]{examples-version-n-change-versioning.tex} \tdocversion[red]{10.2.0-beta}[2023-12-01] - Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \bigskip % CAUTION! This prevents overlapping. \tdocversion{10.2.0-alpha} - Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, @@ -434,91 +597,95 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-side-effect.tex} -\tdocversion[red]{1.2.3}[2024-10-29]% -\paragraph{Before it's problematic.} -Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... - - -\paragraph{After it's misplaced}% -\tdocversion[red]{1.2.3}[2024-10-29] - -Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... - - -\paragraph{No miracle solution.\tdocversion[red]{1.2.3}[2024-10-29]} - -Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, -bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, -bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, -bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli... - - -\paragraph{Manual problem management.\tdocversion{1.2.3}[2024-10-29]<-.7cm>} - -Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-pb.tex} +\begin{tdocprob} + \item Info 1... + \item Info 2... +\end{tdocprob} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-first.tex} -\tdocstartproj{1st version of the project.} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-todo.tex} +\begin{tdoctodo} + \item Info 1... + \item Info 2... +\end{tdoctodo} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-tech.tex} -\begin{tdoctech} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-update.tex} +\begin{tdocupdate} \item Info 1... \item Info 2... -\end{tdoctech} +\end{tdocupdate} \end{filecontents*} \begin{filecontents*}[overwrite]{examples-version-n-change-what-n-when.tex} -\begin{tdoctech}[col = red, - date = 2024-10-29] - \item Info 1... - \item Info 2... +\begin{tdoctech}[date = 2024-10-29, + col-chges = red] + \item Info... \end{tdoctech} -\begin{tdocupdate}[col = ForestGreen, - version = 1.2.3] - \item Info 1... - \item Info 2... +\begin{tdocupdate}[version = 1.2.3, + col-chges = ForestGreen, + col = ForestGreen] + \item Info... \end{tdocupdate} \begin{tdoctopic}{To hide}<\faEyeSlash>% - [version = 4.5.6, date = 2025-11-30] - \item Info 1... - \item Info 2... + [version = 4.5.6, + date = 2025-11-30] + \item Info... \end{tdoctopic} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-break.tex} -\begin{tdocbreak} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-new.tex} +\begin{tdocnew} \item Info 1... \item Info 2... -\end{tdocbreak} +\end{tdocnew} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-pb.tex} -\begin{tdocprob} - \item Info 1... - \item Info 2... -\end{tdocprob} +\begin{filecontents*}[overwrite]{examples-version-n-change-manual-setting.tex} +This is what it looks like without vertical movement. + +\paragraph{A home-made setting}% +\tdocversion{1.2.3}[2024-10-29]<0pt> + +Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-new.tex} -\begin{tdocnew} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-first.tex} +\tdocstartproj{1st version of the project.} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-color-chges-first.tex} +\tdocstartproj[DarkOrchid]% + {Brightly colored version 1.} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-break.tex} +\begin{tdocbreak} \item Info 1... \item Info 2... -\end{tdocnew} +\end{tdocbreak} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-color-chges-fix.tex} +\begin{tdocfix}[col = CadetBlue] + \item Info... +\end{tdocfix} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-fix.tex} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-fix.tex} \begin{tdocfix} \item Info 1... \item Info 2... @@ -640,8 +807,8 @@ VERSUS. \tdoclatexshow[explain = What comes next is colorful..., before = Rendering below., after = Finished rendering., - colstripe = orange, - coltext = blue!70!black] + col-stripe = orange, + col-text = blue!70!black] {examples-listing-xyz.tex} \end{filecontents*} @@ -674,10 +841,10 @@ $x y z = 1$ \begin{filecontents*}[overwrite]{examples-showcase-customized.tex} -\begin{tdocshowcase}[before = My beginning, - after = My end, - colstripe = red, - coltext = orange!75!black] +\begin{tdocshowcase}[before = My beginning, + after = My end, + col-stripe = red, + col-text = orange!75!black] Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \end{tdocshowcase} \end{filecontents*} @@ -690,12 +857,12 @@ $x y z = 1$ \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip-customized.tex} +\begin{filecontents*}[overwrite]{examples-showcase-nostripe-customized.tex} \begin{tdocshowcase}[nostripe, - before = My beginning, - after = My end, - colstripe = green, - coltext = purple] + before = My beginning, + after = My end, + col-stripe = green, + col-text = purple] Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \end{tdocshowcase} \end{filecontents*} @@ -717,7 +884,7 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip.tex} +\begin{filecontents*}[overwrite]{examples-showcase-nostripe.tex} \begin{tdocshowcase}[nostripe] Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \end{tdocshowcase} @@ -728,10 +895,9 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... % == SOURCE FOR THE DOC == % % ======================== % -\documentclass[10pt, a4paper]{tutodoc} +\documentclass{tutodoc} % Community tools -\usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage[english]{babel, varioref} @@ -740,6 +906,7 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \usepackage{fmtcount} \usepackage{multicol} +\usepackage{tasks} \usepackage{pdfpages} @@ -847,7 +1014,7 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \def\FTfile(#1,#2){% node(tmp){} (#1|-tmp)++(0.6em,0) - node(tmp)[anchor=west,black]{\tt #2} + node(tmp)[anchor=west,black]{\texttt{#2}} (#1)|-(tmp.west) ++(0,-1.2em) } @@ -890,9 +1057,9 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \begin{document} -\title{The \texttt{tutodoc} class - Tutorial-style documentation} +\title{The \texttt{tutodoc} class \\ Tutorial-style documentation} \author{Christophe, BAL} -\date{Oct 30, 2024 - Version 1.6.2} +\date{Dec 4, 2024 - Version 1.7.0} \maketitle @@ -913,34 +1080,79 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \emph{\textbf{Remark :} this documentation is also available in French.} \end{abstract} -\medskip +\tdocsep -\begin{center} +{ \small -\begin{minipage}{.9\textwidth} -\begin{tdocnote}[Last changes] + +\bgroup + \addtokomafont{subsection}{\centering} + \subsection*{Last changes} +\egroup + \small +\begin{tdocbreak} + \item Format: the \tdoccls{scrartcl} class replaces the venerable \tdoccls{article}. This implies better placement of the margin notes with the options retained for loading \tdoccls{scrartcl}. + + \item \LaTeX\ code: the macro \tdocmacro{tdocinlatex} has been renamed \tdocmacro{tdoclatexin}. + + \item Color key names will be hyphenated where necessary: this implies the following changes. + % + \begin{enumerate} + \item Admonitions: the \tdoclatexin{colchges} option of the environments has been renamed \tdoclatexin{col-chges}. + + \item Showcases: for the environment \tdocenv*{tdocshowcase} and the macro \tdocmacro{tdocshowcaseinput}, the \tdoclatexin{colstripe} and \tdoclatexin{coltext} options have been renamed \tdoclatexin{col-stripe} and \tdoclatexin{col-text}\,. + \end{enumerate} +\end{tdocbreak} + + +\begin{tdocfix} + \item Admonitions: for the \tdocmacro{newkeytheorem} used with the \tdoclatexin{draft} theme, \tdoclatexin{postheadhook = \leavevmode} has been added (this is necessary because the content can naturally be of the list type). +\end{tdocfix} + + \begin{tdocnew} - \item The macros \tdocmacro{tdocdate} and \tdocmacro{tdocversion} has a new final optional argument \tdocinlatex{<voffset>} to choose a specific vertical offset. + \item Documentation: addition of a section listing dependencies. - \item Better environments to indicate the changes made. + \item Class options. + % \begin{enumerate} - \item The new optional keys \tdocinlatex{col}\,, \tdocinlatex{date} and \tdocinlatex{version} allow to date and version a change of a specific topic. + \item Options not specific to \thisproj\ are passed on to the class in charge of general formatting. - \item Use of \tdocmacro{paragraph} for the title. + \item The \tdoccls{scrartcl} options \tdoclatexin{fontsize} and \tdoclatexin{DIV} can't be used because their values are fixed by \thisproj. + \end{enumerate} + + \item The macro \tdocmacro{tdocinEN} respects the English linguistic rules. + + \item Admonitions. + % + \begin{enumerate} + \item A new environment \tdocenv{tdoctodo} has been added. + + \item Each environment has a new option \tdoclatexin{col} for the color of the content indicating changes. \end{enumerate} \end{tdocnew} \begin{tdocupdate} - \item Version and changes: the font of the margin notes will always have a normal shape. + \item \tdoclatexin{draft} theme and changes: the environments for the kind of changes stop to use icons. - \item Ornament: use of a \tdocinlatex{\cleaders} to avoid orphean rules at the bottom of a page. + \item Documentation: the theme gallery uses a better fake example. \end{tdocupdate} -\end{tdocnote} -\end{minipage} -\end{center} + + + +\begin{tdoctech} + \item Simplified organisation of configuration files in the final project. + % + \begin{enumerate} + \item \texttt{CSS}-like: use of one file per theme with a name like \texttt{tutodoc-bw.css.cls}\,. + + \item Locale: use of names like \texttt{tutodoc-en.loc.cls}\,. + \end{enumerate} +\end{tdoctech} +} \newpage @@ -948,113 +1160,90 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \newpage -\section{General formatting imposed} +\section{Dependencies} -\subsection{Page geometry} +\thisproj\ admits the following dependencies (the dates in brackets are those of the versions used during the latest tests). +% +\begin{tasks}[style=itemize](2) + \task \texttt{scrartcl.cls} + \hfill {\small (2024/10/24)}\kern10pt -The \tdocpack{geometry} package is loaded with the following settings. + \task \texttt{clrstrip.sty} + \hfill {\small (2021/08/28)}\kern10pt + \task \texttt{csquotes.sty} + \hfill {\small (2024/04/04)}\kern10pt -\begin{tdoclatex}[code] -\RequirePackage[ - top = 2.5cm, - bottom = 2.5cm, - left = 2.5cm, - right = 2.5cm, - marginparwidth = 2cm, - marginparsep = 2mm, - heightrounded -]{geometry} -\end{tdoclatex} + \task \texttt{fontawesome5.sty} + \hfill {\small (2022/05/02)}\kern10pt + \task \texttt{geometry.sty} + \hfill {\small (2020/01/02)}\kern10pt -\subsection{Title and table of contents} - -The \tdocpack{titlesec} and \tdocpack{tocbasic} packages are set as follows. - - -\begin{tdoclatex}[code] -\RequirePackage[raggedright]{titlesec} - -% ... -\ifcsundef{chapter}% - {}% - {\renewcommand\thechapter{\Alph{chapter}.}} - -\renewcommand\thesection{\Roman{section}.} -\renewcommand\thesubsection{\arabic{subsection}.} -\renewcommand\thesubsubsection{\roman{subsubsection}.} - -\titleformat{\paragraph}[hang]% - {\normalfont\normalsize\bfseries}% - {\theparagraph}{1em}% - {} - -\titlespacing*{\paragraph}% - {0pt}% - {3.25ex plus 1ex minus .2ex}% - {0.5em} - -% Source -% * https://tex.stackexchange.com/a/558025/6880 -\DeclareTOCStyleEntries[ - raggedentrytext, - linefill = \hfill, - indent = 0pt, - dynindent, - numwidth = 0pt, - numsep = 1ex, - dynnumwidth -]{tocline}{ - chapter, - section, - subsection, - subsubsection, - paragraph, - subparagraph -} + \task \texttt{hyperref.sty} + \hfill {\small (2024/11/05)}\kern10pt -\DeclareTOCStyleEntry[indentfollows = chapter]{tocline}{section} -\end{tdoclatex} + \task \texttt{inputenc.sty} + \hfill {\small (2024/02/08)}\kern10pt + \task \texttt{keytheorems.sty} + \hfill {\small (2024/11/11)}\kern10pt -\subsection{Dynamic links} + \task \texttt{marginnote.sty} + \hfill {\small (2018/08/09)}\kern10pt -The \tdocpack{hyperref} package is imported behind the scenes with the settings below. + \task \texttt{minted.sty} + \hfill {\small (2024/11/17)}\kern10pt + \task \texttt{tcolorbox.sty} + \hfill {\small (2024/10/22)}\kern10pt +\end{tasks} -\begin{tdoclatex}[code] -\newcommand{\tdoclinkcolor}{NavyBlue!85!white} -\hypersetup{ - colorlinks, - citecolor = \tdoclinkcolor, - filecolor = \tdoclinkcolor, - linkcolor = \tdoclinkcolor, - urlcolor = \tdoclinkcolor -} -\end{tdoclatex} +\section{General formatting imposed} + +\subsection{Font size and page geometry} + +The \tdoccls{scrartcl} class is loaded via the \tdoclatexin{fontsize = 10pt} option, and the \tdocpack{geometry} package manages the page dimensions. + + +\begin{tdocwarn} + The macros for dating and versioning presented in the \ref{tutodoc-changes} section require fixed settings for page geometry and font size. +\end{tdocwarn} + + +\subsection{Titles and table of contents} + +The selected settings are directly visible in this documentation. + + +\subsection{Dynamic links} + +The \tdocpack{hyperref} package is imported, if it hasn't already been, and the settings chosen are just for the colors of links relating to citations, files, internal links, and finally \verb#url# (this color will depend on the theme chosen). \section{What language is used by the \thisproj\ class?} -This documentation loads the \tdocpack{babel} package via \tdocinlatex|\usepackage[english]{babel}|\,. -As a result, the \thisproj\ class identifies \tdocinlatex|en| as the main language used by \tdocpack{babel}.%. +This documentation loads the \tdocpack{babel} package via \tdoclatexin|\usepackage[english]{babel}|\, a package that \thisproj\ does not load. +On the other hand, the \thisproj\ class identifies \tdoclatexin|en| as the main language used by \tdocpack{babel}.%. \footnote{ - Technically, we use \tdocinlatex|\BCPdata{language}| which returns a language in short format. + Technically, we use \tdoclatexin|\BCPdata{language}| which returns a language in short format. } As this language is included in the list of languages taken into account, see below, the \thisproj\ class will produce the expected effects. -\begin{multicols}{3} - \begin{itemize} - \item \tdocinlatex|en| : English. - \item \tdocinlatex|es| : Spanish. - \item \tdocinlatex|fr| : French. - \end{itemize} -\end{multicols} +\begin{tasks}[label=\small\textbullet](3) + \task \tdoclatexin|en| : English. + \task \tdoclatexin|es| : Spanish. + \task \tdoclatexin|fr| : French. +\end{tasks} +\begin{tdocnote} + Packages \tdocpack{babel} and \tdocpack{polyglossia} are taken into account. +\end{tdocnote} + + \begin{tdoccaut} If the choice of main language is not made in the preamble, the mechanism used will fail with unintended side effects (see warning that follows). \end{tdoccaut} @@ -1065,11 +1254,6 @@ As this language is included in the list of languages taken into account, see be \end{tdocwarn} -\begin{tdocnote} - The mechanism used should be compatible with the \tdocpack{polyglossia} package. -\end{tdocnote} - - \section{What does that mean in \tdocquote{English}?} The macro \tdocmacro{tdocinEN} and its starred version are useless for English speakers because they have the following effects. @@ -1080,7 +1264,7 @@ Cool and top stand for \tdocinEN*{cool} and \tdocinEN{top}. \end{tdoclatex} -The macro \tdocmacro{tdocinEN} and its starred version are based on \tdocmacro{tdocquote} : for example, \tdocquote{semantic} is obtained via \tdocinlatex|tdocquote{semantic}| . +The macro \tdocmacro{tdocinEN} and its starred version are based on \tdocmacro{tdocquote} : for example, \tdocquote{semantic} is obtained via \tdoclatexin|tdocquote{semantic}| . \begin{tdocnote} @@ -1090,21 +1274,21 @@ The macro \tdocmacro{tdocinEN} and its starred version are based on \tdocmacro{t \section{Choose your theme} -To modify the general layout, there is the \thisproj\ class option \tdocinlatex{theme = <choice>} where \tdocinlatex{<choice>} can take the following values. +To modify the general layout, there is the \thisproj\ class option \tdoclatexin{theme = <choice>} where \tdoclatexin{<choice>} can take the following values. -\begin{itemize} - \item \tdocinlatex|bw| : - this is a black-and-white theme with some shades of gray. +\begin{tasks}[style=itemize] + \task \tdoclatexin{bw}: + a black-and-white theme with some shades of grey. - \item \tdocinlatex|color| : - this theme is colored, \emph{it's the default value}. + \task \tdoclatexin{color}: + a coloured theme : this is the default value. - \item \tdocinlatex|dark| : - this theme is dark, ideal for resting the eyes. + \task \tdoclatexin{dark}: + a dark theme ideal for resting the eyes. - \item \tdocinlatex|draft|: - this theme is just right for a printout to look for content errors that aren't necessarily easy to spot in front of a screen. -\end{itemize} + \task \tdoclatexin{draft}: + a theme for a printout such as to look for content errors that aren't necessarily easy to spot in front of a screen. +\end{tasks} \begin{tdocnote} @@ -1127,7 +1311,8 @@ To modify the general layout, there is the \thisproj\ class option \tdocinlatex{ % Source. % + https://tex.stackexchange.com/a/8547/6880 \bgroup - \titleformat{\section}[block]{\Huge\bfseries\filcenter}{}{1em}{} + \setkomafont{section}{\Huge\bfseries} + \addtokomafont{section}{\centering} \phantomsection\section*{Appendix -- Theme gallery}% \label{tutodoc-theme-gallery} \addcontentsline{toc}{section}{Appendix -- Theme gallery}% @@ -1196,7 +1381,7 @@ To modify the general layout, there is the \thisproj\ class option \tdocinlatex{ \begin{tdocimp} - All the environments presented in this section share the same counter, which will be reset to zero as soon as a section with a level at least equal to a \tdocinlatex|\section| is opened. + All the environments presented in this section share the same counter, which will be reset to zero as soon as a section with a level at least equal to a \tdoclatexin|\section| is opened. \end{tdocimp} @@ -1241,7 +1426,7 @@ Everything happens via \tdocenv{tdocrem}, which works identically to the \tdocen As for the icons, they are obtained via the \tdocpack{fontawesome5} package, and the \tdocmacro{tdocicon} macro manages the spacing in relation to the text. \footnote{ For example, - \tdocinlatex|\fbox{tdocicon{faBed}{Fatigued}}| + \tdoclatexin|\fbox{tdocicon{faBed}{Fatigued}}| produces \fbox{\tdocicon{\faBed}{Fatigued}}\,. } @@ -1260,7 +1445,7 @@ The \tdocenv*{tdoctip} environment is used to give tips. Here's how to use it. \begin{tdoctip} - Sometimes, highlighted content can be reduced to a list. In this case, the formatting can be improved as follows where we use the \tdocinlatex{wide} option from the \tdocpack{enumitem} package. + Sometimes, highlighted content can be reduced to a list. In this case, the formatting can be improved as follows where we use the \tdoclatexin{wide} option from the \tdocpack{enumitem} package. \tdoclatexinput[sbs]{examples-admonitions-leavevmode-items.tex} @@ -1306,12 +1491,13 @@ Here's what you can type semantically. \tdocenv[{[opt1]<opt2>}]{env} \\ Just \tdocenv*{env}... \\ Finally \tdocenv*[{[opt1]<opt2>}]{env}... + % For copy and paste. \end{tdoclatex} \begin{tdocrem} - Unlike \tdocmacro{tdocinlatex}, \tdocmacro{tdocenv} and \tdocmacro{tdocenv*} macros don't color the text they produce. - In addition, \tdocinlatex{\tdocenv{monenv}} produces \tdocenv{monenv} with spaces to allow line breaks if required. + Unlike \tdocmacro{tdoclatexin}, \tdocmacro{tdocenv} and \tdocmacro{tdocenv*} macros don't color the text they produce. + In addition, \tdoclatexin{\tdocenv{monenv}} produces \tdocenv{monenv} with spaces to allow line breaks if required. \end{tdocrem} @@ -1338,7 +1524,7 @@ To explain the names chosen, there is nothing like indicating and explaining the \begin{tdocrem} - The choice of a full stop to split a word allows words with a hyphen to be used, as in \tdocinlatex+\tdocprewhy{bric.k-breaker}+ which gives \tdocprewhy{bric.k-breaker}. + The choice of a full stop to split a word allows words with a hyphen to be used, as in \tdoclatexin+\tdocprewhy{bric.k-breaker}+ which gives \tdocprewhy{bric.k-breaker}. \end{tdocrem} @@ -1404,7 +1590,7 @@ It is sometimes useful to render code directly in the documentation. This type o \begin{tdocnote} In the previous example, the text uses the proposed darkened orange. On the other hand, red is used as a base to obtain the colors used for the strip: the transformations used depend on the theme chosen.% \footnote{ - For example, the themes \tdocinlatex{bw} and \tdocinlatex{draft} ignore the key \tdocinlatex{colstripe}! + For example, the themes \tdoclatexin{bw} and \tdoclatexin{draft} ignore the key \tdoclatexin{col-stripe}! } % You should also be aware that behind the scenes, the macro \tdocmacro{tdocruler} is used. @@ -1442,14 +1628,14 @@ It is possible not to use a coloured strip, as we will see straight away. The use of \tdocenv[{[nostripe]}]{tdocshowcase} indicate to not use \tdocpack{clrstrip}. Here is an example. - \tdoclatexinput[code]{examples-showcase-no-clrstrip.tex} + \tdoclatexinput[code]{examples-showcase-nostripe.tex} This will produce the following. \medskip - \input{examples-showcase-no-clrstrip.tex} + \input{examples-showcase-nostripe.tex} \end{tdocexa} @@ -1460,25 +1646,25 @@ It is possible not to use a coloured strip, as we will see straight away. \begin{tdocexa}[Change the colors and/or the texts] \leavevmode - \tdoclatexinput[code]{examples-showcase-no-clrstrip-customized.tex} + \tdoclatexinput[code]{examples-showcase-nostripe-customized.tex} This will produce the following horror. \medskip - \input{examples-showcase-no-clrstrip-customized.tex} + \input{examples-showcase-nostripe-customized.tex} \end{tdocexa} \subsection{By importing the \LaTeX\ code} -To obtain renderings by importing the code from an external file, instead of typing it, simply use the \tdocmacro{tdocshowcaseinput} macro whose option uses the syntax of that of \tdocenv{tdocshowcase} and the mandatory argument corresponds to the path of the file. +To obtain renderings by importing the code from an external file, simply use the \tdocmacro{tdocshowcaseinput} macro whose option uses the syntax of that of \tdocenv{tdocshowcase} and the mandatory argument corresponds to the path of the file. \begin{tdocexa} - The following was obtained via \tdocinlatex+\tdocshowcaseinput{external.tex}+. + The following was obtained via \tdoclatexin+\tdocshowcaseinput{external.tex}+. \medskip @@ -1487,11 +1673,11 @@ To obtain renderings by importing the code from an external file, instead of typ \medskip - As for \tdocinlatex+\tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{external.tex}+\,, this will produce the color change shown below. + As for \tdoclatexin+\tdocshowcaseinput[col-stripe = red, col-text = orange!75!black]{external.tex}+\,, this will produce the color change shown below. \medskip - \tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{examples-showcase-external.tex} + \tdocshowcaseinput[col-stripe = red, col-text = orange!75!black]{examples-showcase-external.tex} \end{tdocexa} @@ -1513,27 +1699,27 @@ Documenting a package or class is best done through use cases showing both the c \subsection{\tdocquote{Inline} codes} \label{tutodoc-listing-inline} -The \tdocmacro{tdocinlatex} macro +The \tdocmacro{tdoclatexin} macro \footnote{ - The name of the macro \tdocmacro{tdocinlatex} comes from \tdocquote{\tdocprewhy{in.line} \LaTeX}. + The name of the macro \tdocmacro{tdoclatexin} comes from \tdocquote{\tdocprewhy{in.line} \LaTeX}. } can be used to type inline code in a similar way to \tdocmacro{verb} or like a standard macro (see brace management in the last case below). Here are some examples. \begin{tdoclatex}[sbs] - 1: \tdocinlatex|$a^b = c$| \\ - 2: \tdocinlatex+\tdocinlatex|$a^b = c$|+ \\ - 3: \tdocinlatex{\tdocinlatex{$a^b = c$}} + 1: \tdoclatexin|$a^b = c$| \\ + 2: \tdoclatexin+\tdoclatexin|$a^b = c$|+ \\ + 3: \tdoclatexin{\tdoclatexin{$a^b = c$}} \end{tdoclatex} \begin{tdocnote} - The \tdocmacro{tdocinlatex} macro can be used in a footnote: see below. + The \tdocmacro{tdoclatexin} macro can be used in a footnote: see below. \footnote{ - \tdocinlatex+$minted = TOP$+ has been typed \tdocinlatex|\tdocinlatex+$minted = TOP$+| in this footnote... + \tdoclatexin+$minted = TOP$+ has been typed \tdoclatexin|\tdoclatexin+$minted = TOP$+| in this footnote... } - In addition, a background color is deliberately used to subtly highlight the codes \tdocinlatex#\LaTeX#\,. + In addition, a background color is deliberately used to subtly highlight the codes \tdoclatexin#\LaTeX#\,. \end{tdocnote} @@ -1553,9 +1739,9 @@ Here are some examples. \begin{tdocexa}[Following] - \tdocenv{tdoclatex} produces the following result, which corresponds to the default option \tdocinlatex#std#\,. + \tdocenv{tdoclatex} produces the following result, which corresponds to the default option \tdoclatexin#std#\,. \footnote{ - \tdocinlatex{std} refers to the \tdocquote{standard} behaviour of \tdocpack{tcolorbox} in relation to the \tdocpack{minted} library. + \tdoclatexin{std} refers to the \tdocquote{standard} behaviour of \tdocpack{tcolorbox} in relation to the \tdocpack{minted} library. } \begin{tdoclatex} @@ -1633,7 +1819,7 @@ The \tdocmacro{tdoclatexinput} macro, shown below, expects the path of a file an \end{tdoclatex} - This produces the following formatting where the default option is \tdocinlatex#std#. + This produces the following formatting where the default option is \tdoclatexin#std#. \tdoclatexinput{examples-listing-xyz.tex} @@ -1665,7 +1851,7 @@ The \tdocmacro{tdoclatexinput} macro, shown below, expects the path of a file an \label{tutodoc-latexshow} \begin{tdocexa}[Showcase] - The following comes from \tdocinlatex+\tdoclatexshow{examples-listing-xyz.tex}+. + The following comes from \tdoclatexin+\tdoclatexshow{examples-listing-xyz.tex}+. \medskip @@ -1685,12 +1871,12 @@ The \tdocmacro{tdoclatexinput} macro, shown below, expects the path of a file an \begin{tdocexa}[Changing the explanatory text] - Using the key \tdocinlatex|explain|, you can use custom text. Thus, \tdocinlatex|tdoclatexshow[explain = Here is the actual rendering.]{examples-listing-xyz.tex}| will produce the following. + Using the key \tdoclatexin|explain|, you can use custom text. Thus, \tdoclatexin|tdoclatexshow[explain = Here is the rendering.]{examples-listing-xyz.tex}| will give the following. \medskip \begin{tdocshowcaseDOC} - \tdoclatexshow[explain = Here is the actual rendering.]{examples-listing-xyz.tex} + \tdoclatexshow[explain = Here is the rendering.]{examples-listing-xyz.tex} \end{tdocshowcaseDOC} \end{tdocexa} @@ -1722,6 +1908,7 @@ The \tdocmacro{tdoclatexinput} macro, shown below, expects the path of a file an \section{Indicate changes} +\label{tutodoc-changes} To make it easier to monitor a project, it is essential to provide a history indicating the changes made when a new version is published. @@ -1755,6 +1942,22 @@ You can either date something, or version it, in which case the version number c \end{tdocexa} +\begin{tdocexa}[Caution with paragraph titles] + The following example shows that a date and/or version must be placed just after a paragraph title, and not before it. + + \tdoclatexshow{examples-version-n-change-para-title.tex} + +\end{tdocexa} + + +\begin{tdocexa}[Adjust vertical positioning] + If required, you can modify the vertical offset used to place dates and versions in the margin, the default value being $(-8\,\mathit{pt})$. + + \tdoclatexshow{examples-version-n-change-manual-setting.tex} + +\end{tdocexa} + + \begin{tdocimp} \begin{enumerate}[wide] \item The \tdocmacro{tdocdate} and \tdocmacro{tdocversion} macros require two compilations. @@ -1765,7 +1968,7 @@ You can either date something, or version it, in which case the version number c \begin{tdoccaut} - Only the use of the digital format \tdocinlatex+YYYY-MM-DD+ is verified, + Only the use of the digital format \tdoclatexin+YYYY-MM-DD+ is verified, \footnote{ Technically, checking the validity of a date using \LaTeX3 presents no difficulty. } @@ -1773,19 +1976,9 @@ You can either date something, or version it, in which case the version number c \end{tdoccaut} -\begin{tdocwarn} - Behind the scenes, most of the work is done by the \tdocmacro{marginnote} macro in the eponymous package. - The \tdocmacro{tdocdate} and \tdocmacro{tdocversion} macros therefore suffer from the same side effects as in the following example. - However, these problems can be solved using an optional argument \tdocinlatex{<vertical-displacement>}, as at the end of the following example. It's ugly, but functional. - - \tdoclatexshow[nostripe, colstripe=red]{examples-version-n-change-side-effect.tex} - -\end{tdocwarn} - - \subsection{What's new?} -\thisproj\ offers the macro \tdocmacro{tdocstartproj} and different environments to indicate quickly and clearly what has been done during the latest changes.% +\thisproj\ offers the macro \tdocmacro{tdocstartproj} and different environments to indicate quickly and clearly what has been done during the changes made, or to come.% \footnote{ The user doesn't need all the technical details. } @@ -1796,6 +1989,8 @@ You can either date something, or version it, in which case the version number c \end{tdocnote} +\subsubsection{Sobriety first} + \foreach \exatitle/\filename in { {Just for the very first version}/%<-- Translate me! first, @@ -1809,6 +2004,8 @@ You can either date something, or version it, in which case the version number c pb, {For fixes}/% <-- Translate me! fix, + {Roadmap}/% <-- Translate me! + todo, {Technical information}/% <-- Translate me! tech, {Selectable themes with an icon}/% <-- Translate me! @@ -1819,18 +2016,36 @@ You can either date something, or version it, in which case the version number c \begin{tdocexa}[\exatitle] \leavevmode - \tdoclatexinput[sbs]{examples-version-n-change-\filename.tex} + \tdoclatexinput[sbs]{examples-version-n-change-chges-\filename.tex} \end{tdocexa} } -\subsection{The what and the when} +\subsubsection{De la couleur si besoin} -The optional keys \tdocinlatex{col}\,, \tdocinlatex{date} and \tdocinlatex{version} allow to date and version a change of a particular type.% -\footnote{ - The warning at the end of the section \ref{tutodoc-changes-when} gives the technique used behind the scene, while showing the need to offer specialized keys. +\subsubsection{Color if necessary} + +It may be useful to highlight certain changes: this can only be done by modifying the content color. + +\foreach \exatitle/\filename in { + {A flashy first version}/%<-- Translate me! + first, + {Outstanding fixes}/% <-- Translate me! + fix% +} { + \begin{tdocexa}[\exatitle] + \leavevmode + + \tdoclatexinput[sbs]{examples-version-n-change-color-chges-\filename.tex} + + \end{tdocexa} } + + +\subsection{The what and the when} + +The optional keys \tdoclatexin{col}\,, \tdoclatexin{date} and \tdoclatexin{version} allow to date and version a change of a particular type. Here are some examples of use. \tdoclatexshow{examples-version-n-change-what-n-when.tex} @@ -1997,19 +2212,90 @@ The \texttt{LICENSE.txt} file is aptly named, while the \texttt{README.md} file Participation as a coder is made via the \thisrepo\ repository corresponding to the \verb#tutodoc# development branch. + + +\begin{tdoccaut} Do not use the \verb#main# branch, which is used to freeze the latest stable versions of projects in the single \thismonorepo\ repository. +\end{tdoccaut} \section{History} \small +\begin{tdocbreak}[version = 1.7.0, date = 2024-12-04] + \item Format: the \tdoccls{scrartcl} class replaces the venerable \tdoccls{article}. This implies better placement of the margin notes with the options retained for loading \tdoccls{scrartcl}. + + \item \LaTeX\ code: the macro \tdocmacro{tdocinlatex} has been renamed \tdocmacro{tdoclatexin}. + + \item Color key names will be hyphenated where necessary: this implies the following changes. + % + \begin{enumerate} + \item Admonitions: the \tdoclatexin{colchges} option of the environments has been renamed \tdoclatexin{col-chges}. + + \item Showcases: for the environment \tdocenv*{tdocshowcase} and the macro \tdocmacro{tdocshowcaseinput}, the \tdoclatexin{colstripe} and \tdoclatexin{coltext} options have been renamed \tdoclatexin{col-stripe} and \tdoclatexin{col-text}\,. + \end{enumerate} +\end{tdocbreak} + + +\begin{tdocfix} + \item Admonitions: for the \tdocmacro{newkeytheorem} used with the \tdoclatexin{draft} theme, \tdoclatexin{postheadhook = \leavevmode} has been added (this is necessary because the content can naturally be of the list type). +\end{tdocfix} + + +\begin{tdocnew} + \item Documentation: addition of a section listing dependencies. + + \item Class options. + % + \begin{enumerate} + \item Options not specific to \thisproj\ are passed on to the class in charge of general formatting. + + \item The \tdoccls{scrartcl} options \tdoclatexin{fontsize} and \tdoclatexin{DIV} can't be used because their values are fixed by \thisproj. + \end{enumerate} + + \item The macro \tdocmacro{tdocinEN} respects the English linguistic rules. + + \item Admonitions. + % + \begin{enumerate} + \item A new environment \tdocenv{tdoctodo} has been added. + + \item Each environment has a new option \tdoclatexin{col} for the color of the content indicating changes. + \end{enumerate} +\end{tdocnew} + + +\begin{tdocupdate} + \item \tdoclatexin{draft} theme and changes: the environments for the kind of changes stop to use icons. + + \item Documentation: the theme gallery uses a better fake example. +\end{tdocupdate} + + + +\begin{tdoctech} + \item Simplified organisation of configuration files in the final project. + % + \begin{enumerate} + \item \texttt{CSS}-like: use of one file per theme with a name like \texttt{tutodoc-bw.css.cls}\,. + + \item Locale: use of names like \texttt{tutodoc-en.loc.cls}\,. + \end{enumerate} +\end{tdoctech} + +\tdocsep + + +% ------------------ % + + \begin{tdocnew}[version = 1.6.2, date = 2024-10-30] - \item The macros \tdocmacro{tdocdate} and \tdocmacro{tdocversion} has a new final optional argument \tdocinlatex{<voffset>} to choose a specific vertical offset. + \item The macros \tdocmacro{tdocdate} and \tdocmacro{tdocversion} has a new final optional argument \tdoclatexin{<voffset>} to choose a specific vertical offset. \item Better environments to indicate the changes made. \begin{enumerate} - \item The new optional keys \tdocinlatex{col}\,, \tdocinlatex{date} and \tdocinlatex{version} allow to date and version a change of a specific topic. + \item The new optional keys \tdoclatexin{col}\,, \tdoclatexin{date} and \tdoclatexin{version} allow to date and version a change of a specific topic. \item Use of \tdocmacro{paragraph} for the title. \end{enumerate} @@ -2019,7 +2305,7 @@ Do not use the \verb#main# branch, which is used to freeze the latest stable ver \begin{tdocupdate} \item Version and changes: the font of the margin notes will always have a normal shape. - \item Ornament: use of a \tdocinlatex{\cleaders} to avoid orphean rules at the bottom of a page. + \item Ornament: use of a \tdoclatexin{\cleaders} to avoid orphean rules at the bottom of a page. \end{tdocupdate} \tdocsep @@ -2039,18 +2325,18 @@ Do not use the \verb#main# branch, which is used to freeze the latest stable ver \begin{tdocbreak}[version = 1.6.0, date = 2024-10-27] - \item The \tdocenv*{showcase} environment and its descendants: the \tdocinlatex{color} key has been renamed \tdocinlatex{colstripe}. + \item The \tdocenv*{showcase} environment and its descendants: the \tdoclatexin{color} key has been renamed \tdoclatexin{col-stripe}. - \item The macro \tdocmacro{tdoclinkcolor} has been renamed \tdocinlatex{tutodoc@link@color} for internal use. + \item The macro \tdocmacro{tdoclinkcolor} has been renamed \tdoclatexin{tutodoc@link@color} for internal use. \end{tdocbreak} \begin{tdocnew} - \item The \tdocinlatex{theme} class option allows you to choose different formatting themes. + \item The \tdoclatexin{theme} class option allows you to choose different formatting themes. \item Change log: addition of the \tdocenv*{tdoctech} environment for technical information. - \item The \tdocenv*{showcase} environment and its descendants: the \tdocinlatex{coltext} key can also be used to change the text color. + \item The \tdocenv*{showcase} environment and its descendants: the \tdoclatexin{col-text} key can also be used to change the text color. \item The new functionalities have been documented. \end{tdocnew} @@ -2082,7 +2368,7 @@ Do not use the \verb#main# branch, which is used to freeze the latest stable ver \begin{tdocbreak} \item The \thisproj\ class replaces the now-defunct \thisproj\ package (for the moment, the young class offers no specific options). - \item The \tdocmacro{tdocruler} macro is now used via \tdocinlatex{\tdocruler[<color>]{<text>}} (remember that the old syntax was \tdocinlatex{\tdocruler{<text>}{<color>}}). + \item The \tdocmacro{tdocruler} macro is now used via \tdoclatexin{\tdocruler[<color>]{<text>}} (remember that the old syntax was \tdoclatexin{\tdocruler{<text>}{<color>}}). \end{tdocbreak} @@ -2165,18 +2451,14 @@ Do not use the \verb#main# branch, which is used to freeze the latest stable ver \item Content highlighting: colored frames with icons are proposed for the following environments. - \bgroup - \setlength\multicolsep{5pt} - \begin{multicols}{3} - \begin{enumerate}[topsep=0pt] - \item \tdocenv*{tdoccaution} - \item \tdocenv*{tdocimp} - \item \tdocenv*{tdocnote} - \item \tdocenv*{tdoctip} - \item \tdocenv*{tdocwarn} - \end{enumerate} - \end{multicols} - \egroup + % + \begin{tasks}[label=\arabic*.](3) + \task \tdocenv*{tdoccaution} + \task \tdocenv*{tdocimp} + \task \tdocenv*{tdocnote} + \task \tdocenv*{tdoctip} + \task \tdocenv*{tdocwarn} + \end{tasks} \end{tdocnew} \tdocsep @@ -2213,7 +2495,7 @@ Do not use the \verb#main# branch, which is used to freeze the latest stable ver \item \tdocenv{tdocprob} for identified problems. \end{enumerate} - \item \tdocmacro{tdocinlatex}: a light yellow is used as the background color. + \item \tdocmacro{tdoclatexin}: a light yellow is used as the background color. \end{tdocnew} \tdocsep diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf Binary files differindex 30838b5bba9..47cee60d377 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex index d566fe93ea3..0c55d7bfcf4 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex @@ -4,19 +4,23 @@ \begin{filecontents*}[overwrite]{gallery-showcase-bw.tex} -\documentclass[10pt, a4paper, theme = bw]{tutodoc} +\documentclass[theme = bw]{tutodoc} % -- FORDOC -- % +\usepackage[french]{babel} +\frenchsetup{StandardItemLabels=true} + +\usepackage{multicol} + \newcommand\thisstyle{bw} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} + \tdocversion{1.7.0}[2024-12-04] Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance. } @@ -25,73 +29,105 @@ \footnote{ N'oublions pas les notes de bas de page... }? - Je ne sais pas, mais en tout cas, il semble sympathique de montrer ce que peut donner telle mise en forme, ou telle autre. Non ? + Je ne sais pas, mais c'est sympathique. Non ? } \begin{document} -{\Huge\bfseries Le thème \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}} + + +\section{Liens} + +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit. + \section{Mettre en avant, versionner et dater} -\ExplSyntaxOn +\subsection{tdocexa, tdocrem} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +\myexrmktext - \myexrmktext +\ExplSyntaxOn +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff + +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{Nouvelle section démonstrative...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + \section{Des codes \LaTeX} -Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX. +Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant. \begin{tdoclatex} -Voir du code \LaTeX\ mis en forme, c'est sympa : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ? \begin{tdoclatex}[sbs] -Voir du code \LaTeX\ mis en forme, -c'est sympa : $E = m c^2$ ou -$\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : \\ +$E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} \end{document} @@ -99,19 +135,23 @@ $\pi \neq \frac{3}{14}$. \end{filecontents*} \begin{filecontents*}[overwrite]{gallery-showcase-color.tex} -\documentclass[10pt, a4paper, theme = color]{tutodoc} +\documentclass[theme = color]{tutodoc} % -- FORDOC -- % +\usepackage[french]{babel} +\frenchsetup{StandardItemLabels=true} + +\usepackage{multicol} + \newcommand\thisstyle{color} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} + \tdocversion{1.7.0}[2024-12-04] Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance. } @@ -120,73 +160,105 @@ $\pi \neq \frac{3}{14}$. \footnote{ N'oublions pas les notes de bas de page... }? - Je ne sais pas, mais en tout cas, il semble sympathique de montrer ce que peut donner telle mise en forme, ou telle autre. Non ? + Je ne sais pas, mais c'est sympathique. Non ? } \begin{document} -{\Huge\bfseries Le thème \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}} + + +\section{Liens} + +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit. + \section{Mettre en avant, versionner et dater} -\ExplSyntaxOn +\subsection{tdocexa, tdocrem} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +\myexrmktext - \myexrmktext +\ExplSyntaxOn +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff + +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{Nouvelle section démonstrative...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + \section{Des codes \LaTeX} -Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX. +Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant. \begin{tdoclatex} -Voir du code \LaTeX\ mis en forme, c'est sympa : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ? \begin{tdoclatex}[sbs] -Voir du code \LaTeX\ mis en forme, -c'est sympa : $E = m c^2$ ou -$\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : \\ +$E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} \end{document} @@ -194,19 +266,23 @@ $\pi \neq \frac{3}{14}$. \end{filecontents*} \begin{filecontents*}[overwrite]{gallery-showcase-dark.tex} -\documentclass[10pt, a4paper, theme = dark]{tutodoc} +\documentclass[theme = dark]{tutodoc} % -- FORDOC -- % +\usepackage[french]{babel} +\frenchsetup{StandardItemLabels=true} + +\usepackage{multicol} + \newcommand\thisstyle{dark} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} + \tdocversion{1.7.0}[2024-12-04] Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance. } @@ -215,73 +291,105 @@ $\pi \neq \frac{3}{14}$. \footnote{ N'oublions pas les notes de bas de page... }? - Je ne sais pas, mais en tout cas, il semble sympathique de montrer ce que peut donner telle mise en forme, ou telle autre. Non ? + Je ne sais pas, mais c'est sympathique. Non ? } \begin{document} -{\Huge\bfseries Le thème \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}} + + +\section{Liens} + +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit. + \section{Mettre en avant, versionner et dater} -\ExplSyntaxOn +\subsection{tdocexa, tdocrem} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +\myexrmktext - \myexrmktext +\ExplSyntaxOn +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff + +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{Nouvelle section démonstrative...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + \section{Des codes \LaTeX} -Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX. +Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant. \begin{tdoclatex} -Voir du code \LaTeX\ mis en forme, c'est sympa : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ? \begin{tdoclatex}[sbs] -Voir du code \LaTeX\ mis en forme, -c'est sympa : $E = m c^2$ ou -$\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : \\ +$E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} \end{document} @@ -289,19 +397,23 @@ $\pi \neq \frac{3}{14}$. \end{filecontents*} \begin{filecontents*}[overwrite]{gallery-showcase-draft.tex} -\documentclass[10pt, a4paper, theme = draft]{tutodoc} +\documentclass[theme = draft]{tutodoc} % -- FORDOC -- % +\usepackage[french]{babel} +\frenchsetup{StandardItemLabels=true} + +\usepackage{multicol} + \newcommand\thisstyle{draft} \newcommand\myexrmktext{ - \tdocdate{2024-10-23} + \tdocversion{1.7.0}[2024-12-04] Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal. } \newcommand\myadmotext{ - \tdocversion{1.6.0}[2024-10-23] Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance. } @@ -310,73 +422,105 @@ $\pi \neq \frac{3}{14}$. \footnote{ N'oublions pas les notes de bas de page... }? - Je ne sais pas, mais en tout cas, il semble sympathique de montrer ce que peut donner telle mise en forme, ou telle autre. Non ? + Je ne sais pas, mais c'est sympathique. Non ? } \begin{document} -{\Huge\bfseries Le thème \texttt{"\thisstyle"}} +\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}} + + +\section{Liens} + +{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit. + \section{Mettre en avant, versionner et dater} -\ExplSyntaxOn +\subsection{tdocexa, tdocrem} -\seq_map_inline:Nn \g__tutodoc_focus_std_seq { - \subsection*{tdoc#1} +\myexrmktext - \myexrmktext +\ExplSyntaxOn +\seq_map_inline:Nn \g__tutodoc_focus_std_seq { \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myexrmktext } +\ExplSyntaxOff + +\myexrmktext + + +\subsection{tdocnote, tdoctip...} + +\myadmotext + +\ExplSyntaxOn + \ifcsundef{g__tutodoc_focus_color_seq}{ \prop_map_inline:Nn \g__tutodoc_focus_color_prop { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } { \seq_map_inline:Nn \g__tutodoc_focus_color_seq { - \subsection*{tdoc#1} - - \myadmotext + \medskip \begin{tdoc#1} \myhighlightedtext \end{tdoc#1} - - \myadmotext } } \ExplSyntaxOff + +\subsection{tdocbreak, tdocfix...} + +\tdocstartproj{Nouvelle section démonstrative...} + +\medskip + +\myexrmktext + +\ExplSyntaxOn + +\begin{multicols}{2} + +\prop_map_inline:Nn \g__tutodoc_topic_change_prop { + \begin{tdoc#1} + \item Infos... + \end{tdoc#1} +} + +\vfill\null + +\end{multicols} + +\ExplSyntaxOff + + \section{Des codes \LaTeX} -Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX. +Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant. \begin{tdoclatex} -Voir du code \LaTeX\ mis en forme, c'est sympa : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ? \begin{tdoclatex}[sbs] -Voir du code \LaTeX\ mis en forme, -c'est sympa : $E = m c^2$ ou -$\pi \neq \frac{3}{14}$. +Du code \LaTeX\ mis en forme, c'est top : \\ +$E = m c^2$ ou $\pi \neq \frac{3}{14}$. \end{tdoclatex} \end{document} @@ -384,19 +528,40 @@ $\pi \neq \frac{3}{14}$. \end{filecontents*} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-tech.tex} +\begin{tdoctech} + \item Info 1... + \item Info 2... +\end{tdoctech} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-para-title.tex} +\paragraph{Un titre bien versionné.} +\tdocversion{1.2.3}[2024-11-23] +Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... +Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... + +Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli... +Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... + +\tdocdate{2024-11-23} +\paragraph{Un titre mal versionné.} +Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... +\end{filecontents*} + + \begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex} Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \medskip % ATTENTION ! Ceci évite le chevauchement. \tdocdate{2023-09-24} - Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \medskip % ATTENTION ! Ceci évite le chevauchement. \tdocdate[gray]{2020-05-08} - Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli... Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... @@ -405,7 +570,7 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice-icon.tex} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-user-choice-icon.tex} \begin{tdoctopic}{À cacher}<\faEyeSlash> % Une icône venant de fontawesome5. \item Info 1... @@ -414,7 +579,7 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice.tex} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-user-choice.tex} \begin{tdoctopic}{La fin des icônes} \item Info 1... \item Info 2... @@ -422,23 +587,13 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-update.tex} -\begin{tdocupdate} - \item Info 1... - \item Info 2... -\end{tdocupdate} -\end{filecontents*} - - \begin{filecontents*}[overwrite]{examples-version-n-change-versioning.tex} \tdocversion[red]{10.2.0-beta}[2023-12-01] - Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \bigskip % ATTENTION ! Ceci évite le chevauchement. \tdocversion{10.2.0-alpha} - Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, @@ -446,91 +601,95 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-side-effect.tex} -\tdocversion[red]{1.2.3}[2024-10-29]% -\paragraph{Avant c'est problématique.} -Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... - - -\paragraph{Après c'est mal placé.}% -\tdocversion[red]{1.2.3}[2024-10-29] - -Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... - - -\paragraph{Pas de solution miracle.\tdocversion[red]{1.2.3}[2024-10-29]} - -Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, -bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, -bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, -bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli... - - -\paragraph{Gestion manuelle du problème.\tdocversion{1.2.3}[2024-10-29]<-.745cm>} - -Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-pb.tex} +\begin{tdocprob} + \item Info 1... + \item Info 2... +\end{tdocprob} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-first.tex} -\tdocstartproj{Première version du projet.} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-todo.tex} +\begin{tdoctodo} + \item Info 1... + \item Info 2... +\end{tdoctodo} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-tech.tex} -\begin{tdoctech} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-update.tex} +\begin{tdocupdate} \item Info 1... \item Info 2... -\end{tdoctech} +\end{tdocupdate} \end{filecontents*} \begin{filecontents*}[overwrite]{examples-version-n-change-what-n-when.tex} -\begin{tdoctech}[col = red, - date = 2024-10-29] - \item Info 1... - \item Info 2... +\begin{tdoctech}[date = 2024-10-29, + col-chges = red] + \item Info... \end{tdoctech} -\begin{tdocupdate}[col = ForestGreen, - version = 1.2.3] - \item Info 1... - \item Info 2... +\begin{tdocupdate}[version = 1.2.3, + col-chges = ForestGreen, + col = ForestGreen] + \item Info... \end{tdocupdate} \begin{tdoctopic}{À cacher}<\faEyeSlash>% - [version = 4.5.6, date = 2025-11-30] - \item Info 1... - \item Info 2... + [version = 4.5.6, + date = 2025-11-30] + \item Info... \end{tdoctopic} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-break.tex} -\begin{tdocbreak} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-new.tex} +\begin{tdocnew} \item Info 1... \item Info 2... -\end{tdocbreak} +\end{tdocnew} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-pb.tex} -\begin{tdocprob} - \item Info 1... - \item Info 2... -\end{tdocprob} +\begin{filecontents*}[overwrite]{examples-version-n-change-manual-setting.tex} +Voilà ce que cela donne sans déplacement vertical. + +\paragraph{Un réglage maison}% +\tdocversion{1.2.3}[2024-10-29]<0pt> + +Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-new.tex} -\begin{tdocnew} +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-first.tex} +\tdocstartproj{Première version du projet.} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-color-chges-first.tex} +\tdocstartproj[DarkOrchid]% + {Version 1 chamarrée.} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-break.tex} +\begin{tdocbreak} \item Info 1... \item Info 2... -\end{tdocnew} +\end{tdocbreak} \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-version-n-change-fix.tex} +\begin{filecontents*}[overwrite]{examples-version-n-change-color-chges-fix.tex} +\begin{tdocfix}[col = CadetBlue] + \item Info... +\end{tdocfix} +\end{filecontents*} + + +\begin{filecontents*}[overwrite]{examples-version-n-change-chges-fix.tex} \begin{tdocfix} \item Info 1... \item Info 2... @@ -648,8 +807,8 @@ VERSUS. \tdoclatexshow[explain = Ce qui vient est coloré..., before = Rendu ci-après., after = Rendu fini., - colstripe = orange, - coltext = blue!70!black] + col-stripe = orange, + col-text = blue!70!black] {examples-listing-xyz.tex} \end{filecontents*} @@ -682,10 +841,10 @@ $x y z = 1$ \begin{filecontents*}[overwrite]{examples-showcase-customized.tex} -\begin{tdocshowcase}[before = Mon début, - after = Ma fin à moi, - colstripe = red, - coltext = orange!75!black] +\begin{tdocshowcase}[before = Mon début, + after = Ma fin à moi, + col-stripe = red, + col-text = orange!75!black] Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \end{tdocshowcase} \end{filecontents*} @@ -698,12 +857,12 @@ $x y z = 1$ \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip-customized.tex} +\begin{filecontents*}[overwrite]{examples-showcase-nostripe-customized.tex} \begin{tdocshowcase}[nostripe, - before = Mon début, - after = Ma fin à moi, - colstripe = green, - coltext = purple] + before = Mon début, + after = Ma fin à moi, + col-stripe = green, + col-text = purple] Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \end{tdocshowcase} \end{filecontents*} @@ -725,7 +884,7 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \end{filecontents*} -\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip.tex} +\begin{filecontents*}[overwrite]{examples-showcase-nostripe.tex} \begin{tdocshowcase}[nostripe] Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla... \end{tdocshowcase} @@ -736,10 +895,9 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... % == SOURCE FOR THE DOC == % % ======================== % -\documentclass[10pt, a4paper]{tutodoc} +\documentclass{tutodoc} % Community tools -\usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage{enumitem} @@ -748,6 +906,7 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \frenchsetup{StandardItemLabels=true} \usepackage{multicol} +\usepackage{tasks} \usepackage{pdfpages} @@ -831,7 +990,7 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \def\FTfile(#1,#2){% node(tmp){} (#1|-tmp)++(0.6em,0) - node(tmp)[anchor=west,black]{\tt #2} + node(tmp)[anchor=west,black]{\texttt{#2}} (#1)|-(tmp.west) ++(0,-1.2em) } @@ -874,13 +1033,12 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \begin{document} -\title{La classe \texttt{tutodoc} - Documentation de type tutoriel} +\title{La classe \texttt{tutodoc} \\ Documentation de type tutoriel} \author{Christophe, BAL} -\date{30 oct. 2024 - Version 1.6.2} +\date{4 déc. 2024 - Version 1.7.0} \maketitle - \begin{abstract} La classe \thisproj{}\,% \footnote{ @@ -897,15 +1055,16 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \noindent \emph{\textbf{Remarque :} cette documentation est aussi disponible en anglais.} + \smallskip \tdocsep - - {\small\itshape - \vspace{-5pt} - \begin{center} - \textbf{Abstract.} - \end{center} - - The \thisproj{} class\,% + \small + \itshape + \vspace{-5pt} + \begin{center} + \textbf{Abstract.} + \end{center} + + The \thisproj{} class\,% \footnote{ The name comes from \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}}. } @@ -919,35 +1078,80 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \noindent \emph{\textbf{Remark :} this documentation is also available in French.} - } \end{abstract} -\medskip +\tdocsep -\begin{center} +{ \small -\begin{minipage}{.9\textwidth} -\begin{tdocnote}[Derniers changements] + +\bgroup + \addtokomafont{subsection}{\centering} + \subsection*{Derniers changements} +\egroup + +\begin{tdocbreak} + \item Mise en forme : la classe \tdoccls{scrartcl} remplace la vénérable \tdoccls{article}. Cela implique un meilleur positionnement des notes de marge avec les options retenues pour charger \tdoccls{scrartcl}. + + \item Code \LaTeX\ : la macro \tdocmacro{tdocinlatex} a été renommée \tdocmacro{tdoclatexin}. + + \item Les noms des clés pour les couleurs utiliseront des traits d'union lorsque cela sera nécessaire : cela implique les changements suivants. + % + \begin{enumerate} + \item Mise en avant colorée de contenus : l'option \tdoclatexin{colchges} des environnements a été renommée \tdoclatexin{col-chges}. + + \item Démonstration de codes \LaTeX\ : pour l'environnement \tdocenv*{tdocshowcase} et la macro \tdocmacro{tdocshowcaseinput}, les options \tdoclatexin{colstripe} et \tdoclatexin{coltext} ont été renommées \tdoclatexin{col-stripe} et \tdoclatexin{col-text}\,. + \end{enumerate} +\end{tdocbreak} + + +\begin{tdocfix} + \item Mise en avant colorée de contenus : pour les \tdocmacro{newkeytheorem} utilisés avec le thème \tdoclatexin{draft}, il a fallu ajouter \tdoclatexin{postheadhook = \leavevmode} (ceci est nécessaire car le contenu peut juste être de type liste). +\end{tdocfix} + + \begin{tdocnew} - \item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} ont un nouvel argument final facultatif \tdocinlatex{<voffset>} pour choisir un décalage vertical spécifique. + \item Documentation : ajout d'une section listant les dépendances. - \item De meilleurs environnements pour indiquer les modifications apportées. + \item Options de classe. + % \begin{enumerate} - \item Les nouvelles clés facultatives \tdocinlatex{col}\,, \tdocinlatex{date} et \tdocinlatex{version} permettent d'indiquer la date et la version d'une modification apportée à un sujet spécifique. + \item Les options qui ne sont pas spécifiques à \thisproj\ sont transmises à la classe chargée de la mise en forme générale. - \item Utilisation de \tdocmacro{paragraph} pour le titre. + \item Les options \tdoclatexin{fontsize} et \tdoclatexin{DIV} de la classe \tdoccls{scrartcl} ne peuvent pas être utilisées, car leurs valeurs sont fixées par \thisproj. \end{enumerate} -\end{tdocnew} + + \item La macro \tdocmacro{tdocinEN} respecte les règles linguistiques anglaises. + + \item Mise en avant colorée de contenus. + % + \begin{enumerate} + \item Un nouvel environnement \tdocenv{tdoctodo} a été ajouté. + + \item Chaque environnement dispose d'une nouvelle option \tdoclatexin{col} pour la couleur du contenu indiquant les changements. + \end{enumerate} +\end{tdocnew} \begin{tdocupdate} - \item Changements : la police des notes de marge aura toujours une forme normale. + \item Le thème \tdoclatexin{draft} et les changements : les environnements pour les types de changements n'mploient plus d'icones. - \item Ornement : utilisation d'un \tdocinlatex{\cleaders} pour éviter les lignes orphelines en bas de page. + \item Documentation : la galerie des thèmes utilise un meilleur exemple factice. \end{tdocupdate} -\end{tdocnote} -\end{minipage} -\end{center} + + + +\begin{tdoctech} + \item Organisation simplifiée des fichiers de configuration dans le projet final. + % + \begin{enumerate} + \item Comme du \texttt{CSS} : emploi d'un fichier par thème avec des noms du type \texttt{tutodoc-bw.css.cls}\,. + + + \item Locale : utilisation de noms comme \texttt{tutodoc-fr.loc.cls}\,. + \end{enumerate} +\end{tdoctech} +} \newpage @@ -955,113 +1159,90 @@ Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli... \newpage -\section{Mises en forme générales imposées} +\section{Dépendances} -\subsection{Géométrie de la page} +\thisproj\ admet les dépendances suivantes (les dates entre parenthèses sont celles des versions utilisées lors des derniers tests). +% +\begin{tasks}[style=itemize](2) + \task \texttt{scrartcl.cls} + \hfill {\small (2024/10/24)}\kern10pt -Le package \tdocpack{geometry} est chargé avec les réglages suivants. + \task \texttt{clrstrip.sty} + \hfill {\small (2021/08/28)}\kern10pt + \task \texttt{csquotes.sty} + \hfill {\small (2024/04/04)}\kern10pt -\begin{tdoclatex}[code] -\RequirePackage[ - top = 2.5cm, - bottom = 2.5cm, - left = 2.5cm, - right = 2.5cm, - marginparwidth = 2cm, - marginparsep = 2mm, - heightrounded -]{geometry} -\end{tdoclatex} + \task \texttt{fontawesome5.sty} + \hfill {\small (2022/05/02)}\kern10pt + \task \texttt{geometry.sty} + \hfill {\small (2020/01/02)}\kern10pt -\subsection{Titre et table des matières} - -Les packages \tdocpack{titlesec} et \tdocpack{tocbasic} sont réglés comme suit. - - -\begin{tdoclatex}[code] -\RequirePackage[raggedright]{titlesec} - -% ... -\ifcsundef{chapter}% - {}% - {\renewcommand\thechapter{\Alph{chapter}.}} - -\renewcommand\thesection{\Roman{section}.} -\renewcommand\thesubsection{\arabic{subsection}.} -\renewcommand\thesubsubsection{\roman{subsubsection}.} - -\titleformat{\paragraph}[hang]% - {\normalfont\normalsize\bfseries}% - {\theparagraph}{1em}% - {} - -\titlespacing*{\paragraph}% - {0pt}% - {3.25ex plus 1ex minus .2ex}% - {0.5em} - -% Source -% * https://tex.stackexchange.com/a/558025/6880 -\DeclareTOCStyleEntries[ - raggedentrytext, - linefill = \hfill, - indent = 0pt, - dynindent, - numwidth = 0pt, - numsep = 1ex, - dynnumwidth -]{tocline}{ - chapter, - section, - subsection, - subsubsection, - paragraph, - subparagraph -} + \task \texttt{hyperref.sty} + \hfill {\small (2024/11/05)}\kern10pt -\DeclareTOCStyleEntry[indentfollows = chapter]{tocline}{section} -\end{tdoclatex} + \task \texttt{inputenc.sty} + \hfill {\small (2024/02/08)}\kern10pt + \task \texttt{keytheorems.sty} + \hfill {\small (2024/11/11)}\kern10pt -\subsection{Liens dynamiques} + \task \texttt{marginnote.sty} + \hfill {\small (2018/08/09)}\kern10pt -Le package \tdocpack{hyperref} est importé en coulisse avec les réglages ci-dessous. + \task \texttt{minted.sty} + \hfill {\small (2024/11/17)}\kern10pt + \task \texttt{tcolorbox.sty} + \hfill {\small (2024/10/22)}\kern10pt +\end{tasks} -\begin{tdoclatex}[code] -\newcommand{\tdoclinkcolor}{NavyBlue!85!white} -\hypersetup{ - colorlinks, - citecolor = \tdoclinkcolor, - filecolor = \tdoclinkcolor, - linkcolor = \tdoclinkcolor, - urlcolor = \tdoclinkcolor -} -\end{tdoclatex} +\section{Mises en forme générales imposées} + +\subsection{Taille de la police et géométrie de la page} + +La classe \tdoccls{scrartcl} est chargée via l'option \tdoclatexin{fontsize = 10pt}\,, et le package \tdocpack{geometry} gère les dimensions de la page. + + +\begin{tdocwarn} + Les macros pour dater et versionner présentées dans la section \ref{tutodoc-changes} ont besoin de réglages fixes pour la géométrie des pages et la taille de la police. +\end{tdocwarn} + + +\subsection{Titres et table des matières} + +Les réglages choisis sont directement visibles dans cette documentation. + + +\subsection{Liens dynamiques} + +Le package \tdocpack{hyperref} est importé, si ce n'est pas fait, et les réglages choisis portent juste sur les couleurs des liens relatifs aux citations, aux fichiers, aux liens internes, et enfin aux \verb#url# (cette couleur dépendra du thème choisi). \section{Quelle langue est utilisée par la classe \thisproj\ ?} -Cette documentation charge le package \tdocpack{babel} via \tdocinlatex|\usepackage[french]{babel}|\,. -Dès lors, la classe \thisproj\ repère \tdocinlatex|fr| comme langue principale utilisée par \tdocpack{babel}.% +Cette documentation charge le package \tdocpack{babel} via \tdoclatexin|\usepackage[english]{babel}|\, un package que \thisproj\ ne charge pas. +En revanche, la classe \thisproj\ identifie \tdoclatexin|fr| comme la langue principale utilisée par \tdocpack{babel}.%. \footnote{ - Techniquement, on utilise \tdocinlatex|\BCPdata{language}| qui renvoie une langue au format court. + Techniquement, on utilise \tdoclatexin|\BCPdata{language}| qui renvoie une langue au format court. } Comme cette langue fait partie de la liste des langues prises en compte, voir ci-dessous, la classe \thisproj\ produira les effets attendus. -\begin{multicols}{3} - \begin{itemize} - \item \tdocinlatex|en| : anglais. - \item \tdocinlatex|es| : espagnol. - \item \tdocinlatex|fr| : français. - \end{itemize} -\end{multicols} +\begin{tasks}[label=\small\textbullet](3) + \task \tdoclatexin|en| : anglais. + \task \tdoclatexin|es| : espagnol. + \task \tdoclatexin|fr| : français. +\end{tasks} +\begin{tdocnote} + Les packages \tdocpack{babel} et \tdocpack{polyglossia} sont pris en compte. +\end{tdocnote} + + \begin{tdoccaut} Si le choix de la langue principale n'est pas faite dans le préambule, le mécanisme employé échouera avec des effets de bord non voulus (voir l'avertissement qui suit). \end{tdoccaut} @@ -1072,22 +1253,16 @@ Comme cette langue fait partie de la liste des langues prises en compte, voir ci \end{tdocwarn} -\begin{tdocnote} - Le mécanisme utilisé devrait être compatible avec le package \tdocpack{polyglossia}. -\end{tdocnote} - - \section{Cela veut dire quoi en \tdocquote{anglais}} Penser aux non-anglophones est bien, même si ces derniers se font de plus en plus rares. - \begin{tdoclatex} Cool et top signifient \tdocinEN*{cool} et \tdocinEN{top}. \end{tdoclatex} -La macro \tdocmacro{tdocinEN} et sa version étoilée s'appuient sur \tdocmacro{tdocquote} : par exemple, \tdocquote{sémantique} s'obtient via \tdocinlatex|\tdocquote{sémantique}| . +La macro \tdocmacro{tdocinEN} et sa version étoilée s'appuient sur \tdocmacro{tdocquote} : par exemple, \tdocquote{sémantique} s'obtient via \tdoclatexin|\tdocquote{sémantique}| . \begin{tdocnote} @@ -1095,23 +1270,32 @@ La macro \tdocmacro{tdocinEN} et sa version étoilée s'appuient sur \tdocmacro{ \end{tdocnote} +Dans le contenu entre guillemets, les règles linguistiques anglaises sont respectées comme le montre l'exemple suivant. + +\begin{tdoclatex} +Test: \tdocquote{OK?} + +\tdocinEN{Test: \tdocquote{OK?}} +\end{tdoclatex} + + \section{Choisir son thème} -Pour modifier la mise en forme générale, la classe \thisproj\ propose l'option \tdocinlatex{theme = <choix>} où \tdocinlatex{<choix>} peut prendre les valeurs suivantes. +Pour modifier la mise en forme générale, la classe \thisproj\ propose l'option \tdoclatexin{theme = <choix>} où \tdoclatexin{<choix>} peut prendre les valeurs suivantes. -\begin{itemize} - \item \tdocinlatex|bw| : - ce thème est de type noir-et-blanc avec certaines nuances de gris. +\begin{tasks}[style=itemize] + \task \tdoclatexin{bw}: + un thème de type noir-et-blanc avec certaines nuances de gris. - \item \tdocinlatex|color| : - ce thème est coloré, \emph{c'est la valeur par défaut}. + \task \tdoclatexin{color}: + un thème coloré : c'est \emph{la valeur par défaut}. - \item \tdocinlatex|dark| : - ce thème est sombre, idéal pour se reposer les yeux. + \task \tdoclatexin{dark}: + un thème sombre idéal pour se reposer les yeux. - \item \tdocinlatex|draft| : - ce thème est juste pour une impression papier à la recherche d'erreurs de contenu pas forcément simples à débusquer devant son écran. -\end{itemize} + \task \tdoclatexin{draft}: + un thème pour une impression papier à la recherche d'erreurs de contenu pas forcément simples à débusquer devant un écran. +\end{tasks} \begin{tdocnote} @@ -1131,10 +1315,9 @@ Pour modifier la mise en forme générale, la classe \thisproj\ propose l'option % An annex page for a pretty doc. \newpage -% Source. -% + https://tex.stackexchange.com/a/8547/6880 \bgroup - \titleformat{\section}[block]{\Huge\bfseries\filcenter}{}{1em}{} + \setkomafont{section}{\Huge\bfseries} + \addtokomafont{section}{\centering} \phantomsection\section*{Annexe -- Galerie des thèmes}% \label{tutodoc-theme-gallery} \addcontentsline{toc}{section}{Annexe -- Galerie des thèmes}% @@ -1200,7 +1383,7 @@ Pour modifier la mise en forme générale, la classe \thisproj\ propose l'option \subsection{Du contenu dans le flot de la lecture} \begin{tdocimp} - Tous les environnements présentés dans cette section partagent le même compteur qui sera remis à zéro dès qu'une section de niveau au moins égale à une \tdocinlatex|\section| sera ouverte. + Tous les environnements présentés dans cette section partagent le même compteur qui sera remis à zéro dès qu'une section de niveau au moins égale à une \tdoclatexin|\section| sera ouverte. \end{tdocimp} @@ -1241,7 +1424,7 @@ Tout se passe via \tdocenv{tdocrem} avec un fonctionnement identique à l'enviro Quant aux icônes, elles sont obtenues via le package \tdocpack{fontawesome5}, et la macro \tdocmacro{tdocicon} gère l'espacement vis-à-vis du texte. \footnote{ Par exemple, - \tdocinlatex|\fbox{\tdocicon{\faBed}{Fatigué}}| + \tdoclatexin|\fbox{\tdocicon{\faBed}{Fatigué}}| produit\, \fbox{\tdocicon{\faBed}{Fatigué}}\,. } @@ -1261,7 +1444,7 @@ L'environnement \tdocenv*{tdoctip} sert à donner des astuces. Voici comment l'e \begin{tdoctip} - Quelque fois, un contenu mis en avant peut se réduire à une liste. Dans ce cas, la mise en forme peut être améliorée comme suit où nous utilisons l'option \tdocinlatex{wide} du package \tdocpack{enumitem}. + Quelque fois, un contenu mis en avant peut se réduire à une liste. Dans ce cas, la mise en forme peut être améliorée comme suit où nous utilisons l'option \tdoclatexin{wide} du package \tdocpack{enumitem}. \tdoclatexinput[sbs]{examples-admonitions-leavevmode-items.tex} @@ -1307,12 +1490,13 @@ Voici ce qu'il est possible de taper de façon sémantique. \tdocenv[{[opt1]<opt2>}]{env} \\ Juste \tdocenv*{env}... \\ Enfin \tdocenv*[{[opt1]<opt2>}]{env}... + % Pour les copier-coller. \end{tdoclatex} \begin{tdocrem} - Contrairement à \tdocmacro{tdocinlatex}, les macros \tdocmacro{tdocenv} et \tdocmacro{tdocenv*} ne colorent pas le texte produit. - De plus, \tdocinlatex{\tdocenv{monenv}} produit \tdocenv{monenv} avec des espaces afin d'autoriser des retours à la ligne si besoin. + Contrairement à \tdocmacro{tdoclatexin}, les macros \tdocmacro{tdocenv} et \tdocmacro{tdocenv*} ne colorent pas le texte produit. + De plus, \tdoclatexin{\tdocenv{monenv}} produit \tdocenv{monenv} avec des espaces afin d'autoriser des retours à la ligne si besoin. \end{tdocrem} @@ -1339,7 +1523,7 @@ Pour expliquer les noms retenus, rien de tel que d'indiquer et expliciter les co \begin{tdocrem} - Le choix du point pour scinder un mot permet d'utiliser des mots avec un tiret comme dans \tdocinlatex+\tdocprewhy{ca.sse-brique}+ qui donne \tdocprewhy{ca.sse-brique}. + Le choix du point pour scinder un mot permet d'utiliser des mots avec un tiret comme dans \tdoclatexin+\tdocprewhy{ca.sse-brique}+ qui donne \tdocprewhy{ca.sse-brique}. \end{tdocrem} @@ -1402,7 +1586,7 @@ Il est parfois utile d'obtenir directement le rendu d'un code dans la documentat \begin{tdocnote} Dans l'exemple précédent, le texte utilise bien l'orange assombri proposé. Par contre, le rouge sert de base pour obtenir les couleurs utilisées pour la bande : les transformations utilisées dépendent du thème choisi.% \footnote{ - Par exemple, les thèmes \tdocinlatex{bw} et \tdocinlatex{draft} ne tiennent pas compte de la clé \tdocinlatex{colstripe} ! + Par exemple, les thèmes \tdoclatexin{bw} et \tdoclatexin{draft} ne tiennent pas compte de la clé \tdoclatexin{col-stripe} ! } % Il faut également savoir qu'en coulisse, la macro \tdocmacro{tdocruler} est employée. @@ -1436,14 +1620,14 @@ Il est possible de ne pas utiliser une bande colorée comme nous allons le voir L'emploi de \tdocenv[{[nostripe]}]{tdocshowcase} demande de ne pas faire appel à \tdocpack{clrstrip}. Voici un exemple d'utilisation. - \tdoclatexinput[code]{examples-showcase-no-clrstrip.tex} + \tdoclatexinput[code]{examples-showcase-nostripe.tex} Ceci produira ce qui suit. \medskip - \input{examples-showcase-no-clrstrip.tex} + \input{examples-showcase-nostripe.tex} \end{tdocexa} @@ -1451,14 +1635,14 @@ Il est possible de ne pas utiliser une bande colorée comme nous allons le voir \begin{tdocexa}[Changer les couleurs et/ou les textes par défaut] \leavevmode - \tdoclatexinput[code]{examples-showcase-no-clrstrip-customized.tex} + \tdoclatexinput[code]{examples-showcase-nostripe-customized.tex} Ceci produira l'horreur suivante. \medskip - \input{examples-showcase-no-clrstrip-customized.tex} + \input{examples-showcase-nostripe-customized.tex} \end{tdocexa} @@ -1469,7 +1653,7 @@ Pour obtenir des rendus en important le code depuis un fichier externe, au lieu \begin{tdocexa} - Ce qui suit a été obtenu via \tdocinlatex+\tdocshowcaseinput{external.tex}+. + Ce qui suit a été obtenu via \tdoclatexin+\tdocshowcaseinput{external.tex}+. \medskip @@ -1478,11 +1662,11 @@ Pour obtenir des rendus en important le code depuis un fichier externe, au lieu \medskip - Quant à \tdocinlatex+\tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{external.tex}+\,, ceci produira le changement de couleur observable ci-après. + Via \tdoclatexin+\tdocshowcaseinput[col-stripe = red, col-text = orange!75!black]{external.tex}+\,, on obtient le changement de couleur observable ci-après. \medskip - \tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{examples-showcase-external.tex} + \tdocshowcaseinput[col-stripe = red, col-text = orange!75!black]{examples-showcase-external.tex} \end{tdocexa} @@ -1504,27 +1688,27 @@ Documenter un package ou une classe se fait efficacement via des cas d'utilisati \subsection{Codes \tdocquote{en ligne}} \label{tutodoc-listing-inline} -La macro \tdocmacro{tdocinlatex} +La macro \tdocmacro{tdoclatexin} \footnote{ - Le nom de la macro \tdocmacro{tdocinlatex} vient de \tdocquote{\tdocprewhy{in.line} \LaTeX} soit \tdocinEN{\LaTeX\ en ligne}. + Le nom de la macro \tdocmacro{tdoclatexin} vient de \tdocquote{\tdocprewhy{in.line} \LaTeX} soit \tdocinEN{\LaTeX\ en ligne}. } permet de taper du code en ligne via un usage similaire à \tdocmacro{verb} ou bien comme une macro standard (voir la gestion des accolades dans le dernier cas ci-dessous). Voici des exemples d'utilisation. \begin{tdoclatex}[sbs] - 1: \tdocinlatex|$a^b = c$| \\ - 2: \tdocinlatex+\tdocinlatex|$a^b = c$|+ \\ - 3: \tdocinlatex{\tdocinlatex{$a^b = c$}} + 1: \tdoclatexin|$a^b = c$| \\ + 2: \tdoclatexin+\tdoclatexin|$a^b = c$|+ \\ + 3: \tdoclatexin{\tdoclatexin{$a^b = c$}} \end{tdoclatex} \begin{tdocnote} - La macro \tdocmacro{tdocinlatex} est utilisable dans une note de pied de page : voir ci-dessous. + La macro \tdocmacro{tdoclatexin} est utilisable dans une note de pied de page : voir ci-dessous. \footnote{ - \tdocinlatex+$minted = TOP$+ a été tapé \tdocinlatex|\tdocinlatex+$minted = TOP$+| dans cette note de bas de page.. + \tdoclatexin+$minted = TOP$+ a été tapé \tdoclatexin|\tdoclatexin+$minted = TOP$+| dans cette note de bas de page.. } - De plus, une couleur de fond est volontairement utilisée pour subtilement faire ressortir les codes \tdocinlatex#\LaTeX#\,. + De plus, une couleur de fond est volontairement utilisée pour subtilement faire ressortir les codes \tdoclatexin#\LaTeX#\,. \end{tdocnote} @@ -1533,16 +1717,16 @@ Voici des exemples d'utilisation. \begin{tdocexa}[Face à face] Via \tdocenv[{[sbs]}]{tdoclatex}, on affichera un code et son rendu côte à côte. - Indiquons que \tdocinlatex#sbs# est pour \tdocquote{\tdocprewhy{s.ide} \tdocprewhy{b.y} \tdocprewhy{s.ide}} soit \tdocinEN{côte à côte}. + Indiquons que \tdoclatexin#sbs# est pour \tdocquote{\tdocprewhy{s.ide} \tdocprewhy{b.y} \tdocprewhy{s.ide}} soit \tdocinEN{côte à côte}. \tdocbasicinputDOC{examples-listing-ABC.tex} \end{tdocexa} \begin{tdocexa}[À la suite] - \tdocenv{tdoclatex} produit le résultat suivant qui correspond à l'option par défaut \tdocinlatex#std#\,. + \tdocenv{tdoclatex} produit le résultat suivant qui correspond à l'option par défaut \tdoclatexin#std#\,. \footnote{ - \tdocinlatex{std} fait référence au comportement \tdocquote{standard} de \tdocpack{tcolorbox} vis à vis de la librairie \tdocpack{minted}. + \tdoclatexin{std} fait référence au comportement \tdocquote{standard} de \tdocpack{tcolorbox} vis à vis de la librairie \tdocpack{minted}. } \begin{tdoclatex} @@ -1611,7 +1795,7 @@ La macro \tdocmacro{tdoclatexinput}, présentée ci-dessous, attend le chemin d' \end{tdoclatex} - Ceci produit la mise en forme suivante où l'option employée par défaut est \tdocinlatex#std#. + Ceci produit la mise en forme suivante où l'option employée par défaut est \tdoclatexin#std#. \tdoclatexinput{examples-listing-xyz.tex} @@ -1638,7 +1822,7 @@ La macro \tdocmacro{tdoclatexinput}, présentée ci-dessous, attend le chemin d' \label{tutodoc-latexshow} \begin{tdocexa}[Mise en situation] - Ce qui suit s'obtient via \tdocinlatex+\tdoclatexshow{examples-listing-xyz.tex}+. + \tdoclatexin+\tdoclatexshow{examples-listing-xyz.tex}+ produit ce qui suit. \medskip @@ -1655,7 +1839,7 @@ La macro \tdocmacro{tdoclatexinput}, présentée ci-dessous, attend le chemin d' \begin{tdocexa}[Changer le texte explicatif] - Via la clé \tdocinlatex|explain|, on peut utiliser un texte personnalisé. Ainsi, \tdocinlatex|\tdoclatexshow[explain = Voici le rendu réel.]{examples-listing-xyz.tex}| produira ce qui suit. + Via la clé \tdoclatexin|explain|, on peut utiliser un texte personnalisé. Ainsi, \tdoclatexin|\tdoclatexshow[explain = Voici le rendu réel.]{examples-listing-xyz.tex}| produira ce qui suit. \medskip @@ -1689,6 +1873,7 @@ La macro \tdocmacro{tdoclatexinput}, présentée ci-dessous, attend le chemin d' \section{Indiquer les changements} +\label{tutodoc-changes} Afin de faciliter le suivi d'un projet, il est indispensable de fournir un historique indiquant les changements effectués lors de la publication d'une nouvelle version. @@ -1716,6 +1901,22 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas \end{tdocexa} +\begin{tdocexa}[Attention avec les titres de paragraphe] + L'exemple suivant montre qu'il faut placer une dates et/ou une version juste après un titre de paragraphe, et non avant. + + \tdoclatexshow{examples-version-n-change-para-title.tex} + +\end{tdocexa} + + +\begin{tdocexa}[Régler le positionnement vertical] + Si besoin, on peut modifier le décalage vertical utilisé pour bien placer les dates et les versions dans la marge, la valeur par défaut étant $(-8\,\mathit{pt})$. + + \tdoclatexshow{examples-version-n-change-manual-setting.tex} + +\end{tdocexa} + + \begin{tdocimp} \begin{enumerate}[wide] \item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} nécessitent deux compilations. @@ -1726,7 +1927,7 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas \begin{tdoccaut} - Seul l'emploi du format numérique \tdocinlatex+YYYY-MM-DD+ est vérifié, + Seul l'emploi du format numérique \tdoclatexin+YYYY-MM-DD+ est vérifié, \footnote{ Techniquement, vérifier la validité d'une date, via \LaTeX3, ne présente pas de difficulté. } @@ -1737,29 +1938,25 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas \end{tdoccaut} -\begin{tdocwarn} - En coulisse, le gros du travail est fait par la macro \tdocmacro{\marginnote} du package éponyme. - Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} souffrent donc des même effets de bord comme dans l'exemple suivant. - On peut tout de même régler ces problèmes via un argument optionnel \tdocinlatex{<déplacement-vertical>} comme à la fin de l'exemple ci-après. C'est moche, mais fonctionnel. - - \tdoclatexshow[nostripe, colstripe=red]{examples-version-n-change-side-effect.tex} - -\end{tdocwarn} - - \subsection{Quoi de neuf ?} -\thisproj\ propose la macro \tdocmacro{tdocstartproj} et différents environnements pour indiquer rapidement et clairement ce qui a été fait lors des derniers changements.% +\thisproj\ propose la macro \tdocmacro{tdocstartproj} et différents environnements pour indiquer rapidement et clairement ce qui a été fait lors des changements faits, ou à venir.% \footnote{ L'utilisateur n'a pas besoin de tous les détails techniques. } \begin{tdocnote} - Concernant les icônes, voir la note au début de la section \ref{tutodoc-admonitions} page \pageref{tutodoc-admonitions}. +\begin{tdocnew} + \item Info 1... + \item Info 2... +\end{tdocnew} +% Concernant les icônes, voir la note au début de la section \ref{tutodoc-admonitions} page \pageref{tutodoc-admonitions}. \end{tdocnote} +\subsubsection{La sobriété avant tout} + \foreach \exatitle/\filename in { {Juste pour la toute première version}/%<-- Translate me! first, @@ -1773,6 +1970,8 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas pb, {Pour les réparations}/% <-- Translate me! fix, + {Feuille de route}/% <-- Translate me! + todo, {Informations techniques}/% <-- Translate me! tech, % @@ -1784,19 +1983,34 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas \begin{tdocexa}[\exatitle] \leavevmode - \tdoclatexinput[sbs]{examples-version-n-change-\filename.tex} + \tdoclatexinput[sbs]{examples-version-n-change-chges-\filename.tex} \end{tdocexa} } -\subsection{Le quoi et le quand} +\subsubsection{De la couleur si besoin} -Les clés optionnelles \tdocinlatex{col}\,, \tdocinlatex{date} et \tdocinlatex{version} permettent de dater et versionner un changement d'un type particulier.% -\footnote{ - L'avertissement à la fin de la section \ref{tutodoc-changes-when} donne la technique utilisée en coulisse, tout en montrant la nécessité de proposer des clés spécialisées. +Il peut être utile de mettre en avant certains changements : ceci n'est faisable qu'en modifiant la couleur du contenu. + +\foreach \exatitle/\filename in { + {Une première version tape-à-l'oeil}/%<-- Translate me! + first, + {Des réparations exceptionnelles}/% <-- Translate me! + fix% +} { + \begin{tdocexa}[\exatitle] + \leavevmode + + \tdoclatexinput[sbs]{examples-version-n-change-color-chges-\filename.tex} + + \end{tdocexa} } -Voici des exemples d'utilisation. + + +\subsection{Le quoi et le quand} + +Les clés optionnelles \tdoclatexin{col-chges}\,, \tdoclatexin{date} et \tdoclatexin{version} permettent de dater et versionner directement un changement d'un type particulier. Voici des exemples d'utilisation. \tdoclatexshow{examples-version-n-change-what-n-when.tex} @@ -1964,29 +2178,101 @@ Le fichier \texttt{LICENSE.txt} est bien nommé, tandis que le fichier \texttt{R La participation en tant que codeuse, ou codeur, se fait via le dépôt \thisrepo\ correspondant à la branche de développement \verb#tutodoc#. -Ne pas passer via la branche \verb#main# qui sert à figer les dernières versions stables des projets du dépôt unique \thismonorepo\,. + + +\begin{tdoccaut} + Ne pas passer via la branche \verb#main# qui sert à figer les dernières versions stables des projets du dépôt unique \thismonorepo\,. +\end{tdoccaut} \section{Historique} \small +\begin{tdocbreak}[version = 1.7.0, date = 2024-12-04] + \item Mise en forme : la classe \tdoccls{scrartcl} remplace la vénérable \tdoccls{article}. Cela implique un meilleur positionnement des notes de marge avec les options retenues pour charger \tdoccls{scrartcl}. + + \item Code \LaTeX\ : la macro \tdocmacro{tdocinlatex} a été renommée \tdocmacro{tdoclatexin}. + + \item Les noms des clés pour les couleurs utiliseront des traits d'union lorsque cela sera nécessaire : cela implique les changements suivants. + % + \begin{enumerate} + \item Mise en avant colorée de contenus : l'option \tdoclatexin{colchges} des environnements a été renommée \tdoclatexin{col-chges}. + + \item Démonstration de codes \LaTeX\ : pour l'environnement \tdocenv*{tdocshowcase} et la macro \tdocmacro{tdocshowcaseinput}, les options \tdoclatexin{colstripe} et \tdoclatexin{coltext} ont été renommées \tdoclatexin{col-stripe} et \tdoclatexin{col-text}\,. + \end{enumerate} +\end{tdocbreak} + + +\begin{tdocfix} + \item Mise en avant colorée de contenus : pour les \tdocmacro{newkeytheorem} utilisés avec le thème \tdoclatexin{draft}, il a fallu ajouter \tdoclatexin{postheadhook = \leavevmode} (ceci est nécessaire car le contenu peut juste être de type liste). +\end{tdocfix} + + +\begin{tdocnew} + \item Documentation : ajout d'une section listant les dépendances. + + \item Options de classe. + % + \begin{enumerate} + \item Les options qui ne sont pas spécifiques à \thisproj\ sont transmises à la classe chargée de la mise en forme générale. + + \item Les options \tdoclatexin{fontsize} et \tdoclatexin{DIV} de la classe \tdoccls{scrartcl} ne peuvent pas être utilisées, car leurs valeurs sont fixées par \thisproj. + \end{enumerate} + + \item La macro \tdocmacro{tdocinEN} respecte les règles linguistiques anglaises. + + \item Mise en avant colorée de contenus. + % + \begin{enumerate} + \item Un nouvel environnement \tdocenv{tdoctodo} a été ajouté. + + \item Chaque environnement dispose d'une nouvelle option \tdoclatexin{col} pour la couleur du contenu indiquant les changements. + \end{enumerate} +\end{tdocnew} + + +\begin{tdocupdate} + \item Le thème \tdoclatexin{draft} et les changements : les environnements pour les types de changements n'mploient plus d'icones. + + \item Documentation : la galerie des thèmes utilise un meilleur exemple factice. +\end{tdocupdate} + + + +\begin{tdoctech} + \item Organisation simplifiée des fichiers de configuration dans le projet final. + % + \begin{enumerate} + \item Comme du \texttt{CSS} : emploi d'un fichier par thème avec des noms du type \texttt{tutodoc-bw.css.cls}\,. + + + \item Locale : utilisation de noms comme \texttt{tutodoc-fr.loc.cls}\,. + \end{enumerate} +\end{tdoctech} + +\tdocsep + + +% ------------------ % + + \begin{tdocnew}[version = 1.6.2, date = 2024-10-30] - \item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} ont un nouvel argument final facultatif \tdocinlatex{<voffset>} pour choisir un décalage vertical spécifique. + \item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} ont un nouvel argument final facultatif \tdoclatexin{<voffset>} pour choisir un décalage vertical spécifique. \item De meilleurs environnements pour indiquer les modifications apportées. \begin{enumerate} - \item Les nouvelles clés facultatives \tdocinlatex{col}\,, \tdocinlatex{date} et \tdocinlatex{version} permettent d'indiquer la date et la version d'une modification apportée à un sujet spécifique. + \item Les nouvelles clés facultatives \tdoclatexin{col}\,, \tdoclatexin{date} et \tdoclatexin{version} permettent d'indiquer la date et la version d'une modification apportée à un sujet spécifique. \item Utilisation de \tdocmacro{paragraph} pour le titre. \end{enumerate} -\end{tdocnew} +\end{tdocnew} \begin{tdocupdate} \item Changements : la police des notes de marge aura toujours une forme normale. - \item Ornement : utilisation d'un \tdocinlatex{\cleaders} pour éviter les lignes orphelines en bas de page. + \item Ornement : utilisation d'un \tdoclatexin{\cleaders} pour éviter les lignes orphelines en bas de page. \end{tdocupdate} \tdocsep @@ -2006,18 +2292,18 @@ Ne pas passer via la branche \verb#main# qui sert à figer les dernières versio \begin{tdocbreak}[version = 1.6.0, date = 2024-10-27] - \item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdocinlatex{color} a été renommée \tdocinlatex{colstripe}. + \item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdoclatexin{color} a été renommée \tdoclatexin{col-stripe}. - \item La macro \tdocmacro{tdoclinkcolor} devient la couleur \tdocinlatex{tutodoc@link@color} destinée à un usage interne. + \item La macro \tdocmacro{tdoclinkcolor} devient la couleur \tdoclatexin{tutodoc@link@color} destinée à un usage interne. \end{tdocbreak} \begin{tdocnew} - \item L'option de classe \tdocinlatex{theme} permet de choisir différents thèmes de mise en forme. + \item L'option de classe \tdoclatexin{theme} permet de choisir différents thèmes de mise en forme. \item Journal des modifications : ajout de l'environnement \tdocenv*{tdoctech} pour les informations techniques. - \item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdocinlatex{coltext} permet de changer aussi la couleur du texte. + \item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdoclatexin{col-text} permet de changer aussi la couleur du texte. \item Les nouvelles fonctionnalités ont été documentées. \end{tdocnew} @@ -2048,7 +2334,7 @@ Ne pas passer via la branche \verb#main# qui sert à figer les dernières versio \begin{tdocbreak} \item La classe \thisproj\ remplace le défunt package \thisproj\ (pour le moment, la toute jeune classe ne propose aucune option spécifique). - \item La macro \tdocmacro{tdocruler} s'emploie dorénavant via \tdocinlatex{\tdocruler[<color>]{<text>}} (avant il fallait utiliser \tdocinlatex{\tdocruler{<text>}{<color>}}). + \item La macro \tdocmacro{tdocruler} s'emploie via \tdoclatexin{\tdocruler[<color>]{<text>}} au lieu de \tdoclatexin{\tdocruler{<text>}{<color>}}\,. \end{tdocbreak} @@ -2131,18 +2417,14 @@ Ne pas passer via la branche \verb#main# qui sert à figer les dernières versio \item Mise en avant de contenus : des cadres colorés avec des icônes sont proposés pour les environnements suivants. - \bgroup - \setlength\multicolsep{5pt} - \begin{multicols}{3} - \begin{enumerate} - \item \tdocenv*{tdoccaution} - \item \tdocenv*{tdocimp} - \item \tdocenv*{tdocnote} - \item \tdocenv*{tdoctip} - \item \tdocenv*{tdocwarn} - \end{enumerate} - \end{multicols} - \egroup + % + \begin{tasks}[label=\arabic*.](3) + \task \tdocenv*{tdoccaution} + \task \tdocenv*{tdocimp} + \task \tdocenv*{tdocnote} + \task \tdocenv*{tdoctip} + \task \tdocenv*{tdocwarn} + \end{tasks} \end{tdocnew} \tdocsep @@ -2179,7 +2461,7 @@ Ne pas passer via la branche \verb#main# qui sert à figer les dernières versio \item \tdocenv{tdocprob} pour les problèmes repérés. \end{enumerate} - \item \tdocmacro{tdocinlatex}: un jaune léger est utilisé comme couleur de fond. + \item \tdocmacro{tdoclatexin}: un jaune léger est utilisé comme couleur de fond. \end{tdocnew} \tdocsep diff --git a/Master/texmf-dist/tex/latex/tutodoc/DEPENDS.yaml b/Master/texmf-dist/tex/latex/tutodoc/DEPENDS.yaml new file mode 100644 index 00000000000..1b8260eaad0 --- /dev/null +++ b/Master/texmf-dist/tex/latex/tutodoc/DEPENDS.yaml @@ -0,0 +1,27 @@ +# ----------------------------------------------------------- # +# -- File generated automatically by TeXoptidep. -- # +# -- -- # +# -- WARNING! The alphabetical order used does not reflect -- # +# -- the order used in the source code. -- # +# ----------------------------------------------------------- # + +class: + - scrartcl + +package: + - clrstrip + - csquotes + - fontawesome5 + - geometry + - hyperref + - inputenc + - keytheorems + - marginnote + - minted + - tcolorbox + +library: + tcolorbox: + - breakable + - minted + - skins diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty deleted file mode 100644 index ab944027997..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty +++ /dev/null @@ -1,46 +0,0 @@ -% -- COLORFUL HIGHLIGHTING OF CONTENT -- % - -\NewExpandableDocumentCommand{\tutodoc@build@title@color}{m}{% - white% -} - -\NewExpandableDocumentCommand{\tutodoc@build@upper@color}{m}{% - \tdocdarkcolor[40]{Gray}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@back@color}{m}{% - \tdoclightcolor[10]{Gray}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@frame@color}{m}{% - Gray!75!black!45% -} - -\colorlet{tutodoc@admonition@shadow@color}{Gray!15} - - -\ExplSyntaxOn - -%%% -% We use two ''prop'' variables to factorize the code just after. -%%% -\prop_new:N \g__tutodoc_focus_color_prop -\prop_new:N \g__tutodoc_focus_icon_prop - -\prop_set_from_keyval:Nn \g__tutodoc_focus_color_prop { - note = DarkGray, - tip = DarkGray, - imp = DarkGray, - caut = DarkGray, - warn = DarkGray, -} - -\prop_set_from_keyval:Nn \g__tutodoc_focus_icon_prop { - note = \faInfoCircle, - tip = \faLightbulb, - imp = \faHighlighter, - caut = \faBiohazard, - warn = \faSkullCrossbones, -} - -\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty deleted file mode 100644 index cb370a49534..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty +++ /dev/null @@ -1,30 +0,0 @@ -% :: INLINE LATEX MACRO :: % - -\newcommand{\tutodoc@latex@style}{friendly_grayscale} - -\colorlet{tutodoc@latex@back@color}{gray!5} -\colorlet{tutodoc@latex@text@color}{black} - - -% :: THE TCOLORBOX LISTING STYLE :: % - -\colorlet{tutodoc@latex@frame@color}{darkgray} - -\newcommand{\tutodoc@latex@left@len}{1mm} -\newcommand{\tutodoc@latex@right@len}{1mm} -\newcommand{\tutodoc@latex@top@len}{1mm} -\newcommand{\tutodoc@latex@bottom@len}{1mm} - -\newcommand{\tutodoc@latex@arc@len}{.75mm} - -\newcommand{\tutodoc@latex@left@rule@len}{1pt} -\newcommand{\tutodoc@latex@right@rule@len}{1pt} -\newcommand{\tutodoc@latex@top@rule@len}{1pt} -\newcommand{\tutodoc@latex@bottom@rule@len}{1pt} - -\colorlet{tutodoc@latex@shadow@color}{black!30} -\newcommand{\tutodoc@latex@shadow@xshift@len}{.75mm} -\newcommand{\tutodoc@latex@shadow@yshift@len}{-.75mm} -\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} - -\colorlet{tutodoc@latex@segment@color}{gray} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty deleted file mode 100644 index af55d326a5a..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty +++ /dev/null @@ -1,3 +0,0 @@ -% -- LINKS -- % - -\definecolor{tutodoc@link@color}{named}{DimGray} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty deleted file mode 100644 index a04b2719f5e..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty +++ /dev/null @@ -1,21 +0,0 @@ -% -- SHOWCASE -- % - -\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% - darkgray% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% - gray!10% -} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty deleted file mode 100644 index fb32c4d116b..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty +++ /dev/null @@ -1,5 +0,0 @@ -% -- VERSION & CHANGES -- % - -\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% - gray% -} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw.css.cls b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw.css.cls new file mode 100644 index 00000000000..cad88f64de4 --- /dev/null +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw.css.cls @@ -0,0 +1,147 @@ +% -- COLORFUL HIGHLIGHTING OF CONTENT -- % + +\NewExpandableDocumentCommand{\tutodoc@build@title@color}{m}{% + white% +} + +\NewExpandableDocumentCommand{\tutodoc@build@upper@color}{m}{% + \tdocdarkcolor[40]{Gray}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@back@color}{m}{% + \tdoclightcolor[10]{Gray}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@frame@color}{m}{% + Gray!75!black!45% +} + +\colorlet{tutodoc@admonition@shadow@color}{Gray!15} + + +\ExplSyntaxOn + +%%% +% We use two ''prop'' variables to factorize the code just after. +%%% +\prop_new:N \g__tutodoc_focus_color_prop +\prop_new:N \g__tutodoc_focus_icon_prop + +\prop_set_from_keyval:Nn \g__tutodoc_focus_color_prop { + note = DarkGray, + tip = DarkGray, + imp = DarkGray, + caut = DarkGray, + warn = DarkGray, +} + +\prop_set_from_keyval:Nn \g__tutodoc_focus_icon_prop { + note = \faInfoCircle, + tip = \faLightbulb, + imp = \faHighlighter, + caut = \faBiohazard, + warn = \faSkullCrossbones, +} + +\ExplSyntaxOff + + + +% :: LEXER USED :: % + +\newcommand{\tutodoc@latex@lexer}{latex} + +% :: INLINE LATEX MACRO :: % + +\newcommand{\tutodoc@latex@style}{friendly_grayscale} + +\colorlet{tutodoc@latex@back@color}{gray!5} +\colorlet{tutodoc@latex@text@color}{black} + + +% :: THE TCOLORBOX LISTING STYLE :: % + +\colorlet{tutodoc@latex@frame@color}{darkgray} + +\newcommand{\tutodoc@latex@left@len}{1mm} +\newcommand{\tutodoc@latex@right@len}{1mm} +\newcommand{\tutodoc@latex@top@len}{1mm} +\newcommand{\tutodoc@latex@bottom@len}{1mm} + +\newcommand{\tutodoc@latex@arc@len}{.75mm} + +\newcommand{\tutodoc@latex@left@rule@len}{1pt} +\newcommand{\tutodoc@latex@right@rule@len}{1pt} +\newcommand{\tutodoc@latex@top@rule@len}{1pt} +\newcommand{\tutodoc@latex@bottom@rule@len}{1pt} + +\colorlet{tutodoc@latex@shadow@color}{black!30} +\newcommand{\tutodoc@latex@shadow@xshift@len}{.75mm} +\newcommand{\tutodoc@latex@shadow@yshift@len}{-.75mm} +\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} + +\colorlet{tutodoc@latex@segment@color}{gray} + + + +% -- TEXT AND PAGE COLORS -- % + +\colorlet{tutodoc@page@color}{white} +\colorlet{tutodoc@text@color}{black} + + +% -- LINKS COLOR -- % + +\definecolor{tutodoc@link@color}{named}{DimGray} + + + +% -- SHOWCASE -- % + +\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% + darkgray% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% + gray!10% +} + + + +% -- VERSION & CHANGES -- % + +\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% + gray% +} + + +% -- ICONS -- % + +\newcommand{\tutodoc@changes@start@project@icon}{\faAnchor} + +\ExplSyntaxOn + +\prop_new:N \g__tutodoc_topic_change_prop +\prop_set_from_keyval:Nn \g__tutodoc_topic_change_prop { + break = \faCodeBranch, + fix = \faWrench, + new = \faGem, + prob = \faFire*, + tech = \faFlask, + update = \reflectbox{\faHistory}, + todo = \faCompass[regular], +} + +\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty deleted file mode 100644 index 1ce4b721d7d..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty +++ /dev/null @@ -1,50 +0,0 @@ -% -- COLORFUL HIGHLIGHTING OF CONTENT -- % - -\NewExpandableDocumentCommand{\tutodoc@build@title@color}{m}{% - white% -} - -\NewExpandableDocumentCommand{\tutodoc@build@upper@color}{m}{% - \tdocdarkcolor{#1}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@lower@color}{m}{% - \tdocdarkcolor{#1}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@back@color}{m}{% - \tdoclightcolor{#1}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@frame@color}{m}{% - #1!75!black!45% -} - -\colorlet{tutodoc@admonition@shadow@color}{black!30} - - -\ExplSyntaxOn - -%%% -% We use two ''prop'' variables to factorize the code just after. -%%% -\prop_new:N \g__tutodoc_focus_color_prop -\prop_new:N \g__tutodoc_focus_icon_prop - -\prop_set_from_keyval:Nn \g__tutodoc_focus_color_prop { - note = cyan, - tip = ForestGreen, - imp = orange, - caut = violet, - warn = red, -} - -\prop_set_from_keyval:Nn \g__tutodoc_focus_icon_prop { - note = \faInfoCircle, - tip = \faLightbulb, - imp = \faHighlighter, - caut = \faBiohazard, - warn = \faSkullCrossbones, -} - -\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty deleted file mode 100644 index 1d62d2eb922..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty +++ /dev/null @@ -1,30 +0,0 @@ -% :: INLINE LATEX MACRO :: % - -\newcommand{\tutodoc@latex@style}{pastie} - -\colorlet{tutodoc@latex@back@color}{yellow!4} -\colorlet{tutodoc@latex@text@color}{black} - - -% :: THE TCOLORBOX LISTING STYLE :: % - -\colorlet{tutodoc@latex@frame@color}{darkgray} - -\newcommand{\tutodoc@latex@left@len}{1mm} -\newcommand{\tutodoc@latex@right@len}{1mm} -\newcommand{\tutodoc@latex@top@len}{1mm} -\newcommand{\tutodoc@latex@bottom@len}{1mm} - -\newcommand{\tutodoc@latex@arc@len}{.75mm} - -\newcommand{\tutodoc@latex@left@rule@len}{1pt} -\newcommand{\tutodoc@latex@right@rule@len}{1pt} -\newcommand{\tutodoc@latex@top@rule@len}{1pt} -\newcommand{\tutodoc@latex@bottom@rule@len}{1pt} - -\colorlet{tutodoc@latex@shadow@color}{black!30} -\newcommand{\tutodoc@latex@shadow@xshift@len}{.75mm} -\newcommand{\tutodoc@latex@shadow@yshift@len}{-.75mm} -\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} - -\colorlet{tutodoc@latex@segment@color}{gray} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty deleted file mode 100644 index 51e3632918e..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty +++ /dev/null @@ -1,3 +0,0 @@ -% -- LINKS -- % - -\colorlet{tutodoc@link@color}{NavyBlue!85!white} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty deleted file mode 100644 index 0f62dc6a08e..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty +++ /dev/null @@ -1,21 +0,0 @@ -% -- SHOWCASE -- % - -\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% - cyan% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% - \tdocdarkcolor{#1}% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% - \tdoclightcolor{#1}% -} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty deleted file mode 100644 index 998e5ad08b0..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty +++ /dev/null @@ -1,5 +0,0 @@ -% -- VERSION & CHANGES -- % - -\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% - \tdoclightcolor[60]{DarkBlue}% -}
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color.css.cls b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color.css.cls new file mode 100644 index 00000000000..8bcf1d0db00 --- /dev/null +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color.css.cls @@ -0,0 +1,151 @@ +% -- COLORFUL HIGHLIGHTING OF CONTENT -- % + +\NewExpandableDocumentCommand{\tutodoc@build@title@color}{m}{% + white% +} + +\NewExpandableDocumentCommand{\tutodoc@build@upper@color}{m}{% + \tdocdarkcolor{#1}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@lower@color}{m}{% + \tdocdarkcolor{#1}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@back@color}{m}{% + \tdoclightcolor{#1}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@frame@color}{m}{% + #1!75!black!45% +} + +\colorlet{tutodoc@admonition@shadow@color}{black!30} + + +\ExplSyntaxOn + +%%% +% We use two ''prop'' variables to factorize the code just after. +%%% +\prop_new:N \g__tutodoc_focus_color_prop +\prop_new:N \g__tutodoc_focus_icon_prop + +\prop_set_from_keyval:Nn \g__tutodoc_focus_color_prop { + note = cyan, + tip = ForestGreen, + imp = orange, + caut = violet, + warn = red, +} + +\prop_set_from_keyval:Nn \g__tutodoc_focus_icon_prop { + note = \faInfoCircle, + tip = \faLightbulb, + imp = \faHighlighter, + caut = \faBiohazard, + warn = \faSkullCrossbones, +} + +\ExplSyntaxOff + + + +% :: LEXER USED :: % + +\newcommand{\tutodoc@latex@lexer}{latex} + +% :: INLINE LATEX MACRO :: % + +\newcommand{\tutodoc@latex@style}{pastie} + +\colorlet{tutodoc@latex@back@color}{yellow!4} +\colorlet{tutodoc@latex@text@color}{black} + + +% :: THE TCOLORBOX LISTING STYLE :: % + +\colorlet{tutodoc@latex@frame@color}{darkgray} + +\newcommand{\tutodoc@latex@left@len}{1mm} +\newcommand{\tutodoc@latex@right@len}{1mm} +\newcommand{\tutodoc@latex@top@len}{1mm} +\newcommand{\tutodoc@latex@bottom@len}{1mm} + +\newcommand{\tutodoc@latex@arc@len}{.75mm} + +\newcommand{\tutodoc@latex@left@rule@len}{1pt} +\newcommand{\tutodoc@latex@right@rule@len}{1pt} +\newcommand{\tutodoc@latex@top@rule@len}{1pt} +\newcommand{\tutodoc@latex@bottom@rule@len}{1pt} + +\colorlet{tutodoc@latex@shadow@color}{black!30} +\newcommand{\tutodoc@latex@shadow@xshift@len}{.75mm} +\newcommand{\tutodoc@latex@shadow@yshift@len}{-.75mm} +\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} + +\colorlet{tutodoc@latex@segment@color}{gray} + + + +% -- TEXT AND PAGE COLORS -- % + +\colorlet{tutodoc@page@color}{white} +\colorlet{tutodoc@text@color}{black} + + +% -- LINKS COLOR -- % + +\colorlet{tutodoc@link@color}{NavyBlue!85!white} + + + +% -- SHOWCASE -- % + +\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% + cyan% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% + \tdocdarkcolor{#1}% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% + \tdoclightcolor{#1}% +} + + + +% -- VERSION & CHANGES -- % + +\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% + \tdoclightcolor[60]{DarkBlue}% +} + + +% -- ICONS -- % + +\newcommand{\tutodoc@changes@start@project@icon}{\faAnchor} + +\ExplSyntaxOn + +\prop_new:N \g__tutodoc_topic_change_prop +\prop_set_from_keyval:Nn \g__tutodoc_topic_change_prop { + break = \faCodeBranch, + fix = \faWrench, + new = \faGem, + prob = \faFire*, + tech = \faFlask, + update = \reflectbox{\faHistory}, + todo = \faCompass[regular], +} + +\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty deleted file mode 100644 index 5716737a1a4..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty +++ /dev/null @@ -1,50 +0,0 @@ -% -- COLORFUL HIGHLIGHTING OF CONTENT -- % - -\NewExpandableDocumentCommand{\tutodoc@build@title@color}{m}{% - \tdocdarkcolor[95]{white}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@upper@color}{m}{% - \tdocdarkcolor[95]{white}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@lower@color}{m}{% - \tdocdarkcolor[95]{white}% -} - -\NewExpandableDocumentCommand{\tutodoc@build@back@color}{m}{% - #1!75!black!65% -} - -\NewExpandableDocumentCommand{\tutodoc@build@frame@color}{m}{% - \tdocdarkcolor[65]{#1}% -} - -\colorlet{tutodoc@admonition@shadow@color}{black!68} - - -\ExplSyntaxOn - -%%% -% We use two ''prop'' variables to factorize the code just after. -%%% -\prop_new:N \g__tutodoc_focus_color_prop -\prop_new:N \g__tutodoc_focus_icon_prop - -\prop_set_from_keyval:Nn \g__tutodoc_focus_color_prop { - note = cyan, - tip = ForestGreen, - imp = orange, - caut = violet, - warn = red, -} - -\prop_set_from_keyval:Nn \g__tutodoc_focus_icon_prop { - note = \faInfoCircle, - tip = \faLightbulb, - imp = \faHighlighter, - caut = \faBiohazard, - warn = \faSkullCrossbones, -} - -\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty deleted file mode 100644 index d285e06253a..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty +++ /dev/null @@ -1,30 +0,0 @@ -% :: INLINE LATEX MACRO :: % - -\newcommand{\tutodoc@latex@style}{github-dark} - -\colorlet{tutodoc@latex@back@color}{\tdocdarkcolor[30]{white}} -\colorlet{tutodoc@latex@text@color}{\tdocdarkcolor[80]{white}} - - -% :: THE TCOLORBOX LISTING STYLE :: % - -\colorlet{tutodoc@latex@frame@color}{darkgray} - -\newcommand{\tutodoc@latex@left@len}{1mm} -\newcommand{\tutodoc@latex@right@len}{1mm} -\newcommand{\tutodoc@latex@top@len}{1mm} -\newcommand{\tutodoc@latex@bottom@len}{1mm} - -\newcommand{\tutodoc@latex@arc@len}{.75mm} - -\newcommand{\tutodoc@latex@left@rule@len}{1pt} -\newcommand{\tutodoc@latex@right@rule@len}{1pt} -\newcommand{\tutodoc@latex@top@rule@len}{1pt} -\newcommand{\tutodoc@latex@bottom@rule@len}{1pt} - -\colorlet{tutodoc@latex@shadow@color}{black!30} -\newcommand{\tutodoc@latex@shadow@xshift@len}{.75mm} -\newcommand{\tutodoc@latex@shadow@yshift@len}{-.75mm} -\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} - -\colorlet{tutodoc@latex@segment@color}{gray} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty deleted file mode 100644 index ebb8a9a97b6..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty +++ /dev/null @@ -1,9 +0,0 @@ -% -- SPECIFIC TEXT AND PAGE COLORS -- % - -\pagecolor{black} -\color{\tdocdarkcolor[80]{white}} - - -% -- LINKS -- % - -\definecolor{tutodoc@link@color}{HTML}{9591A6} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty deleted file mode 100644 index 63c89b33c0f..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty +++ /dev/null @@ -1,21 +0,0 @@ -% -- SHOWCASE -- % - -\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% - white% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% - white% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% - white% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% - \tdocdarkcolor[80]{#1}% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% - \tdocdarkcolor[30]{#1}% -} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty deleted file mode 100644 index 501e5795781..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty +++ /dev/null @@ -1,5 +0,0 @@ -% -- VERSION & CHANGES -- % - -\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% - \tdoclightcolor[60]{cyan}% -}
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark.css.cls b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark.css.cls new file mode 100644 index 00000000000..765081697d0 --- /dev/null +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark.css.cls @@ -0,0 +1,151 @@ +% -- COLORFUL HIGHLIGHTING OF CONTENT -- % + +\NewExpandableDocumentCommand{\tutodoc@build@title@color}{m}{% + \tdocdarkcolor[95]{white}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@upper@color}{m}{% + \tdocdarkcolor[95]{white}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@lower@color}{m}{% + \tdocdarkcolor[95]{white}% +} + +\NewExpandableDocumentCommand{\tutodoc@build@back@color}{m}{% + #1!75!black!65% +} + +\NewExpandableDocumentCommand{\tutodoc@build@frame@color}{m}{% + \tdocdarkcolor[65]{#1}% +} + +\colorlet{tutodoc@admonition@shadow@color}{black!68} + + +\ExplSyntaxOn + +%%% +% We use two ''prop'' variables to factorize the code just after. +%%% +\prop_new:N \g__tutodoc_focus_color_prop +\prop_new:N \g__tutodoc_focus_icon_prop + +\prop_set_from_keyval:Nn \g__tutodoc_focus_color_prop { + note = cyan, + tip = ForestGreen, + imp = orange, + caut = violet, + warn = red, +} + +\prop_set_from_keyval:Nn \g__tutodoc_focus_icon_prop { + note = \faInfoCircle, + tip = \faLightbulb, + imp = \faHighlighter, + caut = \faBiohazard, + warn = \faSkullCrossbones, +} + +\ExplSyntaxOff + + + +% :: LEXER USED :: % + +\newcommand{\tutodoc@latex@lexer}{latex} + +% :: INLINE LATEX MACRO :: % + +\newcommand{\tutodoc@latex@style}{github-dark} + +\colorlet{tutodoc@latex@back@color}{\tdocdarkcolor[30]{white}} +\colorlet{tutodoc@latex@text@color}{\tdocdarkcolor[80]{white}} + + +% :: THE TCOLORBOX LISTING STYLE :: % + +\colorlet{tutodoc@latex@frame@color}{darkgray} + +\newcommand{\tutodoc@latex@left@len}{1mm} +\newcommand{\tutodoc@latex@right@len}{1mm} +\newcommand{\tutodoc@latex@top@len}{1mm} +\newcommand{\tutodoc@latex@bottom@len}{1mm} + +\newcommand{\tutodoc@latex@arc@len}{.75mm} + +\newcommand{\tutodoc@latex@left@rule@len}{1pt} +\newcommand{\tutodoc@latex@right@rule@len}{1pt} +\newcommand{\tutodoc@latex@top@rule@len}{1pt} +\newcommand{\tutodoc@latex@bottom@rule@len}{1pt} + +\colorlet{tutodoc@latex@shadow@color}{black!30} +\newcommand{\tutodoc@latex@shadow@xshift@len}{.75mm} +\newcommand{\tutodoc@latex@shadow@yshift@len}{-.75mm} +\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} + +\colorlet{tutodoc@latex@segment@color}{gray} + + + +% -- TEXT AND PAGE COLORS -- % + +\colorlet{tutodoc@page@color}{black} +\colorlet{tutodoc@text@color}{\tdocdarkcolor[80]{white}} + + +% -- LINKS COLOR -- % + +\definecolor{tutodoc@link@color}{HTML}{9591A6} + + + +% -- SHOWCASE -- % + +\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% + white% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% + white% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% + white% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% + \tdocdarkcolor[80]{#1}% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% + \tdocdarkcolor[30]{#1}% +} + + + +% -- VERSION & CHANGES -- % + +\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% + \tdoclightcolor[60]{cyan}% +} + + +% -- ICONS -- % + +\newcommand{\tutodoc@changes@start@project@icon}{\faAnchor} + +\ExplSyntaxOn + +\prop_new:N \g__tutodoc_topic_change_prop +\prop_set_from_keyval:Nn \g__tutodoc_topic_change_prop { + break = \faCodeBranch, + fix = \faWrench, + new = \faGem, + prob = \faFire*, + tech = \faFlask, + update = \reflectbox{\faHistory}, + todo = \faCompass[regular], +} + +\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty deleted file mode 100644 index e0e006b0480..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty +++ /dev/null @@ -1,18 +0,0 @@ -% -- COLORFUL HIGHLIGHTING OF CONTENT -- % - -\ExplSyntaxOn - -%%% -% We use a ''seq'' variable to factorize the code just after. -%%% -\seq_new:N \g__tutodoc_focus_color_seq - -\seq_set_from_clist:Nn \g__tutodoc_focus_color_seq { - note, - tip, - imp, - caut, - warn, -} - -\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty deleted file mode 100644 index f4e86a62a22..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty +++ /dev/null @@ -1,31 +0,0 @@ -% :: INLINE LATEX MACRO :: % - -\renewcommand{\tutodoc@latex@lexer}{text} -\newcommand{\tutodoc@latex@style}{default} - -\colorlet{tutodoc@latex@back@color}{white} -\colorlet{tutodoc@latex@text@color}{black} - - -% :: THE TCOLORBOX LISTING STYLE :: % - -\colorlet{tutodoc@latex@frame@color}{darkgray} - -\newcommand{\tutodoc@latex@left@len}{1mm} -\newcommand{\tutodoc@latex@right@len}{1mm} -\newcommand{\tutodoc@latex@top@len}{1mm} -\newcommand{\tutodoc@latex@bottom@len}{1mm} - -\newcommand{\tutodoc@latex@arc@len}{0pt} - -\newcommand{\tutodoc@latex@left@rule@len}{1pt} -\newcommand{\tutodoc@latex@right@rule@len}{0pt} -\newcommand{\tutodoc@latex@top@rule@len}{0pt} -\newcommand{\tutodoc@latex@bottom@rule@len}{0pt} - -\colorlet{tutodoc@latex@shadow@color}{black} -\newcommand{\tutodoc@latex@shadow@xshift@len}{0mm} -\newcommand{\tutodoc@latex@shadow@yshift@len}{0mm} -\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} - -\colorlet{tutodoc@latex@segment@color}{black} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty deleted file mode 100644 index fc1194a3db9..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty +++ /dev/null @@ -1,3 +0,0 @@ -% -- LINKS -- % - -\definecolor{tutodoc@link@color}{named}{black} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty deleted file mode 100644 index 0e1c042616e..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty +++ /dev/null @@ -1,21 +0,0 @@ -% -- SHOWCASE -- % - -\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% - black% -} - -\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% - white% -} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty deleted file mode 100644 index a503714978d..00000000000 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty +++ /dev/null @@ -1,5 +0,0 @@ -% -- VERSION & CHANGES -- % - -\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% - black% -}
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft.css.cls b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft.css.cls new file mode 100644 index 00000000000..d20943ab291 --- /dev/null +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft.css.cls @@ -0,0 +1,119 @@ +% -- COLORFUL HIGHLIGHTING OF CONTENT -- % + +\ExplSyntaxOn + +%%% +% We use a ''seq'' variable to factorize the code just after. +%%% +\seq_new:N \g__tutodoc_focus_color_seq + +\seq_set_from_clist:Nn \g__tutodoc_focus_color_seq { + note, + tip, + imp, + caut, + warn, +} + +\ExplSyntaxOff + + + +% :: LEXER USED :: % + +\newcommand{\tutodoc@latex@lexer}{text} + +% :: INLINE LATEX MACRO :: % + +\newcommand{\tutodoc@latex@style}{default} + +\colorlet{tutodoc@latex@back@color}{white} +\colorlet{tutodoc@latex@text@color}{black} + + +% :: THE TCOLORBOX LISTING STYLE :: % + +\colorlet{tutodoc@latex@frame@color}{darkgray} + +\newcommand{\tutodoc@latex@left@len}{1mm} +\newcommand{\tutodoc@latex@right@len}{1mm} +\newcommand{\tutodoc@latex@top@len}{1mm} +\newcommand{\tutodoc@latex@bottom@len}{1mm} + +\newcommand{\tutodoc@latex@arc@len}{0pt} + +\newcommand{\tutodoc@latex@left@rule@len}{1pt} +\newcommand{\tutodoc@latex@right@rule@len}{0pt} +\newcommand{\tutodoc@latex@top@rule@len}{0pt} +\newcommand{\tutodoc@latex@bottom@rule@len}{0pt} + +\colorlet{tutodoc@latex@shadow@color}{black} +\newcommand{\tutodoc@latex@shadow@xshift@len}{0mm} +\newcommand{\tutodoc@latex@shadow@yshift@len}{0mm} +\newcommand{\tutodoc@latex@shadow@offset@len}{0mm} + +\colorlet{tutodoc@latex@segment@color}{black} + + + +% -- TEXT AND PAGE COLORS -- % + +\colorlet{tutodoc@page@color}{white} +\colorlet{tutodoc@text@color}{black} + + +% -- LINKS COLOR -- % + +\definecolor{tutodoc@link@color}{named}{black} + + + +% -- SHOWCASE -- % + +\NewExpandableDocumentCommand{\tutodoc@showcase@rule@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@stripe@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@text@color}{}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@rule@color}{m}{% + black% +} + +\NewExpandableDocumentCommand{\tutodoc@showcase@build@back@color}{m}{% + white% +} + + + +% -- VERSION & CHANGES -- % + +\NewExpandableDocumentCommand{\tutodoc@changes@when@color}{}{% + black% +} + + +% -- (NO) ICONS -- % + +\newcommand{\tutodoc@changes@start@project@icon}{} + +\ExplSyntaxOn + +\prop_new:N \g__tutodoc_topic_change_prop +\prop_set_from_keyval:Nn \g__tutodoc_topic_change_prop { + break = , + fix = , + new = , + prob = , + tech = , + update = , + todo = , +} + +\ExplSyntaxOff diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-en.loc.cls index f13e20adac5..5e0a31294f6 100644 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-en.loc.cls @@ -11,6 +11,7 @@ \NewDocumentCommand{\tutodoc@trans@caut@title}{}{Caution} \NewDocumentCommand{\tutodoc@trans@warn@title}{}{Warning} \NewDocumentCommand{\tutodoc@trans@chges@tech}{}{Technical information} +\NewDocumentCommand{\tutodoc@trans@chges@todo}{}{Todo} \NewDocumentCommand{\tutodoc@trans@chges@prob}{}{Problem} \NewDocumentCommand{\tutodoc@trans@chges@break}{}{Break} \NewDocumentCommand{\tutodoc@trans@chges@fix}{}{Fix} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-es.loc.cls index d1c5c7d09a9..a9f95cce729 100644 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-es.loc.cls @@ -11,6 +11,7 @@ \NewDocumentCommand{\tutodoc@trans@caut@title}{}{Recomendación} \NewDocumentCommand{\tutodoc@trans@warn@title}{}{Advertencia} \NewDocumentCommand{\tutodoc@trans@chges@tech}{}{Información técnica} +\NewDocumentCommand{\tutodoc@trans@chges@todo}{}{A hacer} \NewDocumentCommand{\tutodoc@trans@chges@prob}{}{Problema} \NewDocumentCommand{\tutodoc@trans@chges@break}{}{Bifurcación} \NewDocumentCommand{\tutodoc@trans@chges@fix}{}{Reparación} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-fr.loc.cls index 21bb1de116c..4944b096654 100644 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-fr.loc.cls @@ -11,6 +11,7 @@ \NewDocumentCommand{\tutodoc@trans@caut@title}{}{Mise en garde} \NewDocumentCommand{\tutodoc@trans@warn@title}{}{Avertissement} \NewDocumentCommand{\tutodoc@trans@chges@tech}{}{Information technique} +\NewDocumentCommand{\tutodoc@trans@chges@todo}{}{À faire} \NewDocumentCommand{\tutodoc@trans@chges@prob}{}{Problème} \NewDocumentCommand{\tutodoc@trans@chges@break}{}{Bifurcation} \NewDocumentCommand{\tutodoc@trans@chges@fix}{}{Réparation} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls b/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls index fad3c185fe3..a85dd64b60e 100644 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls @@ -9,8 +9,8 @@ \ProvidesExplClass {tutodoc} - {2024-10-30} % Creation: 2023-11-29 - {1.6.2} + {2024-12-04} % Creation: 2023-11-29 + {1.7.0} {This package proposes tools for writing "human friendly" documentations of LaTeX packages.} @@ -22,12 +22,32 @@ % -- OPTIONS -- % % ------------- % +%%% +% refs:: +% + https://tex.stackexchange.com/a/729929/6880 +% + https://tex.stackexchange.com/a/729913/6880 +%%% + \ExplSyntaxOn -\tl_new:N \l__tutodoc_other_cls_options_tl +\msg_set:nnnn { tutodoc ~ (main) } + { main : scrartcl-illegal-option } + { The ~ option ~ << ~ #1 ~ >> ~ is ~ not ~ allowed. } + { \msg_see_documentation_text:n { tutodoc } } + -\newcommand{ \tutodoc@theme } { color } +\newcommand{\tutodoc@theme}{color} + +%%% +% prototype:: +% theme : the theme to format the document. +% fontsize : this key is one of those of the '''scrartcl'' class. +% As \tutodoc imposes the value of this key, we must +% forbid its use. +% DIV : similar to the preceding key but here we just want +% to avoid any use of special ''DIV'' value. +%%% \keys_define:nn { tutodoc / main / class / options } { theme .choices:nn = { bw, @@ -35,151 +55,84 @@ dark, draft } { - \renewcommand{ \tutodoc@theme } { - \tl_use:N \l_keys_choice_tl - } + \exp_args:NNV \renewcommand \tutodoc@theme \l_keys_choice_tl }, - unknown .code:n = { - \tl_set:Nn \l__tutodoc_other_cls_options_tl { #1 } - } + fontsize .code:n = { + \msg_error:nnn { tutodoc ~ (main) } + { main : scrartcl-illegal-option } + { fontsize } + }, + DIV .code:n = { + \msg_error:nnn { tutodoc ~ (main) } + { main : scrartcl-illegal-option } + { DIV } + }, +} + +\PassOptionsToClass{ fontsize = 10pt }{ scrartcl } + +\DeclareUnknownKeyHandler[ tutodoc / main / class / options ]{ + \PassOptionsToClass{ \CurrentOption }{ scrartcl } } -\ProcessKeyOptions[tutodoc / main / class / options] +\ProcessKeyOptions[ tutodoc / main / class / options ] -\exp_last_unbraced:NNV \LoadClass[ \l__tutodoc_other_cls_options_tl ]% - { article }% - [ 2022-06-01 ] +\LoadClass{ scrartcl } \ExplSyntaxOff +% ------------------------------------------------- % +% -- OPTIONS FOR PACKAGES IMPORTED BY OTHER ONES -- % +% ------------------------------------------------- % + +% xcolor is loaded by minted and tcolorbox. +\PassOptionsToPackage{svgnames}{xcolor} + + % ------------- % % -- IMPORTS -- % % ------------- % -\RequirePackage[svgnames]% - {xcolor}% - [2023/11/15] +\RequirePackage{geometry} -\RequirePackage[ - top = 2.5cm, - bottom = 2.5cm, - left = 2.5cm, - right = 2.5cm, - marginparwidth = 2cm, - marginparsep = 2mm, - heightrounded -]{geometry}% - [2020-01-02] +\RequirePackage{marginnote} +\RequirePackage{fontawesome5} +\RequirePackage{keytheorems} -\RequirePackage[raggedright]% - {titlesec}% - [2023/10/27] +\RequirePackage{clrstrip} -\RequirePackage{tocbasic} +% Before the tcolorbox library minted. +\RequirePackage[highlightmode = immediate] + {minted} -\RequirePackage{xcolor}% - [2022/06/12] +\RequirePackage{tcolorbox} +\tcbuselibrary{ + minted, + breakable, + skins +} -\RequirePackage{hyperref}% To load after titlesec! - [2023-02-07] +\RequirePackage{hyperref} +%%% % We delegate the management of quoting to the ''csquotes'' package, % which takes care of the locale settings. -\RequirePackage{csquotes}% - [2022-09-14] - - -\RequirePackage{fontawesome5}% - [2022-05-02] - -\RequirePackage{keytheorems}% - [2024/09/19] - -\RequirePackage[svgnames]% - {xcolor}% - [2023/11/15] - -\RequirePackage{tcolorbox}% - [2024/07/10] - -\tcbuselibrary{breakable, - skins} - - -\RequirePackage{clrstrip}% - [2021-08-28] - - -\RequirePackage[highlightmode = immediate]% - {minted}% - [2024/09/22] - -\RequirePackage{tcolorbox}% - [2024/07/10] - -\tcbuselibrary{minted, - breakable, - skins} - - -\RequirePackage{fontawesome5}% - [2022-05-02] +% +% warning:: +% We must load ''inputenc'' before ''csquotes'' +%%% +\RequirePackage[utf8] + {inputenc} -\RequirePackage{marginnote}% - [2018/08/09] +\RequirePackage{csquotes} % =============== % % == MAIN CODE == % % =============== % -% --------------------------- % -% -- COLOR TRANSFORMATIONS -- % -% --------------------------- % - -%%% -% prototype:: -% #1 : (black-rate) -% the amount of color relative to black. -% #2 : (color) -% one color following the ''xcolor'' format. -% -% :return: a "darker" version of the color ''#1''. -%%% -\NewExpandableDocumentCommand{\tdocdarkcolor}{O{50}m}{#2!#1!black} - - -%%% -% prototype:: -% #1 : (transparency) -% the transparency rate. -% #2 : (color) -% one color following the ''xcolor'' format. -% -% :return: a "transparent" version of the color `#1`. -%%% -\NewExpandableDocumentCommand{\tdoclightcolor}{O{5}m}{#2!#1} - - -% ----------- % -% -- ICONS -- % -% ----------- % - -%%% -% prototype:: -% #1 : (aws-icon) -% one material that expects to be an icon command from the -% ''fontawsome5'' \pack. -% -% :return: the icon followed by a small insecable space. -%%% -\NewDocumentCommand{\tdocicon}{m}{% - #1\kern.45em% -} - - % --------------------- % % -- LOCALE SETTINGS -- % % --------------------- % @@ -196,29 +149,48 @@ { \msg_see_documentation_text:n { tutodoc } } +% Management of English composition rules. +\newcommand{\tutodoc@use@english}{\relax} + +% Babel requires colon management for our translations. \newcommand{\tutodoc@colon}{:} \AtBeginDocument{ -% We must take care of colons and spacing. +% Babel is used. \@ifpackageloaded{babel}{ +% We must take care of colons and spacing. \iflanguage{french}{ \renewcommand{\tutodoc@colon}{\babelshorthand{:}} }{} }{} +% Polyglossia is used. + \@ifpackageloaded{polyglossia}{ +% If polyglossia is used, we must load english if necessary +% (see the ''\tutodoc@use@english'' macro below). + \iflanguageloaded{english}{}{ + \setotherlanguage{english} + } + }{}% + \newcommand{\tdoclang}{\BCPdata{language}} +% We must take care of English rules for English contents. + \renewcommand\tutodoc@use@english{% + \foreignlanguage{english}% + } + % If the lang is not supported, we emit a warning and just turn % to the english language. \makeatletter - \InputIfFileExists{tutodoc-main-locale-\tdoclang.cfg.cls.sty}{}{ - \input{tutodoc-main-locale-en.cfg.cls.sty} + \InputIfFileExists{tutodoc-\tdoclang.loc.cls}{}{ + \input{tutodoc-en.loc.cls} - \msg_critical:nnx { tutodoc ~ (main) } - { main : unsupported-lang } - { \tdoclang } - } + \msg_critical:nnx { tutodoc ~ (main) } + { main : unsupported-lang } + { \tdoclang } + } \makeatother } @@ -226,9 +198,19 @@ \ExplSyntaxOff -% ---------------------- % -% -- GENERAL SETTINGS -- % -% ---------------------- % +% ----------------------- % +% -- GEOMETRY SETTINGS -- % +% ----------------------- % + +\geometry{ + top = 1.9cm, + bottom = 1.9cm, + left = 2.25cm, + right = 2.25cm, + marginparwidth = 2cm, + marginparsep = 2pt, + heightrounded +} \setlength{\parindent}{0cm} @@ -239,21 +221,11 @@ \ifcsundef{chapter}% {}% - {\renewcommand{\thechapter}{\Alph{chapter}.}} - -\renewcommand{\thesection}{\Roman{section}.} -\renewcommand{\thesubsection}{\arabic{subsection}.} -\renewcommand{\thesubsubsection}{\roman{subsubsection}.} + {\renewcommand{\thechapter}{\Alph{chapter}}} -\titleformat{\paragraph}[hang]% - {\normalfont\normalsize\bfseries}% - {\theparagraph}{1em}% - {} - -\titlespacing*{\paragraph}% - {0pt}% - {3.25ex plus 1ex minus .2ex}% - {0.5em} +\renewcommand{\thesection}{\Roman{section}} +\renewcommand{\thesubsection}{\arabic{subsection}} +\renewcommand{\thesubsubsection}{\roman{subsubsection}} % Source % * https://tex.stackexchange.com/a/558025/6880 @@ -277,11 +249,59 @@ \DeclareTOCStyleEntry[indentfollows = chapter]{tocline}{section} -% ------------------- % -% -- LINKS AND CO. -- % -% ------------------- % +% --------------------------- % +% -- COLOR TRANSFORMATIONS -- % +% --------------------------- % + +%%% +% prototype:: +% #1 : (black-rate) +% the amount of color relative to black. +% #2 : (color) +% one color following the ''color'' format. +% +% :return: a "darker" version of the color ''#1''. +%%% +\NewExpandableDocumentCommand{\tdocdarkcolor}{ O{50} m }{#2!#1!black} + + +%%% +% prototype:: +% #1 : (transparency) +% the transparency rate. +% #2 : (color) +% one color following the ''color'' format. +% +% :return: a "transparent" version of the color `#1`. +%%% +\NewExpandableDocumentCommand{\tdoclightcolor}{ O{5} m }{#2!#1} + + +% ----------- % +% -- ICONS -- % +% ----------- % + +%%% +% prototype:: +% #1 : (aws-icon) +% one material that expects to be an icon command from the +% ''fontawsome5'' \pack. +% +% :return: the icon followed by a small insecable space. +%%% +\NewDocumentCommand{\tdocicon}{ m }{% + #1\kern.45em% +} + + +% ----------- % +% -- THEME -- % +% ----------- % + +\input{tutodoc-\tutodoc@theme.css.cls} -\input{tutodoc-\tutodoc@theme-main.css.cls.sty} +\pagecolor{tutodoc@page@color} +\color{tutodoc@text@color} \hypersetup{ colorlinks, @@ -303,7 +323,7 @@ % % For example, ''\tdocquote{Something}'' prints **"Something"**. %%% -\NewDocumentCommand{\tdocquote}{m}{% +\NewDocumentCommand{\tdocquote}{ m }{% \enquote{\emph{#1}}% } @@ -332,11 +352,11 @@ % gives % **"Something" et "Another thing" en anglais**. %%% -\NewDocumentCommand{\tdocinEN}{s m}{% - \IfBooleanTF{#1}{% No star used. - \tdocquote{#2}% - }{% Star used. - \tutodoc@trans@in@EN{\tdocquote{#2}}% +\NewDocumentCommand{\tdocinEN}{ s m }{% + \IfBooleanTF{#1}{}{\tutodoc@trans@in@EN}% +% We must activate the English typesetting rules. + {% + \tdocquote{\tutodoc@use@english{#2}}% }% } @@ -381,7 +401,7 @@ ] } - \cs_set:cpn { the tdoc #1 } { \thesection\arabic{tdoc#1} } + \cs_set:cpn { the tdoc #1 } { \thesection.\arabic{tdoc#1} } } \ExplSyntaxOff @@ -391,8 +411,6 @@ % -- COLORFUL HIGHLIGHTING OF CONTENT -- % % -------------------------------------- % -\input{tutodoc-\tutodoc@theme-admonitions.css.cls.sty} - %%% % note:: @@ -470,11 +488,9 @@ \newkeytheorem{tdoc#1}[ name = \use:c { tutodoc@trans@#1@title }, numberlike = tdocexa, -% We could have used -% \AddToHook{env/tdoc#1/before}{\small} -% and -% \AddToHook{env/tdoc#1/after}{\normalsize}. +% Some hooks... preheadhook = \small, + postheadhook = \leavevmode, postfoothook = \normalsize ] } @@ -494,7 +510,7 @@ % % :action: ''\tdoccls{myclass}'' prints verb::''myclass''. %%% -\NewDocumentCommand{\tdoccls}{m}{% +\NewDocumentCommand{\tdoccls}{ m }{% \texttt{#1}% } @@ -506,7 +522,7 @@ % % :action:''\tdocpack{mypack}'' prints verb::''mypack''. %%% -\NewDocumentCommand{\tdocpack}{m}{% +\NewDocumentCommand{\tdocpack}{ m }{% \texttt{#1}% } @@ -518,7 +534,7 @@ % % :action: ''\tdocmacro{mymacro}'' prints verb::''\mymacro''. %%% -\NewDocumentCommand{\tdocmacro}{m}{% +\NewDocumentCommand{\tdocmacro}{ m }{% \texttt{\textbackslash{}#1}% } @@ -548,7 +564,7 @@ %%% % % Cleaner code from https://tex.stackexchange.com/a/703379/6880 . -\NewDocumentCommand{\tdocenv}{s O{} m}{% +\NewDocumentCommand{\tdocenv}{ s O{} m }{% \IfBooleanTF{#1}{% \texttt{#3}% }{% @@ -591,7 +607,7 @@ % % :action: ''\tdocprewhy{pre.fix}'' prints verb::''pre''.fix. %%% -\NewDocumentCommand{\tdocprewhy}{m}{% +\NewDocumentCommand{\tdocprewhy}{ m }{% % Do we have 2 parts? \seq_set_split:Nnn \l__tutodoc_prewhy_parts_seq { . } { #1 } @@ -635,7 +651,7 @@ % which prints: % verb::''pre'' comes from verb::''pre''-fix. %%% -\NewDocumentCommand{\tdocpre}{m}{% +\NewDocumentCommand{\tdocpre}{ m }{% \texttt{#1}% } @@ -644,8 +660,6 @@ % -- GENERAL FORMATTING -- % % ------------------------ % -\input{tutodoc-\tutodoc@theme-showcase.css.cls.sty} - % :::::::::::::::::::::::: % % :: TEXT INSIDE A RULE :: % @@ -710,8 +724,7 @@ % #2 : (down-text) % the descriptive text after the real output % #3 : (color) -% one color following the ''xcolor'' format. -% This color is used to set the one for the decorated texts printed +% one color used to set the one for the decorated texts printed % corresponding to the two first arguments. % #4 : (text color) % color of the content @@ -722,29 +735,20 @@ % between centered materials produced by the macro ''\tdocruler'' % such as to stress the start and the end of the content. %%% -\NewDocumentEnvironment{tutodoc@showcase@basic}{m m m m m}{ +\NewDocumentEnvironment{tutodoc@showcase@basic}{ m m m m m }{% \tdocruler[#5{#3}]{#1}% \nopagebreak\medskip\nopagebreak\color{#4}% -}{ - \nopagebreak\medskip\nopagebreak - \tdocruler[#5{#3}]{#2} +}{% + \nopagebreak\medskip\nopagebreak% + \tdocruler[#5{#3}]{#2}% } %%% % prototype:: -% #1 : (up-text) -% :see: env.tutodoc@showcase@basic -% #2 : (down-text) -% :see: env.tutodoc@showcase@basic -% #3 : (stripe color) -% :see: env.tutodoc@showcase@basic -% #4 : (text color) -% :see: env.tutodoc@showcase@basic -% #5 : (rule color builder) -% :see: env.tutodoc@showcase@basic -% #6 : (back color builder) -% :see: env.tutodoc@showcase@basic +% #1 .. #5 : :see: env.tutodoc@showcase@basic +% #6 : (back color builder) +% the macro used to build the color from the user's back color % % :action: this environment adds a page-width colored stripe in the % background of the environment content processed by \latex. @@ -753,11 +757,11 @@ % start and the end of the content. %%% -\NewDocumentEnvironment{tutodoc@showcase@colorstrip}{m m m m m m}{ - \begin{colorstrip}{#6{#3}} - \begin{tutodoc@showcase@basic}{#1}{#2}{#3}{#4}{#5} -}{ - \end{tutodoc@showcase@basic} +\NewDocumentEnvironment{tutodoc@showcase@colorstrip}{ m m m m m m }{ + \begin{colorstrip}{#6{#3}}% + \begin{tutodoc@showcase@basic}{#1}{#2}{#3}{#4}{#5}% +}{% + \end{tutodoc@showcase@basic}% \end{colorstrip} } @@ -772,21 +776,25 @@ \tl_new:N \l_tutodoc_showcase_after_tl \tl_new:N \l_tutodoc_showcase_stripe_color_tl \tl_new:N \l_tutodoc_showcase_text_color_tl -\bool_new:N \l_tutodoc_showcase_nostripe_bool +\bool_new:N \l_tutodoc_showcase_no_stripe_bool %%% -% We define the key-val options that will be exposed by the \env -% ''tdocshowcase''. +% prototype:: +% col-stripe : the color of the stripe +% col-text : the color of the descriptive texts +% nostripe : a boolean flag to avoid the use of a stripe +% before : the descriptive text before the real output +% after : the descriptive text after the real output %%% \keys_define:nn { tutodoc / showcase } { % Colors. - colstripe .tl_set:N = \l_tutodoc_showcase_stripe_color_tl, - colstripe .initial:n = \tutodoc@showcase@stripe@color, - coltext .tl_set:N = \l_tutodoc_showcase_text_color_tl, - coltext .initial:n = \tutodoc@showcase@text@color, + col-stripe .tl_set:N = \l_tutodoc_showcase_stripe_color_tl, + col-stripe .initial:n = \tutodoc@showcase@stripe@color, + col-text .tl_set:N = \l_tutodoc_showcase_text_color_tl, + col-text .initial:n = \tutodoc@showcase@text@color, % Stripe? - nostripe .bool_set:N = \l_tutodoc_showcase_nostripe_bool, + nostripe .bool_set:N = \l_tutodoc_showcase_no_stripe_bool, nostripe .initial:n = false, % Texts. before .tl_set:N = \l_tutodoc_showcase_before_tl, @@ -802,7 +810,7 @@ % prototype:: % #1 : (key-val options) -% the key-value options (see above). +% :see: \keys_define:nn { tutodoc / showcase } % % :action: this \env formats \latex code, given as an argument, % by framing it with texts decorated by ''\tdocruler'', @@ -818,7 +826,7 @@ \group_begin: \keys_set:nn { tutodoc / showcase } { #1 } - \bool_if:NTF \l_tutodoc_showcase_nostripe_bool { + \bool_if:NTF \l_tutodoc_showcase_no_stripe_bool { \begin{tutodoc@showcase@basic} { \tl_use:N \l_tutodoc_showcase_before_tl } { \tl_use:N \l_tutodoc_showcase_after_tl } @@ -835,7 +843,7 @@ { \tutodoc@showcase@build@back@color } } }{ - \bool_if:NTF \l_tutodoc_showcase_nostripe_bool { + \bool_if:NTF \l_tutodoc_showcase_no_stripe_bool { \end{tutodoc@showcase@basic} }{ \end{tutodoc@showcase@colorstrip} @@ -881,10 +889,6 @@ % :: STYLES OF THE LISTING ENV. AND THE MACRO :: % % :::::::::::::::::::::::::::::::::::::::::::::: % -\newcommand{\tutodoc@latex@lexer}{latex} - -\input{tutodoc-\tutodoc@theme-listing.css.cls.sty} - % :::::::::::::::::::::::: % % :: INLINE LATEX MACRO :: % @@ -892,9 +896,9 @@ %%% % See the \doc of the macro ''\newmintinline'' from the package ''minted'' -% to have \infos about the macro ''tdocinlatex''. +% to have \infos about the macro ''tdoclatexin''. %%% -\newmintinline[tdocinlatex]{\tutodoc@latex@lexer}{% +\newmintinline[tdoclatexin]{\tutodoc@latex@lexer}{% bgcolor = tutodoc@latex@back@color,% style/.expand once = \tutodoc@latex@style % <-- This needs minted3! } @@ -1027,12 +1031,15 @@ \tl_new:N \l_tutodoc_listing_explain_tl + %%% % prototype:: -% :see: macro.tdoclatexshow +% explain : the text between the code and its highlighted output. % -% We add a key-val option specific to ''\tdoclatexshow'', the other ones -% will be sent to ''\tdocshowcaseinput''. +% +% note:: +% This key can be used in addition to those of the ''tdocshowcase'' +% \env, %%% \keys_define:nn { tutodoc / listing / latexshow } { explain .tl_set:N = \l_tutodoc_listing_explain_tl, @@ -1050,16 +1057,15 @@ %%% % prototype:: % #1 : (key-val options) -% the key-value options supported by the ''tdocshowcase'' \env, -% plus one allowing you to change the description of a line -% printed between the code and its highlighted output. +% :see: \keys_define:nn { tutodoc / listing / latexshow } , +% \keys_define:nn { tutodoc / showcase } % #2 : (file path) % the path of a file % % :see: env.tdocshowcase , % macro.tdoclatexinput %%% -\NewDocumentCommand{\tdoclatexshow}{O{} m}{ +\NewDocumentCommand{\tdoclatexshow}{ O{} m} { \group_begin: \keys_set_known:nnN { tutodoc / listing / latexshow } { #1 } @@ -1115,7 +1121,7 @@ % % :see: \__tutodoc_translate_date:n %%% -\NewDocumentCommand{\tutodoc@new@change@margin}{m m m m m}{ +\NewDocumentCommand{\tutodoc@new@change@margin}{ m m m m m }{ \marginnote{ \color{#1} \scriptsize @@ -1151,10 +1157,14 @@ %%% % prototype:: +% #1 : (EN-num-date) +% a content that should have the numerical English date +% format ''YYYY-MM-DD''. +% % :action: this function checks if we have something like -% ''YYYY-MM-DD'' and then it calls the function -% ''\__tutodoc_translate_date_process:w'' to finish -% the job. +% ''YYYY-MM-DD'', and then it calls the function +% ''\__tutodoc_translate_date_process:w'' to +% activate the transformation to the locale format. % % :see: \__tutodoc_translate_date_process:w %%% @@ -1170,6 +1180,13 @@ %%% % prototype:: +% #1 : (year-extracted) +% a 1 to 4 digits integer +% #2 : (month-extracted) +% a 2 digits integer +% #3 : (day-extracted) +% a 2 digits integer +% % :action: this function extracts year, month and day in something % like ''YYYY-MM-DD'' and then it calls ''\tutodoc@trans@date'' % to use the format expected for a "localised" date. @@ -1185,13 +1202,11 @@ % :: VERSION AND DATE :: % % :::::::::::::::::::::: % -\input{tutodoc-\tutodoc@theme-version-n-change.css.cls.sty} - -\newlength{\tutodoc@version@vertical@sep@len} -\setlength{\tutodoc@version@vertical@sep@len}{-4.25pt} +\newlength{\tutodoc@version@date@vertical@sep@len} +\setlength{\tutodoc@version@date@vertical@sep@len}{-4.25pt} -\newlength{\tutodoc@version@vertical@offset@len} -\setlength{\tutodoc@version@vertical@offset@len}{-.345cm} +\newlength{\tutodoc@version@date@vertical@offset@len} +\setlength{\tutodoc@version@date@vertical@offset@len}{-8pt} %%% @@ -1214,12 +1229,17 @@ % to parse the date such as to display it following the standard convention % of the language chosen when loading the package. %%% -\NewDocumentCommand{\tdocversion}{ O{\tutodoc@changes@when@color} m O{} D<>{\tutodoc@version@vertical@offset@len} }{ +\NewDocumentCommand{\tdocversion}{ % + O{\tutodoc@changes@when@color} % + m % + O{} % + D<>{\tutodoc@version@date@vertical@offset@len}% +}{ \tutodoc@new@change@margin% {#1} % Color {#2} % Version {#3} % Date - {\tutodoc@version@vertical@sep@len} % Last negative vertical spacing + {\tutodoc@version@date@vertical@sep@len} % Last negative vertical spacing {#4} % Vertical offset } @@ -1228,12 +1248,6 @@ % :: DATE :: % % :::::::::: % -\newlength{\tutodoc@date@vertical@sep@len} -\setlength{\tutodoc@date@vertical@sep@len}{-5.35pt} - -\newlength{\tutodoc@date@vertical@offset@len} -\setlength{\tutodoc@date@vertical@offset@len}{-.345cm} - %%% % prototype:: % #1 : (color) @@ -1246,12 +1260,16 @@ % :action: this macro is similar to ''\tdocversion'' except that it just % prints a date. %%% -\NewDocumentCommand{\tdocdate}{ O{\tutodoc@changes@when@color} m D<>{\tutodoc@date@vertical@offset@len} }{ +\NewDocumentCommand{\tdocdate}{ + O{\tutodoc@changes@when@color} + m + D<>{\tutodoc@version@date@vertical@offset@len} +}{ \tutodoc@new@change@margin% {#1} % Color {} % Version {#2} % Date - {\tutodoc@date@vertical@sep@len} % Last negative spacing + {\tutodoc@version@date@vertical@sep@len} % Last negative spacing {#3} % Vertical offset } @@ -1276,14 +1294,25 @@ % :: GENERIC TOPIC :: % % ::::::::::::::::::: % +\tl_new:N \l_tutodoc_topic_what_color_tl \tl_new:N \l_tutodoc_topic_when_color_tl \tl_new:N \l_tutodoc_topic_date_tl \tl_new:N \l_tutodoc_topic_version_tl + +%%% +% prototype:: +% col : the color of the full content of a topic \env +% col-chges : the color of the material for changes for a topic \env +% date : the date of the changes a topic \env +% version : the number version of the changes a topic \env +%%% \keys_define:nn { tutodoc / version-n-change / topic / options } { % Colors. - col .tl_set:N = \l_tutodoc_topic_when_color_tl, - col .initial:n = \tutodoc@changes@when@color, + col .tl_set:N = \l_tutodoc_topic_what_color_tl, + col .initial:n = tutodoc@text@color, + col-chges .tl_set:N = \l_tutodoc_topic_when_color_tl, + col-chges .initial:n = \tutodoc@changes@when@color, % Date. date .tl_set:N = \l_tutodoc_topic_date_tl, date .initial:n = \c_empty_tl, @@ -1292,14 +1321,9 @@ version .initial:n = \c_empty_tl, } - \tl_new:N \l__tutodoc_topic_all_user_options_tl -\newlength{\tutodoc@topic@vertical@offset@len} -\setlength{\tutodoc@topic@vertical@offset@len}{-.745cm} - - %%% % prototype:: % #1 : (title) @@ -1308,7 +1332,7 @@ % one material that expects to be an icon command from the % ''fontawsome5'' \pack % #3 : (key-val options) -% see above +% :see: \keys_define:nn { tutodoc / version-n-change / topic / options } % % :action: this environment prints some \infos about specific changes % achieved in a new version (no special formatting is applied). @@ -1327,23 +1351,28 @@ \tl_set_eq:NN \l__tutodoc_topic_all_user_options_tl \l_tutodoc_topic_version_tl \tl_put_right:Nn \l__tutodoc_topic_all_user_options_tl { \l_tutodoc_topic_date_tl } - \paragraph{% + \group_begin: + \color{\tl_use:N \l_tutodoc_topic_what_color_tl} + + \paragraph{ + \color{\tl_use:N \l_tutodoc_topic_what_color_tl} \IfBlankF{#2}{\tdocicon{#2}} \textsc{#1.} \exp_args:Ne \IfBlankF{\l__tutodoc_topic_all_user_options_tl}{ % A date and/or a version. - \exp_args:NNee \tutodoc@new@change@margin% + \exp_args:NNee \tutodoc@new@change@margin {\l_tutodoc_topic_when_color_tl} {\l_tutodoc_topic_version_tl} {\l_tutodoc_topic_date_tl} - {\tutodoc@version@vertical@sep@len} - {\tutodoc@topic@vertical@offset@len} + {\tutodoc@version@date@vertical@sep@len} + {\tutodoc@version@date@vertical@offset@len} } } \begin{itemize} }{ \end{itemize} + \group_end: } @@ -1352,26 +1381,12 @@ % :::::::::::::::::::::: % %%% -% We use a ''prop'' variable to factorize the code just after. -%%% -\prop_new:N \g__tutodoc_topic_change_prop -\prop_set_from_keyval:Nn \g__tutodoc_topic_change_prop { - break = \faCodeBranch, - fix = \faWrench, - new = \faGem, - prob = \faFire*, - tech = \faFlask, - update = \reflectbox{\faHistory}, -} - - -%%% % prototype:: % :see: env.tdoctopic % % :action: ''key/value'' iteration over ''\g__tutodoc_topic_change_prop'' % to build topic-like \envs using the \env ''tdoctopic'' -% (the title used is translated into the good language). +% (the title respects the locale settings). %%% \prop_map_inline:Nn \g__tutodoc_topic_change_prop { \NewDocumentEnvironment{ tdoc#1 } { O{} } { @@ -1384,13 +1399,18 @@ %%% % prototype:: -% #1 : (short-desc) +% #1 : (color-content) +% the color of the full content +% #2 : (short-desc) % a short text expected to indicate the very first version of a project. % % :action: the short text printed will be preceded by a pretty anchor icon. %%% -\NewDocumentCommand{ \tdocstartproj }{ m } { - \tdocicon{\faAnchor}#1 +\NewDocumentCommand{ \tdocstartproj }{ O{tutodoc@text@color} m } { + \group_begin: + \color{#1} + \tdocicon{\tutodoc@changes@start@project@icon}#2 + \group_end: } \ExplSyntaxOff @@ -1411,6 +1431,7 @@ \newlength{\tutodoc@vertical@space@deco@len} \setlength{\tutodoc@vertical@space@deco@len}{\dimeval{2\medskipamount+1.25pt}} + %%% % prototype:: % :action: this macro draws a centered horizontal rule with a height @@ -1420,7 +1441,7 @@ % % :see: len.tutodoc@vertical@space@deco@len %%% -\NewDocumentCommand{\tdocsep}{}{ +\newcommand{\tdocsep}{ \par \cleaders \vbox to \tutodoc@vertical@space@deco@len{ |