Module:Infobox/Fonctions/Logiciel/Documentation

Une page de Wikipédia, l'encyclopédie libre.

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[modifier le code]

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[modifier le code]

p.programmingLanguage(disableCat)[modifier le code]

p.programmingLanguagesSupported()[modifier le code]

p.internationalisation(nbmax)[modifier le code]

p.developmentStart()[modifier le code]

p.versionsNavbox()[modifier le code]

p.firstVersion()[modifier le code]

p.lastStableVersion()[modifier le code]

p.advancedVersion()[modifier le code]

p.softwareType()[modifier le code]

p.creator()[modifier le code]

p.developer()[modifier le code]

p.license()[modifier le code]

Affiche la ou les licences du logiciel. Si la licence dispose d’un identifiant SPDX, c’est celui-ci qui est affiché plutôt que le libellé de l’élément Wikidata de la licence.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Licence
Licences
licence
licences
P275 (« licence »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
P2479 (« identifiant SPDX ») (sur l’élément de la licence)
Licences du logiciel.
Une erreur fréquente est d’utiliser un nom générique de licence plutôt que de préciser sa version précise (par exemple « GPL » au lieu de « GPL-2.0 ») : il faut bien préciser la version de la licence utilisée.

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 :

  1. les valeurs qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les valeurs ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie de valeurs, celles ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred.

Lorsque la licence utilisée dispose d’un identifiant SPDX, c’est ce dernier qui est affiché plutôt que le libellé de la licence.
Exemples :
Pour Inkscape, la licence est [[GPLv2|GPL-2.0]]

p.repository()[modifier le code]

Affiche le lien vers le dépôt de code source de ce logiciel.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Dépôt
Dépôts
dépôt P1324 (« dépôt du code source »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
Lien vers le dépôt de code source de ce 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 :

  1. les valeurs qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les valeurs ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie de valeurs, celles ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred.

Exemples :
Pour OpenVPN, le dépôt de code source est https://gitlab.com/openvpn/openvpn

p.qualityAssurance()[modifier le code]

Affiche l’assurance qualité de ce logiciel.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Assurance qualité assurance qualité P2992 (« assurance qualité logicielle »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
Assurance qualité pour ce 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 :

  1. les valeurs qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les valeurs ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie de valeurs, celles ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred.

Exemples :
Pour Comprehensive Knowledge Archive Network, l’assurance qualité est [[Intégration continue]]

p.graphicalInterface()[modifier le code]

Affiche l’interface graphique utilisée par le logiciel.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Interface
Interfaces
interface
interfaces
P1414 (« bibliothèque d'interface utilisateur »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
Interface graphique utilisée 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 :

  1. les interfaces qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les interfaces ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie d’interfaces, celles ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred.

Exemples :
Pour GIMP, l’interface utilisée est [[GTK (boîte à outils)|GTK]]

p.operatingSystem()[modifier le code]

Affiche le ou les systèmes d’exploitation sur lesquels peut fonctionner le logiciel.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Système d’exploitation
Systèmes d’exploitation
système d'exploitation
systèmes d'exploitation
environnement
environnements
P306 (« système d'exploitation »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
Systèmes d’exploitation sur lesquels peut fonctionner 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 :

  1. les systèmes d’exploitation qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les systèmes d’exploitation ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie de systèmes d’exploitation, celles ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred.

Exemples :
Pour Mozilla Firefox, un des systèmes d’exploitation est [[Microsoft Windows]]

p.platform()[modifier le code]

Affiche la ou les plateformes sur lesquelles peut fonctionner le logiciel.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Plate-forme
Plate-formes
plateforme
plateformes
plate-forme
plate-formes
P400 (« plateforme »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
Plateformes sur lesquelles peut fonctionner 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 :

  1. les plateformes qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les plateformes ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie de plateformes, celles ayant un rang normal ne sont pris en considération que s'il n'y en a aucun ayant un rang preferred.

Exemples :
Pour Minecraft, une des plateformes est [[Xbox 360]]

p.dataSize()[modifier le code]

Affiche la taille d’un logiciel, d’un jeu de données, d’un réseau de neurones, ou d’un fichier individuel.

Paramètres de l'infobox
Libellé Paramètres Wikidata Description
Taille des données taille des données P3575 (« taille des données »)
Font Awesome 5 solid calendar-alt.svg P582 (« date de fin »)
Taille d’un logiciel, d’un jeu de données, d’un réseau de neurones, ou d’un fichier individuel.

Lorsque des propriétés de Wikidata sont utilisées la taille s'affiche en respectant les règles suivantes, dans l'ordre, jusqu'à ce qu'il soit possible de renvoyer quelque chose à afficher :

  1. les tailles qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les tailles ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. pour une catégorie de tailles, 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 Mozilla Firefox, la taille des données est 44 MB

p.readFormats()[modifier le code]

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 »)
Font Awesome 5 solid calendar-alt.svg 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 :

  1. les formats qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les formats ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. 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()[modifier le code]

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 »)
Font Awesome 5 solid calendar-alt.svg 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 :

  1. les formats qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les formats ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. 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()[modifier le code]

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 »)
Font Awesome 5 solid calendar-alt.svg 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 :

  1. les sites qui ont un qualificatif P582 (« date de fin ») avec un valeur dans le passé ne sont jamais pris en compte.
  2. les sites ayant un rang égal à deprecated ne sont jamais pris en compte.
  3. 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)[modifier le code]

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

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

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[2].
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 :

  1. a et b Légende en français de l'image si elle existe.
  2. Image dont la hauteur est supérieur à la largeur.

p.logo(upright)[modifier le code]

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

Fichier du logo à afficher dans l'infobox.

Exemples :

légende logo

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[2].
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.


  1. Légende en français de l'image si elle existe.
  2. Image dont la hauteur est supérieur à la largeur.

p.title()[modifier le code]

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)[modifier le code]

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

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 :

  1. les sites ayant un rang égal à deprecated ne sont jamais pris en compte.
  2. 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.
  3. 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.
  4. 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 :


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