Module:Infobox/Fonctions/Logiciel/Documentation

Cette page réunit des fonctions qui peuvent être réutilisées pour construire des modules d'infobox visant à décrire un logiciel. Sauf mention contraire, les fonctions utilisent des données fournies en paramètre dans l'article, ou alors, lorsque celles-ci sont absentes, des données issues de Wikidata.

Qualificatifs temporels

Certaines valeurs ne sont valables qu'à une certaine date ou pour une période donnée. Ces informations sont ajoutées aux propriétés de l'élément en tant que qualificateurs. Ces informations :

• apparaîtrons, éventuellement, entre parenthèse après la valeur de la propriété,
• permettront de trier chronologiquement les valeurs affichées,
• de n'afficher que la valeur actuelle d'une propriété.

Les qualificatifs temporels sont : P585 (« date »), P580 (« date de début ») et P582 (« date de fin »).

Fonctions exportables

p.readFormats()

Affiche les formats de fichiers ou de flux de données lus ou importés par le logiciel.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Formats lus	importe	P1072 (« format de fichier pouvant être lu ») P582 (« date de fin »)	Formats de fichiers ou de flux de données lus ou importés par le logiciel. Lorsque des propriétés de Wikidata sont utilisées le ou les formats s'affichent en respectant les règles suivantes, dans l'ordre, jusqu'à ce qu'il soit possible de renvoyer quelque chose à afficher : les formats qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte. les formats ayant un rang égal à deprecated ne sont jamais pris en compte. pour une catégorie de formats, ceux ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred. Exemples : Pour Adobe Photoshop, un des formats lus est [[JPEG]]

p.writtenFormats()

Affiche les formats de fichiers ou de flux de données écrits ou exportés par le logiciel.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Formats écrits	exporte	P1073 (« format de fichier pouvant être écrit ») P582 (« date de fin »)	Formats de fichiers ou de flux de données écrits ou exportés par le logiciel. Lorsque des propriétés de Wikidata sont utilisées le ou les formats s'affichent en respectant les règles suivantes, dans l'ordre, jusqu'à ce qu'il soit possible de renvoyer quelque chose à afficher : les formats qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte. les formats ayant un rang égal à deprecated ne sont jamais pris en compte. pour une catégorie de formats, ceux ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred. Exemples : Pour Adobe Photoshop, un des formats exportés est [[JPEG]]

p.documentation()

Affiche le lien vers la documentation du logiciel.

Paramètres de l'infobox

Libellé	Paramètres	Wikidata	Description
Documentation	documentation	P2078 (« lien vers le mode d'emploi ») P582 (« date de fin »)	URL de la documentation du logiciel. L'adresse doit être complète en commençant par http:// ou https://. 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 qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte. 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. Exemples : Pour darktable, le lien vers la documentation est https://www.darktable.org/usermanual/index.html.php

p.mainimage(cat, defaultimage)

Affiche une illustration du logiciel. Généralement, il s’agit d’une capture d’écran.

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ètre	Wikidata	Description
	image photo Photo	P18 (« image »)	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édia »)	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.
	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 :

p.logo(upright)

Affiche le logo du logiciel.

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ètre	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 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

p.title()

Retourne le titre de l’infobox.

Paramètres 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 :

p.website(localparam)

Retourne le site web du logiciel.

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ètre de l'infobox

Libellé	Paramètre	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