diff options
author | Karl Berry <karl@freefriends.org> | 2024-08-24 20:24:27 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-08-24 20:24:27 +0000 |
commit | ec3eff781de9538fcf4ad2dafddacb4a59d359b7 (patch) | |
tree | 52a488aa3c3c536b20486ab3e6e04c8e29280158 /Master | |
parent | 35ac8d1f24e2cc9f20491a6a9443273f02dd23d5 (diff) |
tutodoc (24aug24)
git-svn-id: svn://tug.org/texlive/trunk@72100 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rw-r--r-- | Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf | bin | 709681 -> 713562 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex | 41 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf | bin | 746351 -> 748226 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex | 45 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty | 4 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty | 57 |
6 files changed, 96 insertions, 51 deletions
diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf Binary files differindex 6124b97c99a..84a98f1e35c 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex index f6449b959c7..371b905d97e 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex @@ -1,4 +1,4 @@ - + % -------------------- % % -- RESOURCES USED -- % % -------------------- % @@ -266,8 +266,8 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \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 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \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 @@ The \tdocenv{tdocwarn} environment is used to warn the user of a trap to avoid. \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 @@ To obtain renderings by importing the code from an external file, instead of typ \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 @@ Here are some examples. \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 @@ The \tdocmacro{tdoclatexinput} macro, shown below, expects the path of a file an % ------------------ % -\newpage \subsection{Imported codes put into practice} \label{tdoc-latexshow} \begin{tdocexa}[Showcase] @@ -1101,7 +1098,6 @@ during the latest changes. % ------------------ % -\newpage \begin{tdocexa}[For fixes] \leavevmode @@ -1115,7 +1111,7 @@ during the latest changes. \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 @@ Blo, blo, blo... 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 @@ Blu, blu, blu... First public version of the project. + \end{document} -
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf Binary files differindex a8691e1e8db..d0a970abec9 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex index ae9f99c300e..8291ce4b4a5 100644 --- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex +++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex @@ -266,8 +266,8 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \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 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble... \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 @@ Il est parfois utile d'obtenir directement le rendu d'un code dans la documentat \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 @@ Voici des exemples d'utilisation. \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 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas \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 @@ lors des derniers changements. \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 @@ Blo, blo, blo... 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 @@ Blu, blu, blu... Première version publique du projet. + \end{document} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty index c639e1e9e03..5c97cb2f180 100644 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty @@ -8,8 +8,8 @@ \NewDocumentCommand{\tutodoc@trans@note@title}{}{Note} \NewDocumentCommand{\tutodoc@trans@tip@title}{}{Astuce} \NewDocumentCommand{\tutodoc@trans@important@title}{}{Important} -\NewDocumentCommand{\tutodoc@trans@caution@title}{}{Caution} -\NewDocumentCommand{\tutodoc@trans@warn@title}{}{Danger} +\NewDocumentCommand{\tutodoc@trans@caution@title}{}{Mise ~ en ~ garde} +\NewDocumentCommand{\tutodoc@trans@warn@title}{}{Avertissement} \NewDocumentCommand{\tutodoc@trans@chges@pb}{}{Problème} \NewDocumentCommand{\tutodoc@trans@chges@break}{}{Bifurcation} \NewDocumentCommand{\tutodoc@trans@chges@fix}{}{Réparation} diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty index 5e0ea7a0fb4..a27e1a7ac6c 100644 --- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty +++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty @@ -21,31 +21,42 @@ 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] \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@trans@date{#1} - {#2} - {#3} + {#2} + {#3} } @@ -895,9 +910,9 @@ %%% \NewDocumentCommand{\tdocversion}{O{blue} m O{}}{ \tutodoc@new@change@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 :: % |