Module:Population de France/Outils

 Documentation[voir] [modifier] [historique] [purger]

Utilisation

Contient diverses fonctions utilisées dans le module principal et certains sous-modules :

• p.dump(t, level) : debug. Affiche dans la console le contenu d'une table (récursivement). Ne pas utiliser en prod.
• p.round(val, dp) : arrondi val à dp décimale(s)
• p.color2rgb(color) : transforme une couleur color de la forme #RRVVBB à la forme rgb(r, v, b) (utilisé pour l'appel au modèle {{Histogramme population manuel}})
• p.err_nodata(fonc, donnees, err, court) : retourne un message d'erreur pour la fonction fonc, vis-à-vis du module de données donnees, avec le type d'erreur err. Si court est vrai (true) la version courte est retournée.
• p.test_annee(annee, data) : retourne vrai (true) si l'année annee est à utiliser dans lestableaux et graphiques (selon les règles définies pour les affichages)
• p.liste_annees(data) : retourne la liste des années ayant une référence, pour l'entité dont les données sont dans data. Cette liste prend la forme : pour les années [ref1 année1], [ref2 année2], … [refX annéeX] et [refY annéeY]. Utilisé pour les notes associées à certains textes.
• p.liste_annees_pred(data, annee) : retourne la liste des années qui précèdent annee et qui ont une référence associée, de 5 en 5, par ordre croissant, pour l'entité dont les données sont dans data. Retourne en seconde valeur le nombre d'éléments retournés.

La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.

--[[
  Sous-module de Module:Tableau population d'article de commune de France contenant
  diverses fonctions utilitaires (non classées dans les autres catégories)
--]]

local p = {}

-- il nous faut les constantes
p.constantes = require("Module:Tableau population d'article de commune de France/Constantes")


-- retourne un message d'erreur "pas de données" ('donnees' est le nom du modèle/module cherché)
function p.err_nodata(fonc, donnees)
	-- pas de données (ni module ni modèle) : erreur
	local cat = p.constantes.cat_usage
	if (ttl.namespace == 0) then
		cat = cat .. p.constantes.cat_errdata
	end
	return mw.ustring.format(p.constantes.err_data, fonc, donnees) .. cat
end

-- retourne un message d'erreur "données invalides" ('donnees' est le nom du modèle/module utilisé)
function p.err_baddata(fonc, donnees)
	-- données invalides : erreur
	local cat = p.constantes.cat_usage
	if (ttl.namespace == 0) then
		cat = cat .. p.constantes.cat_errdata
	end
	return mw.ustring.format(p.constantes.err_cont, fonc, donnees) .. cat
end


return p