Module:Palette Dates/Documentation

La documentation pour ce module peut être créée à Module:Palette Dates/Documentation/doc

Erreur de script : Erreur Lua à la ligne 1 : unexpected symbol near '=='.

== Utilisation ==
Ce module contient quelques fonctions utilisées par le modèle {{m|Palette Années}} et autres modèles similaires. Tous les paramètres sont optionnels. Chaque fonction cherche ses paramètres :
* en priorité, dans l'appel de la fonction Lua, par exemple <br><code><nowiki>{{#invoke:Palette Dates | liste | date = 2022}}</nowiki></code> ;
* sinon, dans l'appel du modèle, par exemple <br><code><nowiki>{{Palette Années | date = 2022}}</nowiki></code> ;
* sinon, une valeur par défaut est utilisée, par exemple l'année actuelle.

Les espaces au début et à la fin des paramètres sont supprimées par [[MediaWiki]]. Si c'est indésirable, par exemple quand on spécifie des fragments pour la génération de liens, deux solutions sont possibles :
* soit enclore l'ensemble du paramètre entre apostrophes doubles, par exemple <br><code>après année = " en France"</code> ;
* soit remplacer les espaces par des blancs soulignés, qui sont traités comme les espaces dans les liens, par exemple <br><code>après année = _en France</code>.

== Fonctions ==
* <code>param_annee(frame)</code> – cherche la date dans les paramètres ''date'', ''année'', dans le ''premier argument'', dans le ''titre de l'article'' ou sinon utilise la ''date courante''. Retourne le numéro de l'année, ou une chaîne vide si la date ne représente pas une année. Voir la documentation de {{m|Palette Années}} pour le format de la date. <br>Exemple :<br><code><nowiki>{{#invoke:Palette Dates|param_annee|47 av. J.-C.}}</nowiki></code> <br>→ {{#invoke:Palette Dates|param_annee|47 av. J.-C.}}

* <code>mois(frame)</code> – génère un titre et une liste des mois. Outre les paramètres de param_annee(frame), utilise les paramètres ''mois'', ''titre mois'', ''préfixe'', ''avant mois'', ''après mois'', ''mm aa'' (où mm est le nom d'un mois, p. ex. Janvier, et aa est le numéro d'une année). Par compatibilité, la valeur par défaut de ''mois'' est ''non''.<br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|mois|1900|mois=oui|titre mois=}}</nowiki></code> <br>→ {{#invoke:Palette Dates|mois|1900|mois=oui|titre mois=}}

* <code>annees(frame)</code> – génère un titre et une liste d'années centrée sur la date spécifiée. Outre les paramètres de param_annee(frame), utilise les paramètres ''années'', ''titre années'', ''préfixe'', ''avant année'', ''suite année'', ''après année'', ''année nn'' (où nn est le numéro d'une année). <br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|annees|1900|titre années=}}</nowiki></code> <br>→ {{#invoke:Palette Dates|annees|1900|titre années=}}

* <code>decennies(frame)</code> – génère un titre et une liste de décennies centrée sur la date spécifiée. Outre les paramètres de param_annee(frame), utilise les paramètres ''décennies'', ''titre décennies'', ''préfixe'', ''avant décennie'', ''suite décennie'', ''après décennie'', ''décennie nn'' (où nn est le numéro d'une décennie). <br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|decennies|1900|titre décennies=}}</nowiki></code> <br>→ {{#invoke:Palette Dates|decennies|1900|titre décennies=}}

* <code>siecles(frame)</code> – génère un titre et une liste de siècles centrée sur la date spécifiée. Outre les paramètres de param_annee(frame), utilise les paramètres ''siècles'', ''titre siècles'', ''préfixe'', ''avant siècle'', ''suite siècle'', ''après siècle'', ''siècle nn'' (où nn est le numéro d'un siècle en chiffres romains). <br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|siecles|1900|titre siècles=}}</nowiki></code> <br>→ {{#invoke:Palette Dates|siecles|1900|titre siècles=}}

* <code>millenaires(frame)</code> – génère un titre et une liste de millénaires centrée sur la date spécifiée. Outre les paramètres de param_annee(frame), utilise les paramètres ''millénaires'', ''titre millénaires'', ''préfixe'', ''avant millénaire'', ''suite millénaire'', ''après millénaire'', ''millénaire nn'' (où nn est le numéro d'un millénaire en chiffres romains). <br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|millenaires|1900|titre millénaires=}}</nowiki></code> <br>→ {{#invoke:Palette Dates|millenaires|1900|titre millénaires=}}

* <code>liste(frame)</code> – génère la liste des années, décennies, siècles et millénaires. Outre les paramètres de param_annee(frame), utilise les paramètres de annees(frame), decennies(frame), siecles(frame), millenaires(frame). <br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|liste|1900}}</nowiki></code> <br>→ <br>{{#invoke:Palette Dates|liste|1900}}

* <code>mensuelle(frame)</code> – génère la liste des mois. Outre les paramètres de param_annee(frame), utilise les paramètres ''mensuelle'', ''préfixe'', ''avant mois'', ''après mois'', ''mm aa'' (où mm est le nom d'un mois, p. ex. Janvier, et aa est le numéro d'une année). Par compatibilité, la valeur par défaut de ''mensuelle'' est ''non''. Cette fonction est similaire à <code>mois(frame)</code>, sauf qu'elle utilise le paramètre ''mensuel'' au lieu de ''mois'', qu'elle ne génère pas de titre, et que le résultat est inclus dans un <code><nowiki><td></nowiki></code> pour pouvoir être intégré dans {{m|Palette Années}}.<br>Exemple : <br><code><nowiki>{{#invoke:Palette Dates|mensuelle|1900|mensuelle=oui}}</nowiki></code> <br>→ <br>{{#invoke:Palette Dates|mensuelle|1900|mensuelle=oui}}

Modules externes et autres éléments dont ce module a besoin pour fonctionner :
* <code>[[Module:Chiffres romains]]</code> – pour la conversion entre chiffres romains et chiffres arabes.

== Exemples ==
Pour des exemples et la signification des divers paramètres, voir la documentation du modèle {{m|Palette Années}}.

{{Projet Scribunto}}

<includeonly>
<!-- Catégories pour le module -->

</includeonly>