texlive[72696] Master/texmf-dist: tutodoc (29oct24)
commits+karl at tug.org
commits+karl at tug.org
Tue Oct 29 21:06:40 CET 2024
Revision: 72696
https://tug.org/svn/texlive?view=revision&revision=72696
Author: karl
Date: 2024-10-29 21:06:39 +0100 (Tue, 29 Oct 2024)
Log Message:
-----------
tutodoc (29oct24)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf
trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex
trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf
trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls
Added Paths:
-----------
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty
Removed Paths:
-------------
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-en.cfg.cls.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-fr.cfg.cls.sty
Modified: trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex 2024-10-29 00:41:52 UTC (rev 72695)
+++ trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex 2024-10-29 20:06:39 UTC (rev 72696)
@@ -3,6 +3,375 @@
% ==================== %
+\begin{filecontents*}[overwrite]{gallery-showcase-bw.tex}
+\documentclass[10pt, a4paper, theme = bw]{tutodoc}
+
+\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.
+}
+
+\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.
+}
+
+\newcommand\myhighlightedtext{
+ 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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries The theme \texttt{"\thisstyle"}}
+
+\section{Highlighting, versioning and dating}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{\LaTeX\ codes}
+
+It is essential to be able to demonstrate use cases in \LaTeX.
+
+\begin{tdoclatex}
+It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\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:
+$E = m c^2$ or $\pi \neq \frac{3}{14}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+\begin{filecontents*}[overwrite]{gallery-showcase-color.tex}
+\documentclass[10pt, a4paper, theme = color]{tutodoc}
+
+\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.
+}
+
+\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.
+}
+
+\newcommand\myhighlightedtext{
+ 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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries The theme \texttt{"\thisstyle"}}
+
+\section{Highlighting, versioning and dating}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{\LaTeX\ codes}
+
+It is essential to be able to demonstrate use cases in \LaTeX.
+
+\begin{tdoclatex}
+It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\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:
+$E = m c^2$ or $\pi \neq \frac{3}{14}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+\begin{filecontents*}[overwrite]{gallery-showcase-dark.tex}
+\documentclass[10pt, a4paper, theme = dark]{tutodoc}
+
+\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.
+}
+
+\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.
+}
+
+\newcommand\myhighlightedtext{
+ 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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries The theme \texttt{"\thisstyle"}}
+
+\section{Highlighting, versioning and dating}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{\LaTeX\ codes}
+
+It is essential to be able to demonstrate use cases in \LaTeX.
+
+\begin{tdoclatex}
+It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\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:
+$E = m c^2$ or $\pi \neq \frac{3}{14}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+\begin{filecontents*}[overwrite]{gallery-showcase-draft.tex}
+\documentclass[10pt, a4paper, theme = draft]{tutodoc}
+
+\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.
+}
+
+\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.
+}
+
+\newcommand\myhighlightedtext{
+ 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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries The theme \texttt{"\thisstyle"}}
+
+\section{Highlighting, versioning and dating}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{\LaTeX\ codes}
+
+It is essential to be able to demonstrate use cases in \LaTeX.
+
+\begin{tdoclatex}
+It's nice to see some formatted \LaTeX\ code : $E = m c^2$ ou $\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:
+$E = m c^2$ or $\pi \neq \frac{3}{14}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex}
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
@@ -25,7 +394,7 @@
\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice-icon.tex}
-\begin{tdoctopic}{Don't look}[\faEyeSlash]
+\begin{tdoctopic}{To hide}[\faEyeSlash]
% An icon from fontawesome5.
\item Info 1...
\item Info 2...
@@ -70,6 +439,14 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-version-n-change-tech.tex}
+\begin{tdoctech}
+ \item Info 1...
+ \item Info 2...
+\end{tdoctech}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-version-n-change-break.tex}
\begin{tdocbreak}
\item Info 1...
@@ -180,6 +557,23 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-admonitions-leavevmode-items.tex}
+\begin{tdoctip}[Little elegant]
+ \begin{enumerate}
+ \item Point 1.
+ \item Point 2.
+ \end{enumerate}
+\end{tdoctip}
+VERSUS.
+\begin{tdoctip}[More elegant]
+ \begin{enumerate}[wide]
+ \item Point 1.
+ \item Point 2.
+ \end{enumerate}
+\end{tdoctip}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-admonitions-rmk.tex}
\begin{tdocrem}
Just one remark...
@@ -196,10 +590,11 @@
\begin{filecontents*}[overwrite]{examples-listing-latexshow-options.tex}
-\tdoclatexshow[explain = What comes next is colourful...,
- before = Rendering below.,
- after = Finished rendering.,
- color = orange]
+\tdoclatexshow[explain = What comes next is colorful...,
+ before = Rendering below.,
+ after = Finished rendering.,
+ colstripe = orange,
+ coltext = blue!70!black]
{examples-listing-xyz.tex}
\end{filecontents*}
@@ -232,9 +627,10 @@
\begin{filecontents*}[overwrite]{examples-showcase-customized.tex}
-\begin{tdocshowcase}[before = My beginning,
- after = My end,
- color = red]
+\begin{tdocshowcase}[before = My beginning,
+ after = My end,
+ colstripe = red,
+ coltext = orange!75!black]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
@@ -249,9 +645,10 @@
\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip-customized.tex}
\begin{tdocshowcase}[nostripe,
- before = My beginning,
- after = My end,
- color = green]
+ before = My beginning,
+ after = My end,
+ colstripe = green,
+ coltext = purple]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
@@ -286,6 +683,7 @@
\documentclass[10pt, a4paper]{tutodoc}
+% Community tools
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
@@ -295,11 +693,12 @@
\usepackage{fmtcount}
\usepackage{multicol}
-\usepackage{wrapfig2}
+\usepackage{pdfpages}
+
\setlength{\parindent}{0em}
-
+% Some useful commands.
\newcommand\thisproj{\tdoccls{tutodoc}}
\newcommand\thisrepo{\url{https://github.com/bc-tools/for-latex/tree/tutodoc}}
\newcommand\thismonorepo{\url{https://github.com/bc-tools/for-latex}}
@@ -308,6 +707,7 @@
\newcommand\ctan{\href{https://ctan.org/}{\trademark{CTAN}}}
\newcommand\git{\trademark{git}}
+\newcommand\pdf{\trademark{PDF}}
% --------------- %
@@ -331,7 +731,7 @@
% Source.
% * https://tex.stackexchange.com/a/604698/6880
-\NewDocumentCommand{ \tdocdocbasicinput }{ m }{%
+\NewDocumentCommand{ \tdocbasicinputDOC }{ m }{%
Consider the following code.
\tdoclatexinput[code]{#1}
@@ -347,7 +747,7 @@
% Source.
% * https://tex.stackexchange.com/a/604698/6880
-\NewDocumentCommand{ \tdocdocextraruler }{ m }{%
+\NewDocumentCommand{ \tdocextrarulerDOC }{ m }{%
\par
{
\centering
@@ -362,17 +762,19 @@
}
}
-\NewDocumentEnvironment{ tdoc-doc-showcase }
+\NewDocumentEnvironment{ tdocshowcaseDOC }
{ O{ Start of the rendering in this doc. }
O{ End of rendering in this doc. } }{
- \tdocdocextraruler{#1}
+ \tdocextrarulerDOC{#1}
\nopagebreak\smallskip\nopagebreak
}{
\nopagebreak\smallskip\nopagebreak
- \tdocdocextraruler{#2}
+ \tdocextrarulerDOC{#2}
}
+% == FORDOC == %
+
\NewDocumentCommand{\mailsubject}{m}% <-- Translate me!
{subject \tdocquote{\texttt{tutodoc - CONTRIB - #1}}}
@@ -442,8 +844,8 @@
\title{The \texttt{tutodoc} class - Tutorial-style documentation}
-\author{Christophe BAL}
-\date{Oct 19, 2024 - Version 1.5.0}
+\author{Christophe, BAL}
+\date{Oct 28, 2024 - Version 1.6.1}
\maketitle
@@ -460,7 +862,7 @@
\smallskip
- \noindent
+ \noindent
\emph{\textbf{Remark :} this documentation is also available in French.}
\end{abstract}
@@ -472,27 +874,9 @@
\begin{tdocnote}[Last changes]
\small
-\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>}}).
-\end{tdocbreak}
-
-
-\begin{tdocfix}
- \item Version 3 of \tdocpack{minted} is taken into account.
-
- \item The \tdocmacro{tdocdate} macro did not handle date format and formatting.
-
- \item Colored frames did not color text after a page break.
-\end{tdocfix}
-
-
-\begin{tdocnew}
- \item The class is usable in Spanish.
-
- \item The documentation contains a new section explaining how to contribute.
-\end{tdocnew}
+\begin{tdoctech}
+ \item The naming rules of \ctan\ need the use of \trademark{CSS} files named \verb+tutodoc-*.css.cls.sty+\,.
+\end{tdoctech}
\end{tdocnote}
\end{minipage}
\end{center}
@@ -596,7 +980,7 @@
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}.%.
\footnote{
- Technically, we use \tdocinlatex|\BCPdata{language}| which returns a language in short format.
+ Technically, we use \tdocinlatex|\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.
@@ -611,7 +995,7 @@
\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).
+ 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}
@@ -643,6 +1027,95 @@
\end{tdocnote}
+\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.
+
+\begin{itemize}
+ \item \tdocinlatex|bw| :
+ this is a black-and-white theme with some shades of gray.
+
+ \item \tdocinlatex|color| :
+ this theme is colored, \emph{it's the default value}.
+
+ \item \tdocinlatex|dark| :
+ this theme is dark, 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}
+
+
+\begin{tdocnote}
+ At the end of this document, after the change history, you'll find a gallery of use cases for these different themes : go to appendix page \pageref{tutodoc-theme-gallery}.
+\end{tdocnote}
+
+
+% ----------------------------- %
+% -- AT END DOCUMENT - START -- %
+% ----------------------------- %
+
+% The following AT-END-DOCUMENT lines of codes have been generated
+% automatically. Don't judge their relative beauty...
+
+\AtEndDocument{
+
+% An annex page for a pretty doc.
+\newpage
+
+% Source.
+% + https://tex.stackexchange.com/a/8547/6880
+\bgroup
+ \titleformat{\section}[block]{\Huge\bfseries\filcenter}{}{1em}{}
+ \phantomsection\section*{Appendix -- Theme gallery}%
+ \label{tutodoc-theme-gallery}
+ \addcontentsline{toc}{section}{Appendix -- Theme gallery}%
+\egroup
+
+\bigskip
+
+\begin{tdocnote}
+ Each example is exactly a two pages long \pdf\ and has been inserted directly into this document (so don't be surprised by the page numbers).
+\end{tdocnote}
+
+\newpage
+
+% Let's build the PDFs.
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-bw}
+
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-color}
+
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-dark}
+
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-draft}
+
+% The gallery starts here...
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-bw}
+
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-color}
+
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-dark}
+
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-draft}
+
+}
+
+% --------------------------- %
+% -- AT END DOCUMENT - END -- %
+% --------------------------- %
+
\section{Highlighting content}
\begin{tdocnote}
@@ -662,7 +1135,7 @@
\begin{tdocimp}
- All the environments presented in this section share the same counter.
+ 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.
\end{tdocimp}
@@ -681,14 +1154,6 @@
% ------------------ %
-\begin{tdocimp}
- The numbering of the examples is reset to zero as soon as a section with a level at least equal to a \tdocinlatex|\section| is opened.
-\end{tdocimp}
-
-
-% ------------------ %
-
-
\begin{tdoctip}
It can sometimes be useful to return to the line at the start of the content. The code below shows how to proceed (this trick also applies to the \verb#tdocrem# environment presented next). Note in passing that the numbering follows that of the previous example as desired.
\end{tdoctip}
@@ -707,16 +1172,18 @@
-\subsection{Flashy content} \label{tdoc-admonitions}
+\subsection{Flashy content}
+\label{tutodoc-admonitions}
\begin{tdocnote}
- Icons are obtained via the \tdocpack{fontawesome5} package, and text spacing is managed by the \tdocmacro{tdocicon} macro.
- \footnote{
- For example,
- \tdocinlatex|\fbox{\tdocicon{\faBed}{Tired}}|
- produces\,
- \fbox{\tdocicon{\faBed}{Tired}}\,.
- }
+ The formatting proposed here is the default one, but others are possible by changing the theme: see the gallery of use cases in the appendix page \pageref{tutodoc-theme-gallery}.
+ 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}}|
+ produces
+ \fbox{\tdocicon{\faBed}{Fatigued}},.
+ }
\end{tdocnote}
@@ -730,34 +1197,37 @@
\smallskip
-\begin{tdocnote}
- Colors are obtained via the expandable macros \tdocmacro{tdocbackcolor} and \tdocmacro{tdocdarkcolor}.
- For further information, please refer to the end of the section \ref{tdoc-color-macros} page \pageref{tdoc-color-macros}.
-\end{tdocnote}
+\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.
+ \tdoclatexinput[sbs]{examples-admonitions-leavevmode-items.tex}
+
+\end{tdoctip}
+
+
\foreach \sectitle/\desc/\filename in {
- {Informative note}/%<-- Translate me!
- {The \tdocenv*{tdocnote} environment is used to highlight useful information. Here's how to use it.}/%<-- Translate me!
- note,
- %
- {Something important}/%<-- Translate me!
- {The \tdocenv*{tdocimp} environment is used to indicate something important but harmless.}/%<-- Translate me!
- important,
- %
- {Caution about a delicate point}/%<-- Translate me!
- {The \tdocenv*{tdoccaut} environment is used to indicate a delicate point to the user. Here's how to use it.}/% <-- Translate me!
- caution,
- %
- {Warning of danger}/%<-- Translate me!
- {The \tdocenv*{tdocwarn} environment is used to warn the user of a trap to avoid. Here's how to use it.}/%<-- Translate me!
- warn%
+ {Informative note}/%<-- Translate me!
+ {The \tdocenv*{tdocnote} environment is used to highlight useful information. Here's how to use it.}/%<-- Translate me!
+ note,
+ %
+ {Something important}/%<-- Translate me!
+ {The \tdocenv*{tdocimp} environment is used to indicate something important but harmless.}/%<-- Translate me!
+ important,
+ %
+ {Caution about a delicate point}/%<-- Translate me!
+ {The \tdocenv*{tdoccaut} environment is used to indicate a delicate point to the user. Here's how to use it.}/% <-- Translate me!
+ caution,
+ %
+ {Warning of danger}/%<-- Translate me!
+ {The \tdocenv*{tdocwarn} environment is used to warn the user of a trap to avoid. Here's how to use it.}/%<-- Translate me!
+ warn%
} {
- \subsubsection{\sectitle}
+ \subsubsection{\sectitle}
- \desc
+ \desc
- \tdoclatexinput[sbs]{examples-admonitions-\filename.tex}
+ \tdoclatexinput[sbs]{examples-admonitions-\filename.tex}
}
@@ -779,13 +1249,13 @@
\begin{tdocrem}
- Unlike \tdocmacro{tdocinlatex}, \tdocmacro{tdocenv} and \tdocmacro{tdocenv*} macros don't color the text they produce.
+ 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.
\end{tdocrem}
\begin{tdocwarn}
- The optional argument of the \tdocmacro{tdocenv} macro is copied and pasted
+ The optional argument of the \tdocmacro{tdocenv} macro is copied and pasted
\footnote{
Remember that almost anything is possible from now on.
}
@@ -811,13 +1281,14 @@
\end{tdocrem}
-\section{A real-life rendering} \label{tdoc-showcase}
+\section{A real-life rendering}
+\label{tutodoc-showcase}
It is sometimes useful to render code directly in the documentation. This type of rendering must be dissociable from the explanatory text.
-\subsection{With a colored stripe} \label{tdoc-color-macros}
+\subsection{With a colored stripe}
\begin{tdocexa} [With default text]
It can be useful to show a real rendering directly in a document.
@@ -842,7 +1313,7 @@
\smallskip
\begin{tdocrem}
- See the section \ref{tdoc-latexshow} on page \pageref{tdoc-latexshow} to easily obtain code followed by its actual rendering as in the previous example.
+ See the section \ref{tutodoc-latexshow} on page \pageref{tutodoc-latexshow} to easily obtain code followed by its actual rendering as in the previous example.
\end{tdocrem}
@@ -854,7 +1325,7 @@
% ------------------ %
-\begin{tdocexa}[Change the default colour and/or text]
+\begin{tdocexa}[Change the colors and/or the texts]
\leavevmode
\tdoclatexinput[code]{examples-showcase-customized.tex}
@@ -870,30 +1341,13 @@
\begin{tdocnote}
- You've probably noticed that red is used as a base to obtain the colors used.
+ 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}!
+ }
+ %
+ You should also be aware that behind the scenes, the macro \tdocmacro{tdocruler} is used.
- \begin{itemize}
- \item The background color is provided by \tdocmacro{tdocbackcolor}.
-
- \item The color of titles and lines is provided by \tdocmacro{tdocdarkcolor}.
- \end{itemize}
-
- These expandable macros accept the following codes.
-
- \begin{tdoclatex}[code]
-% Argument 1 : optionally, the amount of color relative to black can be specified.
-% In general, there's no need to change this setting!
-% Argument 2 : a color in xcolor format.
-\NewExpandableDocumentCommand{\tdocdarkcolor}{O{50}m}{#2!#1!black}
-
-% Argument 1 : optionally, the transparency rate can be specified.
-% In general, there's no need to change this setting!
-% Argument 2 : a color in xcolor format.
-\NewExpandableDocumentCommand{\tdoclightcolor}{O{5}m}{#2!#1}
- \end{tdoclatex}
-
- You also have to know that behind the scene, the \tdocmacro{tdocruler} macro is used.
-
\begin{tdoclatex}[std]
\tdocruler[red]{A decorated pseudo-title}
\end{tdoclatex}
@@ -917,7 +1371,7 @@
-\subsection{Without a colour strip}
+\subsection{Without a coloured strip}
The rendering of \tdocenv{tdocshowcase} with a coloured strip may not be suitable, or sometimes may not be acceptable despite the work done by \tdocpack{clrstrip}.
It is possible not to use a coloured strip, as we will see straight away.
@@ -942,13 +1396,13 @@
% ------------------ %
-\begin{tdocexa}[Change the default colour and/or text]
+\begin{tdocexa}[Change the colors and/or the texts]
\leavevmode
\tdoclatexinput[code]{examples-showcase-no-clrstrip-customized.tex}
- This will produce the following.
+ This will produce the following horror.
\medskip
@@ -972,11 +1426,11 @@
\medskip
- As for \tdocinlatex+\tdocshowcaseinput[color = orange]{external.tex}+\,, this will produce the colour change shown below.
+ As for \tdocinlatex+\tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{external.tex}+\,, this will produce the color change shown below.
\medskip
- \tdocshowcaseinput[color = orange]{examples-showcase-external.tex}
+ \tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{examples-showcase-external.tex}
\end{tdocexa}
@@ -985,17 +1439,18 @@
Documenting a package or class is best done through use cases showing both the code and the corresponding result.
\footnote{
- Code is formatted using the \tdocpack{minted} package.
+ Code is formatted using the \tdocpack{minted} package.
}
%\begin{tdoccaut}
-% Version 3 of \tdocpack{minted} cannot be used at the moment, as it contains bugs: see \url{https://github.com/gpoore/minted/issues/401}. We therefore force the use of version 2 of minted.
+% Version 3 of \tdocpack{minted} cannot be used at the moment, as it contains bugs: see \url{https://github.com/gpoore/minted/issues/401}. We therefore force the use of version 2 of minted.
%
%\end{tdoccaut}
-\subsection{\tdocquote{Inline} codes} \label{tdoc-listing-inline}
+\subsection{\tdocquote{Inline} codes}
+\label{tutodoc-listing-inline}
The \tdocmacro{tdocinlatex} macro
\footnote{
@@ -1028,7 +1483,7 @@
\begin{tdocexa}[Side by side]
Using \tdocenv[{[sbs]}]{tdoclatex}, we can display a code and its rendering side by side.
- \tdocdocbasicinput{examples-listing-ABC.tex}
+ \tdocbasicinputDOC{examples-listing-ABC.tex}
\end{tdocexa}
@@ -1065,13 +1520,13 @@
\begin{tdocwarn}
With default formatting, if the code begins with an opening bracket, the default option must be explicitly indicated.
- \tdocdocbasicinput{examples-listing-strange.tex}
+ \tdocbasicinputDOC{examples-listing-strange.tex}
\smallskip
Another method is to use the \tdocmacro{string} primitive.
- \tdocdocbasicinput{examples-listing-strange-bis.tex}
+ \tdocbasicinputDOC{examples-listing-strange-bis.tex}
\end{tdocwarn}
@@ -1145,7 +1600,8 @@
% ------------------ %
-\subsection{Imported codes put into practice} \label{tdoc-latexshow}
+\subsection{Imported codes put into practice}
+\label{tutodoc-latexshow}
\begin{tdocexa}[Showcase]
The following comes from \tdocinlatex+\tdoclatexshow{examples-listing-xyz.tex}+.
@@ -1152,10 +1608,10 @@
\medskip
- \begin{tdoc-doc-showcase}
+ \begin{tdocshowcaseDOC}
\tdoclatexshow{examples-listing-xyz.tex}
- \end{tdoc-doc-showcase}
+ \end{tdocshowcaseDOC}
\end{tdocexa}
@@ -1172,10 +1628,10 @@
\medskip
- \begin{tdoc-doc-showcase}
+ \begin{tdocshowcaseDOC}
\tdoclatexshow[explain = Here is the actual rendering.]{examples-listing-xyz.tex}
- \end{tdoc-doc-showcase}
+ \end{tdocshowcaseDOC}
\end{tdocexa}
@@ -1183,7 +1639,7 @@
\begin{tdocexa}[The options available]
- In addition to the explanatory text, it is also possible to use all the options of \tdocenv*{tdocshowcase} environment, see \ref{tdoc-showcase} page \pageref{tdoc-showcase}.
+ In addition to the explanatory text, it is also possible to use all the options of \tdocenv*{tdocshowcase} environment, see \ref{tutodoc-showcase} page \pageref{tutodoc-showcase}.
Here is an example to illustrate this.
\medskip
@@ -1197,10 +1653,10 @@
\medskip
- \begin{tdoc-doc-showcase}
+ \begin{tdocshowcaseDOC}
\input{examples-listing-latexshow-options.tex}
- \end{tdoc-doc-showcase}
+ \end{tdocshowcaseDOC}
\end{tdocexa}
@@ -1238,7 +1694,7 @@
\begin{tdocimp}
- \begin{enumerate}
+ \begin{enumerate}[wide]
\item The \tdocmacro{tdocdate} and \tdocmacro{tdocversion} macros require two compilations.
\item The final rendering of the dates takes into account the language detected by \thisproj{}: for example, if French is selected, the dates will be displayed in the format \texttt{DD/MM/YYYY}.
@@ -1264,34 +1720,36 @@
\begin{tdocnote}
- For icons, see the note at the beginning of the section \ref{tdoc-admonitions} page \pageref{tdoc-admonitions}.
+ For icons, see the note at the beginning of the section \ref{tutodoc-admonitions} page \pageref{tutodoc-admonitions}.
\end{tdocnote}
\foreach \exatitle/\filename in {
- {Just for the very first version}/%<-- Translate me!
- first,
- {For new features}/% <-- Translate me!
- new,
- {For updates}/% <-- Translate me!
- update,
- {For breaks}/% <-- Translate me!
- break,
- {For problems}/% <-- Translate me!
- pb,
- {For fixes}/% <-- Translate me!
- fix,
- {Selectable themes with an icon}/% <-- Translate me!
- user-choice-icon,
- {Selectable themes without icons}/%<-- Translate me!
- user-choice%
+ {Just for the very first version}/%<-- Translate me!
+ first,
+ {For new features}/% <-- Translate me!
+ new,
+ {For updates}/% <-- Translate me!
+ update,
+ {For breaks}/% <-- Translate me!
+ break,
+ {For problems}/% <-- Translate me!
+ pb,
+ {For fixes}/% <-- Translate me!
+ fix,
+ {Technical information}/% <-- Translate me!
+ tech,
+ {Selectable themes with an icon}/% <-- Translate me!
+ user-choice-icon,
+ {Selectable themes without icons}/%<-- Translate me!
+ user-choice%
} {
- \begin{tdocexa}[\exatitle]
- \leavevmode
+ \begin{tdocexa}[\exatitle]
+ \leavevmode
- \tdoclatexinput[sbs]{examples-version-n-change-\filename.tex}
+ \tdoclatexinput[sbs]{examples-version-n-change-\filename.tex}
- \end{tdocexa}
+ \end{tdocexa}
}
@@ -1320,7 +1778,7 @@
\section{Contribute}
\begin{tdocnote}
- \textbf{You don't need to be a coder to take part in translations}, including those that are useful for the running of \thisproj.
+ \textbf{You don't need to be a coder to take part in translations}, including those that are useful for the running of \thisproj.
\end{tdocnote}
@@ -1341,18 +1799,19 @@
\end{tdoccaut}
-\begin{wrapfigure}{R}
- \contribtranslatedirtree\
- \caption{Simplified view of the translation folder}
- \label{tdoc-contrib-translate-dir}
-\end{wrapfigure}{}
+\begin{figure}[ht]
+ \centering
+ \contribtranslatedirtree\
+ \caption{Simplified view of the translation folder}
+ \label{tutodoc-contrib-translate-dir}
+\end{figure}
-The translations are roughly organized as in figure \ref{tdoc-contrib-translate-dir} where only the folders important for the translations have been \tdocquote{opened}\,.%}.
+The translations are roughly organized as in figure \ref{tutodoc-contrib-translate-dir} where only the folders important for the translations have been \tdocquote{opened}\,.%}.
\footnote{
This was the organization on October 5, 2024, but it's still relevant today.
}
-\textbf{A little further down, the \ref{tdoc-contrib-translate} section explains how to add new translations}.
+\textbf{A little further down, the \ref{tutodoc-contrib-translate} section explains how to add new translations}.
\subsubsection{The \texttt{fr} and \texttt{en} folders}
@@ -1376,7 +1835,7 @@
\subsubsection{New translations}
-\label{tdoc-contrib-translate}
+\label{tutodoc-contrib-translate}
\begin{tdocimp}
The \verb#api# folder contains translations relating to the functionalities of \thisproj.
@@ -1392,7 +1851,7 @@
date = #1-#2-#3
// #1: the idea is to produce one text like
- // "this word means #1 in english".
+ // "this word means #1 in English".
in_EN = #1 in english\end{verbatim}
\end{tdocimp}
@@ -1419,15 +1878,15 @@
\paragraph{Method 1 : \git.}
\begin{enumerate}
- \item Obtain the entire project folder via \thisrepo\,.
+ \item Obtain the entire project folder via \thisrepo\,.
Do not use the \verb#main# branch, which is used to freeze the latest stable versions of projects in the single \thismonorepo\ repository,.
- \item In the \verb#tutodoc/contrib/translate# folder, create a \verb#it# copy of the \verb#en# folder, with the short name of the language documented in
- \href{https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags}%
- {the page \tdocquote{IIETF language tag}}
- from \texttt{Wikipedia}.
+ \item In the \verb#tutodoc/contrib/translate# folder, create a \verb#it# copy of the \verb#en# folder, with the short name of the language documented in
+ \href{https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags}%
+ {the page \tdocquote{IIETF language tag}}
+ from \texttt{Wikipedia}.
- \item Once the translation is complete in the \verb#it# folder, you'll need to communicate it via \thisrepo\ using a classic \verb#git push#\,.
+ \item Once the translation is complete in the \verb#it# folder, you'll need to communicate it via \thisrepo\ using a classic \verb#git push#\,.
\end{enumerate}
@@ -1434,13 +1893,13 @@
\paragraph{Method 2 : communicate by e-mail.}
\begin{enumerate}
- \item By e-mail with the \mailsubject{en FOR italian}, request a version of the English translations (note the use of the English name for the new language).
+ \item By e-mail with the \mailsubject{en FOR italian}, request a version of the English translations (note the use of the English name for the new language).
Be sure to respect the subject of the e-mail, as the author of \thisproj\ automates the pre-processing of this type of e-mail.
- \item You will receive a folder named \verb#italian# containing the English version of the latest translations.
+ \item You will receive a folder named \verb#italian# containing the English version of the latest translations.
This folder will be the place for your contribution.
- \item Once the translation is complete, you will need to compress your \verb#italian# file in \verb#zip# or \verb#rar# format before sending it by e-mail with the \mailsubject{italian}\,.
+ \item Once the translation is complete, you will need to compress your \verb#italian# file in \verb#zip# or \verb#rar# format before sending it by e-mail with the \mailsubject{italian}\,.
\end{enumerate}
@@ -1449,7 +1908,7 @@
\subsection{Improving the source code}
\begin{tdocimp}
- If you want to participate in \thisproj\, you'll need to use the \LaTeX3 programming paradigm.
+ If you want to participate in \thisproj\, you'll need to use the \LaTeX3 programming paradigm.
\end{tdocimp}
@@ -1461,32 +1920,89 @@
\small
-\tdocversion{1.5.0}[2024-10-19]
+\tdocversion{1.6.1}[2024-10-28]
\small
+\begin{tdoctech}
+ \item The naming rules of \ctan\ need the use of \trademark{CSS} files named \verb+tutodoc-*.css.cls.sty+\,.
+\end{tdoctech}
+
+\tdocsep
+
+
+% ------------------ %
+
+
+\tdocversion{1.6.0}[2024-10-27]
+
+\small
+
\begin{tdocbreak}
- \item The \thisproj\ class replaces the now-defunct \thisproj\ package (for the moment, the young class offers no specific options).
+ \item The \tdocenv*{showcase} environment and its descendants: the \tdocinlatex{color} key has been renamed \tdocinlatex{colstripe}.
- \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 macro \tdocmacro{tdoclinkcolor} has been renamed \tdocinlatex{tutodoc at link@color} for internal use.
\end{tdocbreak}
-\begin{tdocfix}
- \item Version 3 of \tdocpack{minted} is taken into account.
+\begin{tdocnew}
+ \item The \tdocinlatex{theme} class option allows you to choose different formatting themes.
- \item The \tdocmacro{tdocdate} macro did not handle date format and formatting.
+ \item Change log: addition of the \tdocenv*{tdoctech} environment for technical information.
- \item Colored frames did not color text after a page break.
+ \item The \tdocenv*{showcase} environment and its descendants: the \tdocinlatex{coltext} key can also be used to change the text color.
+
+ \item The new functionalities have been documented.
+\end{tdocnew}
+
+
+\begin{tdocupdate}
+ \item Change log: the \tdocenv*{tdocupdate} environment uses the icon
+ \raisebox{0pt}[0pt][0pt]{\fbox{\reflectbox{\faHistory}}}
+ instead of
+ \raisebox{0pt}[0pt][0pt]{\fbox{\faMagic}}\,.
+\end{tdocupdate}
+
+
+\begin{tdocfix}
+ \item The Spanish translations were not included in the previous version! Don't laugh too hard...
\end{tdocfix}
+\tdocsep
+
+% ------------------ %
+
+
+\tdocversion{1.5.0}[2024-10-19]
+
+\small
+
+\begin{tdoctech}
+ \item Version 3 of \tdocpack{minted} is taken into account.
+\end{tdoctech}
+
+
+\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>}}).
+\end{tdocbreak}
+
+
\begin{tdocnew}
- \item The class is usable in Spanish.
+ \item The class is usable in Spanish.
- \item The documentation contains a new section explaining how to contribute.
+ \item The documentation contains a new section explaining how to contribute.
\end{tdocnew}
+
+\begin{tdocfix}
+ \item The \tdocmacro{tdocdate} macro did not handle date format and formatting.
+
+ \item Colored frames did not color text after a page break.
+\end{tdocfix}
+
\tdocsep
@@ -1495,12 +2011,14 @@
\tdocversion{1.4.0}[2024-09-28]
+\small
+
\begin{tdocbreak}
- \item The \tdocenv*{tdoccaution} environment has been renamed \tdocenv*{tdoccaut} for simplified input.
+ \item The \tdocenv*{tdoccaution} environment has been renamed \tdocenv*{tdoccaut} for simplified input.
- \item Content highlighting: examples and remarks, indicated via the \tdocenv*{tdocexa} and \tdocenv*{tdocrem} environments, are always numbered using a common counter.
+ \item Content highlighting: examples and remarks, indicated via the \tdocenv*{tdocexa} and \tdocenv*{tdocrem} environments, are always numbered using a common counter.
- \item The unused macro \tdocmacro{tdocxspace} has been deleted.
+ \item The unused macro \tdocmacro{tdocxspace} has been deleted.
\end{tdocbreak}
@@ -1512,16 +2030,16 @@
\begin{tdocupdate}
- \item Colors: the \tdocmacro{tdocdarkcolor} and \tdocmacro{tdoclightcolor} macros offer an optional argument.
- \begin{enumerate}
- \item \tdocmacro{tdocdarkcolor} : the amount of color in relation to black can be optionally defined.
+ \item Colors: the \tdocmacro{tdocdarkcolor} and \tdocmacro{tdoclightcolor} macros offer an optional argument.
+ \begin{enumerate}
+ \item \tdocmacro{tdocdarkcolor}: the amount of color in relation to black can be optionally defined.
- \item \tdocmacro{tdoclightcolor} : the transparency rate can be optionally defined.
- \end{enumerate}
+ \item \tdocmacro{tdoclightcolor}: the transparency rate can be optionally defined.
+ \end{enumerate}
\item Content highlighting: reduced space around content in colored frames.
- \item Versioning: better vertical spacing thanks to \tdocmacro{vphantom}.
+ \item Versioning: better vertical spacing thanks to \tdocmacro{vphantom}.
\end{tdocupdate}
\tdocsep
@@ -1532,6 +2050,8 @@
\tdocversion{1.3.1}[2024-09-26]
+\small
+
\begin{tdocnew}
\item Star version of \tdocmacro{tdocenv} to display only the environment name.
\end{tdocnew}
@@ -1544,13 +2064,15 @@
\tdocversion{1.3.0}[2024-09-25]
-\begin{tdocprob}
- \item Version 3 of \tdocpack{minted} cannot be used for the moment as it contains bugs: see \url{https://github.com/gpoore/minted/issues/401}. We therefore force the use of version 2 of \tdocpack{minted}.
-\end{tdocprob}
+\small
+\begin{tdoctech}
+ \item Version 3 of \tdocpack{minted} cannot be used for the moment as it contains bugs: see \url{https://github.com/gpoore/minted/issues/401}. We therefore force temporarily the use of version 2 of \tdocpack{minted}.
+\end{tdoctech}
+
\begin{tdocbreak}
- \item The \tdocenv*{tdocimportant} environment has been renamed \tdocenv*{tdocimp} for simplified input.
+ \item The \tdocenv*{tdocimportant} environment has been renamed \tdocenv*{tdocimp} for simplified input.
\end{tdocbreak}
@@ -1563,11 +2085,11 @@
\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}
+ \item \tdocenv*{tdoccaution}
+ \item \tdocenv*{tdocimp}
+ \item \tdocenv*{tdocnote}
+ \item \tdocenv*{tdoctip}
+ \item \tdocenv*{tdocwarn}
\end{enumerate}
\end{multicols}
\egroup
@@ -1581,6 +2103,8 @@
\tdocversion{1.2.0-a}[2024-08-23]
+\small
+
\begin{tdocupdate}
\item \tdocmacro{tdocversion}
\begin{enumerate}
@@ -1603,8 +2127,10 @@
\tdocversion{1.1.0}[2024-01-06]
+\small
+
\begin{tdocnew}
- \item Change log : two new environments.
+ \item Change log: two new environments.
\begin{enumerate}
\item \tdocenv{tdocbreak} for breaking changes which are not backward compatible.
@@ -1622,10 +2148,12 @@
\tdocversion{1.0.1}[2023-12-08]
+\small
+
\begin{tdocfix}
\item \tdocmacro{tdocenv}: spacing is now correct, even if the \tdocpack{babel} package is not loaded with the French language.
- \item \tdocenv[{[nostripe]}]{tdocshowcase}: page breaks around \tdocquote{framing} lines should be rare from now on.
+ \item \tdocenv[{[nostripe]}]{tdocshowcase} : page breaks around \tdocquote{framing} lines should be rare from now on.
\end{tdocfix}
\tdocsep
@@ -1636,6 +2164,8 @@
\tdocversion{1.0.0}[2023-11-29]
+\small
+
\tdocstartproj{First public version of the project.}
\end{document}
Modified: trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex 2024-10-29 00:41:52 UTC (rev 72695)
+++ trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex 2024-10-29 20:06:39 UTC (rev 72696)
@@ -3,6 +3,387 @@
% ==================== %
+\begin{filecontents*}[overwrite]{gallery-showcase-bw.tex}
+\documentclass[10pt, a4paper, theme = bw]{tutodoc}
+
+% -- FORDOC -- %
+
+\newcommand\thisstyle{bw}
+
+\newcommand\myexrmktext{
+ \tdocdate{2024-10-23}
+ 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.
+}
+
+\newcommand\myhighlightedtext{
+ Que dire\,%
+ \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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
+
+\section{Mettre en avant, versionner et dater}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{Des codes \LaTeX}
+
+Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX.
+
+\begin{tdoclatex}
+Voir du code \LaTeX\ mis en forme, c'est sympa : $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}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+\begin{filecontents*}[overwrite]{gallery-showcase-color.tex}
+\documentclass[10pt, a4paper, theme = color]{tutodoc}
+
+% -- FORDOC -- %
+
+\newcommand\thisstyle{color}
+
+\newcommand\myexrmktext{
+ \tdocdate{2024-10-23}
+ 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.
+}
+
+\newcommand\myhighlightedtext{
+ Que dire\,%
+ \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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
+
+\section{Mettre en avant, versionner et dater}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{Des codes \LaTeX}
+
+Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX.
+
+\begin{tdoclatex}
+Voir du code \LaTeX\ mis en forme, c'est sympa : $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}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+\begin{filecontents*}[overwrite]{gallery-showcase-dark.tex}
+\documentclass[10pt, a4paper, theme = dark]{tutodoc}
+
+% -- FORDOC -- %
+
+\newcommand\thisstyle{dark}
+
+\newcommand\myexrmktext{
+ \tdocdate{2024-10-23}
+ 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.
+}
+
+\newcommand\myhighlightedtext{
+ Que dire\,%
+ \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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
+
+\section{Mettre en avant, versionner et dater}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{Des codes \LaTeX}
+
+Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX.
+
+\begin{tdoclatex}
+Voir du code \LaTeX\ mis en forme, c'est sympa : $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}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+\begin{filecontents*}[overwrite]{gallery-showcase-draft.tex}
+\documentclass[10pt, a4paper, theme = draft]{tutodoc}
+
+% -- FORDOC -- %
+
+\newcommand\thisstyle{draft}
+
+\newcommand\myexrmktext{
+ \tdocdate{2024-10-23}
+ 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.
+}
+
+\newcommand\myhighlightedtext{
+ Que dire\,%
+ \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 ?
+}
+
+
+\begin{document}
+
+{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
+
+\section{Mettre en avant, versionner et dater}
+
+\ExplSyntaxOn
+
+\seq_map_inline:Nn \__g_tutodoc_focus_std_seq {
+ \subsection*{tdoc#1}
+
+ \myexrmktext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myexrmktext
+}
+
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+} {
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \subsection*{tdoc#1}
+
+ \myadmotext
+
+ \begin{tdoc#1}
+ \myhighlightedtext
+ \end{tdoc#1}
+
+ \myadmotext
+ }
+}
+
+\ExplSyntaxOff
+
+\section{Des codes \LaTeX}
+
+Il est indispensable de pouvoir montrer des cas d'utilisation en \LaTeX.
+
+\begin{tdoclatex}
+Voir du code \LaTeX\ mis en forme, c'est sympa : $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}$.
+\end{tdoclatex}
+
+\end{document}
+
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex}
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
@@ -25,7 +406,7 @@
\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice-icon.tex}
-\begin{tdoctopic}{Ne pas regarder}[\faEyeSlash]
+\begin{tdoctopic}{À cacher}[\faEyeSlash]
% Une icône venant de fontawesome5.
\item Info 1...
\item Info 2...
@@ -70,6 +451,14 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-version-n-change-tech.tex}
+\begin{tdoctech}
+ \item Info 1...
+ \item Info 2...
+\end{tdoctech}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-version-n-change-break.tex}
\begin{tdocbreak}
\item Info 1...
@@ -180,6 +569,23 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-admonitions-leavevmode-items.tex}
+\begin{tdoctip}[Peu élégant]
+ \begin{enumerate}
+ \item Point 1.
+ \item Point 2.
+ \end{enumerate}
+\end{tdoctip}
+VERSUS.
+\begin{tdoctip}[Plus élégant]
+ \begin{enumerate}[wide]
+ \item Point 1.
+ \item Point 2.
+ \end{enumerate}
+\end{tdoctip}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-admonitions-rmk.tex}
\begin{tdocrem}
Juste une remarque...
@@ -192,10 +598,11 @@
\begin{filecontents*}[overwrite]{examples-listing-latexshow-options.tex}
-\tdoclatexshow[explain = Ce qui vient est coloré...,
- before = Rendu ci-après.,
- after = Rendu fini.,
- color = orange]
+\tdoclatexshow[explain = Ce qui vient est coloré...,
+ before = Rendu ci-après.,
+ after = Rendu fini.,
+ colstripe = orange,
+ coltext = blue!70!black]
{examples-listing-xyz.tex}
\end{filecontents*}
@@ -228,9 +635,10 @@
\begin{filecontents*}[overwrite]{examples-showcase-customized.tex}
-\begin{tdocshowcase}[before = Mon début,
- after = Ma fin à moi,
- color = red]
+\begin{tdocshowcase}[before = Mon début,
+ after = Ma fin à moi,
+ colstripe = red,
+ coltext = orange!75!black]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
@@ -245,9 +653,10 @@
\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip-customized.tex}
\begin{tdocshowcase}[nostripe,
- before = Mon début,
- after = Ma fin à moi,
- color = green]
+ before = Mon début,
+ after = Ma fin à moi,
+ colstripe = green,
+ coltext = purple]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
@@ -282,19 +691,20 @@
\documentclass[10pt, a4paper]{tutodoc}
+% Community tools
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{enumitem}
-% \usepackage[german]{babel}
\usepackage[french]{babel, varioref}
\frenchsetup{StandardItemLabels=true}
\usepackage{multicol}
-\usepackage{wrapfig2}
+\usepackage{pdfpages}
+% Some useful commands.
\newcommand\thisproj{\tdoccls{tutodoc}}
\newcommand\thisrepo{\url{https://github.com/bc-tools/for-latex/tree/tutodoc}}
\newcommand\thismonorepo{\url{https://github.com/bc-tools/for-latex}}
@@ -303,12 +713,13 @@
\newcommand\ctan{\href{https://ctan.org/}{\trademark{CTAN}}}
\newcommand\git{\trademark{git}}
+\newcommand\pdf{\trademark{PDF}}
% Source.
% * https://tex.stackexchange.com/a/604698/6880
-\NewDocumentCommand{ \tdocdocbasicinput }{ m }{%
+\NewDocumentCommand{ \tdocbasicinputDOC }{ m }{%
Considérons le code suivant.
\tdoclatexinput[code]{#1}
@@ -322,7 +733,7 @@
% Source.
% * https://tex.stackexchange.com/a/604698/6880
-\NewDocumentCommand{ \tdocdocextraruler }{ m }{%
+\NewDocumentCommand{ \tdocextrarulerDOC }{ m }{%
\par
{
\centering
@@ -337,14 +748,14 @@
}
}
-\NewDocumentEnvironment{ tdoc-doc-showcase }
+\NewDocumentEnvironment{ tdocshowcaseDOC }
{ O{ Début du rendu dans cette doc. }
O{ Fin du rendu dans cette doc. } }{
- \tdocdocextraruler{#1}
+ \tdocextrarulerDOC{#1}
\nopagebreak\smallskip\nopagebreak
}{
\nopagebreak\smallskip\nopagebreak
- \tdocdocextraruler{#2}
+ \tdocextrarulerDOC{#2}
}
@@ -417,8 +828,8 @@
\title{La classe \texttt{tutodoc} - Documentation de type tutoriel}
-\author{Christophe BAL}
-\date{19 oct. 2024 - Version 1.5.0}
+\author{Christophe, BAL}
+\date{28 oct. 2024 - Version 1.6.1}
\maketitle
@@ -436,7 +847,7 @@
\smallskip
- \noindent
+ \noindent
\emph{\textbf{Remarque :} cette documentation est aussi disponible en anglais.}
\tdocsep
@@ -459,7 +870,7 @@
\smallskip
- \noindent
+ \noindent
\emph{\textbf{Remark :} this documentation is also available in French.}
}
\end{abstract}
@@ -470,27 +881,9 @@
\small
\begin{minipage}{.9\textwidth}
\begin{tdocnote}[Derniers changements]
-\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>}}).
-\end{tdocbreak}
-
-
-\begin{tdocfix}
- \item La version 3 de \tdocpack{minted} est prise en compte.
-
- \item La macro \tdocmacro{tdocdate} ne gérait pas le format et la mise en forme de la date.
-
- \item Les cadres colorés ne coloraient pas le texte après un saut de page.
-\end{tdocfix}
-
-
-\begin{tdocnew}
- \item La classe est utilisable en langue espagnole.
-
- \item La documentation contient une nouvelle section expliquant comment contribuer.
-\end{tdocnew}
+\begin{tdoctech}
+ \item Les règles de nommage de \ctan\ nécessitent l'usage de noms du type \verb+tutodoc-*.css.cls.sty+ pour les fichiers à-la \trademark{CSS}.
+\end{tdoctech}
\end{tdocnote}
\end{minipage}
\end{center}
@@ -594,7 +987,7 @@
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}.%
\footnote{
- Techniquement, on utilise \tdocinlatex|\BCPdata{language}| qui renvoie une langue au format court.
+ Techniquement, on utilise \tdocinlatex|\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.
@@ -609,7 +1002,7 @@
\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).
+ 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}
@@ -641,6 +1034,95 @@
\end{tdocnote}
+\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.
+
+\begin{itemize}
+ \item \tdocinlatex|bw| :
+ ce thème est 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}.
+
+ \item \tdocinlatex|dark| :
+ ce thème est 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}
+
+
+\begin{tdocnote}
+ A la fin de ce document, après l'historique des changements, vous trouverez une galerie de cas d'utilisation de ces différents thèmes : se rendre à l'annexe page \pageref{tutodoc-theme-gallery}.
+\end{tdocnote}
+
+
+% ----------------------------- %
+% -- AT END DOCUMENT - START -- %
+% ----------------------------- %
+
+% The following AT-END-DOCUMENT lines of codes have been generated
+% automatically. Don't judge their relative beauty...
+
+\AtEndDocument{
+
+% An annex page for a pretty doc.
+\newpage
+
+% Source.
+% + https://tex.stackexchange.com/a/8547/6880
+\bgroup
+ \titleformat{\section}[block]{\Huge\bfseries\filcenter}{}{1em}{}
+ \phantomsection\section*{Annexe -- Galerie des thèmes}%
+ \label{tutodoc-theme-gallery}
+ \addcontentsline{toc}{section}{Annexe -- Galerie des thèmes}%
+\egroup
+
+\bigskip
+
+\begin{tdocnote}
+ Chaque exemple est un \pdf\ de deux pages exactement qui a été directement inséré dans ce document (ne soyez donc pas surpris par les numéros de page).
+\end{tdocnote}
+
+\newpage
+
+% Let's build the PDFs.
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-bw}
+
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-color}
+
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-dark}
+
+\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-draft}
+
+% The gallery starts here...
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-bw}
+
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-color}
+
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-dark}
+
+\includepdf[
+ pages=1-2,
+ fitpaper=true
+]{gallery-showcase-draft}
+
+}
+
+% --------------------------- %
+% -- AT END DOCUMENT - END -- %
+% --------------------------- %
+
\section{Mettre en avant du contenu}
\begin{tdocnote}
@@ -657,7 +1139,7 @@
\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.
+ 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.
\end{tdocimp}
@@ -671,11 +1153,6 @@
-\begin{tdocimp}
- La numérotation des exemples est remise à zéro dès qu'une section de niveau au moins égale à une \tdocinlatex|\section| est ouverte.
-\end{tdocimp}
-
-
\begin{tdoctip}
Il peut parfois être utile de revenir à la ligne dès le début du contenu. Le code suivant montre comment faire (ce tour de passe-passe reste valable pour l'environnement \verb#tdocrem# présenté juste après). Noter au passage que la numérotation suit celle de l'exemple précédent comme souhaité.
\end{tdoctip}
@@ -695,10 +1172,12 @@
-\subsection{Du contenu tape-à-l'oeil} \label{tdoc-admonitions}
+\subsection{Du contenu tape-à-l'oeil}
+\label{tutodoc-admonitions}
\begin{tdocnote}
- Les icônes sont obtenues via le package \tdocpack{fontawesome5}, et la gestion de l'espacement avec le texte est faite par la macro \tdocmacro{tdocicon}.
+ La mise en forme proposée ici est celle par défaut, mais d'autres sont possible en changeant de thème : voir la galerie de cas d'utilisation dans l'annexe page \pageref{tutodoc-theme-gallery}.
+ 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é}}|
@@ -720,34 +1199,36 @@
\smallskip
-\begin{tdocnote}
- Les couleurs sont obtenues via les macros développables \tdocmacro{tdocbackcolor} et \tdocmacro{tdocdarkcolor}.
- Pour des informations complémentaires à ce sujet, se reporter à la fin de la section \ref{tdoc-color-macros} page \pageref{tdoc-color-macros}.
-\end{tdocnote}
+\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}.
+ \tdoclatexinput[sbs]{examples-admonitions-leavevmode-items.tex}
+\end{tdoctip}
+
+
\foreach \sectitle/\desc/\filename in {
- {Note informative}/% <-- Translate me!
- {L'environnement \tdocenv*{tdocnote} sert à mettre en avant des informations utiles. Voici comment l'utiliser.}/% <-- Translate me!
- note,
- %
- {Un truc important}/% <-- Translate me!
- {L'environnement \tdocenv*{tdocimp} permet d'indiquer quelque chose d'important mais sans danger.}/% <-- Translate me!
- important,
- %
- {Avertir d'un point très délicat}/% <-- Translate me!
- {L'environnement \tdocenv*{tdoccaut} sert à indiquer un point délicat à l'utilisateur. Voici comment l'employer.}/%<-- Translate me!
- caution,
- %
- {Avertir d'un danger}/% <-- Translate me!
- {L'environnement \tdocenv*{tdocwarn} sert à avertir l'utilisateur d'un piège à éviter. Voici comment l'employer.}/% <-- Translate me!
- warn%
+ {Note informative}/% <-- Translate me!
+ {L'environnement \tdocenv*{tdocnote} sert à mettre en avant des informations utiles. Voici comment l'utiliser.}/% <-- Translate me!
+ note,
+ %
+ {Un truc important}/% <-- Translate me!
+ {L'environnement \tdocenv*{tdocimp} permet d'indiquer quelque chose d'important mais sans danger.}/% <-- Translate me!
+ important,
+ %
+ {Avertir d'un point très délicat}/% <-- Translate me!
+ {L'environnement \tdocenv*{tdoccaut} sert à indiquer un point délicat à l'utilisateur. Voici comment l'employer.}/%<-- Translate me!
+ caution,
+ %
+ {Avertir d'un danger}/% <-- Translate me!
+ {L'environnement \tdocenv*{tdocwarn} sert à avertir l'utilisateur d'un piège à éviter. Voici comment l'employer.}/% <-- Translate me!
+ warn%
} {
- \subsubsection{\sectitle}
+ \subsubsection{\sectitle}
- \desc
+ \desc
- \tdoclatexinput[sbs]{examples-admonitions-\filename.tex}
+ \tdoclatexinput[sbs]{examples-admonitions-\filename.tex}
}
@@ -769,13 +1250,13 @@
\begin{tdocrem}
- Contrairement à \tdocmacro{tdocinlatex}, les macros \tdocmacro{tdocenv} et \tdocmacro{tdocenv*} ne colorent pas le texte produit.
+ 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.
\end{tdocrem}
\begin{tdocwarn}
- L'argument optionnel de la macro \tdocmacro{tdocenv} est copié-collé
+ L'argument optionnel de la macro \tdocmacro{tdocenv} est copié-collé
\footnote{
Se souvenir que tout est possible ou presque dorénavant.
}
@@ -801,13 +1282,14 @@
\end{tdocrem}
-\section{Un rendu en situation réelle} \label{tdoc-showcase}
+\section{Un rendu en situation réelle}
+\label{tutodoc-showcase}
Il est parfois utile d'obtenir directement le rendu d'un code dans la documentation. Ceci nécessite que ce type de rendu soit dissociable du texte donnant des explications.
-\subsection{Avec une bande colorée} \label{tdoc-color-macros}
+\subsection{Avec une bande colorée}
\begin{tdocexa}[Avec les textes par défaut]
Il peut être utile de montrer un rendu réel directement dans un document.
@@ -832,7 +1314,7 @@
\begin{tdocrem}
- Voir la section \ref{tdoc-latexshow} page \pageref{tdoc-latexshow} pour obtenir facilement un code suivi de son rendu réel comme dans l'exemple précédent.
+ Voir la section \ref{tutodoc-latexshow} page \pageref{tutodoc-latexshow} pour obtenir facilement un code suivi de son rendu réel comme dans l'exemple précédent.
\end{tdocrem}
@@ -841,7 +1323,7 @@
\end{tdocnote}
-\begin{tdocexa}[Changer la couleur et/ou les textes par défaut]
+\begin{tdocexa}[Changer les couleurs et/ou les textes par défaut]
\leavevmode
\tdoclatexinput[code]{examples-showcase-customized.tex}
@@ -857,31 +1339,13 @@
\begin{tdocnote}
- Vous avez sûrement remarqué que le rouge sert de base pour obtenir les couleurs utilisées.
+ 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} !
+ }
+ %
+ Il faut également savoir qu'en coulisse, la macro \tdocmacro{tdocruler} est employée.
- \begin{itemize}
- \item La couleur de fond est fournie par \tdocmacro{tdocbackcolor}.
-
- \item La couleur des titres et des lignes est fournie par \tdocmacro{tdocdarkcolor}.
- \end{itemize}
-
- Ces macros développables admettent les codes suivants.
-
- \begin{tdoclatex}[code]
-% Argument 1 : de façon optionnelle, on peut indiquer la quantité de couleur
-% relativement au noir.
-% Il est en général inutile de modifier ce paramètre !
-% Argument 2 : une couleur au format xcolor.
-\NewExpandableDocumentCommand{\tdocdarkcolor}{O{50}m}{#2!#1!black}
-
-% Argument 1 : de façon optionnelle, on peut indiquer le taux de transparence.
-% Il est en général inutile de modifier ce paramètre !
-% Argument 2 : une couleur au format xcolor.
-\NewExpandableDocumentCommand{\tdoclightcolor}{O{5}m}{#2!#1}
- \end{tdoclatex}
-
- Il faut également savoir qu'en coulisse, la macro \tdocmacro{tdocruler} est utilisée.
-
\begin{tdoclatex}[std]
\tdocruler[red]{Un pseudo-titre décoré}
\end{tdoclatex}
@@ -923,13 +1387,13 @@
\end{tdocexa}
-\begin{tdocexa}[Changer la couleur et/ou les textes par défaut]
+\begin{tdocexa}[Changer les couleurs et/ou les textes par défaut]
\leavevmode
\tdoclatexinput[code]{examples-showcase-no-clrstrip-customized.tex}
- Ceci produira ce qui suit.
+ Ceci produira l'horreur suivante.
\medskip
@@ -953,11 +1417,11 @@
\medskip
- Quant à \tdocinlatex+\tdocshowcaseinput[color = orange]{external.tex}+\,, ceci produira le changement de couleur observable ci-après.
+ Quant à \tdocinlatex+\tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{external.tex}+\,, ceci produira le changement de couleur observable ci-après.
\medskip
- \tdocshowcaseinput[color = orange]{examples-showcase-external.tex}
+ \tdocshowcaseinput[colstripe = red, coltext = orange!75!black]{examples-showcase-external.tex}
\end{tdocexa}
@@ -966,17 +1430,18 @@
Documenter un package ou une classe se fait efficacement via des cas d'utilisation montrant à la fois du code et le résultat correspondant.%
\footnote{
- La mise en forme des codes se fait via le package \tdocpack{minted}.
+ La mise en forme des codes se fait via le package \tdocpack{minted}.
}
%\begin{tdoccaut}
-% La version 3 de \tdocpack{minted} ne peut pas être prise en compte pour le moment car elle comporte des bugs : voir \url{https://github.com/gpoore/minted/issues/401}. On force donc l'usage de la version 2 de \tdocpack{minted}.
+% La version 3 de \tdocpack{minted} ne peut pas être prise en compte pour le moment car elle comporte des bugs : voir \url{https://github.com/gpoore/minted/issues/401}. On force donc l'usage de la version 2 de \tdocpack{minted}.
%\end{tdoccaut}
-\subsection{Codes \tdocquote{en ligne}} \label{tdoc-listing-inline}
+\subsection{Codes \tdocquote{en ligne}}
+\label{tutodoc-listing-inline}
La macro \tdocmacro{tdocinlatex}
\footnote{
@@ -1008,7 +1473,7 @@
\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}.
- \tdocdocbasicinput{examples-listing-ABC.tex}
+ \tdocbasicinputDOC{examples-listing-ABC.tex}
\end{tdocexa}
@@ -1036,13 +1501,13 @@
\begin{tdocwarn}
Avec la mise en forme par défaut, si le code commence par un crochet ouvrant, il faudra indiquer explicitement l'option par défaut.
- \tdocdocbasicinput{examples-listing-strange.tex}
+ \tdocbasicinputDOC{examples-listing-strange.tex}
\smallskip
Une autre méthode consiste à utiliser la primitive \tdocmacro{string}.
- \tdocdocbasicinput{examples-listing-strange-bis.tex}
+ \tdocbasicinputDOC{examples-listing-strange-bis.tex}
\end{tdocwarn}
@@ -1108,7 +1573,8 @@
-\subsection{Codes importés et mis en situation} \label{tdoc-latexshow}
+\subsection{Codes importés et mis en situation}
+\label{tutodoc-latexshow}
\begin{tdocexa}[Mise en situation]
Ce qui suit s'obtient via \tdocinlatex+\tdoclatexshow{examples-listing-xyz.tex}+.
@@ -1115,10 +1581,10 @@
\medskip
- \begin{tdoc-doc-showcase}
+ \begin{tdocshowcaseDOC}
\tdoclatexshow{examples-listing-xyz.tex}
- \end{tdoc-doc-showcase}
+ \end{tdocshowcaseDOC}
\end{tdocexa}
@@ -1132,15 +1598,15 @@
\medskip
- \begin{tdoc-doc-showcase}
+ \begin{tdocshowcaseDOC}
\tdoclatexshow[explain = Voici le rendu réel.]{examples-listing-xyz.tex}
- \end{tdoc-doc-showcase}
+ \end{tdocshowcaseDOC}
\end{tdocexa}
\begin{tdocexa}[Les options disponibles]
- En plus du texte explicatif, il est aussi possible d'utiliser toutes les options de l'environnement \tdocenv*{tdocshowcase}, voir \ref{tdoc-showcase} page \pageref{tdoc-showcase}.
+ En plus du texte explicatif, il est aussi possible d'utiliser toutes les options de l'environnement \tdocenv*{tdocshowcase}, voir \ref{tutodoc-showcase} page \pageref{tutodoc-showcase}.
Voici un exemple illustrant ceci.
\medskip
@@ -1154,10 +1620,10 @@
\medskip
- \begin{tdoc-doc-showcase}
+ \begin{tdocshowcaseDOC}
\input{examples-listing-latexshow-options.tex}
- \end{tdoc-doc-showcase}
+ \end{tdocshowcaseDOC}
\end{tdocexa}
@@ -1189,7 +1655,7 @@
\begin{tdocimp}
- \begin{enumerate}
+ \begin{enumerate}[wide]
\item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} nécessitent deux compilations.
\item Comme la langue détectée pour cette documentation est le français, la date dans le rendu final est au format \texttt{JJ/MM/AAAA} alors que dans le code celle-ci devra toujours être saisie au format anglais \texttt{AAAA-MM-JJ}.
@@ -1218,34 +1684,37 @@
\begin{tdocnote}
- Concernant les icônes, voir la note au début de la section \ref{tdoc-admonitions} page \pageref{tdoc-admonitions}.
+ Concernant les icônes, voir la note au début de la section \ref{tutodoc-admonitions} page \pageref{tutodoc-admonitions}.
\end{tdocnote}
\foreach \exatitle/\filename in {
- {Juste pour la toute première version}/%<-- Translate me!
- first,
- {Pour les nouveautés}/% <-- Translate me!
- new,
- {Pour les mises à jour}/% <-- Translate me!
- update,
- {Pour les bifurcations}/% <-- Translate me!
- break,
- {Pour les problèmes}/% <-- Translate me!
- pb,
- {Pour les réparations}/% <-- Translate me!
- fix,
- {Thématiques aux choix avec une icône}/%<-- Translate me!
- user-choice-icon,
- {Thématiques aux choix sans icône}/% <-- Translate me!
- user-choice%
+ {Juste pour la toute première version}/%<-- Translate me!
+ first,
+ {Pour les nouveautés}/% <-- Translate me!
+ new,
+ {Pour les mises à jour}/% <-- Translate me!
+ update,
+ {Pour les bifurcations}/% <-- Translate me!
+ break,
+ {Pour les problèmes}/% <-- Translate me!
+ pb,
+ {Pour les réparations}/% <-- Translate me!
+ fix,
+ {Informations techniques}/% <-- Translate me!
+ tech,
+ %
+ {Thématiques aux choix avec une icône}/%<-- Translate me!
+ user-choice-icon,
+ {Thématiques aux choix sans icône}/% <-- Translate me!
+ user-choice%
} {
- \begin{tdocexa}[\exatitle]
- \leavevmode
+ \begin{tdocexa}[\exatitle]
+ \leavevmode
- \tdoclatexinput[sbs]{examples-version-n-change-\filename.tex}
+ \tdoclatexinput[sbs]{examples-version-n-change-\filename.tex}
- \end{tdocexa}
+ \end{tdocexa}
}
@@ -1274,7 +1743,7 @@
\section{Contribuer}
\begin{tdocnote}
- \textbf{Nul besoin d'être un codeur pour participer aux traductions}, y compris pour celles utiles au fonctionnement de \thisproj.
+ \textbf{Nul besoin d'être un codeur pour participer aux traductions}, y compris pour celles utiles au fonctionnement de \thisproj.
\end{tdocnote}
@@ -1283,30 +1752,30 @@
\subsection{Compléter les traductions}
\begin{tdocnote}
- L'auteur de \thisproj\ gère les versions françaises et anglaises des traductions.
+ L'auteur de \thisproj\ gère les versions françaises et anglaises des traductions.
\end{tdocnote}
\begin{tdoccaut}
- Même si nous allons expliquer comment traduire les documentations, il semble peu pertinent de le faire, car l'anglais devrait suffire de nos jours.%
- \footnote{
- L'existence d'une version française est une simple conséquence de la langue maternelle de l'auteur de \thisproj.
- }
+ Même si nous allons expliquer comment traduire les documentations, il semble peu pertinent de le faire, car l'anglais devrait suffire de nos jours.%
+ \footnote{
+ L'existence d'une version française est une simple conséquence de la langue maternelle de l'auteur de \thisproj.
+ }
\end{tdoccaut}
+\begin{figure}[ht]
+ \centering
+ \contribtranslatedirtree\
+ \caption{Vue simplifiée du dossier des traductions}
+ \label{tutodoc-contrib-translate-dir}
+\end{figure}
-\begin{wrapfigure}{R}
- \contribtranslatedirtree\
- \caption{Vue simplifiée du dossier des traductions}
- \label{tdoc-contrib-translate-dir}
-\end{wrapfigure}{}
-
-Les traductions sont organisées grosso-modo comme dans la figure \ref{tdoc-contrib-translate-dir} où seuls les dossiers importants pour les traductions ont été \tdocquote{ouverts}\,.%
+Les traductions sont organisées grosso-modo comme dans la figure \ref{tutodoc-contrib-translate-dir} où seuls les dossiers importants pour les traductions ont été \tdocquote{ouverts}\,.%
\footnote{
- Cette organisation était celle du 5 octobre 2024, mais elle reste d'actualité.
+ Cette organisation était celle du 5 octobre 2024, mais elle reste d'actualité.
}
-\textbf{Un peu plus bas, la section \ref{tdoc-contrib-translate} donne les démarches à suivre pour ajouter de nouvelles traductions.}
+\textbf{Un peu plus bas, la section \ref{tutodoc-contrib-translate} donne les démarches à suivre pour ajouter de nouvelles traductions.}
\subsubsection{Les dossiers \texttt{fr} et \texttt{en}}
@@ -1332,17 +1801,17 @@
-\subsubsection{De nouvelles traductions}
-\label{tdoc-contrib-translate}
+\subsubsection{De nouvelles traductions}
+\label{tutodoc-contrib-translate}
\begin{tdocimp}
- Le dossier \verb#api# contient les traductions relatives aux fonctionnalités de \thisproj.
- Vous y trouverez des fichiers de type \verb#TXT# à modifier via un éditeur de texte, ou de code, mais non via un traitement de texte.
- Les contenus de ces fichiers utilisent des lignes commentées en anglais pour expliquer ce que fera \thisproj\ ; ces lignes commencent par \verb#//#\,. Voici un extrait de ce type de fichier où \textbf{les traductions se font après chaque signe \,$=$\, sans toucher à ce qui se trouve avant}, car ce morceau initial est utilisé en interne par le code de \thisproj..
+ Le dossier \verb#api# contient les traductions relatives aux fonctionnalités de \thisproj.
+ Vous y trouverez des fichiers de type \verb#TXT# à modifier via un éditeur de texte, ou de code, mais non via un traitement de texte.
+ Les contenus de ces fichiers utilisent des lignes commentées en anglais pour expliquer ce que fera \thisproj\ ; ces lignes commencent par \verb#//#\,. Voici un extrait de ce type de fichier où \textbf{les traductions se font après chaque signe \,$=$\, sans toucher à ce qui se trouve avant}, car ce morceau initial est utilisé en interne par le code de \thisproj..
- \tdocsep
- \vspace{-10pt}
- \begin{verbatim}
+ \tdocsep
+ \vspace{-10pt}
+ \begin{verbatim}
// #1: year in format YYYY like 2023.
// #2: month in format MM like 04.
// #3: day in format DD like 29.
@@ -1349,18 +1818,18 @@
date = #1-#2-#3
// #1: the idea is to produce one text like
- // "this word means #1 in english".
+ // "this word means #1 in English".
in_EN = #1 in english\end{verbatim}
\end{tdocimp}
\begin{tdocnote}
- Le dossier \verb#doc# est réservé aux documentations. Il contient des fichiers de type \verb#TEX# compilables directement pour une validation en temps réel des traductions faites.
+ Le dossier \verb#doc# est réservé aux documentations. Il contient des fichiers de type \verb#TEX# compilables directement pour une validation en temps réel des traductions faites.
\end{tdocnote}
\begin{tdocwarn}
- Ne partir que de l'un des dossiers \verb#fr# et \verb#en#, car ceux-ci sont de la responsabilité de l'auteur de \thisproj.
+ Ne partir que de l'un des dossiers \verb#fr# et \verb#en#, car ceux-ci sont de la responsabilité de l'auteur de \thisproj.
\end{tdocwarn}
@@ -1369,7 +1838,7 @@
\emph{\textbf{Imaginons que vous souhaitiez ajouter le support de l'italien en partant de fichiers rédigés en anglais.}}%
\footnote{
- Comme indiqué plus haut, il n'y a pas de besoin réel du côté du dossier \texttt{doc} de la documentation.
+ Comme indiqué plus haut, il n'y a pas de besoin réel du côté du dossier \texttt{doc} de la documentation.
}
@@ -1376,15 +1845,15 @@
\paragraph{Méthode 1 : \git.}
\begin{enumerate}
- \item Obtenir tout le dossier du projet via \thisrepo\,.
- Ne pas passer via la branche \verb#main# qui sert à figer les dernières versions stables des projets du dépôt unique \thismonorepo\,.
-
- \item Dans le dossier \verb#tutodoc/contrib/translate#, créer une copie \verb#it# du dossier \verb#en#\,, le nom court de la langue étant documenté dans
- \href{https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags}%
- {la page \tdocquote{IIETF language tag}}
- de \texttt{Wikipédia}.
-
- \item Une fois la traduction achevée dans le dossier \verb#it# , il faudra la communiquer via \thisrepo\ en usant d'un classique \verb#git push#\,.
+ \item Obtenir tout le dossier du projet via \thisrepo\,.
+ Ne pas passer via la branche \verb#main# qui sert à figer les dernières versions stables des projets du dépôt unique \thismonorepo\,.
+
+ \item Dans le dossier \verb#tutodoc/contrib/translate#, créer une copie \verb#it# du dossier \verb#en#\,, le nom court de la langue étant documenté dans
+ \href{https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags}%
+ {la page \tdocquote{IIETF language tag}}
+ de \texttt{Wikipédia}.
+
+ \item Une fois la traduction achevée dans le dossier \verb#it# , il faudra la communiquer via \thisrepo\ en usant d'un classique \verb#git push#\,.
\end{enumerate}
@@ -1391,13 +1860,13 @@
\paragraph{Méthode 2 : communiquer par courriels.}
\begin{enumerate}
- \item Via un courriel de \mailsubject{en FOR italian}\,, demander une version des traductions anglaises (noter l'emploi du nom anglais de la nouvelle langue).
- Bien respecter le sujet du courriel, car l'auteur de \thisproj\ automatise le pré-traitement de ce type de courriels.
-
- \item Vous recevrez un dossier nommé \verb#italian# contenant la version anglaise des dernières traductions.
- Ce dossier sera le lieu de votre contribution.
-
- \item Une fois la traduction achevée, il faudra compresser votre dossier \verb#italian# au format \verb#zip# ou \verb#rar# avant de l'envoyer par courriel avec le \mailsubject{italian}\,.
+ \item Via un courriel de \mailsubject{en FOR italian}\,, demander une version des traductions anglaises (noter l'emploi du nom anglais de la nouvelle langue).
+ Bien respecter le sujet du courriel, car l'auteur de \thisproj\ automatise le pré-traitement de ce type de courriels.
+
+ \item Vous recevrez un dossier nommé \verb#italian# contenant la version anglaise des dernières traductions.
+ Ce dossier sera le lieu de votre contribution.
+
+ \item Une fois la traduction achevée, il faudra compresser votre dossier \verb#italian# au format \verb#zip# ou \verb#rar# avant de l'envoyer par courriel avec le \mailsubject{italian}\,.
\end{enumerate}
@@ -1406,7 +1875,7 @@
\subsection{Améliorer le code source}
\begin{tdocimp}
- Si vous souhaitez participer à \thisproj\,, il faudra privilégier le paradigme de programmation \LaTeX3.
+ Si vous souhaitez participer à \thisproj\,, il faudra privilégier le paradigme de programmation \LaTeX3.
\end{tdocimp}
@@ -1418,30 +1887,82 @@
\small
-\tdocversion{1.5.0}[2024-10-19]
+\tdocversion{1.6.1}[2024-10-28]
+\begin{tdoctech}
+ \item Les règles de nommage de \ctan\ nécessitent l'usage de noms du type \verb+tutodoc-*.css.cls.sty+ pour les fichiers à-la \trademark{CSS}.
+\end{tdoctech}
+
+\tdocsep
+
+
+% ------------------ %
+
+
+\tdocversion{1.6.0}[2024-10-27]
+
\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 L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdocinlatex{color} a été renommée \tdocinlatex{colstripe}.
- \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{tdoclinkcolor} devient la couleur \tdocinlatex{tutodoc at link@color} destinée à un usage interne.
\end{tdocbreak}
-\begin{tdocfix}
- \item La version 3 de \tdocpack{minted} est prise en compte.
+\begin{tdocnew}
+ \item L'option de classe \tdocinlatex{theme} permet de choisir différents thèmes de mise en forme.
- \item La macro \tdocmacro{tdocdate} ne gérait pas le format et la mise en forme de la date.
+ \item Journal des modifications : ajout de l'environnement \tdocenv*{tdoctech} pour les informations techniques.
- \item Les cadres colorés ne coloraient pas le texte après un saut de page.
+ \item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdocinlatex{coltext} permet de changer aussi la couleur du texte.
+
+ \item Les nouvelles fonctionnalités ont été documentées.
+\end{tdocnew}
+
+
+\begin{tdocupdate}
+ \item Journal des modifications : l'environnement \tdocenv*{tdocupdate} utilise l'icône
+ \raisebox{0pt}[0pt][0pt]{\fbox{\reflectbox{\faHistory}}}
+ au lieu de
+ \raisebox{0pt}[0pt][0pt]{\fbox{\faMagic}}\,.
+\end{tdocupdate}
+
+
+\begin{tdocfix}
+ \item Les traductions espagnoles n'avaient pas été livrées dans la précédente version ! Ne pas rire trop fort...
\end{tdocfix}
+\tdocsep
+
+% ------------------ %
+
+
+\tdocversion{1.5.0}[2024-10-19]
+
+\begin{tdoctech}
+ \item La version 3 de \tdocpack{minted} est prise en compte.
+\end{tdoctech}
+
+\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>}}).
+\end{tdocbreak}
+
+
\begin{tdocnew}
- \item La classe est utilisable en langue espagnole.
+ \item La classe est utilisable en langue espagnole.
- \item La documentation contient une nouvelle section expliquant comment contribuer.
+ \item La documentation contient une nouvelle section expliquant comment contribuer.
\end{tdocnew}
+
+\begin{tdocfix}
+ \item La macro \tdocmacro{tdocdate} ne gérait pas le format et la mise en forme de la date.
+
+ \item Les cadres colorés ne coloraient pas le texte après un saut de page.
+\end{tdocfix}
+
\tdocsep
@@ -1451,11 +1972,11 @@
\tdocversion{1.4.0}[2024-09-28]
\begin{tdocbreak}
- \item L'environnement \tdocenv*{tdoccaution} a été renommé \tdocenv*{tdoccaut} pour une saisie simplifiée.
+ \item L'environnement \tdocenv*{tdoccaution} a été renommé \tdocenv*{tdoccaut} pour une saisie simplifiée.
- \item Mise en avant de contenus : les exemples et remarques, indiqués via les environnements \tdocenv*{tdocexa} et \tdocenv*{tdocrem}, sont toujours numérotés via un compteur commun.
+ \item Mise en avant de contenus : les exemples et remarques, indiqués via les environnements \tdocenv*{tdocexa} et \tdocenv*{tdocrem}, sont toujours numérotés via un compteur commun.
- \item La macro inutilisée \tdocmacro{tdocxspace} a été supprimée.
+ \item La macro inutilisée \tdocmacro{tdocxspace} a été supprimée.
\end{tdocbreak}
@@ -1467,16 +1988,16 @@
\begin{tdocupdate}
- \item Couleurs : les macros \tdocmacro{tdocdarkcolor} et \tdocmacro{tdoclightcolor} proposent un argument facultatif.
- \begin{enumerate}
- \item \tdocmacro{tdocdarkcolor} : la quantité de couleur par rapport au noir peut être définie de manière facultative.
+ \item Couleurs : les macros \tdocmacro{tdocdarkcolor} et \tdocmacro{tdoclightcolor} proposent un argument facultatif.
+ \begin{enumerate}
+ \item \tdocmacro{tdocdarkcolor} : la quantité de couleur par rapport au noir peut être définie de manière facultative.
- \item \tdocmacro{tdoclightcolor} : le taux de transparence peut être défini de manière facultative.
- \end{enumerate}
+ \item \tdocmacro{tdoclightcolor} : le taux de transparence peut être défini de manière facultative.
+ \end{enumerate}
\item Mise en avant de contenus : réduction de l'espace autour du contenu dans les cadres colorés.
- \item Gestion des versions: un meilleur espacement vertical via \tdocmacro{vphantom}.
+ \item Gestion des versions: un meilleur espacement vertical via \tdocmacro{vphantom}.
\end{tdocupdate}
\tdocsep
@@ -1499,13 +2020,13 @@
\tdocversion{1.3.0}[2024-09-25]
-\begin{tdocprob}
- \item La version 3 de \tdocpack{minted} ne peut pas être prise en compte pour le moment car elle comporte des bugs : voir \url{https://github.com/gpoore/minted/issues/401}. On force donc l'usage de la version 2 de \tdocpack{minted}.
-\end{tdocprob}
+\begin{tdoctech}
+ \item La version 3 de \tdocpack{minted} ne peut pas être prise en compte pour le moment car elle comporte des bugs : voir \url{https://github.com/gpoore/minted/issues/401}. On force donc temporairement l'usage de la version 2 de \tdocpack{minted}.
+\end{tdoctech}
\begin{tdocbreak}
- \item L'environnement \tdocenv*{tdocimportant} a été renommé \tdocenv*{tdocimp} pour une saisie simplifiée.
+ \item L'environnement \tdocenv*{tdocimportant} a été renommé \tdocenv*{tdocimp} pour une saisie simplifiée.
\end{tdocbreak}
@@ -1518,11 +2039,11 @@
\setlength\multicolsep{5pt}
\begin{multicols}{3}
\begin{enumerate}
- \item \tdocenv*{tdoccaution}
- \item \tdocenv*{tdocimp}
- \item \tdocenv*{tdocnote}
- \item \tdocenv*{tdoctip}
- \item \tdocenv*{tdocwarn}
+ \item \tdocenv*{tdoccaution}
+ \item \tdocenv*{tdocimp}
+ \item \tdocenv*{tdocnote}
+ \item \tdocenv*{tdoctip}
+ \item \tdocenv*{tdocwarn}
\end{enumerate}
\end{multicols}
\egroup
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,46 @@
+% -- COLORFUL HIGHLIGHTING OF CONTENT -- %
+
+\NewExpandableDocumentCommand{\tutodoc at build@title at color}{m}{%
+ white%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@upper at color}{m}{%
+ \tdocdarkcolor[40]{Gray}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@back at color}{m}{%
+ \tdoclightcolor[10]{Gray}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@frame at color}{m}{%
+ Gray!75!black!45%
+}
+
+\colorlet{tutodoc at admonition@shadow at 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
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-admonitions.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,30 @@
+% :: INLINE LATEX MACRO :: %
+
+\newcommand{\tutodoc at latex@style}{friendly_grayscale}
+
+\colorlet{tutodoc at latex@back at color}{gray!5}
+\colorlet{tutodoc at latex@text at color}{black}
+
+
+% :: THE TCOLORBOX LISTING STYLE :: %
+
+\colorlet{tutodoc at latex@frame at color}{darkgray}
+
+\newcommand{\tutodoc at latex@left}{1mm}
+\newcommand{\tutodoc at latex@right}{1mm}
+\newcommand{\tutodoc at latex@top}{1mm}
+\newcommand{\tutodoc at latex@bottom}{1mm}
+
+\newcommand{\tutodoc at latex@arc}{.75mm}
+
+\newcommand{\tutodoc at latex@left at rule}{1pt}
+\newcommand{\tutodoc at latex@right at rule}{1pt}
+\newcommand{\tutodoc at latex@top at rule}{1pt}
+\newcommand{\tutodoc at latex@bottom at rule}{1pt}
+
+\colorlet{tutodoc at latex@shadow at color}{black!30}
+\newcommand{\tutodoc at latex@shadow at xshift}{.75mm}
+\newcommand{\tutodoc at latex@shadow at yshift}{-.75mm}
+\newcommand{\tutodoc at latex@shadow at offset}{0mm}
+
+\colorlet{tutodoc at latex@segment at color}{gray}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-listing.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,3 @@
+% -- LINKS -- %
+
+\definecolor{tutodoc at link@color}{named}{DimGray}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-main.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,21 @@
+% -- SHOWCASE -- %
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@rule at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@stripe at color}{}{%
+ darkgray%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@text at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at rule@color}{m}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at back@color}{m}{%
+ gray!10%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-showcase.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,9 @@
+% -- VERSION & CHANGES -- %
+
+\NewExpandableDocumentCommand{\tutodoc at changes@version at color}{}{%
+ gray%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at changes@date at color}{}{%
+ gray%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-bw-version-n-change.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,50 @@
+% -- COLORFUL HIGHLIGHTING OF CONTENT -- %
+
+\NewExpandableDocumentCommand{\tutodoc at build@title at color}{m}{%
+ white%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@upper at color}{m}{%
+ \tdocdarkcolor{#1}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@lower at color}{m}{%
+ \tdocdarkcolor{#1}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@back at color}{m}{%
+ \tdoclightcolor{#1}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@frame at color}{m}{%
+ #1!75!black!45%
+}
+
+\colorlet{tutodoc at admonition@shadow at 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
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-admonitions.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,30 @@
+% :: INLINE LATEX MACRO :: %
+
+\newcommand{\tutodoc at latex@style}{pastie}
+
+\colorlet{tutodoc at latex@back at color}{yellow!4}
+\colorlet{tutodoc at latex@text at color}{black}
+
+
+% :: THE TCOLORBOX LISTING STYLE :: %
+
+\colorlet{tutodoc at latex@frame at color}{darkgray}
+
+\newcommand{\tutodoc at latex@left}{1mm}
+\newcommand{\tutodoc at latex@right}{1mm}
+\newcommand{\tutodoc at latex@top}{1mm}
+\newcommand{\tutodoc at latex@bottom}{1mm}
+
+\newcommand{\tutodoc at latex@arc}{.75mm}
+
+\newcommand{\tutodoc at latex@left at rule}{1pt}
+\newcommand{\tutodoc at latex@right at rule}{1pt}
+\newcommand{\tutodoc at latex@top at rule}{1pt}
+\newcommand{\tutodoc at latex@bottom at rule}{1pt}
+
+\colorlet{tutodoc at latex@shadow at color}{black!30}
+\newcommand{\tutodoc at latex@shadow at xshift}{.75mm}
+\newcommand{\tutodoc at latex@shadow at yshift}{-.75mm}
+\newcommand{\tutodoc at latex@shadow at offset}{0mm}
+
+\colorlet{tutodoc at latex@segment at color}{gray}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-listing.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,3 @@
+% -- LINKS -- %
+
+\colorlet{tutodoc at link@color}{NavyBlue!85!white}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-main.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,21 @@
+% -- SHOWCASE -- %
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@rule at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@stripe at color}{}{%
+ cyan%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@text at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at rule@color}{m}{%
+ \tdocdarkcolor{#1}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at back@color}{m}{%
+ \tdoclightcolor{#1}%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-showcase.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,9 @@
+% -- VERSION & CHANGES -- %
+
+\NewExpandableDocumentCommand{\tutodoc at changes@version at color}{}{%
+ \tdoclightcolor[60]{DarkBlue}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at changes@date at color}{}{%
+ \tdoclightcolor[60]{DarkBlue}%
+}
\ No newline at end of file
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-color-version-n-change.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,50 @@
+% -- COLORFUL HIGHLIGHTING OF CONTENT -- %
+
+\NewExpandableDocumentCommand{\tutodoc at build@title at color}{m}{%
+ \tdocdarkcolor[95]{white}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@upper at color}{m}{%
+ \tdocdarkcolor[95]{white}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@lower at color}{m}{%
+ \tdocdarkcolor[95]{white}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@back at color}{m}{%
+ #1!75!black!65%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at build@frame at color}{m}{%
+ \tdocdarkcolor[65]{#1}%
+}
+
+\colorlet{tutodoc at admonition@shadow at 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
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-admonitions.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,30 @@
+% :: INLINE LATEX MACRO :: %
+
+\newcommand{\tutodoc at latex@style}{github-dark}
+
+\colorlet{tutodoc at latex@back at color}{\tdocdarkcolor[30]{white}}
+\colorlet{tutodoc at latex@text at color}{\tdocdarkcolor[80]{white}}
+
+
+% :: THE TCOLORBOX LISTING STYLE :: %
+
+\colorlet{tutodoc at latex@frame at color}{darkgray}
+
+\newcommand{\tutodoc at latex@left}{1mm}
+\newcommand{\tutodoc at latex@right}{1mm}
+\newcommand{\tutodoc at latex@top}{1mm}
+\newcommand{\tutodoc at latex@bottom}{1mm}
+
+\newcommand{\tutodoc at latex@arc}{.75mm}
+
+\newcommand{\tutodoc at latex@left at rule}{1pt}
+\newcommand{\tutodoc at latex@right at rule}{1pt}
+\newcommand{\tutodoc at latex@top at rule}{1pt}
+\newcommand{\tutodoc at latex@bottom at rule}{1pt}
+
+\colorlet{tutodoc at latex@shadow at color}{black!30}
+\newcommand{\tutodoc at latex@shadow at xshift}{.75mm}
+\newcommand{\tutodoc at latex@shadow at yshift}{-.75mm}
+\newcommand{\tutodoc at latex@shadow at offset}{0mm}
+
+\colorlet{tutodoc at latex@segment at color}{gray}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-listing.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,9 @@
+% -- SPECIFIC TEXT AND PAGE COLORS -- %
+
+\pagecolor{black}
+\color{\tdocdarkcolor[80]{white}}
+
+
+% -- LINKS -- %
+
+\definecolor{tutodoc at link@color}{HTML}{9591A6}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-main.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,21 @@
+% -- SHOWCASE -- %
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@rule at color}{}{%
+ white%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@stripe at color}{}{%
+ white%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@text at color}{}{%
+ white%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at rule@color}{m}{%
+ \tdocdarkcolor[80]{#1}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at back@color}{m}{%
+ \tdocdarkcolor[30]{#1}%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-showcase.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,9 @@
+% -- VERSION & CHANGES -- %
+
+\NewExpandableDocumentCommand{\tutodoc at changes@version at color}{}{%
+ \tdoclightcolor[60]{cyan}%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at changes@date at color}{}{%
+ \tdoclightcolor[60]{cyan}%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-dark-version-n-change.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,18 @@
+% -- 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
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-admonitions.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,31 @@
+% :: INLINE LATEX MACRO :: %
+
+\renewcommand{\tutodoc at latex@lexer}{text}
+\newcommand{\tutodoc at latex@style}{default}
+
+\colorlet{tutodoc at latex@back at color}{white}
+\colorlet{tutodoc at latex@text at color}{black}
+
+
+% :: THE TCOLORBOX LISTING STYLE :: %
+
+\colorlet{tutodoc at latex@frame at color}{darkgray}
+
+\newcommand{\tutodoc at latex@left}{1mm}
+\newcommand{\tutodoc at latex@right}{1mm}
+\newcommand{\tutodoc at latex@top}{1mm}
+\newcommand{\tutodoc at latex@bottom}{1mm}
+
+\newcommand{\tutodoc at latex@arc}{0pt}
+
+\newcommand{\tutodoc at latex@left at rule}{1pt}
+\newcommand{\tutodoc at latex@right at rule}{0pt}
+\newcommand{\tutodoc at latex@top at rule}{0pt}
+\newcommand{\tutodoc at latex@bottom at rule}{0pt}
+
+\colorlet{tutodoc at latex@shadow at color}{black}
+\newcommand{\tutodoc at latex@shadow at xshift}{0mm}
+\newcommand{\tutodoc at latex@shadow at yshift}{0mm}
+\newcommand{\tutodoc at latex@shadow at offset}{0mm}
+
+\colorlet{tutodoc at latex@segment at color}{black}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-listing.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,3 @@
+% -- LINKS -- %
+
+\definecolor{tutodoc at link@color}{named}{black}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-main.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,21 @@
+% -- SHOWCASE -- %
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@rule at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@stripe at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@text at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at rule@color}{m}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at showcase@build at back@color}{m}{%
+ white%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-showcase.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,9 @@
+% -- VERSION & CHANGES -- %
+
+\NewExpandableDocumentCommand{\tutodoc at changes@version at color}{}{%
+ black%
+}
+
+\NewExpandableDocumentCommand{\tutodoc at changes@date at color}{}{%
+ black%
+}
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-draft-version-n-change.css.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Deleted: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-en.cfg.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-en.cfg.cls.sty 2024-10-29 00:41:52 UTC (rev 72695)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-en.cfg.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -1,17 +0,0 @@
-\NewDocumentCommand{\tutodoc at trans@date}{mmm}{#1-#2-#3}
-\NewDocumentCommand{\tutodoc at trans@in at EN}{m}{#1 in english}
-\NewDocumentCommand{\tutodoc at trans@this at gives}{m}{This gives #1}
-\NewDocumentCommand{\tutodoc at trans@latex at show@start}{}{Start of the real output}
-\NewDocumentCommand{\tutodoc at trans@latex at show@end}{}{End of the real output}
-\NewDocumentCommand{\tutodoc at trans@exa at title}{}{Example}
-\NewDocumentCommand{\tutodoc at trans@rem at title}{}{Remark}
-\NewDocumentCommand{\tutodoc at trans@note at title}{}{Note}
-\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Tip}
-\NewDocumentCommand{\tutodoc at trans@imp at title}{}{Important}
-\NewDocumentCommand{\tutodoc at trans@caut at title}{}{Caution}
-\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Warning}
-\NewDocumentCommand{\tutodoc at trans@chges at prob}{}{Problem}
-\NewDocumentCommand{\tutodoc at trans@chges at break}{}{Break}
-\NewDocumentCommand{\tutodoc at trans@chges at fix}{}{Fix}
-\NewDocumentCommand{\tutodoc at trans@chges at new}{}{New}
-\NewDocumentCommand{\tutodoc at trans@chges at update}{}{Update}
\ No newline at end of file
Deleted: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-fr.cfg.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-fr.cfg.cls.sty 2024-10-29 00:41:52 UTC (rev 72695)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-fr.cfg.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -1,17 +0,0 @@
-\NewDocumentCommand{\tutodoc at trans@date}{mmm}{#3/#2/#1}
-\NewDocumentCommand{\tutodoc at trans@in at EN}{m}{#1 en anglais}
-\NewDocumentCommand{\tutodoc at trans@this at gives}{m}{Ceci donne #1}
-\NewDocumentCommand{\tutodoc at trans@latex at show@start}{}{Début du rendu réel}
-\NewDocumentCommand{\tutodoc at trans@latex at show@end}{}{Fin du rendu réel}
-\NewDocumentCommand{\tutodoc at trans@exa at title}{}{Exemple}
-\NewDocumentCommand{\tutodoc at trans@rem at title}{}{Remarque}
-\NewDocumentCommand{\tutodoc at trans@note at title}{}{Note}
-\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Astuce}
-\NewDocumentCommand{\tutodoc at trans@imp at title}{}{Important}
-\NewDocumentCommand{\tutodoc at trans@caut at title}{}{Mise en garde}
-\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Avertissement}
-\NewDocumentCommand{\tutodoc at trans@chges at prob}{}{Problème}
-\NewDocumentCommand{\tutodoc at trans@chges at break}{}{Bifurcation}
-\NewDocumentCommand{\tutodoc at trans@chges at fix}{}{Réparation}
-\NewDocumentCommand{\tutodoc at trans@chges at new}{}{Nouveau}
-\NewDocumentCommand{\tutodoc at trans@chges at update}{}{Mise à jour}
\ No newline at end of file
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,18 @@
+\NewDocumentCommand{\tutodoc at trans@date}{mmm}{#1-#2-#3}
+\NewDocumentCommand{\tutodoc at trans@in at EN}{m}{#1 in English}
+\NewDocumentCommand{\tutodoc at trans@this at gives}{m}{This gives #1}
+\NewDocumentCommand{\tutodoc at trans@latex at show@start}{}{Start of the real output}
+\NewDocumentCommand{\tutodoc at trans@latex at show@end}{}{End of the real output}
+\NewDocumentCommand{\tutodoc at trans@exa at title}{}{Example}
+\NewDocumentCommand{\tutodoc at trans@rem at title}{}{Remark}
+\NewDocumentCommand{\tutodoc at trans@note at title}{}{Note}
+\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Tip}
+\NewDocumentCommand{\tutodoc at trans@imp at title}{}{Important}
+\NewDocumentCommand{\tutodoc at trans@caut at title}{}{Caution}
+\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Warning}
+\NewDocumentCommand{\tutodoc at trans@chges at tech}{}{Technical information}
+\NewDocumentCommand{\tutodoc at trans@chges at prob}{}{Problem}
+\NewDocumentCommand{\tutodoc at trans@chges at break}{}{Break}
+\NewDocumentCommand{\tutodoc at trans@chges at fix}{}{Fix}
+\NewDocumentCommand{\tutodoc at trans@chges at new}{}{New}
+\NewDocumentCommand{\tutodoc at trans@chges at update}{}{Update}
\ No newline at end of file
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-en.cfg.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,18 @@
+\NewDocumentCommand{\tutodoc at trans@date}{mmm}{#1/#2/#3}
+\NewDocumentCommand{\tutodoc at trans@in at EN}{m}{#1 en inglés}
+\NewDocumentCommand{\tutodoc at trans@this at gives}{m}{Esto da #1}
+\NewDocumentCommand{\tutodoc at trans@latex at show@start}{}{Inicio de la representación real}
+\NewDocumentCommand{\tutodoc at trans@latex at show@end}{}{Fin de la representación real}
+\NewDocumentCommand{\tutodoc at trans@exa at title}{}{Ejemplo}
+\NewDocumentCommand{\tutodoc at trans@rem at title}{}{Observación}
+\NewDocumentCommand{\tutodoc at trans@note at title}{}{Nota}
+\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Astucia}
+\NewDocumentCommand{\tutodoc at trans@imp at title}{}{Importante}
+\NewDocumentCommand{\tutodoc at trans@caut at title}{}{Recomendación}
+\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Advertencia}
+\NewDocumentCommand{\tutodoc at trans@chges at tech}{}{Información técnica}
+\NewDocumentCommand{\tutodoc at trans@chges at prob}{}{Problema}
+\NewDocumentCommand{\tutodoc at trans@chges at break}{}{Bifurcación}
+\NewDocumentCommand{\tutodoc at trans@chges at fix}{}{Reparación}
+\NewDocumentCommand{\tutodoc at trans@chges at new}{}{Nuevo}
+\NewDocumentCommand{\tutodoc at trans@chges at update}{}{Actualización}
\ No newline at end of file
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-es.cfg.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty 2024-10-29 20:06:39 UTC (rev 72696)
@@ -0,0 +1,18 @@
+\NewDocumentCommand{\tutodoc at trans@date}{mmm}{#3/#2/#1}
+\NewDocumentCommand{\tutodoc at trans@in at EN}{m}{#1 en anglais}
+\NewDocumentCommand{\tutodoc at trans@this at gives}{m}{Ceci donne #1}
+\NewDocumentCommand{\tutodoc at trans@latex at show@start}{}{Début du rendu réel}
+\NewDocumentCommand{\tutodoc at trans@latex at show@end}{}{Fin du rendu réel}
+\NewDocumentCommand{\tutodoc at trans@exa at title}{}{Exemple}
+\NewDocumentCommand{\tutodoc at trans@rem at title}{}{Remarque}
+\NewDocumentCommand{\tutodoc at trans@note at title}{}{Note}
+\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Astuce}
+\NewDocumentCommand{\tutodoc at trans@imp at title}{}{Important}
+\NewDocumentCommand{\tutodoc at trans@caut at title}{}{Mise en garde}
+\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Avertissement}
+\NewDocumentCommand{\tutodoc at trans@chges at tech}{}{Information technique}
+\NewDocumentCommand{\tutodoc at trans@chges at prob}{}{Problème}
+\NewDocumentCommand{\tutodoc at trans@chges at break}{}{Bifurcation}
+\NewDocumentCommand{\tutodoc at trans@chges at fix}{}{Réparation}
+\NewDocumentCommand{\tutodoc at trans@chges at new}{}{Nouveau}
+\NewDocumentCommand{\tutodoc at trans@chges at update}{}{Mise à jour}
\ No newline at end of file
Property changes on: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-main-locale-fr.cfg.cls.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls 2024-10-29 00:41:52 UTC (rev 72695)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.cls 2024-10-29 20:06:39 UTC (rev 72696)
@@ -1,7 +1,7 @@
% ********************************************************* %
% ** This is file `tutodoc.cls' generated automatically. ** %
% ** ** %
-% ** Copyright (C) 2023-2024 by Christophe BAL ** %
+% ** Copyright (C) 2023-2024 by Christophe, BAL ** %
% ** ** %
% ** This file may be distributed and/or modified under ** %
% ** the conditions of the GNU 3 License. ** %
@@ -9,16 +9,54 @@
\ProvidesExplClass
{tutodoc}
- {2024-10-19} % Creation: 2023-11-29
- {1.5.0}
- {This LaTeX class proposes tools for writing "human friendly" PDF documentations of LaTeX packages and classes.}
+ {2024-10-28} % Creation: 2023-11-29
+ {1.6.1}
+ {This package proposes tools for writing "human friendly" documentations of LaTeX packages.}
+% =================== %
% == PACKAGES USED == %
+% =================== %
-\LoadClassWithOptions{article}%
- [2022-06-01]
+% ------------- %
+% -- OPTIONS -- %
+% ------------- %
+\ExplSyntaxOn
+
+\tl_new:N \l__tutodoc_remaining_cls_options_tl
+
+\newcommand{ \tutodoc at theme } { color }
+
+\keys_define:nn { tutodoc / main / class / options } {
+ theme .choices:nn = {
+ bw,
+ color,
+ dark,
+ draft
+ } {
+ \renewcommand{ \tutodoc at theme } {
+ \tl_use:N \l_keys_choice_tl
+ }
+ },
+ unknown .code:n = {
+ \tl_set:Nn \l__tutodoc_remaining_cls_options_tl { #1 }
+ }
+}
+
+\ProcessKeyOptions[tutodoc / main / class / options]
+
+\LoadClass[ \tl_use:N \l__tutodoc_remaining_cls_options_tl ]%
+ { article }%
+ [ 2022-06-01 ]
+
+\ExplSyntaxOff
+
+
+% ------------- %
+% -- IMPORTS -- %
+% ------------- %
+
\RequirePackage[svgnames]%
{xcolor}%
[2023/11/15]
@@ -36,7 +74,7 @@
\RequirePackage[raggedright]%
{titlesec}%
- [2021/07/05]
+ [2023/10/27]
\RequirePackage{tocbasic}
@@ -43,7 +81,7 @@
\RequirePackage{xcolor}%
[2022/06/12]
-\RequirePackage{hyperref}%
+\RequirePackage{hyperref}% To load after titlesec!
[2023-02-07]
@@ -74,8 +112,6 @@
[2021-08-28]
-%\RequirePackage{minted2}% Old implementation.
-
\RequirePackage[highlightmode = immediate]%
{minted}%
[2024/09/22]
@@ -95,15 +131,68 @@
[2023-09-07]
+% =============== %
% == 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 -- %
+% --------------------- %
\ExplSyntaxOn
\msg_set:nnnn { tutodoc ~ (main) }
{ main : unsupported-lang }
- { unsupported ~ language ~ << ~ #1 ~ >>. }
+ {
+ unsupported ~ language ~ << ~ #1 ~ >>. %
+ ~ %
+ We ~ will ~ use ~ << ~ en ~ >>.
+ }
{ \msg_see_documentation_text:n { tutodoc } }
@@ -122,13 +211,15 @@
% If the lang is not supported, we emit a warning and just turn
% to the english language.
\makeatletter
- \InputIfFileExists{tutodoc-locale-main-\tdoclang.cfg.cls.sty}{}{
- \input{tutodoc-locale-main-en.cfg.cls.sty}
+ \InputIfFileExists{tutodoc-main-locale-\tdoclang.cfg.cls.sty}{}{
+ \input{tutodoc-main-locale-en.cfg.cls.sty}
+
\msg_critical:nnx { tutodoc ~ (main) }
- { main : unsupported-lang }
- { \tdoclang }
+ { main : unsupported-lang }
+ { \tdoclang }
}
+
\makeatother
}
@@ -135,25 +226,16 @@
\ExplSyntaxOff
+% ---------------------- %
% -- GENERAL SETTINGS -- %
+% ---------------------- %
\setlength{\parindent}{0cm}
-% -- LINKS -- %
-
-\newcommand{\tdoclinkcolor}{NavyBlue!85!white}
-
-\hypersetup{
- colorlinks,
- citecolor = \tdoclinkcolor,
- filecolor = \tdoclinkcolor,
- linkcolor = \tdoclinkcolor,
- urlcolor = \tdoclinkcolor
-}
-
-
+% --------------- %
% -- TOC & Co. -- %
+% --------------- %
\ifcsundef{chapter}%
{}%
@@ -195,48 +277,24 @@
\DeclareTOCStyleEntry[indentfollows = chapter]{tocline}{section}
-% -- COLOR TRANSFORMATIONS -- %
+% ------------------- %
+% -- LINKS AND CO. -- %
+% ------------------- %
-%%%
-% 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}
+\input{tutodoc-\tutodoc at theme-main.css.cls.sty}
-
-%%%
-% 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%
+\hypersetup{
+ colorlinks,
+ citecolor = tutodoc at link@color,
+ filecolor = tutodoc at link@color,
+ linkcolor = tutodoc at link@color,
+ urlcolor = tutodoc at link@color
}
+% ------------- %
% -- QUOTING -- %
+% ------------- %
%%%
% prototype::
@@ -250,7 +308,9 @@
}
+% ------------------------------ %
% -- EXPLAINING ENGLISH NAMES -- %
+% ------------------------------ %
%%%
% prototype::
@@ -273,16 +333,21 @@
% **"Something" et "Another thing" en anglais**.
%%%
\NewDocumentCommand{\tdocinEN}{s m}{%
- \tdocquote{#2}%
- \IfBooleanF{#1}{% No star used.
- \tutodoc at trans@in at EN{}%
+ \IfBooleanTF{#1}{% No star used.
+ \tdocquote{#2}%
+ }{% Star used.
+ \tutodoc at trans@in at EN{\tdocquote{#2}}%
}%
}
+% ----------------------------------- %
% -- SOBER HIGHLIGHTING OF CONTENT -- %
+% ----------------------------------- %
-% :: EXAMPLE - REMARK :: %
+% :::::::::::::::::::::: %
+% :: EXAMPLE & REMARK :: %
+% :::::::::::::::::::::: %
\ExplSyntaxOn
@@ -322,59 +387,60 @@
\ExplSyntaxOff
+% -------------------------------------- %
% -- COLORFUL HIGHLIGHTING OF CONTENT -- %
+% -------------------------------------- %
-% :: ABSTRACTION :: %
+\input{tutodoc-\tutodoc at theme-admonitions.css.cls.sty}
+
%%%
% note::
+% We provide two ways to define admonitions.
+%
+% 1) ''\__g_tutodoc_focus_color_prop'' and ''__g_tutodoc_focus_icon_prop''
+% are for iconised and colored frames.
+%
+% 1) ''\__g_tutodoc_focus_color_seq'' is to use a dedicated basic theorem
+% (this should be only useful for the draft theme).
+%
+% warning::
+% The variables should be defined inside the themes!
+%%%
+\ifcsundef{__g_tutodoc_focus_color_seq}{
+%%%
+% note::
% The settings used come from the following sources.
% * https://tex.stackexchange.com/a/727022/6880
% * https://tex.stackexchange.com/a/682332/6880
% * https://tex.stackexchange.com/a/623232/6880
%%%
-\tcbset{
- tutodoc-focus-color-style/.style = {
- use color stack, % Must be before breakable!
- breakable,
- enhanced,
- left = 3pt,
- right = 3pt,
- fontupper = \color{\tdocdarkcolor{#1}},
- colback = \tdoclightcolor{#1},
- colframe = #1!75!black!45,
- shadow = {.75mm}{-.75mm}{0mm}{black!30},
+ \tcbset{
+ tutodoc-focus-color-style/.style = {
+% General.
+ use color stack, % Must be before breakable!
+ breakable,
+ enhanced,
+% Colors.
+ coltitle = \tutodoc at build@title at color{#1},
+ colupper = \tutodoc at build@upper at color{#1},
+ colback = \tutodoc at build@back at color{#1},
+ colframe = \tutodoc at build@frame at color{#1},
% We want to use the same color for the footnotes in the frame.
- before upper = {\let\default at color\current at color},
- }
-}
+ before upper = {\let\default at color\current at color},
+% Padding.
+ left = 3pt,
+ right = 3pt,
+% Frame.
+ shadow = {.75mm}{-.75mm}{0mm}{tutodoc at admonition@shadow at color},
+ }
+ }
+}{}
-
-% :: LET'S GO BACK TO THE REAL WORLD :: %
-
\ExplSyntaxOn
+\ifcsundef{__g_tutodoc_focus_color_seq}{
%%%
-% We use two ''prop'' variables to factorize the code just after.
-%%%
-\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,
-}
-
-
-%%%
% prototype::
% :action: ''key/value'' iteration over ''\__g_tutodoc_focus_color_prop''
% to build new colorful unumbered theorems. To achieve that,
@@ -382,22 +448,45 @@
% macro from the ''keytheorems'' \pack, and icons from the
% ''fontawesome5'' \pack.
%%%
-\prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
- \newkeytheorem{tdoc#1}[
- numbered = false,
-% tcolorbox-no-titlebar can be used.
- tcolorbox = {tutodoc-focus-color-style=#2},
- name = {
- \tdocicon{ \prop_item:Nn \__g_tutodoc_focus_icon_prop { #1 } }
- \use:c { tutodoc at trans@#1 at title }
- },
- ]
+ \prop_map_inline:Nn \__g_tutodoc_focus_color_prop {
+ \newkeytheorem{tdoc#1}[
+ numbered = false,
+% tcolorbox-no-titlebar can be used.
+ tcolorbox = {tutodoc-focus-color-style=#2},
+ name = {
+ \tdocicon{ \prop_item:Nn \__g_tutodoc_focus_icon_prop { #1 } }
+ \use:c { tutodoc at trans@#1 at title }
+ },
+ ]
+ }
+} {
+%%%
+% prototype::
+% :action: looping over ''\__g_tutodoc_focus_color_seq'' to build new
+% numbered theorems sharing the same section level counter.
+% To achieve that, we use the ''\newkeytheorem'' macro from
+% the ''keytheorems'' \pack.
+%%%
+ \seq_map_inline:Nn \__g_tutodoc_focus_color_seq {
+ \newkeytheorem{tdoc#1}[
+ name = \use:c { tutodoc at trans@#1 at title },
+ numberlike = tdocexa,
+% We could have used
+% \AddToHook{env/tdoc#1/before}{\small}
+% and
+% \AddToHook{env/tdoc#1/after}{\normalsize}.
+ preheadhook = \small,
+ postfoothook = \normalsize
+ ]
+ }
}
\ExplSyntaxOff
+% ---------------------------------------------- %
% -- NAMES OF PACKAGES, MACROS & ENVIRONMENTS -- %
+% ---------------------------------------------- %
%%%
% prototype::
@@ -471,11 +560,15 @@
}
+% ------------------------- %
% -- EXPLAINING PREFIXES -- %
+% ------------------------- %
\ExplSyntaxOn
+% :::::::::::::: %
% :: MESSAGES :: %
+% :::::::::::::: %
\msg_set:nnnn { tutodoc ~ (macroenv) }
{ macroenv : prefix-why-bad-format }
@@ -483,7 +576,9 @@
{ You ~ must ~ use ~ one ~ single ~ point. }
+% :::::::::::::::::::: %
% :: PREFIX FROM... :: %
+% :::::::::::::::::::: %
%%%
% prototype::
@@ -515,7 +610,9 @@
\ExplSyntaxOff
+% ::::::::::::::::::::: %
% :: JUST ONE PREFIX :: %
+% ::::::::::::::::::::: %
%%%
% prototype::
@@ -533,9 +630,16 @@
}
+% ------------------------ %
% -- GENERAL FORMATTING -- %
+% ------------------------ %
+\input{tutodoc-\tutodoc at theme-showcase.css.cls.sty}
+
+
+% :::::::::::::::::::::::: %
% :: TEXT INSIDE A RULE :: %
+% :::::::::::::::::::::::: %
\ExplSyntaxOn
@@ -554,7 +658,8 @@
% cf::''this post ;
% https://tex.stackexchange.com/a/604708/6880''.
%%%
-\NewDocumentCommand{\tdocruler}{O{black} m}{
+
+\NewDocumentCommand{\tdocruler}{O{\tutodoc at showcase@rule at color} m}{
\par
{
\centering
@@ -580,7 +685,9 @@
\ExplSyntaxOff
+% ::::::::::::::::::::::::::: %
% :: INTERNAL ENVIRONMENTS :: %
+% ::::::::::::::::::::::::::: %
%%%
% prototype::
@@ -592,17 +699,21 @@
% one color following the ''xcolor'' format.
% This color is used to set the one for the decorated texts printed
% corresponding to the two first arguments.
+% #4 : (text color)
+% XXXXX
+% #5 : (rule color builder)
+% YYY
%
% :action: this environment just adds its content processed by \latex
% between centered materials produced by the macro ''\tdocruler''
% such as to stress the start and the end of the content.
%%%
-\NewDocumentEnvironment{tutodoc at showcase@basic}{m m m}{
- \tdocruler[\tdocdarkcolor{#3}]{#1}
- \nopagebreak\medskip\nopagebreak
+\NewDocumentEnvironment{tutodoc at showcase@basic}{m m m m m}{
+ \tdocruler[#5{#3}]{#1}%
+ \nopagebreak\medskip\nopagebreak\color{#4}%
}{
\nopagebreak\medskip\nopagebreak
- \tdocruler[\tdocdarkcolor{#3}]{#2}
+ \tdocruler[#5{#3}]{#2}
}
@@ -612,8 +723,14 @@
% :see: env.tutodoc at showcase@basic
% #2 : (down-text)
% :see: env.tutodoc at showcase@basic
-% #3 : (color)
+% #3 : (stripe color)
% :see: env.tutodoc at showcase@basic
+% #4 : (text color)
+% :see: env.tutodoc at showcase@basic
+% #5 : (rule color builder)
+% :see: env.tutodoc at showcase@basic
+% #6 : (back color builder)
+% :see: env.tutodoc at showcase@basic
%
% :action: this environment adds a page-width colored stripe in the
% background of the environment content processed by \latex.
@@ -622,9 +739,9 @@
% start and the end of the content.
%%%
-\NewDocumentEnvironment{tutodoc at showcase@colorstrip}{m m m}{
- \begin{colorstrip}{\tdoclightcolor{#3}}
- \begin{tutodoc at showcase@basic}{#1}{#2}{#3}
+\NewDocumentEnvironment{tutodoc at showcase@colorstrip}{m m m m m m}{
+ \begin{colorstrip}{#6{#3}}
+ \begin{tutodoc at showcase@basic}{#1}{#2}{#3}{#4}{#5}
}{
\end{tutodoc at showcase@basic}
\end{colorstrip}
@@ -633,11 +750,14 @@
\ExplSyntaxOn
+% ::::::::::::::::::::::: %
% :: SETTING SOME KEYS :: %
+% ::::::::::::::::::::::: %
\tl_new:N \l_tutodoc_showcase_before_tl
\tl_new:N \l_tutodoc_showcase_after_tl
-\tl_new:N \l_tutodoc_showcase_color_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
@@ -651,15 +771,20 @@
before .initial:n = \tutodoc at trans@latex at show@start,
after .tl_set:N = \l_tutodoc_showcase_after_tl,
after .initial:n = \tutodoc at trans@latex at show@end,
-% Decorations.
- color .tl_set:N = \l_tutodoc_showcase_color_tl,
- color .initial:n = cyan,
+% Colors.
+ colstripe .tl_set:N = \l_tutodoc_showcase_stripe_color_tl,
+ colstripe .initial:n = \tutodoc at showcase@stripe at color,
+ coltext .tl_set:N = \l_tutodoc_showcase_text_color_tl,
+ coltext .initial:n = \tutodoc at showcase@text at color,
+% Stripe?
nostripe .bool_set:N = \l_tutodoc_showcase_nostripe_bool,
nostripe .initial:n = false,
}
+% :::::::::::::::::::::::::::::: %
% :: SHOWCASE FROM TYPED CODE :: %
+% :::::::::::::::::::::::::::::: %
% prototype::
% #1 : (key-val)
@@ -680,15 +805,20 @@
\keys_set:nn { tutodoc / showcase } { #1 }
\bool_if:NTF \l_tutodoc_showcase_nostripe_bool {
- \begin{tutodoc at showcase@basic}%
- { \tl_use:N \l_tutodoc_showcase_before_tl }%
- { \tl_use:N \l_tutodoc_showcase_after_tl }%
- { \tl_use:N \l_tutodoc_showcase_color_tl }
+ \begin{tutodoc at showcase@basic}
+ { \tl_use:N \l_tutodoc_showcase_before_tl }
+ { \tl_use:N \l_tutodoc_showcase_after_tl }
+ { \tl_use:N \l_tutodoc_showcase_stripe_color_tl }
+ { \tl_use:N \l_tutodoc_showcase_text_color_tl }
+ { \tutodoc at showcase@build at rule@color }
}{
- \begin{tutodoc at showcase@colorstrip}%
- { \tl_use:N \l_tutodoc_showcase_before_tl }%
- { \tl_use:N \l_tutodoc_showcase_after_tl }%
- { \tl_use:N \l_tutodoc_showcase_color_tl }
+ \begin{tutodoc at showcase@colorstrip}
+ { \tl_use:N \l_tutodoc_showcase_before_tl }
+ { \tl_use:N \l_tutodoc_showcase_after_tl }
+ { \tl_use:N \l_tutodoc_showcase_stripe_color_tl }
+ { \tl_use:N \l_tutodoc_showcase_text_color_tl }
+ { \tutodoc at showcase@build at rule@color }
+ { \tutodoc at showcase@build at back@color }
}
}{
\bool_if:NTF \l_tutodoc_showcase_nostripe_bool {
@@ -700,7 +830,9 @@
}
+% :::::::::::::::::::::::: %
% :: SHOWCASE FROM FILE :: %
+% :::::::::::::::::::::::: %
%%%
% prototype::
@@ -724,18 +856,36 @@
\ExplSyntaxOff
+% -------------------- %
% -- LATEX EXAMPLES -- %
+% -------------------- %
-% :: INLINE SHORT LATEX CODE :: %
+% :::::::::::::::::::::::::::::::::::::::::::::: %
+% :: STYLES OF THE LISTING ENV. AND THE MACRO :: %
+% :::::::::::::::::::::::::::::::::::::::::::::: %
+\newcommand{\tutodoc at latex@lexer}{latex}
+
+\input{tutodoc-\tutodoc at theme-listing.css.cls.sty}
+
+
+% :::::::::::::::::::::::: %
+% :: INLINE LATEX MACRO :: %
+% :::::::::::::::::::::::: %
+
%%%
% See the \doc of the macro ''\newmintinline'' from the package ''minted''
% to have \infos about the macro ''tdocinlatex''.
%%%
-\newmintinline[tdocinlatex]{latex}{bgcolor = yellow!4}
+\newmintinline[tdocinlatex]{\tutodoc at latex@lexer}{%
+ bgcolor = tutodoc at latex@back at color,%
+ style/.expand once = \tutodoc at latex@style% <-- This needs minted3!
+}
-% :: SHORTCUTS FOR TCOLORBOX LISTING FORMATING :: %
+% ::::::::::::::::::::::::::::::::::: %
+% :: TCOLORBOX LISTING ENVIRONMENT :: %
+% ::::::::::::::::::::::::::::::::::: %
\ExplSyntaxOn
@@ -753,7 +903,7 @@
%
% term::
% Package pgfkeys Error: I do not know the key '/tcb/tdoclatex bad option
-% "NOT-A-STYLE"' and I am going to ignore it. Perhaps you misspelled it.
+% "MISTYPED-STYLE"' and I am going to ignore it. Perhaps you misspelled it.
%
% See the pgfkeys package documentation for explanation.
%%%
@@ -767,32 +917,43 @@
\ExplSyntaxOff
-
-% :: THE TCOLORBOX LISTING STYLE :: %
-
-% Source.
-% * https://tex.stackexchange.com/a/604821/6880
-% * https://tex.stackexchange.com/a/327983/6880
+%%
+% source::
+% + https://tex.stackexchange.com/a/604821/6880
+% + https://tex.stackexchange.com/a/327983/6880
+%%
\tcbset{
tutodoc-latex-listing-style/.style = {
- minted language = latex,
+% General.
+ minted language/.expand once = \tutodoc at latex@lexer,
+ minted style/.expand once = \tutodoc at latex@style,
breakable,
enhanced,
-% Code and output
- colback = yellow!5,
-% Frame
- colframe = darkgray,
- shadow = {.75mm}{-.75mm}{0mm}{black!30},
- arc = .75mm,
- left = 1mm, right = 1mm,
- bottom = 1mm, top = 1mm,
-% We can use ''sharp corners'' to obtain an "old school" style.
-%
-% Separating line
+% Colors.
+ colframe = tutodoc at latex@frame at color,
+ colback = tutodoc at latex@back at color,
+ colupper = tutodoc at latex@text at color,
+ collower = tutodoc at latex@text at color,
+% Padding.
+ left = \tutodoc at latex@left,
+ right = \tutodoc at latex@right,
+ bottom = \tutodoc at latex@bottom,
+ top = \tutodoc at latex@top,
+% Frame.
+ shadow = {\tutodoc at latex@shadow at xshift}%
+ {\tutodoc at latex@shadow at yshift}%
+ {\tutodoc at latex@shadow at offset}%
+ {tutodoc at latex@shadow at color},
+ arc = \tutodoc at latex@arc,
+ leftrule = \tutodoc at latex@left at rule,
+ rightrule = \tutodoc at latex@right at rule,
+ bottomrule = \tutodoc at latex@bottom at rule,
+ toprule = \tutodoc at latex@top at rule,
+% Separating line.
segmentation style = {
- gray,
+ tutodoc at latex@segment at color,
dash pattern = {on 5pt off 2.5pt},
- line width = 1.25pt
+ line width = .75pt
},
#1
},
@@ -799,8 +960,6 @@
}
-% :: TCOLORBOX LISTING ENVIRONMENT :: %
-
%%%
% prototype::
% #1 : (tdoclatex-style)
@@ -818,7 +977,9 @@
}
+% :::::::::::::::::::::::::::::::::::::: %
% :: TCOLORBOX IMPORTED LISTING MACRO :: %
+% :::::::::::::::::::::::::::::::::::::: %
%%%
% prototype::
@@ -837,11 +998,15 @@
}
+% -------------------------- %
% -- LATEX REAL USE CASES -- %
+% -------------------------- %
\ExplSyntaxOn
+% ::::::::::::::::::::: %
% :: SETTING THE KEY :: %
+% ::::::::::::::::::::: %
\tl_new:N \l_tutodoc_listing_explain_tl
@@ -858,7 +1023,9 @@
}
+% ::::::::::::::::::::: %
% :: LATEXSHOW MACRO :: %
+% ::::::::::::::::::::: %
%%%
% prototype::
@@ -894,7 +1061,9 @@
\ExplSyntaxOn
+% :::::::::::::: %
% :: MESSAGES :: %
+% :::::::::::::: %
\msg_set:nnnn { tutodoc ~ (version-n-change) }
{ version-n-change : date-bad-format }
@@ -902,7 +1071,9 @@
{ Use ~ YYYY-MM-DD. }
+% ::::::::::::::::: %
% :: MARGIN NOTE :: %
+% ::::::::::::::::: %
\reversemarginpar{}
@@ -988,8 +1159,12 @@
\ExplSyntaxOff
+% :::::::::::::::::::::: %
% :: VERSION AND DATE :: %
+% :::::::::::::::::::::: %
+\input{tutodoc-\tutodoc at theme-version-n-change.css.cls.sty}
+
%%%
% prototype::
% #1 : (color)
@@ -1008,7 +1183,7 @@
% to parse the date such as to display it following the standard convention
% of the language chosen when loading the package.
%%%
-\NewDocumentCommand{\tdocversion}{O{blue} m O{}}{
+\NewDocumentCommand{\tdocversion}{O{\tutodoc at changes@version at color} m O{}}{
\tutodoc at new@change at margin{#1} % Color
{#2} % Version
{#3} % Date
@@ -1016,7 +1191,9 @@
}
+% :::::::::: %
% :: DATE :: %
+% :::::::::: %
%%%
% prototype::
@@ -1028,7 +1205,7 @@
% :action: this macro is similar to ''\tdocversion'' except that it just
% prints a date.
%%%
-\NewDocumentCommand{\tdocdate}{O{blue} m}{
+\NewDocumentCommand{\tdocdate}{O{\tutodoc at changes@date at color} m}{
\tutodoc at new@change at margin{#1} % Color
{} % Version
{#2} % Date
@@ -1036,11 +1213,15 @@
}
+% --------------------- %
% -- CHANGES - WHAT? -- %
+% --------------------- %
\ExplSyntaxOn
+% :::::::::::::: %
% :: MESSAGES :: %
+% :::::::::::::: %
\msg_set:nnnn { tutodoc ~ (version-n-change) }
{ version-n-change : topic-missing-title }
@@ -1048,7 +1229,9 @@
{ One ~ single ~ title ~ must ~ be ~ indicated. }
+% ::::::::::::::::::::: %
% :: CHANGES - TOPIC :: %
+% ::::::::::::::::::::: %
%%%
% prototype::
@@ -1066,11 +1249,11 @@
\msg_fatal:nn { tutodoc ~ (version-n-change) }
{ version-n-change : topic-missing-title }
}%
+% \paragraph{%
\textbf{%
\IfBlankF{#2}{\tdocicon{#2}}%
\textsc{#1.}
}
-
\begin{itemize}
}{
\end{itemize}
@@ -1077,7 +1260,9 @@
}
+% :::::::::::::::::::::::::: %
% :: CHANGES - NEW THINGS :: %
+% :::::::::::::::::::::::::: %
%%%
% We use a ''prop'' variable to factorize the code just after.
@@ -1088,7 +1273,8 @@
fix = \faWrench,
new = \faGem,
prob = \faFire*,
- update = \faMagic,
+ tech = \faFlask,
+ update = \reflectbox{\faHistory},
}
@@ -1123,7 +1309,9 @@
\ExplSyntaxOff
+% ----------------- %
% -- DECORATIONS -- %
+% ----------------- %
% Source
% * https://tex.stackexchange.com/a/705938/6880
More information about the tex-live-commits
mailing list.