summaryrefslogtreecommitdiff
path: root/Master
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-12-09 21:35:48 +0000
committerKarl Berry <karl@freefriends.org>2023-12-09 21:35:48 +0000
commit4324d90d32588c8b9c23cfd1aa4fe05e3f21b0e5 (patch)
tree745233f84a691d2fe99b48bd59537cf03ce062aa /Master
parent20c6018246c73a328973845b3e80fd3f5fbf3812 (diff)
tutodoc (9dec23)
git-svn-id: svn://tug.org/texlive/trunk@69079 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rw-r--r--Master/texmf-dist/doc/latex/tutodoc/README.md2
-rw-r--r--Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdfbin710329 -> 687653 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex97
-rw-r--r--Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdfbin730016 -> 757927 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex108
-rw-r--r--Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty20
6 files changed, 139 insertions, 88 deletions
diff --git a/Master/texmf-dist/doc/latex/tutodoc/README.md b/Master/texmf-dist/doc/latex/tutodoc/README.md
index 335d288b1db..7458ee34e7c 100644
--- a/Master/texmf-dist/doc/latex/tutodoc/README.md
+++ b/Master/texmf-dist/doc/latex/tutodoc/README.md
@@ -16,4 +16,4 @@ This project may be distributed and/or modified under the conditions of the GNU
Where is the documentation?
---------------------------
-At this time, there is a French and an English documentation writing with a tutorial-like flavor (in the repository, see the folder `rollout/doc`).
+Documentation is currently available in French and English, they arewriting with a tutorial-like flavor (in the repository, see the folder `rollout/doc`).
diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf
index 4d051d30104..a83fc1915df 100644
--- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf
+++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex
index a520d22847d..8d628d7b4a8 100644
--- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex
+++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-en.tex
@@ -4,7 +4,7 @@
% -------------------- %
-\begin{filecontents*}{examples-focus-exa.tex}
+\begin{filecontents*}[overwrite]{examples-focus-exa.tex}
Bla, bla, bla...
\begin{tdocexa}
@@ -25,7 +25,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-exa-leavevmode.tex}
+\begin{filecontents*}[overwrite]{examples-focus-exa-leavevmode.tex}
\begin{tdocexa}
\leavevmode
@@ -38,7 +38,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-rmk.tex}
+\begin{filecontents*}[overwrite]{examples-focus-rmk.tex}
\begin{tdocrem}
Just one remark...
\end{tdocrem}
@@ -49,7 +49,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-tip.tex}
+\begin{filecontents*}[overwrite]{examples-focus-tip.tex}
\begin{tdoctip}
A tip.
\end{tdoctip}
@@ -60,7 +60,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-note.tex}
+\begin{filecontents*}[overwrite]{examples-focus-note.tex}
\begin{tdocnote}
Something useful to tell you...
\end{tdocnote}
@@ -71,7 +71,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-important.tex}
+\begin{filecontents*}[overwrite]{examples-focus-important.tex}
\begin{tdocimportant}
Important and harmless.
\end{tdocimportant}
@@ -82,7 +82,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-caution.tex}
+\begin{filecontents*}[overwrite]{examples-focus-caution.tex}
\begin{tdoccaution}
Caution, caution...
\end{tdoccaution}
@@ -93,7 +93,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-focus-warn.tex}
+\begin{filecontents*}[overwrite]{examples-focus-warn.tex}
\begin{tdocwarn}
Avoid the dangers...
\end{tdocwarn}
@@ -104,7 +104,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-default.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-default.tex}
\begin{tdocshowcase}
\bfseries A bit of code \LaTeX.
@@ -115,7 +115,7 @@
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-customized.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-customized.tex}
\begin{tdocshowcase}[before = My beginning,
after = My end,
color = red]
@@ -124,21 +124,21 @@ Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-hook.tex}
-\begin{tdocshowcase}[]
- [This works...]
+\begin{filecontents*}[overwrite]{examples-showcase-hook.tex}
+\begin{tdocshowcase}
+ \string[This works...]
\end{tdocshowcase}
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-no-clrstrip.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip.tex}
\begin{tdocshowcase}[nostripe]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-no-clrstrip-customized.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip-customized.tex}
\begin{tdocshowcase}[nostripe,
before = My beginning,
after = My end,
@@ -149,32 +149,32 @@ Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-external.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-external.tex}
Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli...
\end{filecontents*}
-\begin{filecontents*}{examples-listing-ABC.tex}
+\begin{filecontents*}[overwrite]{examples-listing-ABC.tex}
\begin{tdoclatex}[sbs]
$A = B + C$
\end{tdoclatex}
\end{filecontents*}
-\begin{filecontents*}{examples-listing-strange.tex}
+\begin{filecontents*}[overwrite]{examples-listing-strange.tex}
\begin{tdoclatex}[std]
[Strange... Or not!]
\end{tdoclatex}
\end{filecontents*}
-\begin{filecontents*}{examples-listing-xyz.tex}
+\begin{filecontents*}[overwrite]{examples-listing-xyz.tex}
% Just one demo.
$x y z = 1$
\end{filecontents*}
-\begin{filecontents*}{examples-listing-latexshow-options.tex}
+\begin{filecontents*}[overwrite]{examples-listing-latexshow-options.tex}
\tdoclatexshow[explain = What comes next is colourful...,
before = Rendering below.,
after = Finished rendering.,
@@ -183,7 +183,7 @@ $x y z = 1$
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-dating.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex}
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\medskip % CAUTION! This prevents overlapping.
@@ -204,7 +204,7 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-versioning.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-versioning.tex}
\tdocversion[red]{10.2.0-beta}[2023-12-01]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
@@ -220,7 +220,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-new.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-new.tex}
\begin{tdocnew}
\item Info 1...
\item Info 2...
@@ -228,7 +228,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-update.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-update.tex}
\begin{tdocupdate}
\item Info 1...
\item Info 2...
@@ -236,7 +236,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-fix.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-fix.tex}
\begin{tdocfix}
\item Info 1...
\item Info 2...
@@ -244,7 +244,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-topic.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-topic.tex}
\begin{tdoctopic}{Unclassifiable changes}
% This is where the point needs to be put.
\item Info 1...
@@ -257,7 +257,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
% -- SOURCE FOR THE DOC -- %
% ------------------------ %
-\documentclass[12pt, a4paper]{article}
+\documentclass[10pt, a4paper]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
@@ -270,6 +270,8 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\usepackage{tabularray}
\usepackage{fmtcount}
+\setlength{\parindent}{0em}
+
% Package documented.
\usepackage[lang = english]{tutodoc}
@@ -278,11 +280,11 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
% * https://tex.stackexchange.com/a/604698/6880
\NewDocumentCommand{ \tdocdocbasicinput }{ m }{%
- Considérons le code suivant.
+ Consider the following code.
\tdoclatexinput[code]{#1}
- Ceci produira ce qui suit.
+ This will produce the following.
\input{#1}
}
@@ -307,12 +309,12 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
}
\NewDocumentEnvironment{ tdoc-doc-showcase }
- { O{ Début du rendu dans cette doc. }
- O{ Fin du rendu dans cette doc. } }{
+ { O{ Start of the rendering in this doc. }
+ O{ End of rendering in this doc. } }{
\tdocdocextraruler{#1}
- \smallskip
+ \nopagebreak\smallskip\nopagebreak
}{
- \smallskip
+ \nopagebreak\smallskip\nopagebreak
\tdocdocextraruler{#2}
}
@@ -322,11 +324,12 @@ 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{29 Nov. 2023 - Version 1.0.0}
+\date{8th Dec. 2023 - Version 1.0.1}
\maketitle
\begin{abstract}
+\noindent
The \tdocpack{tutodoc} package
\footnote{
The name comes from \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}}.
@@ -337,10 +340,15 @@ is used by its author to semantically produce documentation of \LaTeX\ packages
},
and with a sober rendering for reading on screen.
+\medskip
-\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}
+\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}
\end{abstract}
@@ -690,7 +698,7 @@ It is sometimes useful to render code directly in the documentation. This type o
\begin{tdocwarn}
- With the default settings, if the code to be formatted begins with an opening bracket, an empty option must be explicitly indicated, as in 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. the following example.
\tdoclatexinput[code]{examples-showcase-hook.tex}
@@ -935,7 +943,8 @@ The \tdocmacro{tdoclatexinput} macro, shown below, is used in the same way as th
\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.
- \medskip
+ \newpage
+% \medskip
\begin{tdoc-doc-showcase}
\tdoclatexshow[explain = Here is the actual rendering.]{examples-listing-xyz.tex}
@@ -1089,8 +1098,18 @@ Blu, blu, blu...
+\newpage
\section{History}
+\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}
+
+\tdocsep
+
\tdocversion{1.0.0}[2023-11-29]
First public version of the project.
diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf
index 61c26a3f4fc..3b37329ef4c 100644
--- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf
+++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex
index d5c55ff6672..ef86f8a9bcf 100644
--- a/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex
+++ b/Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex
@@ -4,7 +4,7 @@
% -------------------- %
-\begin{filecontents*}{examples-focus-exa.tex}
+\begin{filecontents*}[overwrite]{examples-focus-exa.tex}
Bla, bla, bla...
\begin{tdocexa}
@@ -25,7 +25,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-exa-leavevmode.tex}
+\begin{filecontents*}[overwrite]{examples-focus-exa-leavevmode.tex}
\begin{tdocexa}
\leavevmode
@@ -38,7 +38,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-rmk.tex}
+\begin{filecontents*}[overwrite]{examples-focus-rmk.tex}
\begin{tdocrem}
Juste une remarque...
\end{tdocrem}
@@ -49,7 +49,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-tip.tex}
+\begin{filecontents*}[overwrite]{examples-focus-tip.tex}
\begin{tdoctip}
Une astuce.
\end{tdoctip}
@@ -60,7 +60,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-note.tex}
+\begin{filecontents*}[overwrite]{examples-focus-note.tex}
\begin{tdocnote}
Un truc utile à vous dire...
\end{tdocnote}
@@ -71,7 +71,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-important.tex}
+\begin{filecontents*}[overwrite]{examples-focus-important.tex}
\begin{tdocimportant}
Un truc important sans danger.
\end{tdocimportant}
@@ -82,7 +82,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-caution.tex}
+\begin{filecontents*}[overwrite]{examples-focus-caution.tex}
\begin{tdoccaution}
Prudence, prudence...
\end{tdoccaution}
@@ -93,7 +93,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-focus-warn.tex}
+\begin{filecontents*}[overwrite]{examples-focus-warn.tex}
\begin{tdocwarn}
Evitez les dangers...
\end{tdocwarn}
@@ -104,7 +104,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-default.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-default.tex}
\begin{tdocshowcase}
\bfseries Un peu de code \LaTeX.
@@ -115,7 +115,7 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-customized.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-customized.tex}
\begin{tdocshowcase}[before = Mon début,
after = Ma fin à moi,
color = red]
@@ -124,21 +124,21 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-hook.tex}
-\begin{tdocshowcase}[]
- [Cela fonctionne...]
+\begin{filecontents*}[overwrite]{examples-showcase-hook.tex}
+\begin{tdocshowcase}
+ \string[Cela fonctionne...]
\end{tdocshowcase}
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-no-clrstrip.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip.tex}
\begin{tdocshowcase}[nostripe]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-no-clrstrip-customized.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-no-clrstrip-customized.tex}
\begin{tdocshowcase}[nostripe,
before = Mon début,
after = Ma fin à moi,
@@ -148,32 +148,32 @@ Bla, bla, bla...
\end{filecontents*}
-\begin{filecontents*}{examples-showcase-external.tex}
+\begin{filecontents*}[overwrite]{examples-showcase-external.tex}
Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli...
\end{filecontents*}
-\begin{filecontents*}{examples-listing-ABC.tex}
+\begin{filecontents*}[overwrite]{examples-listing-ABC.tex}
\begin{tdoclatex}[sbs]
$A = B + C$
\end{tdoclatex}
\end{filecontents*}
-\begin{filecontents*}{examples-listing-strange.tex}
+\begin{filecontents*}[overwrite]{examples-listing-strange.tex}
\begin{tdoclatex}[std]
[Étrange... Ou pas !]
\end{tdoclatex}
\end{filecontents*}
-\begin{filecontents*}{examples-listing-xyz.tex}
+\begin{filecontents*}[overwrite]{examples-listing-xyz.tex}
% Juste une démo.
$x y z = 1$
\end{filecontents*}
-\begin{filecontents*}{examples-listing-latexshow-options.tex}
+\begin{filecontents*}[overwrite]{examples-listing-latexshow-options.tex}
\tdoclatexshow[explain = Ce qui vient est coloré...,
before = Rendu ci-après.,
after = Rendu fini.,
@@ -182,7 +182,7 @@ $x y z = 1$
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-dating.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex}
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\medskip % ATTENTION ! Ceci évite le chevauchement.
@@ -203,7 +203,7 @@ Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-versioning.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-versioning.tex}
\tdocversion[red]{10.2.0-beta}[2023-12-01]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
@@ -219,7 +219,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-new.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-new.tex}
\begin{tdocnew}
\item Info 1...
\item Info 2...
@@ -227,7 +227,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-update.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-update.tex}
\begin{tdocupdate}
\item Info 1...
\item Info 2...
@@ -235,7 +235,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-fix.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-fix.tex}
\begin{tdocfix}
\item Info 1...
\item Info 2...
@@ -243,7 +243,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
-\begin{filecontents*}{examples-version-n-change-topic.tex}
+\begin{filecontents*}[overwrite]{examples-version-n-change-topic.tex}
\begin{tdoctopic}{Des changements inclassables}
% Ici le point s'impose.
\item Info 1...
@@ -269,6 +269,7 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
% Package documented.
\usepackage[lang = french]{tutodoc}
+\setlength{\parindent}{0em}
% Source.
% * https://tex.stackexchange.com/a/604698/6880
@@ -306,9 +307,9 @@ ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
{ O{ Début du rendu dans cette doc. }
O{ Fin du rendu dans cette doc. } }{
\tdocdocextraruler{#1}
- \smallskip
+ \nopagebreak\smallskip\nopagebreak
}{
- \smallskip
+ \nopagebreak\smallskip\nopagebreak
\tdocdocextraruler{#2}
}
@@ -318,11 +319,12 @@ 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{29 Nov. 2023 - Version 1.0.0}
+\date{8 Déc. 2023 - Version 1.0.1}
\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}.
@@ -333,19 +335,28 @@ est utilisé par son auteur pour produire de façon sémantique des documentatio
},
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.
+
+ \item Cette documentation est aussi disponible en anglais.
+\end{itemize}
+
+
+% ------------------ %
-\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}
\tdocsep
-{\small\itshape
+{\noindent
+\small\itshape
\textbf{Abstract.}
The \tdocpack{tutodoc} package
\footnote{
- The name comes from \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}}.
+ The name comes from \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}}.
}
is used by its author to semantically produce documentation of \LaTeX\ packages and classes in a tutorial style
\footnote{
@@ -353,10 +364,15 @@ is used by its author to semantically produce documentation of \LaTeX\ packages
},
and with a sober rendering for reading on screen.
+\medskip
-\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}
+\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}
}
\end{abstract}
@@ -708,7 +724,7 @@ Il est parfois utile d'obtenir directement le rendu d'un code dans la documentat
\begin{tdocwarn}
- Avec les réglages par défaut, si le code \LaTeX\ à mettre en forme commence par un crochet ouvrant, il faudra indiquer explicitement une option vide comme dans l'exemple suivant.
+ Avec les réglages par défaut, si le code \LaTeX\ à mettre en forme commence par un crochet ouvrant, il faudra user de \tdocmacro{string} comme dans l'exemple suivant.
\tdoclatexinput[code]{examples-showcase-hook.tex}
@@ -882,6 +898,7 @@ La macro \tdocmacro{tdoclatexinput} , présentée ci-après, s'utilise comme l'e
% ------------------ %
+\newpage
\begin{tdocexa}[Face à face]
\leavevmode
@@ -1050,6 +1067,7 @@ On peut au choix dater quelque chose, ou bien le versionner, dans ce second cas
lors des derniers changements.
+\newpage
\begin{tdocexa}[Pour les nouveautés]
\leavevmode
@@ -1109,8 +1127,20 @@ Blo, blo, blo...
Blu, blu, blu...
\end{tdoclatex}
+
+\newpage
\section{Historique}
+\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.
+\end{tdocfix}
+
+\tdocsep
+
\tdocversion{1.0.0}[2023-11-29]
Première version publique du projet.
diff --git a/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty b/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty
index 83b6c884339..cd4a6aecb39 100644
--- a/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty
+++ b/Master/texmf-dist/tex/latex/tutodoc/tutodoc.sty
@@ -9,8 +9,8 @@
\ProvidesExplPackage
{tutodoc}
- {2023-11-29} % Creation: 2023-11-29
- {1.0.0}
+ {2023-12-08} % Creation: 2023-11-29
+ {1.0.1}
{This package proposes tools for writing "human friendly" documentations of LaTeX packages.}
\RequirePackage[
@@ -344,7 +344,7 @@
% prototype::
% #1 : the name of a macro
%
-% :action: ''\tdocenv{mymacro}'' prints verb::''\mymacro''.
+% :action: ''\tdocmacro{mymacro}'' prints verb::''\mymacro''.
%%%
\NewDocumentCommand{\tdocmacro}{m}{%
\texttt{\textbackslash{}#1}%
@@ -360,10 +360,12 @@
% or something like verb::''\begin{myenv}<opt1> ... \end{myenv}'',
% the spaces being secable.
%%%
+%
+% Cleaner code from https://tex.stackexchange.com/a/703379/6880 .
\NewDocumentCommand{\tdocenv}{O{}m}{%
- \texttt{\textbackslash{}begin\{#2\}#1 %
- \!...\! %
- \textbackslash{}end\{#2\}}%
+ \texttt{\string\begin\string{#2\string}#1 %
+ \!\!...\@\!\!\! %
+ \string\end\string{#2\string}}%
}
@@ -510,9 +512,9 @@
%%%
\NewDocumentEnvironment{tdoc@showcase@basic}{m m m}{
\tdocruler{#1}{\tdocdarkcolor{#3}}
- \medskip
+ \nopagebreak\medskip\nopagebreak
}{
- \medskip
+ \nopagebreak\medskip\nopagebreak
\tdocruler{#2}{\tdocdarkcolor{#3}}
}
@@ -587,7 +589,7 @@
% :see: env.tdoc@showcase@basic ,
% env.tdoc@showcase@colorstrip
%%%
-\NewDocumentEnvironment{tdocshowcase}{O{}}{
+\NewDocumentEnvironment{tdocshowcase}{ O{} }{
\group_begin:
\keys_set:nn { tdoc/showcase } { #1 }