From bb3966b189425623966fcc9c1bf0e5fa1e9a73b4 Mon Sep 17 00:00:00 2001
From: Jean-Christian Denis <contact@jcdenis.fr>
Date: Sun, 12 Sep 2021 23:01:19 +0200
Subject: [PATCH] add more help on phpheader module, and fix typo

---
 inc/lib.improve.action.dcstore.php   |  2 +-
 inc/lib.improve.action.phpheader.php | 14 ++++++++-
 locales/fr/main.lang.php             | 43 +++++++++++++------------
 locales/fr/main.po                   | 47 +++++++++++++---------------
 4 files changed, 57 insertions(+), 49 deletions(-)

diff --git a/inc/lib.improve.action.dcstore.php b/inc/lib.improve.action.dcstore.php
index 994dd5d..c797052 100644
--- a/inc/lib.improve.action.dcstore.php
+++ b/inc/lib.improve.action.dcstore.php
@@ -46,7 +46,7 @@ class ImproveActionDcstore extends ImproveAction
         form::field('dcstore_pattern', 160, 255, $this->getPreference('pattern')) . '</label>' .
         '</p>' .
         '<p class="form-note">' . 
-        sprintf(__('You can use widcards %s'), '%author%, %type%, %id%, %version%.') . 
+        sprintf(__('You can use wildcards %s'), '%author%, %type%, %id%, %version%.') . 
         '<br /> ' .
         __('For exemple on github https://github.com/MyGitName/%id%/releases/download/v%version%/%type%-%id%.zip') . 
         '<br />' .
diff --git a/inc/lib.improve.action.phpheader.php b/inc/lib.improve.action.phpheader.php
index 78f6894..3d71254 100644
--- a/inc/lib.improve.action.phpheader.php
+++ b/inc/lib.improve.action.phpheader.php
@@ -13,6 +13,17 @@
 
 class ImproveActionPhpheader extends ImproveAction
 {
+    private static $exemple = "
+@brief %module_id%, a %module_type% for Dotclear 2
+
+@package Dotclear
+@subpackage \u%module_type%
+
+@author %module_author%
+
+@copyright %user_cn%
+@copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html";
+
     private $bloc_wildcards = [
         '%year%',
         '%module_id%',
@@ -90,7 +101,8 @@ class ImproveActionPhpheader extends ImproveAction
         sprintf(
             __('You can use wildcards %s') , 
             '%year%, %module_id%, %module_name%, %module_author%, %module_type%, %user_cn%, %user_name%, %user_email%, %user_url%'
-        ) . '<br />' . __('Do not put structural elements to the begining of lines.') . '</p>';
+        ) . '<br />' . __('Do not put structural elements to the begining of lines.') . '</p>' .
+        '<div class="fieldset box"><h4>' . __('Exemple') .'</h4><pre class="code">' . self::$exemple . '</pre></div>';
     }
 
     public function openModule(string $module_type, array $module_info): ?bool
diff --git a/locales/fr/main.lang.php b/locales/fr/main.lang.php
index 5a18019..c894a7e 100644
--- a/locales/fr/main.lang.php
+++ b/locales/fr/main.lang.php
@@ -1,7 +1,7 @@
 <?php
 // Language: Français 
-// Module: improve - 0.1
-// Date: 2021-09-11 20:59:33 
+// Module: improve - 0.1.1
+// Date: 2021-09-12 21:00:21 
 // Translated with dcTranslater - 2021.09.02.1 
 
 #inc/class.improve.php:77
@@ -14,7 +14,7 @@ $GLOBALS['__l10n']['File content has been removed: %s by %s'] = 'Le contenu du f
 $GLOBALS['__l10n']['Fix dcstore.xml'] = 'Fixer dcstore.xml';
 
 #inc/lib.improve.action.dcstore.php:21
-$GLOBALS['__l10n']['Re-create dcstore.xml file according to _define.php variables'] = 'Re-créer le fichier dcstore.xml suivant les variables du fichier _dephine.php';
+$GLOBALS['__l10n']['Re-create dcstore.xml file according to _define.php variables'] = 'Re-créer le fichier dcstore.xml suivant les variables du fichier _define.php';
 
 #inc/lib.improve.action.dcstore.php:43
 $GLOBALS['__l10n']['File will be overwritten if it exists'] = 'Le fichier sera réécrit si il existe';
@@ -23,7 +23,8 @@ $GLOBALS['__l10n']['File will be overwritten if it exists'] = 'Le fichier sera r
 $GLOBALS['__l10n']['Predictable URL to zip file on the external repository'] = 'URL prédictive du fichier zip sur le dépôt externe';
 
 #inc/lib.improve.action.dcstore.php:49
-$GLOBALS['__l10n']['You can use widcards %s'] = 'Vous pouvez utiliser les jokers %s';
+#inc/lib.improve.action.phpheader.php:102
+$GLOBALS['__l10n']['You can use wildcards %s'] = 'Vous pouvez utiliser les jokers suivants : %s.';
 
 #inc/lib.improve.action.dcstore.php:51
 $GLOBALS['__l10n']['For exemple on github https://github.com/MyGitName/%id%/releases/download/v%version%/%type%-%id%.zip'] = 'Par exemple sur github https://github.com/MyGitName/%id%/releases/download/v%version%/%type%-%id%.zip';
@@ -95,7 +96,7 @@ $GLOBALS['__l10n']['Add or remove full license file to module root'] = 'Ajoute o
 $GLOBALS['__l10n']['no version selected'] = 'aucune version selectionnée';
 
 #inc/lib.improve.action.licensefile.php:43
-#inc/lib.improve.action.phpheader.php:44
+#inc/lib.improve.action.phpheader.php:55
 $GLOBALS['__l10n']['Do nothing'] = 'Ne rien faire';
 
 #inc/lib.improve.action.licensefile.php:44
@@ -161,46 +162,43 @@ $GLOBALS['__l10n']['Add a blank line to the end of file'] = 'Ajouter une ligne v
 #inc/lib.improve.action.php:155
 $GLOBALS['__l10n']['PSR2 must have a blank line, whereas PSR12 must not.'] = 'PSR2 doit avoir une ligne vide, alors que PSR12 non.';
 
-#inc/lib.improve.action.phpheader.php:36
+#inc/lib.improve.action.phpheader.php:47
 $GLOBALS['__l10n']['Fix PHP header'] = 'Fixer les enêtes php';
 
-#inc/lib.improve.action.phpheader.php:37
+#inc/lib.improve.action.phpheader.php:48
 $GLOBALS['__l10n']['Add or remove phpdoc header bloc from php file'] = 'Ajouter ou supprimer les bloc d\'entête phpdoc des fichiers php';
 
-#inc/lib.improve.action.phpheader.php:45
+#inc/lib.improve.action.phpheader.php:56
 $GLOBALS['__l10n']['Add bloc if it does not exist'] = 'Ajouter les blocs si ils n\'existent pas déjà';
 
-#inc/lib.improve.action.phpheader.php:46
+#inc/lib.improve.action.phpheader.php:57
 $GLOBALS['__l10n']['Add and overwrite bloc'] = 'Ajouter et écraser les blocs';
 
-#inc/lib.improve.action.phpheader.php:47
+#inc/lib.improve.action.phpheader.php:58
 $GLOBALS['__l10n']['Overwrite bloc only if it exists'] = 'Ecraser les blocs seulement si ils existent';
 
-#inc/lib.improve.action.phpheader.php:48
+#inc/lib.improve.action.phpheader.php:59
 $GLOBALS['__l10n']['Remove existing bloc header'] = 'Retirer les blocs d\'entête existant';
 
-#inc/lib.improve.action.phpheader.php:72
+#inc/lib.improve.action.phpheader.php:83
 $GLOBALS['__l10n']['Action:'] = 'Action :';
 
-#inc/lib.improve.action.phpheader.php:78
+#inc/lib.improve.action.phpheader.php:89
 $GLOBALS['__l10n']['Remove old style bloc header (using #)'] = 'Supprimer les bloc d\'entête ancien (utilisant #)';
 
-#inc/lib.improve.action.phpheader.php:83
+#inc/lib.improve.action.phpheader.php:94
 $GLOBALS['__l10n']['Do not add bloc to files from "locales" and "libs" folder'] = 'Ne pas ajouter les blocs d\'entête aux fichiers des répertoires "locales" et "llibs"';
 
-#inc/lib.improve.action.phpheader.php:86
+#inc/lib.improve.action.phpheader.php:97
 $GLOBALS['__l10n']['Bloc content:'] = 'Contenu du bloc :';
 
-#inc/lib.improve.action.phpheader.php:91
-$GLOBALS['__l10n']['You can use wildcards %s'] = 'Vous pouvez utiliser les jokers suivants :';
-
-#inc/lib.improve.action.phpheader.php:93
+#inc/lib.improve.action.phpheader.php:104
 $GLOBALS['__l10n']['Do not put structural elements to the begining of lines.'] = 'Ne pas mettre d\'élément de structure en début de ligne';
 
-#inc/lib.improve.action.phpheader.php:153
+#inc/lib.improve.action.phpheader.php:165
 $GLOBALS['__l10n']['bloc is empty'] = 'le bloc est vide';
 
-#inc/lib.improve.action.phpheader.php:182
+#inc/lib.improve.action.phpheader.php:194
 $GLOBALS['__l10n']['failed to parse bloc'] = 'impossible de traiter le bloc';
 
 #inc/lib.improve.action.zip.php:42
@@ -295,4 +293,5 @@ $GLOBALS['__l10n']['Save fields selection as preference'] = 'Enregistrer la sél
 $GLOBALS['__l10n']['Select a module:'] = 'Sélectionner un  module :';
 
 #index.php:188
-$GLOBALS['__l10n']['Fix it'] = 'Corriger';
\ No newline at end of file
+$GLOBALS['__l10n']['Fix it'] = 'Corriger';
+
diff --git a/locales/fr/main.po b/locales/fr/main.po
index e045dcb..71a7f44 100644
--- a/locales/fr/main.po
+++ b/locales/fr/main.po
@@ -1,14 +1,14 @@
 # Language: Français
-# Module: improve - 0.1
-# Date: 2021-09-11 20:59:33
+# Module: improve - 0.1.1
+# Date: 2021-09-12 21:00:21
 # Translated with translater 2021.09.02.1
 
 msgid ""
 msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
-"Project-Id-Version: improve 0.1\n"
+"Project-Id-Version: improve 0.1.1\n"
 "POT-Creation-Date: \n"
-"PO-Revision-Date: 2021-09-11T20:59:33+00:00\n"
+"PO-Revision-Date: 2021-09-12T21:00:21+00:00\n"
 "Last-Translator: Jean-Christian Denis\n"
 "Language-Team: \n"
 "MIME-Version: 1.0\n"
@@ -29,7 +29,7 @@ msgstr "Fixer dcstore.xml"
 
 #: inc/lib.improve.action.dcstore.php:21
 msgid "Re-create dcstore.xml file according to _define.php variables"
-msgstr "Re-créer le fichier dcstore.xml suivant les variables du fichier _dephine.php"
+msgstr "Re-créer le fichier dcstore.xml suivant les variables du fichier _define.php"
 
 #: inc/lib.improve.action.dcstore.php:43
 msgid "File will be overwritten if it exists"
@@ -40,8 +40,9 @@ msgid "Predictable URL to zip file on the external repository"
 msgstr "URL prédictive du fichier zip sur le dépôt externe"
 
 #: inc/lib.improve.action.dcstore.php:49
-msgid "You can use widcards %s"
-msgstr "Vous pouvez utiliser les jokers %s"
+#: inc/lib.improve.action.phpheader.php:102
+msgid "You can use wildcards %s"
+msgstr "Vous pouvez utiliser les jokers suivants : %s."
 
 #: inc/lib.improve.action.dcstore.php:51
 msgid "For exemple on github https://github.com/MyGitName/%id%/releases/download/v%version%/%type%-%id%.zip"
@@ -136,7 +137,7 @@ msgid "no version selected"
 msgstr "aucune version selectionnée"
 
 #: inc/lib.improve.action.licensefile.php:43
-#: inc/lib.improve.action.phpheader.php:44
+#: inc/lib.improve.action.phpheader.php:55
 msgid "Do nothing"
 msgstr "Ne rien faire"
 
@@ -224,59 +225,55 @@ msgstr "Ajouter une ligne vide en fin de fichier"
 msgid "PSR2 must have a blank line, whereas PSR12 must not."
 msgstr "PSR2 doit avoir une ligne vide, alors que PSR12 non."
 
-#: inc/lib.improve.action.phpheader.php:36
+#: inc/lib.improve.action.phpheader.php:47
 msgid "Fix PHP header"
 msgstr "Fixer les enêtes php"
 
-#: inc/lib.improve.action.phpheader.php:37
+#: inc/lib.improve.action.phpheader.php:48
 msgid "Add or remove phpdoc header bloc from php file"
 msgstr "Ajouter ou supprimer les bloc d'entête phpdoc des fichiers php"
 
-#: inc/lib.improve.action.phpheader.php:45
+#: inc/lib.improve.action.phpheader.php:56
 msgid "Add bloc if it does not exist"
 msgstr "Ajouter les blocs si ils n'existent pas déjà"
 
-#: inc/lib.improve.action.phpheader.php:46
+#: inc/lib.improve.action.phpheader.php:57
 msgid "Add and overwrite bloc"
 msgstr "Ajouter et écraser les blocs"
 
-#: inc/lib.improve.action.phpheader.php:47
+#: inc/lib.improve.action.phpheader.php:58
 msgid "Overwrite bloc only if it exists"
 msgstr "Ecraser les blocs seulement si ils existent"
 
-#: inc/lib.improve.action.phpheader.php:48
+#: inc/lib.improve.action.phpheader.php:59
 msgid "Remove existing bloc header"
 msgstr "Retirer les blocs d'entête existant"
 
-#: inc/lib.improve.action.phpheader.php:72
+#: inc/lib.improve.action.phpheader.php:83
 msgid "Action:"
 msgstr "Action :"
 
-#: inc/lib.improve.action.phpheader.php:78
+#: inc/lib.improve.action.phpheader.php:89
 msgid "Remove old style bloc header (using #)"
 msgstr "Supprimer les bloc d'entête ancien (utilisant #)"
 
-#: inc/lib.improve.action.phpheader.php:83
+#: inc/lib.improve.action.phpheader.php:94
 msgid "Do not add bloc to files from \"locales\" and \"libs\" folder"
 msgstr "Ne pas ajouter les blocs d'entête aux fichiers des répertoires \"locales\" et \"llibs\""
 
-#: inc/lib.improve.action.phpheader.php:86
+#: inc/lib.improve.action.phpheader.php:97
 msgid "Bloc content:"
 msgstr "Contenu du bloc :"
 
-#: inc/lib.improve.action.phpheader.php:91
-msgid "You can use wildcards %s"
-msgstr "Vous pouvez utiliser les jokers suivants :"
-
-#: inc/lib.improve.action.phpheader.php:93
+#: inc/lib.improve.action.phpheader.php:104
 msgid "Do not put structural elements to the begining of lines."
 msgstr "Ne pas mettre d'élément de structure en début de ligne"
 
-#: inc/lib.improve.action.phpheader.php:153
+#: inc/lib.improve.action.phpheader.php:165
 msgid "bloc is empty"
 msgstr "le bloc est vide"
 
-#: inc/lib.improve.action.phpheader.php:182
+#: inc/lib.improve.action.phpheader.php:194
 msgid "failed to parse bloc"
 msgstr "impossible de traiter le bloc"