texlive[72100] Master/texmf-dist: tutodoc (24aug24)
commits+karl at tug.org
commits+karl at tug.org
Sat Aug 24 22:24:28 CEST 2024
Revision: 72100
https://tug.org/svn/texlive?view=revision&revision=72100
Author: karl
Date: 2024-08-24 22:24:27 +0200 (Sat, 24 Aug 2024)
Log Message:
-----------
tutodoc (24aug24)
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-locale-main-french.cfg.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.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-08-24 20:24:14 UTC (rev 72099)
+++ trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex 2024-08-24 20:24:27 UTC (rev 72100)
@@ -1,4 +1,4 @@
-
+
% -------------------- %
% -- RESOURCES USED -- %
% -------------------- %
@@ -266,8 +266,8 @@
\end{filecontents*}
-\begin{filecontents*}[overwrite]{examples-version-n-change-unclassifiable.tex}
-\begin{tdoctopic}{Unclassifiable}
+\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice.tex}
+\begin{tdoctopic}{It's my choice}
% This is where the point needs to be put.
\item Info 1...
\item Info 2...
@@ -343,9 +343,9 @@
\begin{document}
-\title{Le package \texttt{tutodoc} - Documentation de type tutoriel}
+\title{The \texttt{tutodoc} package - Tutorial-type documentation}
\author{Christophe BAL}
-\date{\ordinalnum{1} Jan. 2024 - Version 1.1.0}
+\date{23 Aug. 2024 - Version 1.2.0}
\maketitle
@@ -582,7 +582,6 @@
\tdoclatexinput[sbs]{examples-focus-warn.tex}
-\newpage
\section{Specify packages, classes, macros or environments}
Here's what you can type semantically.
@@ -794,7 +793,6 @@
\end{tdocexa}
-\newpage
\section{Use cases in \LaTeX}
Documenting a package or a class is done efficiently using use cases showing both the code and the corresponding result.
@@ -873,9 +871,9 @@
\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}
-
+
\smallskip
-
+
Another method is to use the \tdocmacro{string} primitive.
\tdocdocbasicinput{examples-listing-strange-bis.tex}
\end{tdocwarn}
@@ -943,7 +941,6 @@
% ------------------ %
-\newpage
\subsection{Imported codes put into practice} \label{tdoc-latexshow}
\begin{tdocexa}[Showcase]
@@ -1101,7 +1098,6 @@
% ------------------ %
-\newpage
\begin{tdocexa}[For fixes]
\leavevmode
@@ -1115,7 +1111,7 @@
\begin{tdocexa}[Chosen topics]
\leavevmode
- \tdoclatexinput[sbs]{examples-version-n-change-unclassifiable.tex}
+ \tdoclatexinput[sbs]{examples-version-n-change-user-choice.tex}
\end{tdocexa}
@@ -1151,9 +1147,26 @@
Blu, blu, blu...
\end{tdoclatex}
-\newpage
\section{History}
+\tdocversion{1.2.0}[2024-08-23]
+
+\begin{tdocupdate}
+ \item \tdocmacro{tdocversion}
+ \begin{enumerate}
+ \item The version number is above the date.
+
+ \item The spacing is better managed when the date is absent.
+ \end{enumerate}
+\end{tdocupdate}
+
+
+\begin{tdocfix}
+ \item Content highlighting: the French translations of \tdocinEN*{caution} and \tdocinEN*{danger} were incorrect.
+\end{tdocfix}
+
+\tdocsep
+
\tdocversion{1.1.0}[2024-01-06]
\begin{tdocnew}
@@ -1183,5 +1196,5 @@
First public version of the project.
+
\end{document}
-
\ No newline at end of file
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-08-24 20:24:14 UTC (rev 72099)
+++ trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex 2024-08-24 20:24:27 UTC (rev 72100)
@@ -266,8 +266,8 @@
\end{filecontents*}
-\begin{filecontents*}[overwrite]{examples-version-n-change-unclassifiable.tex}
-\begin{tdoctopic}{Inclassable}
+\begin{filecontents*}[overwrite]{examples-version-n-change-user-choice.tex}
+\begin{tdoctopic}{C'est mon choix}
% Ici le point s'impose.
\item Info 1...
\item Info 2...
@@ -341,7 +341,7 @@
\title{Le package \texttt{tutodoc} - Documentation de type tutoriel}
\author{Christophe BAL}
-\date{1\ier{} Janv. 2024 - Version 1.1.0}
+\date{23 Août 2024 - Version 1.2.0}
\maketitle
@@ -671,18 +671,18 @@
\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
+ Il peut être utile de montrer un rendu réel directement dans un document.
\footnote{
Typiquement lorsque l'on fait une démo.
- }.
+ }
Ceci se tape via \tdocenv{tdocshowcase} comme suit.
\tdoclatexinput[code]{examples-showcase-default.tex}
- On obtient alors le rendu suivant
+ On obtient alors le rendu suivant.
\footnote{
En coulisse, la bande est créée sans effort grâce au package \tdocpack{clrstrip}.
- }.
+ }
\medskip
@@ -889,9 +889,9 @@
\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}
-
+
\smallskip
-
+
Une autre méthode consiste à utiliser la primitive \tdocmacro{string}.
\tdocdocbasicinput{examples-listing-strange-bis.tex}
\end{tdocwarn}
@@ -1059,10 +1059,10 @@
\begin{tdocwarn}
- Seul l'emploi du format numérique \tdocinlatex+YYYY-MM-DD+ est vérifié
+ Seul l'emploi du format numérique \tdocinlatex+YYYY-MM-DD+ est vérifié,
\footnote{
Techniquement, vérifier la validité d'une date, via \LaTeX3, ne présente pas de difficulté.
- },
+ }
et ceci est un choix ! Pourquoi cela ? Tout simplement car dater et versionner des explications devrait se faire de façon semi-automatisée afin d'éviter tout bug humain.
% \footnote{
% L'auteur de \tdocpack{tutodoc} est entrain de mettre en place un ensemble d'outils permettant une telle semi-automatisation.
@@ -1132,11 +1132,10 @@
\begin{tdocexa}[Thématiques aux choix]
\leavevmode
- \tdoclatexinput[sbs]{examples-version-n-change-unclassifiable.tex}
+ \tdoclatexinput[sbs]{examples-version-n-change-user-choice.tex}
\end{tdocexa}
-\newpage
\section{Décorations}
Finissons cette documentation avec de petites outils de mise en forme pouvant rendre de grands services.
@@ -1169,9 +1168,26 @@
Blu, blu, blu...
\end{tdoclatex}
-\newpage
\section{Historique}
+\tdocversion{1.2.0}[2024-08-23]
+
+\begin{tdocupdate}
+ \item \tdocmacro{tdocversion}
+ \begin{enumerate}
+ \item Le numéro de version est au-dessus de la date.
+
+ \item L'espacement est mieux géré lorsque la date est absente.
+ \end{enumerate}
+\end{tdocupdate}
+
+
+\begin{tdocfix}
+ \item Mise en avant de contenus : les traductions françaises de \tdocinEN*{caution} et \tdocinEN*{danger} étaient erronées.
+\end{tdocfix}
+
+\tdocsep
+
\tdocversion{1.1.0}[2024-01-06]
\begin{tdocnew}
@@ -1201,4 +1217,5 @@
Première version publique du projet.
+
\end{document}
Modified: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty 2024-08-24 20:24:14 UTC (rev 72099)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty 2024-08-24 20:24:27 UTC (rev 72100)
@@ -8,8 +8,8 @@
\NewDocumentCommand{\tutodoc at trans@note at title}{}{Note}
\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Astuce}
\NewDocumentCommand{\tutodoc at trans@important at title}{}{Important}
-\NewDocumentCommand{\tutodoc at trans@caution at title}{}{Caution}
-\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Danger}
+\NewDocumentCommand{\tutodoc at trans@caution at title}{}{Mise ~ en ~ garde}
+\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Avertissement}
\NewDocumentCommand{\tutodoc at trans@chges at pb}{}{Problème}
\NewDocumentCommand{\tutodoc at trans@chges at break}{}{Bifurcation}
\NewDocumentCommand{\tutodoc at trans@chges at fix}{}{Réparation}
Modified: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty 2024-08-24 20:24:14 UTC (rev 72099)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty 2024-08-24 20:24:27 UTC (rev 72100)
@@ -21,24 +21,34 @@
marginparwidth = 2cm,
marginparsep = 2mm,
heightrounded
-]{geometry}[2020-01-02]
+]{geometry}%
+ [2020-01-02]
-\RequirePackage[raggedright]{titlesec}[2021/07/05]
+\RequirePackage[raggedright]%
+ {titlesec}%
+ [2021/07/05]
+
\RequirePackage{tocbasic}
-\RequirePackage{xcolor}[2022/06/12]
-\RequirePackage{hyperref}[2023-02-07]
+\RequirePackage{xcolor}%
+ [2022/06/12]
+\RequirePackage{hyperref}%
+ [2023-02-07]
+
% We delegate the management of quoting to the `csquotes' package,
% which takes care of the linguistic parameters.
-\RequirePackage{csquotes}[2022-09-14]
+\RequirePackage{csquotes}%
+ [2022-09-14]
-\RequirePackage{amsthm}[2017/09]
+\RequirePackage{amsthm}%
+ [2017/09]
-\RequirePackage{clrstrip}[2021-08-28]
+\RequirePackage{clrstrip}%
+ [2021-08-28]
\RequirePackage{tcolorbox}[2023/06/19]
@@ -45,7 +55,8 @@
\tcbuselibrary{minted, breakable, skins}
-\RequirePackage{marginnote}[2023-09-07]
+\RequirePackage{marginnote}%
+ [2023-09-07]
% -- LOCALE LANG -- %
@@ -808,8 +819,8 @@
%%%
% prototype::
% #1 : the color of the margin note
-% #2 : the first material (a date or nothing)
-% #3 : the second material (a version number or nothing)
+% #2 : the first material (a version number or nothing)
+% #3 : the second material (a date or nothing)
% #4 : the last negative vertical spacing for the 2nd rule
%
% :action: this macro factorizes the printing of the changes
@@ -829,15 +840,19 @@
\IfBlankTF{#2}{}{
\par
- \__tdoc_translate_date:n { #2 }
+ #2
\par
}
- \vspace{1pt}
+ \IfBlankTF{#3}{}{
+ \IfBlankTF{#2}{}{
+ \vspace{1pt}
+ }
- \par
- #3
- \par
+ \par
+ \__tdoc_translate_date:n { #3 }
+ \par
+ }
\vspace{#4}
\rule{1.65cm}{.95pt}
@@ -871,8 +886,8 @@
%%%
\cs_new:Npn \__tdoc_translate_date_process:w #1 - #2 - #3 \q_stop {
\tutodoc at trans@date{#1}
- {#2}
- {#3}
+ {#2}
+ {#3}
}
@@ -895,9 +910,9 @@
%%%
\NewDocumentCommand{\tdocversion}{O{blue} m O{}}{
\tutodoc at new@change at margin{#1} % Color
- {#3} % Date
- {#2} % Version
- {-4.25pt} % Last negative vertical spacing
+ {#2} % Version
+ {#3} % Date
+ {-4.25pt} % Last negative vertical spacing
}
@@ -919,7 +934,7 @@
}
-% -- CHANGES - WHAT?
+% -- CHANGES - WHAT? -- %
% :: MESSAGES :: %
More information about the tex-live-commits
mailing list.