Module:Date républicaine/Documentation

Le module date républicaine permet la mise en forme de dates du calendrier républicain. Il est lié aux modèles {{date républicaine}} et {{date républicaine-}}.

Utilisation

Fonctions utilisables depuis un modèle

• date_republicaine(frame) – renvoie une chaîne de caractères présentant une date du calendrier républicain avec les liens les plus pertinents en respectant les conventions typographiques, et éventuellement la date du calendrier républicain correspondante.
• date_republicaine_sans_liens(frame) – renvoie une chaîne de caractères présentant une date du calendrier républicain en respectant les conventions typographiques, et éventuellement la date du calendrier républicain correspondante.

Fonctions utilisables depuis un autre module

• conversion_Gregorien(jour, mois, an) – renvoie les jours, mois et années dans le calendrier républicain à partir des jour, mois et année dans le calendrier grégorien.
• _date_republicaine(liens, {a1, a2, a3, a4}) – renvoie une chaîne de caractères présentant une date du calendrier républicain avec les liens les plus pertinents en respectant les convention typographiques (en paramètres : un booléen indiquant s'il faut faire des liens, et un table contenant une chaine de caractères avec une date du calendrier républicain en extension (« jour mois année », ou une chaîne de caractère par élément (« jour », « mois », « année »)).

Autres fonctions

• extraction_argument (argument, chaine) – extrait de « argument » une chaine de caractère correspondant au pattern « chaine » ainsi que des informations sur le mode d'affichage de l'élément (suivi de « - » : ne pas afficher ; suivi de « * », ne pas présenter de lien wiki pour cet élément), et renvoie argument délesté de cette chaîne.
• test_argument (argument) – analyse les paramètres fournis à la fonction _date républicaine(frame)
• annee_affichee(annee, lien_annee, libelle_an) – mise en forme de l'année (liens et typographie) composant une date du calendrier républicain.
• categorie_erreur (message) – mise en forme d'un message d'erreur avec insertion d'une catégorie de maintenance.

Modules externes dont ce module a besoin pour fonctionner

• Module:Date - mise en forme des dates du calendrier grégorien.
• Module:Chiffres romains - mise en forme des expressions contenant des chiffres romains.
• Module:Outils - bibliothèque d'outils.

Fonctionnement

La mise en forme et le paramétrage ont été définis en fonction des conventions typographiques et de l'usage de présentation des dates dans les articles.

Le frame reçu peut se présenter sous deux formes :

• avec séparateurs : {{date républicaine|jour|mois|année|(paramètre conversion optionnel)}} ;
• sans séparateurs : {{date républicaine|jour mois année|(paramètre conversion optionnel)}}.

Le module analyse crée une chaîne concaténant tous les paramètres qui ne contiennent pas « conversion ». Il est nécessaire que :

• l'année, si elle est fournie, soit en chiffres romains ; elle peut être précédée de « an » ou « de l'an », avec ou sans majuscule, les deux apostrophes sont acceptées ;
• l'orthographe du mois, si il est fourni, soit exacte aux accents près ;
• le jour, s'il est fourni, soit numérique.

Les liens créés suivent la même logique que le modèle date :

• pour le jour : [[jour mois]], sinon pas de lien ;
• pour le mois : [[mois année]], sinon [[mois]] (tous les mois ont un article) ;
• pour l'année : [[année]] (toutes les années ont un article).

Accessibilité :

• les nombres en chiffres romains sont dotés d'une infobulle donnant leur valeur en chiffres arabes.

Typographie :

• les éléments sont séparés par des espaces insécables ;
• les mois et année sont affichés avec une minuscule, sauf dans le cas où ils sont les premiers éléments de la chaîne de caractère renvoyée, auquel cas la casse retenue est celle fournie en entrée (cas où le mois ou l'année sont au début d'une phrase) ;
• le choix de l'apostrophe est laissé au rédacteur, le module restitue celle fournie en entrée.

Mode de sélection des éléments affichés :

• comme pour le module Date, la mention d'un « - » accolé à un élément permet d'en éviter l'affichage ;
• la mention d'un « * » accolé à un élément permet d'éviter l'affichage d'un lien pour cet élément (inutile pour le module Date_republicaine_sans_lien, mais ne provoque pas d'erreur).

Paramètre de conversion en date grégorienne (passage d'un élément contenant « conversion » ou « grégorien ») :

• séparateur :
  • par défaut, la présentation est de la forme « jj mois an NN (jj mois an) »,
  • en précisant « : » (« conversion: » ou « grégorien: »), la présentation est de la forme « jj mois an NN : jj mois an » ;
• affichage ou non des liens :
  • sa mention simple permet l'affichage de la date grégorienne correspondante entre parenthèses, avec les liens (équivalent du modèle {{date}}),
  • sa mention avec « * » fait la même chose sans liens (équivalent du modèle {{date-}}) ;
• sélection des éléments à afficher :
  • l'ajout d'une combinaison des lettres j, m et a (j : jour, m : mois, a : année) permet de sélectionner les éléments de la date grégorienne à afficher. Sans précision ou en précisant « jma » tout est affiché, en précisant « jm » seul le jour et le mois sont affichés, etc.

Exemples

Pour plus d'exemples, voir les pages de test des modèles date républicaine et date républicaine- permettant d'évaluer les modifications apportées.

• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire an II}} → 1^er vendémiaire an II
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire de l’an II}} → 1^er vendémiaire de l’an II
• {{#invoke:Date républicaine|date_republicaine_sans_liens|1er vendémiaire an II}} → 1^er vendémiaire an II
• {{#invoke:Date républicaine|date_republicaine|2 vendémiaire an II}} → 2 vendémiaire an II
• {{#invoke:Date républicaine|date_republicaine|2 vendémiaire an III}} → 2 vendémiaire an III
• {{#invoke:Date républicaine|date_republicaine|Vendémiaire an III}} → Vendémiaire an III
• {{#invoke:Date républicaine|date_republicaine|An III}} → An III
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire* an II}} → 1^er vendémiaire an II
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire an II-}} → 1^er vendémiaire
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire an II|grégorien}} → 1^er vendémiaire an II (22 septembre 1793)
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire an II|grégorien*}} → 1^er vendémiaire an II (22 septembre 1793)
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire an II|grégorien:}} → 1^er vendémiaire an II : 22 septembre 1793
• {{#invoke:Date républicaine|date_republicaine|1er vendémiaire an II|grégorien jm}} → 1^er vendémiaire an II (22 septembre)