Merge branch 'tutodoc'

tutodoc/README.md

@@ -1,10 +1,10 @@
-The `LaTeX` package `tutodoc`
-=============================
+The `LaTeX` class `tutodoc`
+===========================
 
 About `tutodoc`
 ---------------
 
-This package proposes some macros to write human documentations of `LaTeX` packages with a tutorial-like flavour.
+This class proposes some settings and macros to write human documentations of `LaTeX` packages and classes with a tutorial-like flavour.
 
 
 License
@@ -13,16 +13,8 @@ License
 This project may be distributed and/or modified under the conditions of the GNU 3 License.
 
 
-Contact
--------
-
-**Author.**
-
-  * Christophe Bal
-  * [email protected]
-
-
-**WEB pages.**
+WEB pages
+---------
 
   * `CTAN`: https://ctan.org/pkg/tutodoc
   * Repository: https://github.com/bc-tools/for-latex/tree/main/tutodoc

tutodoc/changes/TODO-FR.txt

@@ -9,87 +9,77 @@ NOW
 
 > ---------------------------- <
 
-Pour publier nvle version, il reste à ...
+??? script fabriquant les examples tdoc warn and co à partir d'un donné (cec évite de redander des trads déjà faites !) + idem pour chge what è!!
 
-    ---> intégrer main.cls avec au passge les load classe !!!
-
-    ---> gérer DOC-LANGS et ALL-LANGS (api lang mis dans metadata)
-
-> ---------------------------- <
-
-gestion des pacakages et classe importés
-
-    --> besoin d'un fichier  DEPENDSN.txt des dépendances ventuellement vide pour indiquer els depndances ordonnées ! pas d'auto, charge au condeur de nourrir texfacto !
-x
 
 > ---------------------------- <
 
-lang régélé via une commande \TDocSetLocale et du coup modigfiable à la amin, ceci nécessite de crérer une version de base avec des renewcommand
-
-+
-
-faire gestion des langues grérées dans les docs !
-
-    ---> mettre exemple avec chgt local de la langue
+texfacto-poc
 
+    ---> Templates to be translated but not used directly by the manual \doc.
 
-https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags
-
+    ---> prise en compte desc pour build.lua
 
 
 > ---------------------------- <
 
-réorganiser contrib trad via dossier de lang et non via doc, api, ... car au final trop de chemins à parcourrir par le traducteur
+THÈMES
 
+mettre aussi
 
-> ---------------------------- <
 
-test format date !!! cf bug oubli du formatage
+    \begin{itemize}
+    	\item La couleur de fond est fournie par \tdocmacro{tdocbackcolor}.
 
+    	\item La couleur des titres et des lignes est fournie par \tdocmacro{tdocdarkcolor}.
+    \end{itemize}
 
-> ---------------------------- <
+    Ces macros développables admettent les codes suivants.
 
-doc : section sur la contribtuion, maintenat que la structu est figée !
+    \begin{tdoclatex}[code]
+% Argument 1 : de façon optionnelle, on peut indiquer la quantité de couleur
+%              relativement au noir.
+%              Il est en général inutile de modifier ce paramètre !
+% Argument 2 : une couleur au format xcolor.
+\NewExpandableDocumentCommand{\tdocdarkcolor}{O{50}m}{#2!#1!black}
 
-    ---> incister sur besoin de trad de l'api et tools en priorité, pour la doc c'est pour les ourageux !
+% Argument 1 : de façon optionnelle, on peut indiquer le taux de transparence.
+%              Il est en général inutile de modifier ce paramètre !
+% Argument 2 : une couleur au format xcolor.
+\NewExpandableDocumentCommand{\tdoclightcolor}{O{5}m}{#2!#1}
+    \end{tdoclatex}
 
 
+    --> intégerre cela dans tefacto-POC
 
------
-LATER
------
+    --> ajout de macro du type newpage met avec tag qui agisse uniquement si la thème est choisi
 
 
 > ---------------------------- <
 
-nouvelle page tjrs pour les \sections en format écran mais en format paper (cf du coup l'usage de macro du type newpage met avec tag)
-
-
-> ---------------------------- <
+IMPORTS
 
-note and co
+    --> ATTENTION le lieu des imports est aussi celui de la gestiond es options : il faut donc aussi une section dédier à le gestiond es options de pack/cls qui sera toujours au début ????
 
-    --> différents mef possible ?
-        OK quand je ferais une classe : on choisi le CCS templ et on forunit alors les macro et réglage attendus; toit simplement !
+    --> nettoyer les doublons en les comprant
 
+    --> créer au passage un fichier  DEPENNDS.yaml des dépendances ventuellement vide pour indiquer els depndances ordonnées !
+    on le construit auto pour ce qui est utilisé, et on propose un clé pour indiquer des ordres d'imports imposés, cette partie n'atant jmaais touchée par texfacto
 
-            + format = color par défaut
-            + format = bw pour black/white pour ceux faches avec les couleurs
-            + format = dark pour white/black pour se reposer les yeux
-            + format = paper  pour relecture sur papier avec dans ce cas
 
-            + ajout de macro du type newpage met avec tag qui agisse uniquement si la format est choisi
+> ---------------------------- <
 
+LANG
 
-> ---------------------------- <
+    --> les trads dans la doc : faire uns cript qui gère cela automatiquement !
 
-focus
+    --> ref à https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags ???
 
-    ---> nonb as a package option
 
-    ---> "choice" option ''nb/nonb'' poir tous les cas mais en choissisant de numéroté que les exemples par défaut
 
-    ---> code auto  mêm si c'est fixé a priori
+-----
+LATER
+-----
 
 
 > ---------------------------- <

tutodoc/changes/dev/2024/10.txt

@@ -1,3 +1,158 @@
+==
+27  (1.6.0)
+==
+
+[[:test:]]
+Updates were needed regarding the new ''theme'' option. From now, we will use prefixes path::''pdf'' and path::''unit'' to indicate either a visual test, or a unit one.
+
+
+// ---------- //
+
+
+==
+26  (1.6.0-rc.2)
+==
+
+-----
+:fix:
+-----
+
+''tdocinEN'': this macro was bad designed (indeed, we don't know where the \arg should be printed).
+
+
+-----
+:new:
+-----
+
+[[:api:]]
+\Chges history: the new \env ''tdoctech'' allows to talk about technical \infos for geeks.
+
+
+--------
+:fordev:
+--------
+
+[[:flow:]]
+Translation of the \api: the code has been updated to follow the new organization of the folders.
+
+
+// ---------- //
+
+
+==
+25  (1.6.0-rc.1)
+==
+
+--------
+:fordev:
+--------
+
+[[:flow:]]
+The ugly \texfacto \poc has been updated to meet the following new requirements.
+
+    1) Use of post hooks (see the building of the gallery of themes).
+
+    1) \css like features for themes.
+
+
+--------
+:update:
+--------
+
+[[:doc:]]
+Manual: explanations about the use of the ''wide'' option from the \enumitem \pack (useful with admonition \envs).
+
+
+// ---------- //
+
+
+==
+23  (1.6.0-beta.4)
+==
+
+-----
+:new:
+-----
+
+[[:doc:]]
+Manual: a section talks about the themes, and also adds at the very end of the manual the results obtained according to a chosen theme.
+
+
+// ---------- //
+
+
+==
+23  (1.6.0-beta.3)
+==
+
+-------
+:break:
+-------
+
+[[:api:]]
+Here are the breaking changes.
+
+    1) Showcase: the key ''color'' has been renamed ''colstripe''.
+
+    1) Themes: the color ''tdoclinkcolor'' becomes ''tutodoc@link@color'' such as to avoid unwanted changes by a common user.
+
+
+-----
+:new:
+-----
+
+[[:api:]]
+Themes.
+
+    1) Draft versions look good. This concerns the following folders.
+
+        * path::''admonitions''
+        * path::''listing''
+        * path::''main''
+        * path::''showcase''
+        * path::''version-n-change''
+
+    1) Showcase: addition of a new missing option ''coltext'' to change the text color (the themes need this new option).
+
+
+--------
+:update:
+--------
+
+[[:doc:]]
+Manual: the new options for the \env ''showcase'' have been documented (but not yet the ''theme'' option of the class).
+
+
+// ---------- //
+
+
+==
+21  (1.6.0-beta.2)
+==
+
+--------
+:update:
+--------
+
+[[:api:]]
+Themes: the macro ``\tdoclinkcolor`` becomes ''tdoclinkcolor'' an \xcolor color.
+
+
+// ---------- //
+
+
+==
+20  (1.6.0-beta.1)
+==
+
+-----
+:new:
+-----
+
+[[:api:]]
+Themes: a \1st draft version just for admonitions looks good.
+
+
 // ---------- //
 
 

tutodoc/changes/stable/2024/10.txt

@@ -1,10 +1,70 @@
 // ---------- //
 
 
+==
+27  (1.6.0)
+==
+
+
+------
+:desc:
+------
+
+This version adds the possibility to change the layout via the choice of one theme.
+
+
+-------
+:break:
+-------
+
+[[:api:]]
+Here are the breaking changes.
+
+    1) Showcase: the key ''color'' has been renamed ''colstripe''.
+
+    1) The macro ``\tdoclinkcolor`` becomes the internal \xcolor ''tutodoc@link@color''.
+
+
+-----
+:new:
+-----
+
+[[:api:]]
+Here are the new features.
+
+    1) Themes: the \cls option ''theme'' allows to change the formatting.
+
+    1) \Chges history: the new \env ''tdoctech'' allows to talk about technical \infos for geeks.
+
+    1) Showcase: addition of the option ''coltext'' to change the text color (the themes need this new option).
+
+
+[[:doc:]]
+Manual: the new features have been documented.
+
+
+--------
+:update:
+--------
+
+[[:api:]]
+\Chges history: the icon for updates is now ''\reflectbox{\faHistory}''.
+
+
+// ---------- //
+
+
 ==
 19  (1.5.0)
 ==
 
+------
+:desc:
+------
+
+The main change in this version is the move from the ''tutodoc'' package to the ''tutodoc'' class.
+
+
 -------
 :break:
 -------

tutodoc/changes/stable/next.txt

@@ -1,6 +1 @@
-// ---------- //
-
-
-==
-??  (??)
-==
+TODO