Module:RbpNote/Documentation
Aller à la navigation
Aller à la recherche
La documentation pour ce module peut être créée à Module:RbpNote/Documentation/doc
Erreur de script : Erreur Lua à la ligne 1 : unexpected symbol near '=='.
==Utilisation==
;Basique:
Vérifie la concordance du paramétrage article avec les paramètres répertoriés. Teste les doublons des alias.
:<code><nowiki>{{#invoke:RbpNote|verifier_parametres_</nowiki></code><br>
:<code><nowiki>|__configuration=;÷₦÷!¿__catégorie≈[[Catégorie:CATEGORIE]]<!--à adapter-->¿__modèle≈MODELE<!--à adapter-->¿__double_barre≈REFUS ou ADMIS<!--à adapter-->¿commentaire≈COMMENTAIRE ADAPTÉ</nowiki></code><br>
:<code><nowiki>|_parametres=PARAM1;PARAM2;...PARAMi;ALIASA;ALIASB;...;ALIASZ;...;PARAMn;</nowiki></code><br>
:<code><nowiki>|_P:PARAMi=<!-- ≈ -et pas = -->ALIASA;ALIASB;...;ALIASZ;PARAMi}}</nowiki></code>
Exemples: voir {{m|Notes}} {{m|Efn}}
==Paramètres développés==
===Principe===
:<code><nowiki>{{#invoke</nowiki>:RbpNote|verifier_parametres_|__configuration=''table-configuration-du-paramétrage''|_parametres=''table-paramètres-corrects-dans-l'article-plus-filtres''|_P:''paramètre''=''table-alias-corrects-pour-le-paramètre-plus-valeurs-cataloguées''}}</code>.<br>
La fonction de ce module affiche selon le besoin dans l'article les messages de non cohérence entre les paramètres qui ont été saisis dans l'appel au modèle; Traduit les paramètres non répertoriés, les doublons d'alias, les doublons fonctionnels, les liaisons hiérarchiques, les valeurs de paramètre non admises, et une mise en catégorie (cachée ou non) d'erreur répertoriant les articles défaillants est optionnelle. La logique de cohérence de paramétrage est codée dans le modèle associé au module, elle est mise dans des tables: configuration du modèle, paramètres, paramètre et ses alias.<br>
====table de configuration du modèle====
*(balises-délimeurs <nowiki>;÷₦÷!¿</nowiki> {{Efn|à ne pas toucher dans un modèle déjà en usage, sauf s'il apparait un gros problème (tuning) avec les libellés des messages générés. Substituer et configurer le modèle avec les nouvelles balises.|nom=a}})
*catégorie des articles en erreur:
:<code><nowiki>__catégorie≈[[Catégorie:la-catégorie-du-modèle]]¿</nowiki></code>
*libellé de ce modèle affiché dans la liste d'erreurs dans l'article
:<code><nowiki>__modèle≈identifiant-modèle¿</nowiki></code>
*traitement des paramètres non-nommés (positionnels)
:<code><nowiki>__double_barre≈option¿</nowiki></code>
::option "admis" si paramètres non nommés et nommés ou bien "refus" si uniquement paramètres à noms
*commentaire
:<code><nowiki>commentaire≈commentaire-explicatif</nowiki></code>
====table des paramètres====
Les paramètres utilisables dans un article sont répertoriés dans une table littérale:
:<code>|_parametres=''liste-des-paramètres-en-ordre-indifférent''</code>
*les paramètres sont séparés par “;”{{Efn|nom=a}}
*les paramètres ne doivent pas avoir d'espace avant et après eux.
;Un filtre concernant un paramètre est une option qui est inscrite comme un paramètre supplémentaire à la fin de la liste des paramètres déclarés.
C'est une table littérale inscrite dans la table. Le filtre s'écrit en ordonnant les paramètres de comparaison au paramètre particulier qui est mis en question:
:<code>_filtre:''paramètre-concerné-(item 1)''₦''message-complémentaire-à-afficher-si-doublon-fonctionnel-(item 2)''₦''paramètre-prééminent-1-(item 3)''₦''paramètre-prééminent-2-(item 4)''₦...</code>
*les paramètres considérés sont séparés par “₦”{{Efn|nom=a}}
*les paramètres ne doivent pas avoir d'espace avant et après eux
*premier item le paramètre remis en question
*deuxième item le message d'erreur de fonction en double à libellé sans “₦” ni “;”{{Efn|nom=a}}
*items suivant le deuxième paramètre recommandés par rapport au premier remis en question
*NB: finir par un ";"{{Efn|nom=a}} s'il y a un autre filtre ou une autre liaison qui suit.
;Une liaison "hiérarchique" concernant un paramètre est une option qui est inscrite comme un paramètre supplémentaire à la fin de la liste des paramètres déclarés.
C'est une table littérale inscrite dans la table. La liaison s'écrit en ordonnant les paramètres de dépendance hiérarchique{{Efn|La dépendance en arbre ou en réseau est décrite linéairement par la série de liaisons.|nom=b}} du paramètre particulier qui est mis en erreur si le lien de la séquence est brisé par l'absence du paramètre dont il dépend:
:<code>_liaison:''paramètre-concerné-(item 1)''₦''message-complémentaire-à-afficher-si-brisure-(item 2)''₦''paramètre-maître-1-(item 3)''₦''paramètre-maître-2-(item 4)''₦...</code>
*les paramètres considérés sont séparés par “₦”{{Efn|nom=a}}
*les paramètres ne doivent pas avoir d'espace avant et après eux
*premier item le paramètre remis en question
*deuxième item le message d'erreur de séquence hiérarchique{{Efn|nom=b}} brisée, sans “₦” ni “;”{{Efn|nom=a}}
*items suivant le deuxième paramètre indispensables (maîtres) par rapport au premier remis en question
*NB: finir par un ";"{{Efn|nom=a}} s'il y a un autre filtre ou une autre liaison qui suit.
====tables des alias====
Les alias sont mis en groupe dans chaque table littérale par paramètre principal clé concerné (celui suggéré à l'édition visuelle). Ils sont testés pour déterminer les doublons.
:<code>_P:''nom-du-paramètre-ayant-des-alias''= ''liste-des-alias-en-ordre-de-prééminence-terminée-par-le-paramètre-lui-même''</code>
*les alias sont séparés par “;”{{Efn|nom=a}}
*les alias ne doivent pas avoir d'espace avant et après eux.
;Un "écran" filtrant les valeurs concernant un paramètre clé est une option qui est inscrite comme un paramètre supplémentaire à la fin de la liste.
Deux options conjointes existent pour la vérification de valeur paramétrée admise, une pour une obtenir une valeur parmi un ensemble obligatoire et une pour éviter une valeur inappropriée. Ce sont deux tables littérales inscrites dans la table des paramètres-alias. <br>
:table catalogue des valeurs à choisir:
: <code>;_vobligatoire:''message-complémentaire-à-afficher-si-choix-incorrect-(item 1)''₦''valeur-possible-(item 2)''₦''valeur-possible-(item 3)''₦...₦''valeur-possible-(item n)''</code>
*NB: si cette table est suivie de celle des refus la terminer par “;”{{Efn|nom=a}}
:table catalogue des valeurs à refuser:
: <code>;_vrefus:''message-complémentaire-à-afficher-si-refus-(item 1)''₦''valeur-impossible-(item 2)''₦''valeur-impossible-(item 3)''₦...₦''valeur-impossible-(item n)''</code>
*NB: si cette table est suivie de celle des obligatoires la terminer par “;”{{Efn|nom=a}}
*les valeurs cataloguées dans chaque table sont séparées par “₦”{{Efn|nom=a}}
*les valeurs n'ont ni espace avant et arrière entre les virgules ni de virgule interne
*et l'ensemble des valeurs est précédé du message d'erreur dont le libellé n'a pas de “₦” ni de “;”{{Efn|nom=a}}.
==Code pour constituer un modèle==
Configurer éventuellement à partir de ce code et adapter:
:<code><nowiki>{{#invoke:RbpNote|verifier_parametres_
|__configuration=;÷₦÷!
¿__catégorie≈[[Catégorie:CATEGORIE]]
¿__modèle≈MODELE
¿__double_barre≈REFUS ou ADMIS
¿commentaire≈COMMENTAIRE
|_parametres=PARAM1;PARAM2;...;PARAMn;<!--filtre présent ensuite
-->filtre:PARAMx₦MESSAGEX₦PARAMa₦PARAMb₦...₦PARAMz;<!--; car autre filtre présent ensuite
-->_filtre:PARAMπ₦MESSAGEΠ₦PARAMα₦PARAMβ₦...₦PARAMω;<!--; car liaison présente ensuite
-->_liaison:PARAM£₦MESSAGE♦₦PARAM$₦PARAM€₦...₦PARAM¥
|_P:PARAMP=<!-- ≈ -et pas = -->ALIASA;ALIASB;...;ALIASZ;PARAMP;<!--catalogue refus présent ensuite
-->_vrefus:MESSAGE-REFUS-(LISTE-VALEURS-REFUSEES)₦REFUSA₦REFUSB₦...₦REFUSZ;<!--catalogue choix présent
-->_vobligatoire:MESSAGE-OBLIGATOIRE-(LISTE-VALEUR-A-CHOISIR)₦CHOIXA₦CHOIXB₦...₦CHOIXC
|_P:ETC=<!-- ≈ -et pas =-->BLA;BLI;BLO;ETC;<!--catalogue refus
-->_vrefus:MESSAGECSUR₦ah bon₦non₦peut-être;<!--; car catalogue choix présent ensuite
-->_vobligatoire:MESSAGECHADOK₦ga₦bu₦zo₦meu}}</nowiki></code>
<!--==Exemples==
Fabriqués avec la configuration suivante, voir plus de détails sur le modèle jeu-d'essai {{m|RbpNote/docdem}} qui appelle le module Lua RbpNote:
*parametres auteur;auteur1;nom1;prénom1;prénom2;lien auteur1;url;texte;nom;name;groupe;group;gr;
**auteur filtré selon auteur1,nom1,prénom1;
**auteur1 filtré selon nom1,prénom1,lien auteur1;
**prénom1 en dépendance de nom1;
**prénom2 en dépendance de nom1,prénom1
*groupe alias gr;group;groupe;
**valeurs refusées ref,Ref,référent,Référent,reference,Reference,référence,Référence
*nom alias name;nom
*auteur alias nom1;auteur1;auteur;
**valeurs obligatoires Tu,Vous;
**valeurs refusées Plus,Moins
<!--===Exemple de paramétrage correct===
; Le système modèle-module est dans ce cas «'' muet ''» pour la configuration du modèle de la documentation (RbpNote/docdem):
:<code><nowiki>{{RbpNote/docdem|texte=untexte|groupe=ungroupe|nom1=Vous|prénom1=Hector|prénom2=Jules|lien auteur1=Vous|url=http://cnrtl.fr/portail/}}</nowiki></code>
{{RbpNote/docdem|texte=untexte|groupe=ungroupe|nom1=Vous|prénom1=Hector|prénom2=Jules|lien auteur1=Vous|url=http://cnrtl.fr/portail/}}
<!--===Jeu d'essai des erreurs de paramétrage===
1/ avec expression de 3 groupes <code><nowiki>{{RbpNote/docdem|groupe=GROUPEOK|group=OUIGROUP|gr=GRRRR}}</nowiki></code>{{RbpNote/docdem|groupe=GROUPEOK|group=OUIGROUP|gr=GRRRR}}
---------- --><!--
2/avec un nom-id et un name déclarés <code><nowiki>{{RbpNote/docdem|name=UNIDDETROP|nom=monid}}</nowiki></code>{{RbpNote/docdem|name=UNIDDETROP|nom=monid}}
---------- --><!--
3/ (avec un double nom-id traité par la prévisu) et un invalide <code><nowiki>{{RbpNote/docdem|nom=monid|nom=encensoir|groupe=normal|loc=DANSLEVIDE}}</nowiki></code>{{RbpNote/docdem<!--|nom=monid- ->|nom=encensoir|groupe=normal|loc=DANSLEVIDE}}
---------- --><!--
4/ avec refus écran sur seulement gr=ref <code><nowiki>{{RbpNote/docdem|gr=ref}}</nowiki></code>{{RbpNote/docdem|gr=ref}}
---------- --><!--
5/ erreur avec valeur obligatoire sur patronyme nom1 <code><nowiki>{{RbpNote/docdem|nom1=nom-jeune-fils}}</nowiki></code>{{RbpNote/docdem|nom1=nom-jeune-fils}}
---------- --><!--
6/ avec filtre auteur1 et patronyme nom1 sur auteur <code><nowiki>{{RbpNote/docdem|auteur1=nom-jeune-fille|nom1=Vous|prénom1=Tu|auteur=flotteur}}
</nowiki></code>{{RbpNote/docdem|auteur1=nom-jeune-fille|nom1=Vous|prénom1=Tu|auteur=flotteur}}
---------- --><!--
7/ avec double_barre en refus parce que les paramètres positionnels ne sont pas admis<code><nowiki>{{RbpNote/docdem|nom1=Vous|}}</nowiki></code>{{RbpNote/docdem|nom1=Vous|}}
---------- --><!--
8/ mélange d'erreurs <code><nowiki>{{RbpNote/docdem|pataquès=àpoildru|group=Ref|groupe=unbongroupe|name=nominé|nom1=Vous|nom1=nomunpaspréférable|prénom2=prénomdeuxpaspréférable|auteur1=HUNS|auteur=flotteurs|nom=nmid|name=na!|}}</nowiki></code>{{RbpNote/docdem|pataquès=àpoildru|group=Ref|groupe=unbongroupe<!--|name=nominé--><!--|nom1=Vous- ->|nom1= nomunpaspréférable|prénom2=prénomdeuxpaspréférable|auteur1=HUNS|auteur=flotteurs|nom=nmid|name=na!|}}
-->
==Notes techniques==
{{Notes}}
{{Projet Scribunto}}
<includeonly>
[[Catégorie:Module en langage Lua]]
</includeonly>
