texlive[69338] Master/texmf-dist: tutodoc (6jan24)
commits+karl at tug.org
commits+karl at tug.org
Sun Jan 7 22:27:45 CET 2024
Revision: 69338
https://tug.org/svn/texlive?view=revision&revision=69338
Author: karl
Date: 2024-01-07 22:27:45 +0100 (Sun, 07 Jan 2024)
Log Message:
-----------
tutodoc (6jan24)
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.sty
Added Paths:
-----------
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-english.cfg.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty
Removed Paths:
-------------
trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-english.cfg.sty
trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-french.cfg.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-01-07 21:27:30 UTC (rev 69337)
+++ trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex 2024-01-07 21:27:45 UTC (rev 69338)
@@ -1,4 +1,4 @@
-
+
% -------------------- %
% -- RESOURCES USED -- %
% -------------------- %
@@ -5,23 +5,23 @@
\begin{filecontents*}[overwrite]{examples-focus-exa.tex}
- Bla, bla, bla...
+Bla, bla, bla...
- \begin{tdocexa}
- Ble, ble, ble...
- \end{tdocexa}
+\begin{tdocexa}
+ Ble, ble, ble...
+\end{tdocexa}
- \begin{tdocexa}[Wonderful]
- Bli, bli, bli...
- \end{tdocexa}
+\begin{tdocexa}[Wonderful]
+ Bli, bli, bli...
+\end{tdocexa}
- \begin{tdocexa}<nonb>
- Blo, blo, blo...
- \end{tdocexa}
+\begin{tdocexa}<nonb>
+ Blo, blo, blo...
+\end{tdocexa}
- \begin{tdocexa}<nonb>[Superb]
- Blu, blu, blu...
- \end{tdocexa}
+\begin{tdocexa}<nonb>[Superb]
+ Blu, blu, blu...
+\end{tdocexa}
\end{filecontents*}
@@ -119,7 +119,7 @@
\begin{tdocshowcase}[before = My beginning,
after = My end,
color = red]
-Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
+ Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
@@ -143,9 +143,8 @@
before = My beginning,
after = My end,
color = green]
-Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
+ Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
-
\end{filecontents*}
@@ -168,6 +167,13 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-listing-strange-bis.tex}
+\begin{tdoclatex}
+ \string[Strange... Or not!]
+\end{tdoclatex}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-listing-xyz.tex}
% Just one demo.
$x y z = 1$
@@ -236,6 +242,22 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-version-n-change-break.tex}
+\begin{tdocbreak}
+ \item Info 1...
+ \item Info 2...
+\end{tdocbreak}
+\end{filecontents*}
+
+
+\begin{filecontents*}[overwrite]{examples-version-n-change-pb.tex}
+\begin{tdocprob}
+ \item Info 1...
+ \item Info 2...
+\end{tdocprob}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-version-n-change-fix.tex}
\begin{tdocfix}
\item Info 1...
@@ -244,8 +266,8 @@
\end{filecontents*}
-\begin{filecontents*}[overwrite]{examples-version-n-change-topic.tex}
-\begin{tdoctopic}{Unclassifiable changes}
+\begin{filecontents*}[overwrite]{examples-version-n-change-unclassifiable.tex}
+\begin{tdoctopic}{Unclassifiable}
% This is where the point needs to be put.
\item Info 1...
\item Info 2...
@@ -265,7 +287,6 @@
\usepackage[english]{babel, varioref}
\usepackage{enumitem}
-%\frenchsetup{StandardItemLabels=true}
\usepackage{tabularray}
\usepackage{fmtcount}
@@ -324,12 +345,11 @@
\title{Le package \texttt{tutodoc} - Documentation de type tutoriel}
\author{Christophe BAL}
-\date{8th Dec. 2023 - Version 1.0.1}
+\date{\ordinalnum{1} Jan. 2024 - Version 1.1.0}
\maketitle
\begin{abstract}
-\noindent
The \tdocpack{tutodoc} package
\footnote{
The name comes from \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}}.
@@ -340,15 +360,10 @@
},
and with a sober rendering for reading on screen.
-\medskip
-\noindent
-Two important points to note.
-\begin{itemize}
- \item This package imposes a formatting style. In the not-too-distant future, \tdocpack{tutodoc} will probably be split into a class and a package.
-
- \item This documentation is also available in French.
-\end{itemize}
+\begin{tdocnote}
+ This package imposes a formatting style. In the not-too-distant future, \tdocpack{tutodoc} will probably be split into a class and a package.
+\end{tdocnote}
\end{abstract}
@@ -374,6 +389,7 @@
]{geometry}
\end{tdoclatex}
+
\subsection{Title and table of contents}
The \tdocpack{titlesec} and \tdocpack{tocbasic} packages are set as follows.
@@ -495,9 +511,9 @@
Numbered or unnumbered examples can be indicated using the \tdocenv{tdocexa} environment, which offers two optional arguments.
\begin{enumerate}
- \item The \ordinalnum{1} argument between brackets \verb#<...># can take the values \verb#nb# to number, which is the default setting, and \verb#nonb# to not number.
+ \item The \ordinalnum{1} argument between brackets \tdocinlatex#<...># can take the values \tdocinlatex#nb# to number, which is the default setting, and \tdocinlatex#nonb# to not number.
- \item The \ordinalnum{2} argument in square brackets \verb#[...]# is used to add a mini-title..
+ \item The \ordinalnum{2} argument in square brackets \tdocinlatex#[...]# is used to add a mini-title..
\end{enumerate}
@@ -545,7 +561,6 @@
\tdoclatexinput[sbs]{examples-focus-note.tex}
-
\subsection{Something important}
The \tdocenv{tdocimportant} environment is used to indicate something important but harmless.
@@ -552,6 +567,7 @@
\tdoclatexinput[sbs]{examples-focus-important.tex}
+
\subsection{Caution about a delicate point}
The \tdocenv{tdoccaution} environment is used to indicate a delicate point to the user. Here's how to use it.
@@ -566,6 +582,7 @@
\tdoclatexinput[sbs]{examples-focus-warn.tex}
+\newpage
\section{Specify packages, classes, macros or environments}
Here's what you can type semantically.
@@ -698,7 +715,7 @@
\begin{tdocwarn}
- With the default settings, if the code to be formatted begins with an opening bracket, use \tdocmacro{string} as in the following example. the following example.
+ With the default settings, if the code to be formatted begins with an opening bracket, use \tdocmacro{string} as in the following example.
\tdoclatexinput[code]{examples-showcase-hook.tex}
@@ -769,7 +786,7 @@
\medskip
- As for \tdocinlatex+\tdocshowcaseinput[color = orange]{external.tex}+ , this will produce the colour change shown below.
+ As for \tdocinlatex+\tdocshowcaseinput[color = orange]{external.tex}+\,, this will produce the colour change shown below.
\medskip
@@ -777,6 +794,7 @@
\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.
@@ -789,7 +807,7 @@
The \tdocmacro{tdocinlatex} macro
\footnote{
- The name of the macro \tdocmacro{tdocinlatex} comes from \tdocquote{tdocprewhy{in.line} \LaTeX}.
+ The name of the macro \tdocmacro{tdocinlatex} comes from \tdocquote{\tdocprewhy{in.line} \LaTeX}.
}
can be used to type inline code in a similar way to \tdocmacro{verb}.
Here are some examples.
@@ -803,10 +821,11 @@
\begin{tdocnote}
- The \tdocmacro{tdocinlatex} macro can be used in a footnote: see the bottom of this page
+ The \tdocmacro{tdocinlatex} macro can be used in a footnote: see below.
\footnote{
- \tdocinlatex+$minted = TOP$+ was typed \tdocinlatex|\tdocinlatex+$minted = TOP$+| in this footnote.
+ \tdocinlatex+$minted = TOP$+ has been typed \tdocinlatex|\tdocinlatex+$minted = TOP$+| in this footnote...
}.
+ In addition, a background color is deliberately used to subtly highlight the codes \tdocinlatex#\LaTeX#\,.
\end{tdocnote}
@@ -854,6 +873,11 @@
\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}
@@ -865,7 +889,7 @@
\medskip
-The \tdocmacro{tdoclatexinput} macro, shown below, is used in the same way as the \tdocenv{tdoclatex} environment except that the path to a file is supplied.
+The \tdocmacro{tdoclatexinput} macro, shown below, expects the path of a file and offers the same options as the \tdocenv{tdoclatex} environment.
% ------------------ %
@@ -919,10 +943,11 @@
% ------------------ %
+\newpage
\subsection{Imported codes put into practice} \label{tdoc-latexshow}
\begin{tdocexa}[Showcase]
- The following can be obtained via \tdocinlatex+\tdoclatexshow{examples-listing-xyz.tex}+.
+ The following comes from \tdocinlatex+\tdoclatexshow{examples-listing-xyz.tex}+.
\medskip
@@ -943,8 +968,7 @@
\begin{tdocexa}[Changing the explanatory text]
Using the key \tdocinlatex|explain|, you can use custom text. Thus, \tdocinlatex|tdoclatexshow[explain = Here is the actual rendering.]{examples-listing-xyz.tex}| will produce the following.
- \newpage
-% \medskip
+ \medskip
\begin{tdoc-doc-showcase}
\tdoclatexshow[explain = Here is the actual rendering.]{examples-listing-xyz.tex}
@@ -1057,6 +1081,27 @@
% ------------------ %
+\begin{tdocexa}[For breaks]
+ \leavevmode
+
+ \tdoclatexinput[sbs]{examples-version-n-change-break.tex}
+\end{tdocexa}
+
+
+% ------------------ %
+
+
+\begin{tdocexa}[For problems]
+ \leavevmode
+
+ \tdoclatexinput[sbs]{examples-version-n-change-pb.tex}
+\end{tdocexa}
+
+
+% ------------------ %
+
+
+\newpage
\begin{tdocexa}[For fixes]
\leavevmode
@@ -1070,9 +1115,10 @@
\begin{tdocexa}[Chosen topics]
\leavevmode
- \tdoclatexinput[sbs]{examples-version-n-change-topic.tex}
+ \tdoclatexinput[sbs]{examples-version-n-change-unclassifiable.tex}
\end{tdocexa}
+
\section{Ornaments}
Let's finish this documentation with a few small formatting tools that can be very useful.
@@ -1083,6 +1129,16 @@
\tdocsep % Practical for demarcation.
+This works with enumerations.
+
+\begin{itemize}
+ \item Underline.
+
+ \item Something else useful.
+\end{itemize}
+
+\tdocsep % Uniform behaviour.
+
Ble, ble, ble...
Bli, bli, bli...
@@ -1095,18 +1151,31 @@
Blu, blu, blu...
\end{tdoclatex}
+\newpage
+\section{History}
+\tdocversion{1.1.0}[2024-01-06]
+\begin{tdocnew}
+ \item Change log : two new environments.
+ \begin{enumerate}
+ \item \tdocenv{tdocbreak} for breaking changes which are not backward compatible.
-\newpage
-\section{History}
+ \item \tdocenv{tdocprob} for identified problems.
+ \end{enumerate}
+ \item \tdocmacro{tdocinlatex}: a light yellow is used as the background color.
+\end{tdocnew}
+
+\tdocsep
+
\tdocversion{1.0.1}[2023-12-08]
\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]}]{showcase}: page breaks around the rulers are no longer possible.\end{tdocfix}
+ \item \tdocenv[{[nostripe]}]{tdocshowcase}: page breaks around \tdocquote{framing} lines should be rare from now on.
+\end{tdocfix}
\tdocsep
@@ -1115,3 +1184,4 @@
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-01-07 21:27:30 UTC (rev 69337)
+++ trunk/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex 2024-01-07 21:27:45 UTC (rev 69338)
@@ -167,6 +167,13 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-listing-strange-bis.tex}
+\begin{tdoclatex}
+ \string[Étrange... Ou pas !]
+\end{tdoclatex}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-listing-xyz.tex}
% Juste une démo.
$x y z = 1$
@@ -235,6 +242,22 @@
\end{filecontents*}
+\begin{filecontents*}[overwrite]{examples-version-n-change-break.tex}
+\begin{tdocbreak}
+ \item Info 1...
+ \item Info 2...
+\end{tdocbreak}
+\end{filecontents*}
+
+
+\begin{filecontents*}[overwrite]{examples-version-n-change-pb.tex}
+\begin{tdocprob}
+ \item Info 1...
+ \item Info 2...
+\end{tdocprob}
+\end{filecontents*}
+
+
\begin{filecontents*}[overwrite]{examples-version-n-change-fix.tex}
\begin{tdocfix}
\item Info 1...
@@ -243,8 +266,8 @@
\end{filecontents*}
-\begin{filecontents*}[overwrite]{examples-version-n-change-topic.tex}
-\begin{tdoctopic}{Des changements inclassables}
+\begin{filecontents*}[overwrite]{examples-version-n-change-unclassifiable.tex}
+\begin{tdoctopic}{Inclassable}
% Ici le point s'impose.
\item Info 1...
\item Info 2...
@@ -269,7 +292,6 @@
% Package documented.
\usepackage[lang = french]{tutodoc}
-\setlength{\parindent}{0em}
% Source.
% * https://tex.stackexchange.com/a/604698/6880
@@ -319,12 +341,11 @@
\title{Le package \texttt{tutodoc} - Documentation de type tutoriel}
\author{Christophe BAL}
-\date{8 Déc. 2023 - Version 1.0.1}
+\date{1\ier{} Janv. 2024 - Version 1.1.0}
\maketitle
\begin{abstract}
-\noindent
Le package \tdocpack{tutodoc}
\footnote{
Le nom vient de \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}} se traduit en \tdocquote{documentation de type tutoriel}.
@@ -335,24 +356,15 @@
},
et avec un rendu sobre pour une lecture sur écran.
-\medskip
-\noindent
-Deux points importants à noter.
-\begin{itemize}
- \item Ce package impose un style de mise en forme. Dans un avenir plus ou moins proche, \tdocpack{tutodoc} sera sûrement éclaté en une classe et un package.
+\begin{tdocnote}
+ Ce package impose un style de mise en forme.
+ Dans un avenir plus ou moins proche, \tdocpack{tutodoc} sera sûrement éclaté en une classe et un package.
+\end{tdocnote}
- \item Cette documentation est aussi disponible en anglais.
-\end{itemize}
-
-
-% ------------------ %
-
-
\tdocsep
-{\noindent
-\small\itshape
+{\small\itshape
\textbf{Abstract.}
The \tdocpack{tutodoc} package
\footnote{
@@ -364,15 +376,10 @@
},
and with a sober rendering for reading on screen.
-\medskip
-\noindent
-Two important points to note.
-\begin{itemize}
- \item This package imposes a formatting style. In the not-too-distant future, \tdocpack{tutodoc} will probably be split into a class and a package.
-
- \item This documentation is also available in French.
-\end{itemize}
+\begin{tdocnote}
+ This package imposes a formatting style. In the not-too-distant future, \tdocpack{tutodoc} will probably be split into a class and a package.
+\end{tdocnote}
}
\end{abstract}
@@ -521,9 +528,9 @@
Des exemples numérotés, ou non, s'indiquent via l'environnement \tdocenv{tdocexa} qui propose deux arguments optionnels.
\begin{enumerate}
- \item Le 1\ier{} argument entre chevrons \verb#<...># peut prendre au choix les valeurs \verb#nb# pour numéroter, réglage par défaut, et \verb#nonb# pour ne pas numéroter.
+ \item Le 1\ier{} argument entre chevrons \tdocinlatex#<...># peut prendre au choix les valeurs \tdocinlatex#nb# pour numéroter, réglage par défaut, et \tdocinlatex#nonb# pour ne pas numéroter.
- \item Le 2\ieme{} argument entre crochets \verb#[...]# sert à ajouter un mini-titre.
+ \item Le 2\ieme{} argument entre crochets \tdocinlatex#[...]# sert à ajouter un mini-titre.
\end{enumerate}
@@ -795,7 +802,7 @@
\medskip
- Quant à \tdocinlatex+\tdocshowcaseinput[color = orange]{external.tex}+ , ceci produira le changement de couleur observable ci-après.
+ Quant à \tdocinlatex+\tdocshowcaseinput[color = orange]{external.tex}+\,, ceci produira le changement de couleur observable ci-après.
\medskip
@@ -829,10 +836,11 @@
\begin{tdocnote}
- La macro \tdocmacro{tdocinlatex} est utilisable dans une note de pied de page : voir le bas de cette page
+ La macro \tdocmacro{tdocinlatex} est utilisable dans une note de pied de page : voir plus bas
\footnote{
\tdocinlatex+$minted = TOP$+ a été tapé \tdocinlatex|\tdocinlatex+$minted = TOP$+| dans cette note de bas de page..
}.
+ De plus, une couleur de fond est volontairement utilisée pour subtilement faire ressortir les codes \tdocinlatex#\LaTeX#\,.
\end{tdocnote}
@@ -881,6 +889,11 @@
\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}
@@ -892,13 +905,12 @@
\medskip
-La macro \tdocmacro{tdoclatexinput} , présentée ci-après, s'utilise comme l'environnement \tdocenv{tdoclatex} excepté que l'on fournit le chemin d'un fichier.
+La macro \tdocmacro{tdoclatexinput}, présentée ci-dessous, attend le chemin d'un fichier et propose les mêmes options que l'environnement \tdocenv{tdoclatex}.
% ------------------ %
-\newpage
\begin{tdocexa}[Face à face]
\leavevmode
@@ -1067,7 +1079,6 @@
lors des derniers changements.
-\newpage
\begin{tdocexa}[Pour les nouveautés]
\leavevmode
@@ -1088,6 +1099,26 @@
% ------------------ %
+\begin{tdocexa}[Pour les bifurcations]
+ \leavevmode
+
+ \tdoclatexinput[sbs]{examples-version-n-change-break.tex}
+\end{tdocexa}
+
+
+% ------------------ %
+
+
+\begin{tdocexa}[Pour les problèmes]
+ \leavevmode
+
+ \tdoclatexinput[sbs]{examples-version-n-change-pb.tex}
+\end{tdocexa}
+
+
+% ------------------ %
+
+
\begin{tdocexa}[Pour les réparations]
\leavevmode
@@ -1101,10 +1132,11 @@
\begin{tdocexa}[Thématiques aux choix]
\leavevmode
- \tdoclatexinput[sbs]{examples-version-n-change-topic.tex}
+ \tdoclatexinput[sbs]{examples-version-n-change-unclassifiable.tex}
\end{tdocexa}
+\newpage
\section{Décorations}
Finissons cette documentation avec de petites outils de mise en forme pouvant rendre de grands services.
@@ -1115,6 +1147,16 @@
\tdocsep % Pratique pour délimiter.
+Ceci fonctionne avec des énumérations.
+
+\begin{itemize}
+ \item Point souligné.
+
+ \item Autre chose utile.
+\end{itemize}
+
+\tdocsep % Un comportement uniforme.
+
Ble, ble, ble...
Bli, bli, bli...
@@ -1127,16 +1169,30 @@
Blu, blu, blu...
\end{tdoclatex}
-
\newpage
\section{Historique}
+\tdocversion{1.1.0}[2024-01-06]
+
+\begin{tdocnew}
+ \item Journal des changements : deux nouveaux environnements.
+ \begin{enumerate}
+ \item \tdocenv{tdocbreak} pour les \tdocquote{bifurcations}\,, soit les modifications non rétrocompatibles.
+
+ \item \tdocenv{tdocprob} pour les problèmes repérés.
+ \end{enumerate}
+
+ \item \tdocmacro{tdocinlatex}: un jaune léger est utilisé comme couleur de fond.
+\end{tdocnew}
+
+\tdocsep
+
\tdocversion{1.0.1}[2023-12-08]
\begin{tdocfix}
\item \tdocmacro{tdocenv}: l'espacement est maintenant correct, même si le paquet \tdocpack{babel} n'est pas chargé avec la langue française.
- \item \tdocenv[{[nostripe]}]{showcase}: les sauts de page autour des règles ne sont plus possibles.
+ \item \tdocenv[{[nostripe]}]{tdocshowcase}: les sauts de page autour des lignes \tdocquote{cadrantes} devraient être rares dorénavant.
\end{tdocfix}
\tdocsep
Deleted: trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-english.cfg.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-english.cfg.sty 2024-01-07 21:27:30 UTC (rev 69337)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-english.cfg.sty 2024-01-07 21:27:45 UTC (rev 69338)
@@ -1,17 +0,0 @@
-\NewDocumentCommand{\tdoc at trans@in at EN}{}{in \ english}
-\NewDocumentCommand{\tdoc at trans@latex at show@start}{}{Start \ of \ the \ real \ output}
-\NewDocumentCommand{\tdoc at trans@latex at show@end}{}{End \ of \ the \ real \ output}
-\NewDocumentCommand{\tdoc at trans@this at gives}{}{This \ gives}
-\NewDocumentCommand{\tdoc at trans@exa at title}{}{Example}
-\NewDocumentCommand{\tdoc at trans@rmk at title}{}{Remark}
-\NewDocumentCommand{\tdoc at trans@important at title}{}{Important}
-\NewDocumentCommand{\tdoc at trans@warn at title}{}{Warning}
-\NewDocumentCommand{\tdoc at trans@caution at title}{}{Caution}
-\NewDocumentCommand{\tdoc at trans@note at title}{}{Note}
-\NewDocumentCommand{\tdoc at trans@tip at title}{}{Tip}
-
-\NewDocumentCommand{\tdoc at trans@chges at new}{}{New}
-\NewDocumentCommand{\tdoc at trans@chges at update}{}{Update}
-\NewDocumentCommand{\tdoc at trans@chges at fix}{}{Fix}
-
-\NewDocumentCommand{\tdoc at trans@date}{ mmm }{#1-#2-#3}
Deleted: trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-french.cfg.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-french.cfg.sty 2024-01-07 21:27:30 UTC (rev 69337)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tdoc-locale-french.cfg.sty 2024-01-07 21:27:45 UTC (rev 69338)
@@ -1,17 +0,0 @@
-\NewDocumentCommand{\tdoc at trans@in at EN}{}{en \ anglais}
-\NewDocumentCommand{\tdoc at trans@latex at show@start}{}{Début \ du \ rendu \ réel}
-\NewDocumentCommand{\tdoc at trans@latex at show@end}{}{Fin \ du \ rendu \ réel}
-\NewDocumentCommand{\tdoc at trans@this at gives}{}{Ceci \ donne}
-\NewDocumentCommand{\tdoc at trans@exa at title}{}{Exemple}
-\NewDocumentCommand{\tdoc at trans@rmk at title}{}{Remarque}
-\NewDocumentCommand{\tdoc at trans@important at title}{}{Important}
-\NewDocumentCommand{\tdoc at trans@warn at title}{}{Avertissement}
-\NewDocumentCommand{\tdoc at trans@caution at title}{}{Prudence}
-\NewDocumentCommand{\tdoc at trans@note at title}{}{Note}
-\NewDocumentCommand{\tdoc at trans@tip at title}{}{Astuce}
-
-\NewDocumentCommand{\tdoc at trans@chges at new}{}{Nouveau}
-\NewDocumentCommand{\tdoc at trans@chges at update}{}{Mise \ à \ jour}
-\NewDocumentCommand{\tdoc at trans@chges at fix}{}{Réparation}
-
-\NewDocumentCommand{\tdoc at trans@date}{ mmm }{#3/#2/#1}
Added: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-english.cfg.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-english.cfg.sty (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-english.cfg.sty 2024-01-07 21:27:45 UTC (rev 69338)
@@ -0,0 +1,17 @@
+\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@rmk at title}{}{Remark}
+\NewDocumentCommand{\tutodoc at trans@note at title}{}{Note}
+\NewDocumentCommand{\tutodoc at trans@tip at title}{}{Tip}
+\NewDocumentCommand{\tutodoc at trans@important at title}{}{Important}
+\NewDocumentCommand{\tutodoc at trans@caution at title}{}{Caution}
+\NewDocumentCommand{\tutodoc at trans@warn at title}{}{Warning}
+\NewDocumentCommand{\tutodoc at trans@chges at pb}{}{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-locale-main-english.cfg.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: 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 (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc-locale-main-french.cfg.sty 2024-01-07 21:27:45 UTC (rev 69338)
@@ -0,0 +1,17 @@
+\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@rmk at title}{}{Remarque}
+\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@chges at pb}{}{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-locale-main-french.cfg.sty
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty 2024-01-07 21:27:30 UTC (rev 69337)
+++ trunk/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty 2024-01-07 21:27:45 UTC (rev 69338)
@@ -1,7 +1,7 @@
% ------------------------------------------------------- %
% - This is file `tutodoc.sty' generated automatically. - %
% - - %
-% - Copyright (C) 2023 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,8 +9,8 @@
\ProvidesExplPackage
{tutodoc}
- {2023-12-08} % Creation: 2023-11-29
- {1.0.1}
+ {2024-01-06} % Creation: 2023-11-29
+ {1.1.0}
{This package proposes tools for writing "human friendly" documentations of LaTeX packages.}
\RequirePackage[
@@ -88,18 +88,18 @@
% -- LOCALE SETTINGS -- %
-\NewDocumentCommand{\tdoc at colon}{}{:}
+\NewDocumentCommand{\tutodoc at colon}{}{:}
% We must take care of the colons, babel and spacing.
\@ifpackageloaded{babel}{
\iflanguage{french}{
- \RenewDocumentCommand{\tdoc at colon}{}{\babelshorthand{:}}
+ \RenewDocumentCommand{\tutodoc at colon}{}{\babelshorthand{:}}
}{}
}{}
\ExplSyntaxOn
-\input{tdoc-locale-\l_tdoc_opt_lang_str.cfg.sty}
+\input{tutodoc-locale-main-\l_tdoc_opt_lang_str.cfg.sty}
\ExplSyntaxOff
@@ -199,7 +199,7 @@
\NewDocumentCommand{\tdocinEN}{s m}{%
\tdocquote{#2}%
\IfBooleanF{#1}{% No star used.
- \ \tdoc at trans@in at EN{}%
+ \ \tutodoc at trans@in at EN{}%
}%
}
@@ -212,7 +212,7 @@
% See the \doc of the macro ''\newtheorem'' from the package ''amsthm''
% to have \infos about the environment ''@@tdocexa at nb''.
%%%
-\newtheorem{@@tdocexa at nb}{\tdoc at trans@exa at title}%
+\newtheorem{@@tdocexa at nb}{\tutodoc at trans@exa at title}%
[subsubsection]
%%%
@@ -226,7 +226,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''@@tdocexa at no@nb''.
%%%
-\newtheorem*{@@tdocexa at no@nb}{\tdoc at trans@exa at title}
+\newtheorem*{@@tdocexa at no@nb}{\tutodoc at trans@exa at title}
% :: EXAMPLE - PUBLIC VERSION :: %
@@ -268,7 +268,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''tdocrem''.
%%%
-\newtheorem*{tdocrem}{\tdoc at trans@rmk at title}
+\newtheorem*{tdocrem}{\tutodoc at trans@rmk at title}
% :: IMPORTANT :: %
@@ -277,7 +277,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''tdocimportant''.
%%%
-\newtheorem*{tdocimportant}{\tdoc at trans@important at title}
+\newtheorem*{tdocimportant}{\tutodoc at trans@important at title}
% :: NOTE :: %
@@ -286,7 +286,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''tdocnote''.
%%%
-\newtheorem*{tdocnote}{\tdoc at trans@note at title}
+\newtheorem*{tdocnote}{\tutodoc at trans@note at title}
% :: TIP :: %
@@ -295,7 +295,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''tdoctip''.
%%%
-\newtheorem*{tdoctip}{\tdoc at trans@tip at title}
+\newtheorem*{tdoctip}{\tutodoc at trans@tip at title}
% :: CUATION :: %
@@ -304,7 +304,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''tdoccaution''.
%%%
-\newtheorem*{tdoccaution}{\tdoc at trans@caution at title}
+\newtheorem*{tdoccaution}{\tutodoc at trans@caution at title}
% :: WARNING :: %
@@ -313,7 +313,7 @@
% See the \doc of the macro ''\newtheorem*'' from the package ''amsthm''
% to have \infos about the environment ''tdocwarn''.
%%%
-\newtheorem*{tdocwarn}{\tdoc at trans@warn at title}
+\newtheorem*{tdocwarn}{\tutodoc at trans@warn at title}
% -- NAMES OF PACKAGES, MACROS & ENVIRONMENTS -- %
@@ -563,9 +563,9 @@
\keys_define:nn { tdoc/showcase } {
% Texts.
before .tl_set:N = \l_tdoc_showcase_before_tl,
- before .initial:n = \tdoc at trans@latex at show@start,
+ before .initial:n = \tutodoc at trans@latex at show@start,
after .tl_set:N = \l_tdoc_showcase_after_tl,
- after .initial:n = \tdoc at trans@latex at show@end,
+ after .initial:n = \tutodoc at trans@latex at show@end,
% Decorations.
color .tl_set:N = \l_tdoc_showcase_color_tl,
color .initial:n = cyan,
@@ -644,7 +644,7 @@
% See the \doc of the macro ''\newmintinline'' from the package ''minted''
% to have \infos about the macro ''tdocinlatex''.
%%%
-\newmintinline[tdocinlatex]{latex}{}
+\newmintinline[tdocinlatex]{latex}{bgcolor = yellow!4}
% :: SHORTCUTS FOR TCOLORBOX LISTING FORMATING :: %
@@ -662,7 +662,7 @@
%
% See the pgfkeys package documentation for explanation.
%%%
-\NewExpandableDocumentCommand{\tdoc at latex@listing at formating}{ m }{
+\NewExpandableDocumentCommand{\tutodoc at latex@listing at formating}{ m }{
\str_case:nnF { #1 } {
{ sbs } { listing ~ side ~ text }
{ code } { listing ~ only }
@@ -721,7 +721,7 @@
% ''tcolorbox'' to have \infos about the environment ''tdoclatex''.
%%%
\newtcblisting{tdoclatex}[1][std]{%
- tdoclatex_tcbstyle = \tdoc at latex@listing at formating{#1}
+ tdoclatex_tcbstyle = \tutodoc at latex@listing at formating{#1}
}
@@ -738,7 +738,7 @@
%%%
\newtcbinputlisting{\tdoclatexinput}[2][std]{
listing file = {#2},
- tdoclatex_tcbstyle = \tdoc at latex@listing at formating{#1}
+ tdoclatex_tcbstyle = \tutodoc at latex@listing at formating{#1}
}
@@ -758,7 +758,7 @@
%%%
\keys_define:nn { tdoc/latexshow } {
explain .tl_set:N = \l_tdoc_listing_explain_tl,
- explain .initial:n = { \tdoc at trans@this at gives \tdoc at colon },
+ explain .initial:n = { \tutodoc at trans@this at gives \tutodoc at colon },
}
@@ -817,7 +817,7 @@
%
% :see: \__tdoc_translate_date:n
%%%
-\NewDocumentCommand{\tdoc at new@change at margin}{m m m m}{
+\NewDocumentCommand{\tutodoc at new@change at margin}{m m m m}{
\marginnote{
\color{#1}
\scriptsize
@@ -866,11 +866,11 @@
%%%
% prototype::
% :action: this function extracts year, month and day in something
-% like ''YYYY-MM-DD'' and then it calls ''\tdoc at trans@date''
+% like ''YYYY-MM-DD'' and then it calls ''\tutodoc at trans@date''
% to use the format expected for a "localised" date.
%%%
\cs_new:Npn \__tdoc_translate_date_process:w #1 - #2 - #3 \q_stop {
- \tdoc at trans@date{#1}
+ \tutodoc at trans@date{#1}
{#2}
{#3}
}
@@ -894,7 +894,7 @@
% of the language chosen when loading the package.
%%%
\NewDocumentCommand{\tdocversion}{O{blue} m O{}}{
- \tdoc at new@change at margin{#1} % Color
+ \tutodoc at new@change at margin{#1} % Color
{#3} % Date
{#2} % Version
{-4.25pt} % Last negative vertical spacing
@@ -912,7 +912,7 @@
% prints a date.
%%%
\NewDocumentCommand{\tdocdate}{O{blue} m}{
- \tdoc at new@change at margin{#1} % Color
+ \tutodoc at new@change at margin{#1} % Color
{#2} % Date
{} % Version
{-5.35pt} % Last negative spacing
@@ -962,7 +962,7 @@
% translated into the good language.
%%%
\NewDocumentEnvironment{tdocnew}{}{
- \begin{tdoctopic}{\tdoc at trans@chges at new}
+ \begin{tdoctopic}{\tutodoc at trans@chges at new}
}{
\end{tdoctopic}
}
@@ -978,12 +978,44 @@
% translated into the good language.
%%%
\NewDocumentEnvironment{tdocupdate}{}{
- \begin{tdoctopic}{\tdoc at trans@chges at update}
+ \begin{tdoctopic}{\tutodoc at trans@chges at update}
}{
\end{tdoctopic}
}
+% :: CHANGES - BREAK :: %
+
+%%%
+% prototype::
+% :see: env.tdoctopic
+%
+% :action: similar to the \env ''tdoctopic'' with the title "Break"
+% translated into the good language.
+%%%
+\NewDocumentEnvironment{tdocbreak}{}{
+ \begin{tdoctopic}{\tutodoc at trans@chges at break}
+}{
+ \end{tdoctopic}
+}
+
+
+% :: CHANGES - PROBLEM :: %
+
+%%%
+% prototype::
+% :see: env.tdoctopic
+%
+% :action: similar to the \env ''tdoctopic'' with the title "Problem"
+% translated into the good language.
+%%%
+\NewDocumentEnvironment{tdocprob}{}{
+ \begin{tdoctopic}{\tutodoc at trans@chges at pb}
+}{
+ \end{tdoctopic}
+}
+
+
% :: CHANGES - FIX :: %
%%%
@@ -994,7 +1026,7 @@
% translated into the good language.
%%%
\NewDocumentEnvironment{tdocfix}{}{
- \begin{tdoctopic}{\tdoc at trans@chges at fix}
+ \begin{tdoctopic}{\tutodoc at trans@chges at fix}
}{
\end{tdoctopic}
}
@@ -1004,6 +1036,9 @@
% -- DECORATIONS -- %
+% Source for \addvspace{\medskipamount} instead of \medskip.
+% * https://tex.stackexchange.com/a/705938/6880
+
%%%
% prototype::
% :action: this macro draws a centered horizontal rule with a height
@@ -1012,9 +1047,9 @@
% Extra vertical spaces are added above and below the rule.
%%%
\NewDocumentCommand{\tdocsep}{}{
+ \par\addvspace{\medskipamount}
+ \hfill\rule{0.5\textwidth}{0.75pt}\hfill\null
\medskip
- \hfill\rule{0.5\textwidth}{0.75pt}\hfill
- \medskip
\smallskip
}
More information about the tex-live-commits
mailing list.