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
[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.versionsNavigator()
[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.
Libellé | Paramètres | Wikidata | Description |
---|---|---|---|
Licence Licences
|
licence licences
|
P275 (« licence »)P582 (« date de fin ») |
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 :
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. |
p.repository()
[modifier le code]Affiche le lien vers le dépôt de code source de ce logiciel.
Libellé | Paramètres | Wikidata | Description |
---|---|---|---|
Dépôt Dépôts
|
dépôt
|
P1324 (« dépôt du code source »)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 :
Exemples : |
p.qualityAssurance()
[modifier le code]Affiche l’assurance qualité de ce logiciel.
Libellé | Paramètres | Wikidata | Description |
---|---|---|---|
Assurance qualité
|
assurance qualité
|
P2992 (« assurance qualité logicielle »)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 :
Exemples : |
p.graphicalInterface()
[modifier le code]Affiche l’interface graphique utilisée par le logiciel.
Libellé | Paramètres | Wikidata | Description |
---|---|---|---|
Interface Interfaces
|
interface interfaces
|
P1414 (« bibliothèque d'interface utilisateur »)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 :
Exemples : |
p.operatingSystem()
[modifier le code]Affiche le ou les systèmes d’exploitation sur lesquels peut fonctionner le logiciel.
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 »)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 :
Exemples : |
p.platform()
[modifier le code]Affiche la ou les plateformes sur lesquelles peut fonctionner le logiciel.
Libellé | Paramètres | Wikidata | Description |
---|---|---|---|
Plate-forme Plate-formes
|
plateforme plateformes plate-forme plate-formes
|
P400 (« plateforme »)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 :
Exemples : |
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.
Libellé | Paramètres | Wikidata | Description |
---|---|---|---|
Taille des données
|
taille des données
|
P3575 (« taille des données »)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 :
Exemples : |
p.readFormats()
[modifier le code]Affiche les formats de fichiers ou de flux de données lus ou importés par le logiciel.
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 :
Exemples : |
p.writtenFormats()
[modifier le code]Affiche les formats de fichiers ou de flux de données écrits ou exportés par le logiciel.
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 :
Exemples : |
p.documentation()
[modifier le code]Affiche le lien vers la documentation du logiciel.
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://.
Exemples : |
p.mainimage(cat, defaultimage)
[modifier le code]Affiche une illustration du logiciel. Généralement, il s’agit d’une capture d’écran.
Libellé | Paramètre | Wikidata | Description |
---|---|---|---|
|
Fichier de l'image ou de la photographie à afficher dans l'infobox. Exemples : | ||
|
Qualificatif de l'image affichée : |
Légende de l'image. Exemples : | |
|
Facteur de redimensionnement de l'image. Utile en particulier lorsque l'image est en mode portrait[2]. Exemples : | ||
|
Largeur de l'image, en pixels. Exemples : | ||
|
Voir la proposition de propriété alt text |
Texte à afficher quand l'image ne peut l'être. Exemples : |
- Légende en français de l'image si elle existe.
- Image dont la hauteur est supérieur à la largeur.
p.logo(upright)
[modifier le code]Affiche le logo du logiciel.
Argument | Type | Description |
---|---|---|
upright |
nombre | Valeur par défaut du facteur de redimensionnement du logo. |
Libellé | Paramètre | Wikidata | Description |
---|---|---|---|
|
Fichier du logo à afficher dans l'infobox. Exemples : | ||
|
Légende du logo. Exemples : | ||
|
Facteur de redimensionnement du logo. Utile en particulier lorsque le logo est en mode portrait[2]. Exemples : | ||
|
Largeur du logo, en pixels. Exemples : | ||
|
Voir la proposition de propriété alt text |
Texte à afficher quand l'image ne peut l'être. Exemples : Alternative textuelle à un logo |
- Légende en français de l'image si elle existe.
- Image dont la hauteur est supérieur à la largeur.
p.title()
[modifier le code]Retourne le titre de l’infobox.
Libellé | Paramètre | Wikidata | Description |
---|---|---|---|
|
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.
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 ).
|
Libellé | Paramètre | Wikidata | Description |
---|---|---|---|
|
|
P856 (« site officiel ») |
URL du site internet.
Remarques :
Exemples : |
|
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 : |