Module:Infobox/Fonctions/Documentation

Cette page contient des fonctions aidant à la création des modèles de type infobox. Elle utilise deux variables globales définies par Module:Infobox : localdata (les paramètres passés à l'infobox) et item la table Lua de l'élément Wikidata utilisé.

Fonctions exportables

title(icon, style, subtitleparam, subtitlequery, italic)

Retourne la barre de titre de l'infobox.

Paramètres de la fonction

Argument	Type	Description
icon	chaîne	pictogramme s'affichant à droite de la barre de titre. Voir les valeurs possibles dans le Projet pictogrammes des infobox
style	chaîne	paramètres html de style, si différents du style par défaut.
subtitleparam	chaîne?	???
subtitlequery	chaîne?	???
italic	chaîne?	???

Paramètre de l'infobox

Libellé	Paramètre	Wikidata	Description
	nom association_nom nom_think acronymelaboratoire titre		Texte à afficher dans la barre de titre de l'infobox. Par défaut c'est le libellé en français de l'élément wikidata lié à la page. En son absence, c'est le nom de la page Wikipédia. Exemples :

standardImage(imageType, imageparameters, property, upright)

Fonction destinée à être appelée par d'autres fonctions spécifiques à un type d'image et non pas directement pour créer une infobox. Elle permet de mettre en place les paramètres standard pour un type d'images donné. Par exemple si le type d'image vaut 'logo', les paramètres générés et utilisable dans l'infobox seront : légende logo, upright logo, taille logo et alternative logo.

Paramètres de la fonction

Argument	Type	Description
imageType	chaîne	Type de l'image à afficher. Par exemple :'logo'
imageparameters	table	Liste des paramètres à utiliser dans l'infobox. Par exemple : {'blason', 'sceau'}
property	chaîne	Propriétés wikidata qui seront utilisées par défaut en cas d'absence de paramètres dans l'infobox.
upright	nombre	Valeur par défaut du facteur de redimensionnement de l'image de l'intérieur.

mainimage(cat, defaultimage) ou mainimage(args, defaultimage)

Retourne l'image principale de l'infobox ; généralement c'est une photo.

Paramètres de la fonction

Argument	Type	Description
Première syntaxe
cat	chaîne	Catégorie à laquelle sera ajoutée la page contenant l'infobox si cette denière n'a pas d'image.
defaultimage	chaîne	Image à afficher en l'absence d'image fournie. Par exemple .
Deuxième syntaxe
args	tableau	tableau d'arguments qui peut contenir : defaultimage, upright, size, cat, altparameter, alt, defaultimagealt, wikidata,
defaultimage	chaîne?	???

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	image photo Photo	P18 (« imagetrue ») P5252 (« vue hivernaletrue »)	Fichier de l'image ou de la photographie à afficher dans l'infobox. Pour les « bâtiments récents » prennez en compte les règles exceptions au droit d'auteur. Exemples :
	légende image légende Légende	Qualificatif de l'image affichée : P2096 (« légende de médiatrue »)	Légende de l'image. Si l'image provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») de l'image, sinon il y a un risque d'incohérence. La légende ne s'affiche que si l'image s'affiche. Exemples : Pour l'Académie des Jeux floraux l'infobox est paramétrée avec : légende image = L’hôtel d'Assézat, où siège l’académie.
	upright		Facteur de redimensionnement de l'image. Utile en particulier lorsque l'image est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright = 0.5
	taille image		Largeur de l'image, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples : Pour AARP l'infobox est paramétrée avec : taille image = 150.
	alternative image	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Société d'outillage mécanique et d'usinage d'artillerie

interior(upright)

Retourne une représentation de l'intérieur de l'élément.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement de l'image de l'intérieur.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	intérieur interior	P5775 (« vue de l'intérieurtrue »)	Fichier de l'intérieur du lieu. Exemples :
	légende intérieur	P2096 (« légende de médiatrue ») de P5775 (« vue de l'intérieurtrue »)	Légende de l'illustration de l'intérieur. Si l'image provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») de l'image, sinon il y a un risque d'incohérence. La légende ne s'affiche que si le l'image s'affiche. Exemples :
	upright intérieur		Facteur de redimensionnement de l'image de l'intérieur. Utile en particulier lorsque l'image est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright intérieur = 0.5
	taille intérieur		Largeur de l'image de l'intérieur, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright intérieur est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative intérieur	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Hôtel Opéra Cadet

logo(upright)

Retourne le logo.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement du logo.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	logo association_logo	P154 (« image du logotypetrue »)	Fichier du logo à afficher dans l'infobox. Exemples :
	légende logo	P2096 (« légende de médiatrue ») de P154 (« image du logotypetrue »)	Légende du logo. Si le logo provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») du logo, sinon il y a un risque d'incohérence. La légende ne s'affiche que si le logo s'affiche. Exemples :
	upright logo		Facteur de redimensionnement du logo. Utile en particulier lorsque le logo est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright logo = 0.5
	taille logo		Largeur du logo, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright logo est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative logo	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Alternative textuelle à un logo

blason(upright)

Retourne le blason ou le sceau.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement du blason ou du sceau.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	blason sceau	P94 (« image du blasontrue ») P158 (« image du sceautrue »)	Fichier du blason ou du sceau à afficher dans l'infobox. Exemples :
	légende blason légende sceau	P2096 (« légende de médiatrue ») de P94 (« image du blasontrue ») ou P158 (« image du sceautrue »)	Légende du blason ou du sceau. Si le blason ou le sceau provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») du blason ou du sceau, sinon il y a un risque d'incohérence. La légende ne s'affiche que si le blason ou le sceau s'affiche. Exemples :
	upright blason upright sceau		Facteur de redimensionnement du blason ou du sceau. Utile en particulier lorsque le blason ou le sceau est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright blason = 0.5
	taille blason taille sceau		Largeur du du blason ou du sceau, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright blason est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative blason	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Hôtel Opéra Cadet

flag(upright, id)

Retourne le drapeau.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement du drapeau.
id	nombre	???

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	drapeau	P41 (« image du drapeautrue »)	Fichier du drapeau à afficher dans l'infobox. Exemples :
	légende drapeau	P2096 (« légende de médiatrue ») de P41 (« image du drapeautrue »)	Légende du drapeau. Si le drapeau provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») du drapeau, sinon il y a un risque d'incohérence. La légende ne s'affiche que si le drapeau s'affiche. Exemples :
	upright drapeau		Facteur de redimensionnement du drapeau. Utile en particulier lorsque le drapeau est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright drapeau = 0.5
	taille drapeau		Largeur du drapeau, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright drapeau est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative drapeau	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Affichage du pavillon de la garde côtière du Japon. et d'un texte alternatif

sign(upright)

Retourne la signalisation utilisée.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement du logo.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	signalisation	P14 (« symbole graphique de la voietrue »)	Fichier de la signalisation à afficher dans l'infobox. Exemples :
	légende signalisation	P2096 (« légende de médiatrue ») de P14 (« symbole graphique de la voietrue »)	Légende de la signalisation. Si la signalisation provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») de la signalisation, sinon il y a un risque d'incohérence. La légende ne s'affiche que si la signalisation s'affiche. Exemples :
	upright signalisation		Facteur de redimensionnement de la signalisation. Utile en particulier lorsque la signalisation est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright signalisation = 0.5
	taille signalisation		Largeur de la signalisation, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright signalisation est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative signalisation	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Alternative textuelle à un logo

icon(upright)

Retourne l'Icône.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement du logo.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	icône	P2910 (« icônetrue »)	Fichier de l'icône à afficher dans l'infobox. Exemples :
	légende icône	P2096 (« légende de médiatrue ») de P2910 (« icônetrue »)	Légende de l'icône. Si l'icône provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») de l'icône, sinon il y a un risque d'incohérence. La légende ne s'affiche que si l'icône s'affiche. Exemples :
	upright icône		Facteur de redimensionnement de l'icône. Utile en particulier lorsque l'icône est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright icône = 0.5
	taille icône		Largeur de l'icône, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright icône est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative icône	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Alternative textuelle à un logo

bathymetricmap(upright)

Retourne la carte carte bathymétrique d'un plan d'eau.

Paramètre de la fonction

Argument	Type	Description
upright	nombre	Valeur par défaut du facteur de redimensionnement du logo.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
	carte bathymétrique	P207 (« carte bathymétriquetrue »)	Fichier de la carte bathymétrique à afficher dans l'infobox. Exemples :
	légende carte bathymétrique	P2096 (« légende de médiatrue ») de P207 (« carte bathymétriquetrue »)	Légende de la carte bathymétrique. Si la carte bathymétrique provient de Wikidata, la légende doit être précisée dans le qualificateur P2096 (« légende de médiatrue ») de la carte bathymétrique, sinon il y a un risque d'incohérence. La légende ne s'affiche que si la carte bathymétrique s'affiche. Exemples :
	upright carte bathymétrique		Facteur de redimensionnement de la carte bathymétrique. Utile en particulier lorsque la carte bathymétrique est en mode portrait. Voir l'aide sur la mise en forme des images Exemples : upright icône = 0.5
	taille carte bathymétrique		Largeur de la carte bathymétrique, en pixels. L'utilisation de ce paramètre est déconseillée dans l'aide sur la mise en forme des images. Le paramètre upright carte bathymétrique est préférable. Valeur par défaut : 300 Valeur maximum : 315 Exemples :
	alternative carte bathymétrique	Voir la proposition de propriété alt text	Texte à afficher quand l'image ne peut l'être. Si l'image provient de Wikidata, le texte alternatif devrait être précisé dans un qualificateur de l'image, afin d'éviter un risque d'incohérence. Exemples : Alternative textuelle à un logo

selectSound(prop)

Sélectionne les sons de la propriété prop en français (qualificateur P407 (« langue de l'œuvre, du nom ou du termetrue ») à pour valeur Q150 (« françaistrue »))

Paramètre de la fonction

Argument	Type	Description
prop	texte	Propriété wikidata du type de son à afficher

prononciation()

Retourne un lecteur audio avec l'enregistrement de la prononciation.

Paramètre de la fonction

Argument	Type	Description
Cette fonction n'a aucun paramètre

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
prononciation	prononciation	P443 (« prononciation (fichier son)true »)	Fichier de la prononciation à afficher dans l'infobox. Exemples : De-Albert Einstein-Pronuciation.ogg
	légende prononciation		Légende affichée sous le lecteur audio Par défaut : Prononciation Exemples :

country()

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Pays	pays		Affiche le pays. Exemples :

wikidataDivRows(countryid)

Liste de lignes de divisions administrative basée sur des données de Wikidata

Arguments de la fonction

Argument	Type	Description
countryid	???	Permet de limiter la recherche quand le niveau Pays est atteint.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Division		P131 (« localisation administrativetrue ») Actuel	Recherche itérativement les divisions dans laquelle se trouve l'entité en se limitant à 3 niveaux ou si le niveau pays (countryid) est atteint. Exemple : Kulti, Rochebonne
		P31 (« nature de l’élémenttrue »)	Nom court[Information douteuse] de la division administrative

website(localparam)

Retourne le ou les meilleurs sites web.

Paramètre de la fonction

Argument	Type	Description
localparam	chaîne	Nom du paramètre à ajouter aux paramètres de l'infobox existants (site web, site_web, site officiel, site internet, web).

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Site web	site web site_web site officiel site internet web	P856 (« site officieltrue ») Qualificateur obligatoire : P407 (« langue de l'œuvre, du nom ou du termetrue ») Autres qualificateurs : P1001 (« ressort territorialtrue »)	URL du site internet. L'adresse doit être complète en commençant par http:// ou https://. Lorsque l'un des paramètres est utilisé il ne peut y avoir qu'un seul site. Lorsque des propriétés de Wikidata sont utilisées le ou les sites internet s'affichent en respectant les règles suivantes, dans l'ordre, jusqu'à ce qu'il soit possible de renvoyer quelque chose à afficher : les sites ayant un rang égal à deprecated ne sont jamais pris en compte. pour une catégorie de sites, ceux ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred. S'il y a au moins un site dont le qualificateur P407 (« langue de l'œuvre, du nom ou du termetrue ») est le français, seuls les sites en français sont renvoyés pour affichage. Sinon les sites dans les autres langues sont précédés du code de langue, par exemple (en) pour l'anglais et sont renvoyés pour affichage. Remarques : Normalement tous les P856 (« site officieltrue ») doivent avoir une P407 (« langue de l'œuvre, du nom ou du termetrue »). Lorsqu'un site s'affiche en plusieurs langues pour une même URL, P407 (« langue de l'œuvre, du nom ou du termetrue ») doit avoir la valeur Q20923490 (« multilinguetrue »). Ni la P580 (« date de débuttrue »), ni la P582 (« date de fintrue ») ne sont prises en compte pour sélectionner les sites à afficher. Exemples : Pour la règle 3 voir Conseil international de la danse. Pour la règle 4 voir Académie nationale des sciences d'Azerbaïdjan.
	nom site		Texte affiché pour le lien du site. Ce paramètre ne fonctionne que lorsque l'adresse est spécifiée par un paramètre. Exemples : nom site = site officiel

coordinates(moduleparams)

Paramètre de la fonction

Argument	Type	Description
moduleparams	table	liste des éléments mystérieux de cette table Modèle:Triste. maxdistance usage inconu, wikidataquery usage inconu, si le paramètre est vide est utilisé à la place. entity usage inconu, displayformat peut être forcé par le paramètre de l'infobox format coordonnées. Voir la desciption de ce paramètre pour plus de détails. displayinline peut être forcé par le paramètre de l'infobox coords en ligne. Usage inconnu, displaytitle peut être forcé par le paramètre de l'infobox coords en titre. Usage inconnu, globe peut être forcé par les paramètres de l'infobox globe et planète. Usage inconnu, latitude peut être forcé par le paramètre de l'infobox latitude. Latitude du point à afficher. Le format utilisé est soit en degrés au format décimal (par exemple : 16.74170), soit en degrés, minutes et secondes (par exemple : 16°44'29.88"N ou 16/44/29.88/N) longitude peut être forcé par le paramètre de l'infobox longitude. Longitude du point à afficher. Le format utilisé est soit en degrés au format décimal (par exemple : -92.62982), soit en degrés, minutes et secondes (par exemple : 92°37'47.28"O ou 92/37/47.28/O) fallbackquery requête de replis dans le cas où la requête standard ne renvoie rien. ...

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Coordonnées	coordonnées		Si coordonnées est égal à « - » ou « non » supprime l'affichage des coordonnées dans l'infobox. Exemples : coordonnées = -
	format coordonnées		Modifie le format d'affichage des coordonnées pour l'un des formats suivants : dms pour un affichage degré/minute/seconde, c'est à priori la valeur par défaut. dms long pour un affichage degré/minute/seconde avec l'orientation en toute lettres, dec pour un affichage décimal en degré Force la valeur du paramètre de la fonctiondisplayformat. Exemples : voir Format des coordonnées
	coords en ligne		L'utilisation est inconnue. Force la valeur du paramètre de la fonctiondisplayinline. Exemples :
	coords en titre		Permet d'afficher les coordonnées sur la droite de la ligne du titre de l'article et le code source mentionne : « par défaut : on met dans les coordonnées de l'infobox principale en titre » Force la valeur du paramètre de la fonctiondisplaytitle. Exemples :
	globe planète		L'utilisation complète est inconnue, mais permet d'afficher une autre carte que la Terre. Force la valeur du paramètre de la fonctionglobe. Par défaut on utilise notre bonne vielle Terre. Exemples :
	latitude		Latitude à afficher. Force la valeur du paramètre de la fonctionlatitude. Le format utilisé est soit en degrés au format décimal (par exemple : 16.74170), soit en degrés, minutes et secondes (par exemple : 16°44'29.88"N ou 16/44/29.88/N). Exemples :
	longitude		Longitude à afficher. Force la valeur du paramètre de la fonctionlongitude. Le format utilisé est soit en degrés au format décimal (par exemple : -92.62982), soit en degrés, minutes et secondes (par exemple : 92°37'47.28"O ou 92/37/47.28/O). Exemples :
	référence géolocalisation		Dans la documentation du modèle on trouve : « référence où l'on a trouvé ces coordonnées géographiques, à mettre entre <ref> </ref> ». Mais, semble-t-il sans utilisation. Exemples :
Il existe deux possibilités pour l'affichage d'une carte : des cartes utilisant la géolocalisation statique. en l'absence du paramètre géolocalisation, une carte dynamique. Dans les 2 cas les coordonnées sont définies par P625 (« coordonnées géographiquestrue ») ou les paramètres latitude et longitude. Dans le cas où le sujet de l'infobox n'existe plus, il faut vérifier si une carte actuelle est pertinent.
	géolocalisation		Carte utilisée pour afficher la géolocalisation du siège donnée par les latitude et longitude. Si géolocalisation=pas pertinent, les coordonnées sont affichées mais la carte ne l'est pas. Si géolocalisation=- ou géolocalisation=non, ni les coordonnées ni la carte ne sont affichées. Pour une utilisation standard de ce paramètre les cartes doivent être séparées par un « / ». Par exemple géolocalisation = Monde/Canada/Québec/Montréal. Le nombre de cartes semble être limité à 4 (non testé). Exemples : utilisation « classique » :Agence mondiale antidopage Suppression de la géolocalisation.