Module:Population de France/Documentation

Utilisation

Voir Discussion module:Population de France/Données pour une description du format des données.

Fonctions exportables :

• tableau(frame) – génère un tableau de population pour la commune (article courant ou paramètre « nom ») à partir des données de population stockés dans "Module:Données/NOM-COMMUNE/évolution population" (ou dans "Modèle:Données/NOM-COMMUNE/évolution population" si le premier n'existe pas). Les seuls paramètres sont nom (le nom de la commune, sinon SUBPAGENAME) et titre (utilisé pour surcharger le titre par défaut
• introduction(frame) – génère une introduction pour la commune (article courant ou paramètre « nom », seul paramètre)
• graphique(frame) – génère un graphique de population pour la commune (article courant ou paramètre « nom », seul paramètre avec « titre », plus « seuil », voir plus bas).
• densite(frame) – retourne la densité de population. Les paramètres sont « nom » (le nom de la commune, page courante si absent) ; « précision » (nombre) indique le nombre de chiffres après la virgule. Si « format » est présent et non vide le nombre retourné est mis en forme via formatNum
• variation_texte(frame) – retourne une phrase décrivant la variation de population sous la forme « en augmentation/diminution de XXX % par rapport à AAAA ». Les paramètres sont « nom » (le nom de la commune, page courante si absent) et « type ». Si ce dernier vaut « picto » la fonction retourne juste un symbole (augmentation/diminuation) avec la phrase indiquée en infobulle.
• derniere_population(frame) – retourne l'année ou la population correspondant aux données les plus récentes. Les paramètres sont « nom » (le nom de la commune, page courante si absent) et « type ». Si « type » vaut « date » l'année est retournée. S'il vaut vide (ou absent) la population est retournée, sans formatage, et s'il vaut « nombre » la population est retournée, formatée via fomatNum.

Fonctions utilisables depuis un autre module :

• tableau_m(param) – fonction identique à la précédente (la précédente appelle celle-ci) mais appelable directement depuis un autre module. Les seuls paramètres sont nom (le nom de la commune, sinon SUBPAGENAME) et titre (utilisé pour surcharger le titre par défaut)
• introduction_m(param) – fonction identique à la précédente (la précédente appelle celle-ci) mais appelable directement depuis un autre module. Le seul paramètre est nom (le nom de la commune, sinon SUBPAGENAME)
• graphique_m(param) – fonction identique à la précédente (la précédente appelle celle-ci) mais appelable directement depuis un autre module. Les paramètres sont nom (le nom de la commune, sinon SUBPAGENAME), titre (utilisé pour surcharger le titre par défaut), et seuil qui fixe le nombre minimal de valeurs pour afficher un graphique (en dessous de cette valeur l'appel ne fait rien) (valeur par défaut : 5)
• derniere_population_m(param) – fonction identique à la précédente (la précédente appelle celle-ci) mais appelable directement depuis un autre module. Les seuls paramètres sont nom (le nom de la commune, sinon SUBPAGENAME) et type (le type de données demandé)
• densite_m(param) – fonction identique à la précédente (la précédente appelle celle-ci) mais appelable directement depuis un autre module. Les paramètres sont nom (le nom de la commune, sinon SUBPAGENAME), précision (le nombre de décimales) et format (si non vide formatage du nombre avec formatNum)
• variation_texte_m(param) – fonction identique à la précédente (la précédente appelle celle-ci) mais appelable directement depuis un autre module. Les paramètres sont nom (le nom de la commune, sinon SUBPAGENAME) et type (si vaut "picto" retourne un symbole d'augmentation/diminution avec le texte en infobulle)

Modules et modules externes dont ce module a besoin pour fonctionner :

• Module:Démographie – utilisé pour la construction de la table des populations
• Module:Chartes − utilisé pour la charte de couleur (fond des années et des graphiques)
• Modèle:Histogramme population manuel − utilisé pour générer les graphiques de population (existe-t-il un module ?)

Sous-modules (modules dédiés utilisés pour alléger le code et regrouper par thématique certaines parties) :

• Module:Population de France/Constantes − contient les données constantes du module (textes, noms de catégories…)
• Module:Population de France/Sources − contient les fonctions utilisées pour générer les sources présentées par les fonctions du module principal
• Module:Population de France/Notes − contient les fonctions utilisées pour générer les notes présentées par les fonctions du module principal
• Module:Population de France/Données − contient les fonctions de chargement, de traitement et de manipulation des données de population
• Module:Population de France/Outils − contient diverses fonctions non rangées sans les autres sous-modules (par ex. génération de messages d'erreur, arrondi…)
• Module:Population de France/Introductions − contient les fonctions chargées de générer les textes d'introduction selon le type de division.