Module:Démographie/Documentation

Note : ce module est protégé et utilisé sur de nombreux articles. Vous pouvez pour ce faire utiliser Module:Démographie/Bac à sable dont le code est identique. Une page testant le résultat de ce module de test se trouve ici : Discussion module:Démographie/Bac à sable/Documentation.

Utilisation

Fonctions exportables :

• demographie(frame) – génère une table de années / population avec diverses options et contrôles
• charte_de_couleur(frame) – retourne un code couleur HTML en fonction du nom de charte désiré et du nom de couleur

Fonction directement utilisable depuis un autre module :

• demographie_m(param) − fonction identique à la précédente (en fait la précédente appelle celle-ci), mais utilisable depuis un autre module. La table param contient les mêmes paramètres (en version sans accent et "-" remplacés par "_" : par ex. "années-fond" → "annees_fond")

charte_de_couleur

Cette fonction ne doit plus être utilisée (si elle l'a été). Désormais c'est Module:Chartes qu'il faut utiliser pour cela.
La fonction reste présente le temps de s'assurer qu'elle n'est pas utilisée.

Cette fonction attend deux paramètres nom nommés : nom et code.

• nom : peut valoir « communes » ou « communes contraste ». Si une valeur différente est fournie la couleur #FFFFFF est retournée
• code : peut valoir canton, région… (voir table p.chartes). Si une valeur inconnue est fournie retourne la couleur associée à « défaut »

Code : pas de difficulté particulière.
Mise à jour : probablement uniquement modifier le contenu de la table p.chartes.

demographie

Cette fonction génère un tableau pour mettre en forme des séries de "année = population", avec diverses fonctionnalités.
Voir la documentation du modèle pour son utilisation.

Description des fonctions internes :

• p.erreur(message, cle) : enregistre une erreur (un message en clair et une clé de tri pour la catégorie). Ces erreurs sont exploitées à la fin, soit pour insertion en catégorie soit pour insertion en texte (selon le namespace)
• p.lit_parametre(nom) : lit la valeur du paramètre nommé nom passé lors de l'appel au modèle, ou nil si inexistant
• p.couleur(nom) : ajoute un "#" au début de la chaîne nom si non présent → fonction supprimée car devenue inutile
• p.sans_nl(texte) : supprime l'éventuel <br/> en début de texte

Déroulement du code de p.demographie() :

• lecture de la valeur de tous les paramètres référencés (table p.parametres)
• gestion de toutes les valeurs par défaut pour les paramètres récupérés (et gestion des valeurs invalides)
• récupération des paramètres non nommés (qui correspondent aux années. Ex. : 1990=xxxx) dans un table. Par la même occasion vérification qu'il n'y a pas de paramètre nommé qui ne corresponde à rien.
• tri de cette table pour ordonner les années (les paramètres non nommés n'ont pas d'ordre).
• parcours de la table triée pour générer la structure du tableau final (lignes / colonnes).
• ouverture du div général
• boucle de parcours sur les lignes à générer
  • ouverture du tableau (et gestion du titre selon les cas)
  • parcours des colonnes pour créer les années
  • parcours des colonnes pour créer les valeurs de population correspondante
  • fermeture du tableau
• gestion des éléments insérés en pied de tableau :
  • notes
  • sources
  • sansdoublescomptes et enquêteannuelle
  • liste des erreurs, éventuellement (si pas espace encyclopédique)
• insertion éventuelle des catégories d'erreur (si espace encyclopédique)
• fermeture du div général

La fonction détecte les paramètres invalides, à l'exception de ceux commençant par « _ ». Cette exception sert aux modèles {{Tableau population}} et {{Tableau population d'article de commune de France}} (ainsi que {{Tableau population d'article de commune de France/case année}}), qui appellent Module:Démographie avec un nombre fixe de paramètres (voir cette discussion).