« Module:Date/Documentation » : différence entre les versions

Contenu supprimé Contenu ajouté
Création
 
Aucun résumé des modifications
Ligne 1 :
== Utilisation ==
=== Fonctions exportablesutilisables depuis un modèle === :
* <code>fonctionmodeleDate(frame)</code> – descriptionaffiche (courteune descriptiondate deavec <code>fonction(frame)</code>les etliens autresles informationsplus pertinents (précisions pertinentesci-dessous).
* <code>modeleInscriptionDate(frame)</code> – affiche une date correctement formatée, sans lien. l'année est obligatoire. Paramètres nommés année, mois, jour. (utilisé par module Biblio)
* <code>fonction2()</code> – description2 (courte description de <code>fonction2()</code> et autres informations pertinentes).
* <code>dateISO(frame)</code> – similaire à modeleInscriptionDate mais la date est au format aaaa-mm-jj. Paramètres nommés année, mois, jour.
* <code>dateRepublicain(frame)</code> – affiche une date grégorienne au format républicain (sans liens). Paramètres 1=année, 2=mois, 3=jour.
* <code>modeleAge(frame)</code> - retourne l'age (nombre d'année) depuis une date ou entre deux dates. Paramètres 1=année, 2=mois, 3=jour, 4=année, 5=mois, 6=jour.
* <code>erreurModuleData()</code> - retourne un message d'erreur si Module:Date/Data ne se charge pas correctement.
* <code>checkDataCat(frame)</code> - retourne une liste de page annuelle et mensuelle pour facilité les mises à jour de Date/Data. Paramètres 1=cat, mois=liste de mois si 'oui', alias = liste tous les alias si 'oui'
 
=== fonction utilisable depuis un autre module ===
Autres fonctions :
* <code>fonctionnomDuMois( num )</code> – description2retourne (courtele descriptionnom defrançais du mois n° <code>fonction()num</code> et autres informations pertinentes).
* <code>valideMois( mois )</code> – retourne le nom français et le n° de <code>mois</code> (nom français, abrégé, anglais, ou nombre entre 1 et 12).
* <code>determinationMois( mois, frame )</code> - similaire à valideMois, mais le numéro du mois n'est pas limité (14 → février), et peut même être une expréssion si un objet frame est fourni ( 6 + 3 → septembre )
* <code>do_dayRank(arguments)</code> - Rang du jour dans l'année. Paramètre arguments = { année, mois, jour } ou { year = année, month = mois, day = jour }
* <code>isLeapYear(year)</code> - retourne true si year est une année bisextile dans le calendrier grégorien.
* <code>toRoman(number)</code> - transforme number en une chaine le représentant en « [[chiffres romains]] ».
* <code>age( an, mn, jn, ac, mc, jc )</code> - similaire à modeleAge, mais les paramètres ne sont pas dans une table
* <code>julianDay( year, month, day, hour, minute, second )</code> - retourne le [[jour julien]] de la date transmise, suivant le [[Calendrier grégorien proleptique|calendrier grégorien astronomique]] (avec année 0)
* <code>julianDayJulian( year, month, day, hour, minute, second )</code> - retourne le [[jour julien]] d'une date du [[Calendrier julien proleptique|calendrier julien astronomique]] (avec année 0)
* <code>jullianDayToGregorian( jd )</code> - retourne trois variable année, mois, jour représentant la date du [[Calendrier grégorien proleptique|calendrier grégorien astronomique]] correspondant à ce jour julien.
* <code>jullianToGregorian( year, month, day )</code> - transforme une date du calendrier julien en date du calendrier grégorien.
 
Modules externes et autres éléments dont ce module a besoin pour fonctionner :
* <code>Date/Data</code> - Base de donnée permettant de ne pas tester les pages que l'on sait existante, ou n'existant pas.
* <code>mw.title</code> – description (courte description expliquant la dépendance de ce module externe).
* <code>TableBuilder</code> – Utilise <code>.insert</code> et <code>.concat</code> pour simplifier la syntaxe.
 
== ExemplesmodeleDate( frame ) ==
=== Paramètres ===
Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.
* <code>1</code> - jour ou vide - numérique, exeption possible pour 1er ou {{1er}}.
* <code>2</code> - mois ou jour - numérique ou nom français ou anglais, éventuellement une abréviation courante.
* <code>3</code> - année ou mois - Un nombre sera considéré comme année. Les années sont considérées comme suivant le calendrier grégorien depuis le 14 octobre 1582 (sauf si julien = 'oui') et le calendrier julien auparavant, sans année 0.
* <code>4</code> - qualificatif ou année - texte correspondant à une page type « en photographie » pour « [[2008 en photographie]] »
* <code>5</code> - qualificatif
* <code>age</code> ou <code>âge</code> - non vide pour afficher l'age (aucun age n'est affiché pour les date dans le futur)
* <code>julien</code> - 'oui' pour que la date soit considérée suivant le calendrier julien après le 14 otobre 1582. La date sera affiché suivant les deux calendrier.
* <code>avJC</code> - 'non' pour ne pas affiché 'av. J.-C.' après l'année si elle représente une année anvant Jésus Chirst. Utile pour éviter les répétitions.
<!--
* <code>paramètres page</code> - Si un modèle date contient ce paramètre, et les paramètre <code>julien</code>, <code>avJC</code> et <code>qualificatif</code> seront appliqué à toutes les dates de la page, sauf si une autre valeur de ces paramètres est indiquée.
* <code>qualificatif</code> - qualificatif a appliquer sur toute la page, en liaison avec le paramètre <code>paramétres page</code>
-->
 
=== fonctionnement ===
== Fonction modeleDate comparée aux modèles existant ==
* Le modèle cherche à afficher la date avec des liens vers les pages liè au qualificatif. s'il n'y a pas de page lié au qualificatif un lien sera fait vers la page générale.
* le premier paramètre est vide et le troisième correspond à un mois (texte uniquement), tous les paramètres sont considérés comme décalé et l'année ne sera pas affichée.
* S'il n'y a pas de page spécifique pour ce mois-année, le mois sera affiché liè avec le jour à l'éphéméride. Priorité est donné à l'éphéméride du qualificatif sur le lien mois-année sans qualificatif.
* Le modèle s'aide de la base de donnée [[Module:Date/Data|Date/Data]] pour éviter d'utiliser la fonction mw.title (équivalent du parser #ifexist:).
* Cette base permet de remplacer le qualificatif par une catégorie plus générique. Si le qualificatif est « en tennis », l'éphéméride et la page mensuelle sera liè au qualificatif « en sport ».
 
 
=== Fonction modeleDate comparée aux modèles existant ===
=== Comparaison avec {{m|date}} ===