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?	???
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 :

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?	???
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 (« image ») P5252 (« vue hivernale »)	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	P2096 (« légende de média ») de P18 (« image ») P2096 (« légende de média ») de P5252 (« vue hivernale »)	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édia ») 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.

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 logotype »)	Fichier du logo à afficher dans l'infobox. Exemples :
	légende logo	P2096 (« légende de média ») de P154 (« image du logotype »)	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édia ») 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 = 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 :

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) »)	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 Exemples : Par défaut : Prononciation

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 officiel ») Qualificateur obligatoire : P407 (« langue de l'œuvre, du nom ou du terme ») Autres qualificateurs : P1001 (« ressort territorial »)	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 terme ») 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 officiel ») doivent avoir une P407 (« langue de l'œuvre, du nom ou du terme »). Lorsqu'un site s'affiche en plusieurs langues pour une même URL, P407 (« langue de l'œuvre, du nom ou du terme ») doit avoir la valeur Q20923490 (« multilingue »). Ni la P580 (« date de début »), ni la P582 (« date de fin ») 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