Modèle:IndexJour/Documentation

Ceci est la sous-page de documentation du modèle {{IndexJour}} ; 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 tous les X jours (tous les jours par défaut), dont la valeur va de 0 à N-1 où N est le paramètre spécifié. Il sert à mettre à jour régulièrement certaines pages automatiquement.

Utilisation

{{IndexJour|nombre_total|multiplicateur|décalage|période|decalage=decalage_jours}}

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

( (({{IndexDate|aujourd'hui}}+decalage_jours)/période + décalage) * multiplicateur ) mod nombre_total

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

Paramètres non nommés

nombre_total

(obligatoire) Nombre total de pages. L'index généré va de 0 inclu à nombre_total exclu.

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 ...

décalage

(optionnel) Quantité ajoutée avant le modulo (0 par défaut).

période

(optionnel) Période de changement en nombre de jours (1 par défaut).

Paramètres nommés

decalage=decalage_jours

(optionnel) Nombre de jours de décalage pour la date. Permet d'avoir l'index d'un jour relatif à auhourd'hui.

Exemples

Pour un index sur 12 éléments qui change tous les jours :

{{IndexJour|12}}

11

Pour un index sur 10 éléments qui change tous les 7 jours :

{{IndexJour|10|1|0|7}}

9

Modèles liés

• {{IndexDate}} : Modèle utilisé pour le calcul de l'index du jour.
• {{IndexMensuel}} : Autre modèle pour un index qui change tous les mois.