tutodoc --> New stable version: 1.5.0

TeXitEasy/about.yaml

@@ -1,5 +1,5 @@
 general:
-  desc   : This project contains tools to work with ¨latex.
+  desc   : This project contains tools to work with \latex.
   author : Christophe BAL
   licence: gnu 3
   lang   :

TeXitEasy/src/escape.py

@@ -2,8 +2,8 @@
 
 ###
 # This file proposes two escaping functions.
-#     1) The 1st one escape a text to be used in a ¨latex content.
-#     2) The 2nd one prepare a ¨latex source code to be used in a f-string.
+#     1) The 1st one escape a text to be used in a \latex content.
+#     2) The 2nd one prepare a \latex source code to be used in a f-string.
 ###
 
 
@@ -46,10 +46,10 @@
 ###
 # prototype::
 #     text : the text to be escaped.
-#     mode : the ¨latex mode where the text will be used.
+#     mode : the \latex mode where the text will be used.
 #          @ mode in [MODE_MATH, MODE_TEXT]
 #
-#     :return: the text with all specific ¨latex characters escaped so as
+#     :return: the text with all specific \latex characters escaped so as
 #              to be used verbatim in either a math formula or a text
 #              regarding to the value of ''mode''.
 ###
@@ -95,9 +95,9 @@ def escape(
 
 ###
 # prototype::
-#     code : the ¨latex source to transform into a f-string template.
+#     code : the \latex source to transform into a f-string template.
 #
-#     :return: the source with all specific ¨latex characters escaped so as
+#     :return: the source with all specific \latex characters escaped so as
 #              to be used verbatim in either a math formula or a text
 #              regarding to the value of ''mode''.
 ###

TeXitEasy/texiteasy/escape.py

@@ -2,8 +2,8 @@
 
 ###
 # This file proposes two escaping functions.
-#     1) The 1st one escape a text to be used in a ¨latex content.
-#     2) The 2nd one prepare a ¨latex source code to be used in a f-string.
+#     1) The 1st one escape a text to be used in a \latex content.
+#     2) The 2nd one prepare a \latex source code to be used in a f-string.
 ###
 
 
@@ -45,10 +45,10 @@
 ###
 # prototype::
 #     text : the text to be escaped.
-#     mode : the ¨latex mode where the text will be used.
+#     mode : the \latex mode where the text will be used.
 #          @ :in: [MODE_MATH, MODE_TEXT]
 #
-#     :return: the text with all specific ¨latex characters escaped so as
+#     :return: the text with all specific \latex characters escaped so as
 #              to be used verbatim in either a math formula or a text
 #              regarding to the value of ''mode''.
 ###
@@ -96,9 +96,9 @@ def escape(
 
 ###
 # prototype::
-#     code : the ¨latex source to transform to a f-string template.
+#     code : the \latex source to transform to a f-string template.
 #
-#     :return: the source with all specific ¨latex characters escaped so as
+#     :return: the source with all specific \latex characters escaped so as
 #              to be used verbatim in either a math formula or a text
 #              regarding to the value of ''mode''.
 ###

changes/2023/07.txt

@@ -10,4 +10,4 @@
 --------
 
 [[:doc:]]
-\Abbrevs: the syntax has moved from ''¨myabrev'' to ''\myabrev''.
+\Abbrevs: the syntax has moved from ''\myabrev'' to ''\myabrev''.

gitignore

@@ -13,12 +13,10 @@ x-*-x.*
 x-*-x/
 
 *.unq
+*.unq
+*.config.minted
 
 
-# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode
-# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,latex,tex,python,lua
-###
-
 # Created by https://www.toptal.com/developers/gitignore/api/lua,tex,latex,python,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=lua,tex,latex,python,visualstudiocode
 

tutodoc/about.yaml

@@ -1,10 +1,13 @@
 general:
-  desc   : This package proposes tools for writing "human friendly"
-           documentations of LaTeX packages.
+  desc   : This LaTeX class proposes tools for writing "human friendly"
+           PDF documentations of LaTeX packages and classes.
   acronym: "[tuto]rial [doc]umentation"
   author : Christophe BAL
+
   licence: gnu 3
+
   lang   :
     doc: fr
+
   require:
     - latex

tutodoc/changes/TODO-FR.txt

@@ -9,28 +9,60 @@ NOW
 
 > ---------------------------- <
 
-classe + package car il y a des choix esthétique
+Pour publier nvle version, il reste à ...
 
-    + class pour une mef perso :
-        --> police, marge
-        --> couleur / noir-et-blanc
+    ---> intégrer main.cls avec au passge les load classe !!!
 
-    + pack pour le reste
+    ---> gérer DOC-LANGS et ALL-LANGS (api lang mis dans metadata)
 
+> ---------------------------- <
 
------
-LATER
------
+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
 
 > ---------------------------- <
 
-cleaner code
+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
 
-    ---> latex3 strict pour showcase et listinginput
++
+
+faire gestion des langues grérées dans les docs !
 
-    ---> respecter mes specs latex : on isole les messages par exemple!
+    ---> mettre exemple avec chgt local de la langue
 
 
+https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags
+
+
+
+> ---------------------------- <
+
+réorganiser contrib trad via dossier de lang et non via doc, api, ... car au final trop de chemins à parcourrir par le traducteur
+
+
+> ---------------------------- <
+
+test format date !!! cf bug oubli du formatage
+
+
+> ---------------------------- <
+
+doc : section sur la contribtuion, maintenat que la structu est figée !
+
+    ---> incister sur besoin de trad de l'api et tools en priorité, pour la doc c'est pour les ourageux !
+
+
+
+-----
+LATER
+-----
+
+
+> ---------------------------- <
+
+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)
 
 
 > ---------------------------- <
@@ -40,7 +72,13 @@ note and co
     --> 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 !
 
-    --> Numéroter ?
+
+            + 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
 
 
 > ---------------------------- <

tutodoc/changes/dev/2021/07.txt

@@ -94,7 +94,7 @@ The macro ''\docversion'' prints now the date with the format of the language lo
 
 
 [[:format:]]
-For the showcases, the strip contains now also the focusing rules, and this strip uses a blue color instead of a green one.
+For the showcases, the strip contains now also the highlighting rules, and this strip uses a blue color instead of a green one.
 
 
 --------

tutodoc/changes/dev/2023/09.txt

@@ -149,7 +149,7 @@ Some simplifications have been made.
 [[:api:]]
 Here are the new features.
 
-    1) Two \envs ''bdocwarning'' and ''bdocinfo'' have been added: this allows to focus some content more precisely.
+    1) Two \envs ''bdocwarning'' and ''bdocinfo'' have been added: this allows to highlight some content more precisely.
 
     1) The new \envs ''bdoclatexshow*'' and ''bdocshowcase*'' work without the ''clrstrip'' package.
 

tutodoc/changes/dev/2023/11.txt

@@ -139,7 +139,7 @@ Use of path::''doc-header.cfg'' instead of path::''doc-header.tex''.
 -----
 
 [[:api:]]
-Focus: the use of verbatim content was no longer possible with the latest version of the \env ''bdocexa''.
+Highlight: the use of verbatim content was no longer possible with the latest version of the \env ''bdocexa''.
 
 
 --------
@@ -162,7 +162,7 @@ Avoid unwanted \pdf changes: a \bash file added (but later the job will be done
 -------
 
 [[:api:]]
-Focusing examples.
+Highlighting examples.
 
     1) The \env ''bdocexa*'' has been removed
 
@@ -181,7 +181,7 @@ Focusing examples.
 --------
 
 [[:api:]]
-Focus: a full list of \envs has been build by following the choices made by cf::''asciidoctor ; https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions''.
+Highlight: a full list of \envs has been build by following the choices made by cf::''asciidoctor ; https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions''.
 
     1) Unchanged.
 

tutodoc/changes/dev/2024/09.txt

@@ -34,7 +34,7 @@ Versions: better vertical spacing thanks to ''\vphantom{Mp}''.
 --------
 
 [[:test:]]
-Focus.
+Highlight.
 
     1) Tests on colored frames showed that finer adjustment could be necessary (see above).
 
@@ -65,7 +65,7 @@ Two major additions done.
 -------
 
 [[:api:]]
-Focus.
+Highlight.
 
     1) The ''tdoccaution'' \env has been renamed to ''tdoccaut'' for ease of use.
 
@@ -89,7 +89,7 @@ Change log: the ''\tdocstartproj'' macro is used to manage the case of the first
 --------
 
 [[:format:]]
-Focus: reduced space around content in colored frames.
+Highlight: reduced space around content in colored frames.
 
 
 // ---------- //
@@ -142,7 +142,7 @@ Too much small \pbs have been fixed.
 -------
 
 [[:api:]]
-Focus: the ''tdocimportant'' \env has been renamed to ''tdocimp'' for ease of use.
+Highlight: the ''tdocimportant'' \env has been renamed to ''tdocimp'' for ease of use.
 
 
 --------
@@ -192,7 +192,7 @@ Change log: icons are associated to the kind-of-\infos \env (use of the \fontawe
 --------
 
 [[:format:]]
-Focus.
+Highlight.
 
     1) Use of two-parts colored frames (the recognition becomes better).
 
@@ -211,4 +211,4 @@ Focus.
 -----
 
 [[:format:]]
-Focus: colored frames for easy recognition of information types (the \pack \keytheorems is used in backstage).
+Highlight: colored frames for easy recognition of information types (the \pack \keytheorems is used in backstage).