Modèle:IndexMensuel/Documentation

Un livre de Wikilivres.
Sauter à la navigation Sauter à la recherche
Template doc page.svg
Ceci est la sous-page de documentation du modèle {{IndexMensuel}} ; elle est insérée sur la page de celui-ci à l’aide du modèle {{Documentation}}. C’est également sur cette page que vous placerez les liens interwiki et les catégories du modèle.

Ce modèle est utilisé pour générer un numéro de page à afficher qui change chaque mois, dont la valeur va de 0 à N-1 où N est le paramètre spécifié. Il sert à mettre à jour mensuellement certaines pages automatiquement.

Utilisation[modifier le wikicode]

{{IndexMensuel|nombre_total|multiplicateur|décalage}}

L'index généré est calculé selon la formule suivante :

( (année*12 + mois + décalage) * multiplicateur ) mod nombre_total

où mod représente le reste de la division.

Paramètres non nommés[modifier le wikicode]

nombre_total
(obligatoire) Nombre total de pages. L'index généré va de 0 à nombre_total inclus.
multiplicateur
(optionnel) Facteur par lequel l'index généré est multiplié (modulo nombre_total) pour modifier l'ordre de la séquence.
La valeur par défaut est 1, ce qui donne l'ordre normal des nombres : 0 1 2 3 ...
Si ce paramètre est spécifié, il ne doit avoir aucun facteur commun avec nombre_total.
Par exemple, multiplicateur=7 pour nombre_total=15 donnera comme séquence : 0 7 14 6 13 5 12 4 11 3 10 2 9 1 8 0 7 14 6 ...
décalage
(optionnel) Quantité ajoutée avant le modulo (0 par défaut).

Exemples[modifier le wikicode]

Pour un index sur 12 éléments :

{{IndexMensuel|12}}

10

Pour un index sur 10 éléments :

{{IndexMensuel|10}}

8

Modèles liés[modifier le wikicode]

  • {{IndexJour}} : Autre modèle pour un index qui change tous les X jours.