diff options
author | Karl Berry <karl@freefriends.org> | 2023-12-09 21:35:48 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2023-12-09 21:35:48 +0000 |
commit | 4324d90d32588c8b9c23cfd1aa4fe05e3f21b0e5 (patch) | |
tree | 745233f84a691d2fe99b48bd59537cf03ce062aa /Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex | |
parent | 20c6018246c73a328973845b3e80fd3f5fbf3812 (diff) |
tutodoc (9dec23)
git-svn-id: svn://tug.org/texlive/trunk@69079 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/tutodoc/tutodoc-fr.tex | 108 |
1 files changed, 69 insertions, 39 deletions
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. |