Module:Designation2/Documentation

La bibliothèque libre.
Documentation du module [voir] [modifier] [purger]
Ceci est la page de documentation du module Scribunto dont le code écrit en Lua est dans la page Module:Designation2 [historique].
Cette page n’est pas destinée à être visualisée directement. Les liens utilisant des pseudo-variables peuvent paraître rompus (en rouge) ; ne pas les remplacer par des noms de pages codés en dur ni des URL.

Le module:Designation (version 2) contient le code pertinent à des modèles servant à abréger des titres ({{Mgr}}, {{Mme}}...), des ordinaux ({{1er}}, {{2de}}…, IIe, XXe…) et toute autre abréviation mettant en exposant.

Exemples[modifier]

Ce code dans un modèle
{{#invoke:Designation2|Construire|un=M|deux=me|trois=Madame}}
donne
Mme
Au survol de « Mme », le mot « Madame » est affiché.


Ce code dans un modèle
{{#invoke:Designation2|Construire|un=M|deux=me|trois=Madame|r=sc}}
donne
Mme
Les lettres en exposant sont en petites capitales. Au survol de « Mme », le mot « Madame » est affiché.


Ce code dans un modèle
{{#invoke:Designation2|Construire|un=M|deux=me|trois=Madame|r=s}}
donne
Mme
Les lettres en exposant sont soulignées. Au survol de « Mme », le mot « Madame » est affiché.


Ce code dans un modèle
{{#invoke:Designation2|Construire|un=M.|deux=|trois=monsieur}}
donne
M.
Le paramètre deux est vide, ce que le module accepte. Au survol de « M. », le mot « monsieur » est affiché.
Les paramètres un, deux et trois peuvent être vides, mais doivent être nommés explicitement.

Paramètres dans l'appel de modèle[modifier]

Paramètres à passer au modèle :

  • <texte> (optionnel) : texte affiché à la suite du titre, les deux liés par une espace insécable

Paramètres dans le code du modèle[modifier]

Paramètres à passer au module (et non PAS au modèle) :

  • un=<texte> (obligatoire) : première partie de l'abréviation (peut être vide)
  • deux=<texte> (obligatoire) : deuxième partie de l'abréviation (peut être vide)
  • trois=<texte> (obligatoire) : message de l'infobulle (peut être vide)
  • r= (optionnel) : registre d'états, chaque état séparé par une virgule et autant d'espaces que souhaité (exemples : r=s, r=m, p,   nx)
    • m (état optionnel) : mettre en minuscule les lettres du paramètre un
    • p (état optionnel) : insérer un point (.) entre les paramètres un et deux
    • nx (état optionnel) : ne PAS mettre en exposant les lettres du paramètre deux
    • s (état optionnel) : souligner le texte du paramètre deux
    • sc (état optionnel) : mettre en petites capitales (small caps) les lettres du paramètre deux

Vecteur de test[modifier]

Voir Utilisateur:Cantons-de-l'Est/Module/Designation2