Modifications
Module:Wikidata/Documentation (voir la source)
Version du 3 novembre 2017 à 19:33
, 3 novembre 2017 à 19:33→Fonctions opérant au niveau d'un snak : correction (les noms de fonction ne correspondent plus trop à la logique :(
Module permettant d'utiliser de récupérer et de mettre en forme des données issues de Wikidata.
Dans la mesure du possible, ce module devrait être neutre sur le plan linguistique. Pour les textes spécifiquement français, voir [[Module:Wikidata/I18n]].
== Fonctions exportables ==
=== Fonctions opérant au niveau d'un snak ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| formatSnak || <code>snak, params</code> || Récupère la valeur d'un snak et la met en forme
|-
| getDataValue || <code>snak, params</code> || Récupère la valeur d'un snak avec une valeur de type "value" et la met en forme
|-
| isSpecial || <code>snak</code> || retourne <code>true</code> si un snak est une valeur spéciale (''novalue'' ou ''somevalue'')
|-
| getId || <code>snak</code> || retourne l'identifiant Qdd de l'élément utilisé comme valeur d'un snak
|}
=== Fonctions opérant au niveau d'une affirmation ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| formatStatement || <code>params</code> || Transforme une déclaration individuelle en chaîne wikitexte, selon les mêmes paramètres que stringTable
|-
| getDate || <code>statement, qualifs</code> || récupère les informations de date stockées dans une déclaration Wikidata (qualificatifs ou valeur principale) et les stocke sous forme de table
|-
| getFormattedDate || <code>statement, params</code> || récupère la date associée à un déclaration Wikidata comme getDate, mais la retourne sous forme d'une chaîne formattée selon les paramètres <code>params</code>
|-
| hasQualifier || <code>claim, acceptedqualifs, acceptedvals, excludequalifiervalues</code> || retourne <code>true</code> si l'affirmation comporte des qualificatifs utilisant les propriétés acceptedqualifs avec les valeurs acceptedvals, et sans les valeurs excludequalifiervalues. Si acceptedqualifs n'est pas renseignée, toutes les propriétés sont acceptées. Si acceptedvals n'est pas renseigné, toutes les valeurs sont acceptées.
|-
| getMainId || <code>claim</code> || retourne l'identifiant Qdd de l'élément utilisé comme valeur du "mainsnak" d'une déclaration
|-
| getFormattedQualifiers || <code>statement, qualifs, params</code> || à partir d'une affirmation, retourne une chaîne contenant les qualificatifs demandés. La table params permet de personnaliser l'affichage, voir [[#Paramètres]].
|-
| getReferences || <code>statement</code> || récupère et affiche la partie références d'une déclaration Wikidata.
|-
| addtrackingcat|| <code>property, cat</code> || catégorise dans <nowiki>[[Catégorie:Page utilisant $property]]</nowiki>
|-
|}
=== Fonctions opérant au niveau d'une entité ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| sortClaims|| <code>claims</code> || Met en ordre une série de valeurs. L'ordre choisit peut être <code>'chronological'</code> ou <code>'inverted'</code> (chronologique inversé). Dans ce cas là, ce les dates utilisées sont celles données comme valeur du mainsnak ou dans les qualificatifs. L'ordre peut aussi être une fonction (voir l'aide Lua pour le classement des tables). Cette fonction est appelée par l'argument <code>sorttype</code> de <code>wd.formatGetClaims</code> et donc aussi de <code>wd.formatStatements</code>
|-
| filterClaims || <code>claims, params</code> || Prend une table d'affirmations, et exclut celles qui ne correspondent pas aux critères donnés dans la table <code>params</code>. Pour la liste de ces arguments, voir l'aide ci dessous
|-
| getClaims || <code>params</code> || Retourne une table d'affirmations (ou nil) en fonction des instructions données dans la table <code>params</code>, qui dont contenir une clé <code>|entity = </code> et <code>|property = </code>, et peut contenir de nombreux autres paramètres optonnels, voir [[#Paramètres]].
|-
| getIds || <code>params</code> || Sélectionne des affirmations de la même manière que <code>getClaims</code> met au lieu de retourner les affirmations complètes, elle ne retourne que l'identifiant de son ''mainsnak'' (ne fonctionne que pour les données de type ''élément'').
|-
| stringTable || <code></code> || Retourne les mêmes affirmations que getClaims, sauf éventuellement celles supprimées par le paramètre removedupes. Chacune est rendue sous forme d'une chaîne en Wikitexte directement utilisable. Les paramètres de mise en forme sont également contenus dans la table params.
|-
| formatStatements || <code>params</code> || Retourne les mêmes valeurs que stringTable, mais concaténées sous forme de chaîne unique. La méthode de concaténation est définie par le paramètre <code>conjtype</code> qui utilise [[Module:Linguistique]]. Si les paramètres <code>linkback</code> et <code>addcat</code> sont activés, un rétrolien et une catégorie de maintenance peuvent également être ajoutés.
|-
| formatAndCat || <code>params</code> || Même fonction que <code>formatStatements</code>, mais ajoute un rétrolien vers Wikidata et une catégorie de maintenance
|-
| getTheDate|| <code>params</code> || affiche une date qui se trouve soit en valeur principale soit en qualificatif de la propriété prop de l'élément item
|-
| mainDate || <code>entity</code> || Récupère et met en forme la "date principale" que l'on peut associer à l'élément, en fonction de ses propriétés{{WD P|580}}, {{WD P|582}} et {{WD P|585}}
|-
| keyDate || <code>event, item, params</code> || Récupère et format une date provenant de l'élément <code>item</code>. <code>event</code> doit être soit un identifiant de propriété, dans ce cas là, la fonction récupérera les valeurs dans cette propriété, soit un identifiant d'élément. Dans ce cas là, elle cherchera cet élément dans les valeurs de {{WD P|793}} et retournera la date indiquée en qualificatif.<code>event</code> peut également être une liste d'identifiants sous forme de table, dans ce cas là, la valeur retournée sera celle du premier identifiant pour lequel quelque chose est trouvé. Par exemple <code>wd.keyDate('Q1417098', 'P1690'}</code> cherchera la valeur dans {{WD P|793}} {{WD Q|Q1417098}} et si elle ne trouve rien, elle cherchera dans {{WD P|1690}}.
|-
| getLabel ||<code>entity, lang, labelformat</code> || Retourne par défaut le libellé Wikidata de l'entité dans, en français ou dans la langue indiquée dans le deuxième paramètre. Le paramètre optionnel <code>labelformat</code> permet de définir un affichage alternatif. Sa valeur doit être une fonction prenant pour argument l'entité et retournant une chaîne.
|-
| siteLink || <code>entity, lang, project</code> || retourne un lien vers la page projet demandé ('wikipedia', 'wikivoyage', 'commons') etc. lié à l'entité Wikidata indiquée, dans la langue demandée. Par défaut, la langue est le français et le projet Wikpédia.
|-
| formatEntity||<code>entity, params</code> || Prend l'identifiant (ou la table de données) donnée en paramètre entité et la transforme, et la retourne sur la forme d'un texte contenant un libellé et éventuellement un lien interne.
|-
| getDescription || <code>entity, lang</code> || affiche la description Wikidata pour une entité donnée, dans un langue donnée (français par défaut)
|-
| getNumericId || <code>snak</code> || retourne l'identifiant numérique de l'élément utilisé comme valeur d'un snak
|-
| getEntity || <code>str</code> || retourne la table de données correpondant à un identifiant (inverse de getEntityId)
|-
| getEntityId || <code>str</code> || retourne l'identifiant d'une entité Wikidata passée sous la forme d'une table de données (inverse de getEntity)
|-
|}
=== Fonctions récupérant des données dans plusieurs entités ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| isSubclass || <code>class, item, maxdepth</code>||
|-
| isinstance || <code>class, item, maxdepth</code>||
|-
| inTransitiveVals || <code>searchedval, sourceval, query, maxdepth, maxnodes</code>||
|}
=== Divers ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Descriptions
|-
| Dump || <code>entity</code> || affiche le contenu d'une entité Wikidata
|-
| sourceStr || <code></code> ||
|-
| frameFun || (frame) || appelle une des fonctions précédentes depuis le frame. Le nom de la fonction est donné en argument 1
|-
| addRefAnchor || <code></code> ||
|-
| addLinkback || <code></code> || ajoute un rétrolien (généralement utilisé par <code>formatStatements{arglinkback = true}</code>, mais peut être utile comme fonction indépendante lorsque les données ont besoin font l'objet de nombreuses manipulations avant leur rendu final
|-
| isHere || <code>searchset, val</code> || retourne <code>true</code> si la chaîne <code>val</code> se trouve dans la table <code>searchset</code>
|-
| addNewValues || <code>old, new</code> || ajoute les de nouvelles valeurs à une table, seulement si elles ne s'y trouvent pas déjà
|}
== Paramètres ==
Liste des clés pouvant être utilisé dans la table "params" mentionnée ci dessous.
=== Choix des déclarations ===
Paramètres utilisés par la fonction <code>filterclaims</code> et donc indirectement par les fonctions y faisant appel, tels que <code>getClaims</code> et <code>formatStatements</code>.
{| class="wikitable sortable"
|-
! Nom !! Mode d'utilisation !! Description
|-
| claims || Lua || Liste de déclarations à utiliser. Lorsque ce paramètre est activé, les paramètres <code>property</code> et <code>entity</code> ne sont pas utilisés pour la récupération des données.
|-
| entity || Lua et wikicode || L'identifiant de l'entité Wikidata à utiliser. Par défaut, celle liée à la page. <br />En Lua, on peut passer une entité déjà chargée plutôt que son identifiant.
|-
| property ||Lua et wikicode || Le nom de la propriété à utiliser, sous la forme <code>property = PXX</code>. En Lua, on peut utiliser plusieurs propriétés sous forme de tables
|-
| excludespecial || Lua et wikicode || Retire les déclarations dont la valeur principale (mainsnak) n'est pas de type "valeur", c'est-à-dire les déclarations "valeur inconnue" ou "aucune valeur".
En wikicode : activée par la <code>|excludespecial = true</code><br /> En Lua, activée par un booléen (<code>excludespecial = true</code>)
|-
| targetvalue || Lua et wikicode || Ne retient que la ou les déclarations dont la valeur du snak principal correspond à la (ou une des) valeurs indiquées
|-
| excludevalues || Lua et wikicode || Exclut les déclarations dont la valeur du snak principal correspond à la (ou une des) valeurs indiquées
|-
| qualifier || Lua et wikicode || Seules les déclarations contenant ce qualificatif son retournées. Pour activer l'affichage du qualificatif, voir <code>showqualifiers</code>
|-
| qualifiervalue || Lua et wikicode || Le qualificatif utilisé par l'argument <code>qualifier</code> doit avoir cette valeur (ou une de ces valeurs, s'il s'agit d'une table ou d'une liste de propriétés séparées par des virgules
|-
| excludequalifier || Lua et wikicode || Les déclarations contenant ce qualificatif sont exclues
|-
| excludequalifiervalue || Lua et wikicode || Si ce paramètre est renseigné, <code>excludequalifier</code> n'est activé que lorsque la valeur du qualificatif se trouve dans celles qu'il indique.
|-
| withsource || Lua et wikicode || Ne retourne que les valeurs contenant une source, utilisant la source indiquée dans la propriété {{WD P|248}}, ou une autre propriété définie par le paramètre <code>sourceproperty</code>. Pour accepter n'importe quelle source du moment qu'elle utilise la propriété demandée, mettre la valeur <code>any</code>. Pour désactiver ce paramètre, mettre la valeur <code>-</code>.
|-
| sourceproperty || Lua et wikicode || Propriété à utiliser pour le paramètre <code>withsource</code>
|-
|rank || Lua et wikicocde || [[d:Help:Ranking/fr|Rangs]] acceptés :
* <code>preferred</code>
* <code>normal</code>
* <code>deprecated</code>
* <code>valid</code> (= preferred + normal)
* <code>best</code> (preferred, ou, si aucune ne répond aux autres critères de la requête, normal)
Valeur par défaut : <code>best</code>
|-
| numval || Lua et wikicode || Nombre maximal de valeurs à retourner (les n premières valeurs de la liste établie par les autres paramètres)
|-
| withlink || Lua et wikicode || Ne retourne que les valeurs contenant un lien vers le site spécifié. Si la valeur du paramètre est simplement <code>true</code>, le site utilisé sera Wikipédia en français.
|-
| withdate || Lua et wikicode || Ne retourne que les valeurs possédant un qualificatif de date : {{WD P|585}}, {{WD P|580}}, {{WD P|582}}
|-
| atdate || Lua et wikicode || Exclut les valeurs dont les qualificatifs {{WD P|580}} ou {{WD P|582}} indiquent qu'elle n'était pas valable à la période indiquée. atdate peut-être une date au format wikibase ou au format ISO. Les valeurs sans date ne sont pas exclues (elle peuvent l'être en ayant recours à la fonction <code>withdate</code>). Pour demander la valeur à la date d'aujourd'hui utiliser : <code>|atdate = today</code>.
|-
| minprecision || Lua et Wikicode || Degré de précision minimum accepté pour les données de type date. Doit être une valeur numérique correspondant au modèle de Wikidata (par exemple année = 9)
|-
| condition || Lua || Pour définir une fonction libre. Si la fonction retourne <code>true</code>, la déclaration sera gardée
|-
| sorttype|| Lua et wikicode || Manière de classer les déclarations. Valeurs possibles :
* <code>chronological</code>
* <code>inverted</code> (chronologique inversé
* fonction Lua (voir la fonction <code>sortClaims</code>)
|}
=== Activation / désactivation de Wikidata ===
{| class="wikitable sortable"
|-
! Nom !! Mode d'utilisation !! Description
|-
| value || Lua et wikicode || Lorsque le paramètre value est non vide, le module ne cherche pas les données de Wikidata, mais utilise celles fournies localement par ce paramètre. Les fonction formatAndCat en revanche lui applique <code>linkback</code> et <code>addcat</code>)
|-
| expl || Lua et wikicode || Lorsque le paramètre expl est présent, la fonction formatStatements ne fait rien si le paramètre value n'a pas la valeur résultat de {{m|WD}} (utile pour des données mises à jour mais dont l'utilité dans chaque article est difficile à décider automatiquement).
|-
|}
=== Mise en forme des données ===
{| class="wikitable sortable"
|-
! Nom !! Niveau d'application !! Mode d'utilisation !! Description
|-
| conjtype || liste des déclarations|| Lua et wikicode || La manière de coordonner les déclarations, en utilisant la fonction <code>conj</code> de [[Module:Linguistique]]. Valeurs possibles :
* <code>and</code> ajoute " et " entre l'avant dernière et la dernière valeur, une virgule entre les autres.
* <code>or</code> ajout " ou " entre l'avant dernière et la dernière valeur
* <code>comma</code> des virgules partout
* <code>new line</code> un retour à la ligne
Toute autre valeur donnée au paramètre sera insérée entre chaque valeur (<code>|conjtype = et puis aussi</code> ajoutera "et puis aussi" entre chaque valeurs)
|-
| linkback || liste des déclarations || Lua et wikicode || Ajoute un rétrolien vers Wikidata sous forme d'un crayon « [[File:Blue pencil.svg|10px]] »
|-
| addcat || liste des déclarations || Lua et wikicode || Met la page dans une catégorie de suivi (voir [[:Catégorie:Page utilisant des données de Wikidata]]). Le nom de la catégorie correspond à la valeur du paramètre. Si cette valeur est simplement <code>true</code>, la catégorie est fonction du paramètre property.
Attention, ce paramètre peut être source de bugs. Par exemple, si la propriété est utilisée dans une url ou un lien.
|-
| removedupes || choix des déclarations <br />(à la fin, dans une fonction différente) || Lua et wikicode || Lorsque, après toutes les mises en forme, deux déclarations sont rendues de la même manière, une seule est conservée.
|-
|rowspan=2| lang || mise en forme des données || Lua et Wikicode || Langue dans lequel le texte doit être retourné.
|-
| snak (entité) || Lua et wikicode || Code Wikimédia de la langue utilisée pour afficher les libellés (par défaut : français)
|-
| ucfirst || liste des déclarations || Lua et Wikicode || Par défaut, la fonction formatStatements ajoute une majuscule en début de texte. <code>|ucfirst=-</code> permet de désactiver cela
|-
| statementformat || déclaration || Lua || doit être une fonction <code><nowiki>fonction(statement) return XX </nowiki></code> retournant une chaîne. Elle sera appliquée à sur chaque déclaration (permet de simplifier certaines infobox Lua)
|-
| showdate|| déclaration || Lua et wikicode || Pour afficher la date entre parenthèses en petit pour chaque déclaration en utilisant les mêmes qualificatifs que (withdate). Lorsqu'aucune date n'est trouvée, la valeur est affichée sans aucune date.
|-
| displayformat || snak || Lua et wikicode|| Pour changer le format par défaut entre chaque valeur. <br />
* <code>weblink</code> transforme les données de type chaîne en lien web
* <code>raw</code> retourne un format plus brut parfois utile au codage
* <code>latitude</code> pour [[Module:Coordinates]]
* <code>longitude</code> pour [[Module:Coordinates]]
En lua, la valeur du paramètre peut aussi être une fonction.
|-
| qualifdisplayformat || snak || Lua et wikicode|| Format d'affichage des qualificatifs. Même fonctionnement que le paramètre <code>displayformat</code>. Lorsque ce paramètre est laissé vide, les qualificatifs utilisent le paramètre <code>displayformat</code> comme la valeur principale.
|-
| showsource || déclaration || Lua et wikicode || Identifiant d'une source que l'on souhaiterait voir affichée en référence si elle est présente. <code>true</code> affichera toutes les sources utilisant la propriété {{WD P|248}}.
|-
| linktopic || snak (temporel) || Lua et wikicode || Type de lien à ajouter aux dates (voir [[Module:Date]]). Pour ne mettre aucun lien : <code>linktopic = - </code>
|-
|-
| precision|| snak (temporel) || Lua et wikicode || Précision avec laquelle les dates doivent être affichées. Valeurs possibles :
* <code>day</code>
* <code>month</code>
*<code>year</code>
Valeur par défaut : <code>day</code>
|-
| textformat || snak (temporel) || Lua et wikicode || Format d'affichage des intervalles de temps, tels que définis par [[Module:Date complexe]]
* <code>minimum</code> affichera "1995" à la place de "à partir de 1995".
|-
| speciallabels || snak (entité) || Lua|| Tables de valeurs spéciales à utiliser à la place du libellé Wikidata pour la valeur de certains éléments, par exemple [[Module:Dictionnaire Wikidata/Métiers]].female
|-
| labelformat || snak (entité) || Lua || Fonction de mise en forme des libellés
|-
| showlang || déclaration || Lua et wikicode || Lorsque la valeur principale est de type "texte monolingue", son code langue est affiché (utilisé par [[Module:Site officiel]])
|-
| showqualifiers || déclaration || Lua et wikicode || Qualificatif à retourner entre parenthèses derrière la valeur de la propriété principale demandée. En wikicode sous le format <code><nowiki>|</nowiki>showqualifiers = P460</code>, en Lua sous le format <code>showqualifiers = "P460"</code> ou <code>showqualifiers = {"P460", "P461"}</code>
|-
| showonlyqualifier || déclaration || Lua et wikicode || Qualificatif de même, mais à retourner seul sans la valeur de la propriété principale demandée
|-
| link || snak (entité) || Lua et wikicode || Site vers lequel doivent lier les données de type élément. Par défaut : Wikidata en français. Si égal à "-", aucun lien ne sera créé.
|-
| defaultlink || snak (entité) || Lua et wikicode || Lorsque le site demandé par le paramètre link ne retourne pas de lien, affiche un lien entre parenthèses vers le site demandé. Par défaut : Wikipédia en anglais ou, si absent, Wikidata. La valeur "-" désactive le paramètre.
|-
| defaultlinkquery || snak (entité) || Lua || Lorsque le site demandé par le paramètre link ne retourne pas de lien, ce paramètre définit une requête que <code>recup.getClaims</code> utilise pour créer un lien. Par exemple, avec <code>|defaultlinkquery = {property = 'P279'}</code> le lien créé correspondra à celui fourni par l'élément utilisé dans la propriété {{WD P|279}}.
|-
| targetunit || snak (quantité) || Lua et Wikicode || Unité dans laquelle doivent être converties les données de type quantité. Les valeurs possibles sont visibles dans [[Module:Conversion/Données]], par exemple km ou km2.
|-
| showunit || snak (quantité) || Lua et Wikicode ||
Manière d'afficher l'unité demandée. Valeurs possibles :
* <code>'long'</code> : affiche le nom complet de l'unité (par exemple "12,7 mètres")
* <code>'short'</code> affiche l'abréviation conventionnellement utilisée ("12,7 m")
* <code>'-'</code> : aucune unité affichée
défaut : 'short'</code>
|-
| rounding || snak (quantité) nombre de chiffres || Lua et Wikicode || Nombre de chiffres significatifs à afficher dans les données de type quantité, après conversion éventuelle (défaut : dépend de la précision indiquée sur Wikidata)
|-
| urlpattern || snak (string) || Lua et wikicode || La valeur du paramètre est un chaîne représentant une URL, l'expression "$1" sera remplacée par la valeur Wikidata <br /> Avec la propriété {{WD P|214}} et la valeur de paramètre <nowiki>http://viaf.org/viaf/$1</nowiki>, la valeur de l'identifiant VIAF stockée sur Wikidata sera utilisée pour créer un lien externe..
|-
| text || snak (string) || Lua et wikicode || Texte à afficher lorsque la valeur crée un lien externe, c'est-à-dire pour les données de type chaîne avec <code>displayformat = "weblink"</code> ou avec le paramètre <code>urlpattern</code> renseigné. Par défaut : la valeur initiale de la déclaration. Utilisé sur [[Module:Site officiel]] [[Module:Bases archi]].
|-
| novaluelabel || snak (novalue) || Lua et wikicode || Libellé à retourner lorsque la valeur est de type "novalue". Par défaut : "-". <br />
En Lua, la valeur peut-être une fonction.
|-
| somevaluelabel || snak (somevalue) || Lua et wikicode || Libellé à retourner lorsque la valeur est de type "somevalue". Par défaut : "inconnu". <br />
En Lua, la valeur peut-être une fonction.
|-
| returnnumberofvalues || liste des déclarations || Lua || retourne en deuxième valeur le nombre de valeurs récupérées par getClaims (si la fonction est appelée depuis du Wikicode, le nombre sera concaténé au reste de la chaîne retournée
|}
== Exemples ==
=== Définition des liens ===
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}} || Capitale de l'Égypte, format standard
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}} || Capitale de l'Égypte, sans lien
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}} || Capitale de l'Égypte, avec lien vers Wikidata
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}} || Date de naissance d'Albert Einstein, en utilisant le format standard de Wikipédia en français
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = football }}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569 |linktopic = football }} || Date de naissance d'Einstein, avec liens spécialisés dans le football
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}} || Date de naissance d'Einstein, sans lien
|}
=== Rang ===
Il existe trois types de rang sur Wikidata : "normal", "preferred" et "deprecated". Le rang deprecated est réservé aux données que l'on sait fausse mais que l'on garde pour mémoire, par exemple pour documenter une croyance ancienne qui a été infirmée par des études plus récentes.
Par défaut, seul le rang "preferred" est récupéré, mais le paramètre "rank" permet de changer cela.
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}} || Matériau de la Joconde, affichage par défaut (donc seulement celles avec le rang "preferred" s'il y en a)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}} || rank = "valid" accepte les valeur de rang "normal" et "preferred" (par exemple, le matériau d'un chassis qui a été ajouté ultérieurement à la Joconde)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}} || rank = "normal" ne récupère que les données avec un rang "normal", et ignore celles avec un rang "preferred"
|}
=== Qualificatifs ===
Les qualificatifs sont des données supplémentaires intégrées à une affirmation Wikidata qu'elle permet de préciser.
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518}} || ne retient que les valeurs ayant un qualificatif {{WD P|518}}
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|qualifiervalue=Q1737943}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518|qualifiervalue=Q1737943}} || qualifiervalue définit la valeur que possède le qualificatif. Ici, {{WD Q|1737943}} précise que l'on demande la matériau du chassis. Notez qu'aucune valeur de rang "preferred" n'étant trouvé, un valeur de rang "normal" est retournée.
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}} || showqualifiers affiche la valeur des qualificatifs demandé entre parenthèse, après la valeur principale
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showdate = true|rank=valid}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid|showdate = true}} || si des qualificatifs indiquant la date sont fournis, ils sont affichées
|}
=== Affichage des sources ===
{| class="wikitable"
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}} ||
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}} ||
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}} || Montre seulement les valeurs données par la source
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}} ||
|}
<references />
=== Autres options ===
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P106|conjtype = new line|showdate= true}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q1299 | property = P527|conjtype = new line|showdate=true}} || conjtype permet de définir le séparateur entre les valeurs (voir [[Module:Linguistique]]). Ici "<nowiki>new line</nowiki>" indique qu'il faut revenir à la ligne après chaque valeur.
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=chronological|conjtype =new line}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=chronological|showdate=true|conjtype = new line}} || sorttype = chronological tente de classer les valeurs par ordre chronologique (en se basant sur les qualificatifs). Ici : les événements principaux ([[:d:P:P793]]) dans l'histoire de l'ancien Stade d'Arsenal.
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=inverted|conjtype = new line}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=inverted|showdate=true|conjtype = new line}} || sorttype = inverted pour inverser l'ordre chronologique
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}} || affiche les identifiants des valeurs (essentiellement utile pour la programmation)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}} || retourne les numval première valeurs répondant au reste de la requête (utile notamment pour récupérer une image)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }} || avec expl=, pour que la valeur soir retournée il faut value=<nowiki>{{WD}}</nowiki>
|-
|}
<includeonly>
{{Projet Scribunto}}
</includeonly>
<noinclude>
[[Catégorie:Documentation de module|{{BASEPAGENAME}}]]
</noinclude>
Dans la mesure du possible, ce module devrait être neutre sur le plan linguistique. Pour les textes spécifiquement français, voir [[Module:Wikidata/I18n]].
== Fonctions exportables ==
=== Fonctions opérant au niveau d'un snak ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| formatSnak || <code>snak, params</code> || Récupère la valeur d'un snak et la met en forme
|-
| getDataValue || <code>snak, params</code> || Récupère la valeur d'un snak avec une valeur de type "value" et la met en forme
|-
| isSpecial || <code>snak</code> || retourne <code>true</code> si un snak est une valeur spéciale (''novalue'' ou ''somevalue'')
|-
| getId || <code>snak</code> || retourne l'identifiant Qdd de l'élément utilisé comme valeur d'un snak
|}
=== Fonctions opérant au niveau d'une affirmation ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| formatStatement || <code>params</code> || Transforme une déclaration individuelle en chaîne wikitexte, selon les mêmes paramètres que stringTable
|-
| getDate || <code>statement, qualifs</code> || récupère les informations de date stockées dans une déclaration Wikidata (qualificatifs ou valeur principale) et les stocke sous forme de table
|-
| getFormattedDate || <code>statement, params</code> || récupère la date associée à un déclaration Wikidata comme getDate, mais la retourne sous forme d'une chaîne formattée selon les paramètres <code>params</code>
|-
| hasQualifier || <code>claim, acceptedqualifs, acceptedvals, excludequalifiervalues</code> || retourne <code>true</code> si l'affirmation comporte des qualificatifs utilisant les propriétés acceptedqualifs avec les valeurs acceptedvals, et sans les valeurs excludequalifiervalues. Si acceptedqualifs n'est pas renseignée, toutes les propriétés sont acceptées. Si acceptedvals n'est pas renseigné, toutes les valeurs sont acceptées.
|-
| getMainId || <code>claim</code> || retourne l'identifiant Qdd de l'élément utilisé comme valeur du "mainsnak" d'une déclaration
|-
| getFormattedQualifiers || <code>statement, qualifs, params</code> || à partir d'une affirmation, retourne une chaîne contenant les qualificatifs demandés. La table params permet de personnaliser l'affichage, voir [[#Paramètres]].
|-
| getReferences || <code>statement</code> || récupère et affiche la partie références d'une déclaration Wikidata.
|-
| addtrackingcat|| <code>property, cat</code> || catégorise dans <nowiki>[[Catégorie:Page utilisant $property]]</nowiki>
|-
|}
=== Fonctions opérant au niveau d'une entité ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| sortClaims|| <code>claims</code> || Met en ordre une série de valeurs. L'ordre choisit peut être <code>'chronological'</code> ou <code>'inverted'</code> (chronologique inversé). Dans ce cas là, ce les dates utilisées sont celles données comme valeur du mainsnak ou dans les qualificatifs. L'ordre peut aussi être une fonction (voir l'aide Lua pour le classement des tables). Cette fonction est appelée par l'argument <code>sorttype</code> de <code>wd.formatGetClaims</code> et donc aussi de <code>wd.formatStatements</code>
|-
| filterClaims || <code>claims, params</code> || Prend une table d'affirmations, et exclut celles qui ne correspondent pas aux critères donnés dans la table <code>params</code>. Pour la liste de ces arguments, voir l'aide ci dessous
|-
| getClaims || <code>params</code> || Retourne une table d'affirmations (ou nil) en fonction des instructions données dans la table <code>params</code>, qui dont contenir une clé <code>|entity = </code> et <code>|property = </code>, et peut contenir de nombreux autres paramètres optonnels, voir [[#Paramètres]].
|-
| getIds || <code>params</code> || Sélectionne des affirmations de la même manière que <code>getClaims</code> met au lieu de retourner les affirmations complètes, elle ne retourne que l'identifiant de son ''mainsnak'' (ne fonctionne que pour les données de type ''élément'').
|-
| stringTable || <code></code> || Retourne les mêmes affirmations que getClaims, sauf éventuellement celles supprimées par le paramètre removedupes. Chacune est rendue sous forme d'une chaîne en Wikitexte directement utilisable. Les paramètres de mise en forme sont également contenus dans la table params.
|-
| formatStatements || <code>params</code> || Retourne les mêmes valeurs que stringTable, mais concaténées sous forme de chaîne unique. La méthode de concaténation est définie par le paramètre <code>conjtype</code> qui utilise [[Module:Linguistique]]. Si les paramètres <code>linkback</code> et <code>addcat</code> sont activés, un rétrolien et une catégorie de maintenance peuvent également être ajoutés.
|-
| formatAndCat || <code>params</code> || Même fonction que <code>formatStatements</code>, mais ajoute un rétrolien vers Wikidata et une catégorie de maintenance
|-
| getTheDate|| <code>params</code> || affiche une date qui se trouve soit en valeur principale soit en qualificatif de la propriété prop de l'élément item
|-
| mainDate || <code>entity</code> || Récupère et met en forme la "date principale" que l'on peut associer à l'élément, en fonction de ses propriétés{{WD P|580}}, {{WD P|582}} et {{WD P|585}}
|-
| keyDate || <code>event, item, params</code> || Récupère et format une date provenant de l'élément <code>item</code>. <code>event</code> doit être soit un identifiant de propriété, dans ce cas là, la fonction récupérera les valeurs dans cette propriété, soit un identifiant d'élément. Dans ce cas là, elle cherchera cet élément dans les valeurs de {{WD P|793}} et retournera la date indiquée en qualificatif.<code>event</code> peut également être une liste d'identifiants sous forme de table, dans ce cas là, la valeur retournée sera celle du premier identifiant pour lequel quelque chose est trouvé. Par exemple <code>wd.keyDate('Q1417098', 'P1690'}</code> cherchera la valeur dans {{WD P|793}} {{WD Q|Q1417098}} et si elle ne trouve rien, elle cherchera dans {{WD P|1690}}.
|-
| getLabel ||<code>entity, lang, labelformat</code> || Retourne par défaut le libellé Wikidata de l'entité dans, en français ou dans la langue indiquée dans le deuxième paramètre. Le paramètre optionnel <code>labelformat</code> permet de définir un affichage alternatif. Sa valeur doit être une fonction prenant pour argument l'entité et retournant une chaîne.
|-
| siteLink || <code>entity, lang, project</code> || retourne un lien vers la page projet demandé ('wikipedia', 'wikivoyage', 'commons') etc. lié à l'entité Wikidata indiquée, dans la langue demandée. Par défaut, la langue est le français et le projet Wikpédia.
|-
| formatEntity||<code>entity, params</code> || Prend l'identifiant (ou la table de données) donnée en paramètre entité et la transforme, et la retourne sur la forme d'un texte contenant un libellé et éventuellement un lien interne.
|-
| getDescription || <code>entity, lang</code> || affiche la description Wikidata pour une entité donnée, dans un langue donnée (français par défaut)
|-
| getNumericId || <code>snak</code> || retourne l'identifiant numérique de l'élément utilisé comme valeur d'un snak
|-
| getEntity || <code>str</code> || retourne la table de données correpondant à un identifiant (inverse de getEntityId)
|-
| getEntityId || <code>str</code> || retourne l'identifiant d'une entité Wikidata passée sous la forme d'une table de données (inverse de getEntity)
|-
|}
=== Fonctions récupérant des données dans plusieurs entités ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Description
|-
| isSubclass || <code>class, item, maxdepth</code>||
|-
| isinstance || <code>class, item, maxdepth</code>||
|-
| inTransitiveVals || <code>searchedval, sourceval, query, maxdepth, maxnodes</code>||
|}
=== Divers ===
{| class="wikitable sortable"
|-
! Nom !! Arguments !! Descriptions
|-
| Dump || <code>entity</code> || affiche le contenu d'une entité Wikidata
|-
| sourceStr || <code></code> ||
|-
| frameFun || (frame) || appelle une des fonctions précédentes depuis le frame. Le nom de la fonction est donné en argument 1
|-
| addRefAnchor || <code></code> ||
|-
| addLinkback || <code></code> || ajoute un rétrolien (généralement utilisé par <code>formatStatements{arglinkback = true}</code>, mais peut être utile comme fonction indépendante lorsque les données ont besoin font l'objet de nombreuses manipulations avant leur rendu final
|-
| isHere || <code>searchset, val</code> || retourne <code>true</code> si la chaîne <code>val</code> se trouve dans la table <code>searchset</code>
|-
| addNewValues || <code>old, new</code> || ajoute les de nouvelles valeurs à une table, seulement si elles ne s'y trouvent pas déjà
|}
== Paramètres ==
Liste des clés pouvant être utilisé dans la table "params" mentionnée ci dessous.
=== Choix des déclarations ===
Paramètres utilisés par la fonction <code>filterclaims</code> et donc indirectement par les fonctions y faisant appel, tels que <code>getClaims</code> et <code>formatStatements</code>.
{| class="wikitable sortable"
|-
! Nom !! Mode d'utilisation !! Description
|-
| claims || Lua || Liste de déclarations à utiliser. Lorsque ce paramètre est activé, les paramètres <code>property</code> et <code>entity</code> ne sont pas utilisés pour la récupération des données.
|-
| entity || Lua et wikicode || L'identifiant de l'entité Wikidata à utiliser. Par défaut, celle liée à la page. <br />En Lua, on peut passer une entité déjà chargée plutôt que son identifiant.
|-
| property ||Lua et wikicode || Le nom de la propriété à utiliser, sous la forme <code>property = PXX</code>. En Lua, on peut utiliser plusieurs propriétés sous forme de tables
|-
| excludespecial || Lua et wikicode || Retire les déclarations dont la valeur principale (mainsnak) n'est pas de type "valeur", c'est-à-dire les déclarations "valeur inconnue" ou "aucune valeur".
En wikicode : activée par la <code>|excludespecial = true</code><br /> En Lua, activée par un booléen (<code>excludespecial = true</code>)
|-
| targetvalue || Lua et wikicode || Ne retient que la ou les déclarations dont la valeur du snak principal correspond à la (ou une des) valeurs indiquées
|-
| excludevalues || Lua et wikicode || Exclut les déclarations dont la valeur du snak principal correspond à la (ou une des) valeurs indiquées
|-
| qualifier || Lua et wikicode || Seules les déclarations contenant ce qualificatif son retournées. Pour activer l'affichage du qualificatif, voir <code>showqualifiers</code>
|-
| qualifiervalue || Lua et wikicode || Le qualificatif utilisé par l'argument <code>qualifier</code> doit avoir cette valeur (ou une de ces valeurs, s'il s'agit d'une table ou d'une liste de propriétés séparées par des virgules
|-
| excludequalifier || Lua et wikicode || Les déclarations contenant ce qualificatif sont exclues
|-
| excludequalifiervalue || Lua et wikicode || Si ce paramètre est renseigné, <code>excludequalifier</code> n'est activé que lorsque la valeur du qualificatif se trouve dans celles qu'il indique.
|-
| withsource || Lua et wikicode || Ne retourne que les valeurs contenant une source, utilisant la source indiquée dans la propriété {{WD P|248}}, ou une autre propriété définie par le paramètre <code>sourceproperty</code>. Pour accepter n'importe quelle source du moment qu'elle utilise la propriété demandée, mettre la valeur <code>any</code>. Pour désactiver ce paramètre, mettre la valeur <code>-</code>.
|-
| sourceproperty || Lua et wikicode || Propriété à utiliser pour le paramètre <code>withsource</code>
|-
|rank || Lua et wikicocde || [[d:Help:Ranking/fr|Rangs]] acceptés :
* <code>preferred</code>
* <code>normal</code>
* <code>deprecated</code>
* <code>valid</code> (= preferred + normal)
* <code>best</code> (preferred, ou, si aucune ne répond aux autres critères de la requête, normal)
Valeur par défaut : <code>best</code>
|-
| numval || Lua et wikicode || Nombre maximal de valeurs à retourner (les n premières valeurs de la liste établie par les autres paramètres)
|-
| withlink || Lua et wikicode || Ne retourne que les valeurs contenant un lien vers le site spécifié. Si la valeur du paramètre est simplement <code>true</code>, le site utilisé sera Wikipédia en français.
|-
| withdate || Lua et wikicode || Ne retourne que les valeurs possédant un qualificatif de date : {{WD P|585}}, {{WD P|580}}, {{WD P|582}}
|-
| atdate || Lua et wikicode || Exclut les valeurs dont les qualificatifs {{WD P|580}} ou {{WD P|582}} indiquent qu'elle n'était pas valable à la période indiquée. atdate peut-être une date au format wikibase ou au format ISO. Les valeurs sans date ne sont pas exclues (elle peuvent l'être en ayant recours à la fonction <code>withdate</code>). Pour demander la valeur à la date d'aujourd'hui utiliser : <code>|atdate = today</code>.
|-
| minprecision || Lua et Wikicode || Degré de précision minimum accepté pour les données de type date. Doit être une valeur numérique correspondant au modèle de Wikidata (par exemple année = 9)
|-
| condition || Lua || Pour définir une fonction libre. Si la fonction retourne <code>true</code>, la déclaration sera gardée
|-
| sorttype|| Lua et wikicode || Manière de classer les déclarations. Valeurs possibles :
* <code>chronological</code>
* <code>inverted</code> (chronologique inversé
* fonction Lua (voir la fonction <code>sortClaims</code>)
|}
=== Activation / désactivation de Wikidata ===
{| class="wikitable sortable"
|-
! Nom !! Mode d'utilisation !! Description
|-
| value || Lua et wikicode || Lorsque le paramètre value est non vide, le module ne cherche pas les données de Wikidata, mais utilise celles fournies localement par ce paramètre. Les fonction formatAndCat en revanche lui applique <code>linkback</code> et <code>addcat</code>)
|-
| expl || Lua et wikicode || Lorsque le paramètre expl est présent, la fonction formatStatements ne fait rien si le paramètre value n'a pas la valeur résultat de {{m|WD}} (utile pour des données mises à jour mais dont l'utilité dans chaque article est difficile à décider automatiquement).
|-
|}
=== Mise en forme des données ===
{| class="wikitable sortable"
|-
! Nom !! Niveau d'application !! Mode d'utilisation !! Description
|-
| conjtype || liste des déclarations|| Lua et wikicode || La manière de coordonner les déclarations, en utilisant la fonction <code>conj</code> de [[Module:Linguistique]]. Valeurs possibles :
* <code>and</code> ajoute " et " entre l'avant dernière et la dernière valeur, une virgule entre les autres.
* <code>or</code> ajout " ou " entre l'avant dernière et la dernière valeur
* <code>comma</code> des virgules partout
* <code>new line</code> un retour à la ligne
Toute autre valeur donnée au paramètre sera insérée entre chaque valeur (<code>|conjtype = et puis aussi</code> ajoutera "et puis aussi" entre chaque valeurs)
|-
| linkback || liste des déclarations || Lua et wikicode || Ajoute un rétrolien vers Wikidata sous forme d'un crayon « [[File:Blue pencil.svg|10px]] »
|-
| addcat || liste des déclarations || Lua et wikicode || Met la page dans une catégorie de suivi (voir [[:Catégorie:Page utilisant des données de Wikidata]]). Le nom de la catégorie correspond à la valeur du paramètre. Si cette valeur est simplement <code>true</code>, la catégorie est fonction du paramètre property.
Attention, ce paramètre peut être source de bugs. Par exemple, si la propriété est utilisée dans une url ou un lien.
|-
| removedupes || choix des déclarations <br />(à la fin, dans une fonction différente) || Lua et wikicode || Lorsque, après toutes les mises en forme, deux déclarations sont rendues de la même manière, une seule est conservée.
|-
|rowspan=2| lang || mise en forme des données || Lua et Wikicode || Langue dans lequel le texte doit être retourné.
|-
| snak (entité) || Lua et wikicode || Code Wikimédia de la langue utilisée pour afficher les libellés (par défaut : français)
|-
| ucfirst || liste des déclarations || Lua et Wikicode || Par défaut, la fonction formatStatements ajoute une majuscule en début de texte. <code>|ucfirst=-</code> permet de désactiver cela
|-
| statementformat || déclaration || Lua || doit être une fonction <code><nowiki>fonction(statement) return XX </nowiki></code> retournant une chaîne. Elle sera appliquée à sur chaque déclaration (permet de simplifier certaines infobox Lua)
|-
| showdate|| déclaration || Lua et wikicode || Pour afficher la date entre parenthèses en petit pour chaque déclaration en utilisant les mêmes qualificatifs que (withdate). Lorsqu'aucune date n'est trouvée, la valeur est affichée sans aucune date.
|-
| displayformat || snak || Lua et wikicode|| Pour changer le format par défaut entre chaque valeur. <br />
* <code>weblink</code> transforme les données de type chaîne en lien web
* <code>raw</code> retourne un format plus brut parfois utile au codage
* <code>latitude</code> pour [[Module:Coordinates]]
* <code>longitude</code> pour [[Module:Coordinates]]
En lua, la valeur du paramètre peut aussi être une fonction.
|-
| qualifdisplayformat || snak || Lua et wikicode|| Format d'affichage des qualificatifs. Même fonctionnement que le paramètre <code>displayformat</code>. Lorsque ce paramètre est laissé vide, les qualificatifs utilisent le paramètre <code>displayformat</code> comme la valeur principale.
|-
| showsource || déclaration || Lua et wikicode || Identifiant d'une source que l'on souhaiterait voir affichée en référence si elle est présente. <code>true</code> affichera toutes les sources utilisant la propriété {{WD P|248}}.
|-
| linktopic || snak (temporel) || Lua et wikicode || Type de lien à ajouter aux dates (voir [[Module:Date]]). Pour ne mettre aucun lien : <code>linktopic = - </code>
|-
|-
| precision|| snak (temporel) || Lua et wikicode || Précision avec laquelle les dates doivent être affichées. Valeurs possibles :
* <code>day</code>
* <code>month</code>
*<code>year</code>
Valeur par défaut : <code>day</code>
|-
| textformat || snak (temporel) || Lua et wikicode || Format d'affichage des intervalles de temps, tels que définis par [[Module:Date complexe]]
* <code>minimum</code> affichera "1995" à la place de "à partir de 1995".
|-
| speciallabels || snak (entité) || Lua|| Tables de valeurs spéciales à utiliser à la place du libellé Wikidata pour la valeur de certains éléments, par exemple [[Module:Dictionnaire Wikidata/Métiers]].female
|-
| labelformat || snak (entité) || Lua || Fonction de mise en forme des libellés
|-
| showlang || déclaration || Lua et wikicode || Lorsque la valeur principale est de type "texte monolingue", son code langue est affiché (utilisé par [[Module:Site officiel]])
|-
| showqualifiers || déclaration || Lua et wikicode || Qualificatif à retourner entre parenthèses derrière la valeur de la propriété principale demandée. En wikicode sous le format <code><nowiki>|</nowiki>showqualifiers = P460</code>, en Lua sous le format <code>showqualifiers = "P460"</code> ou <code>showqualifiers = {"P460", "P461"}</code>
|-
| showonlyqualifier || déclaration || Lua et wikicode || Qualificatif de même, mais à retourner seul sans la valeur de la propriété principale demandée
|-
| link || snak (entité) || Lua et wikicode || Site vers lequel doivent lier les données de type élément. Par défaut : Wikidata en français. Si égal à "-", aucun lien ne sera créé.
|-
| defaultlink || snak (entité) || Lua et wikicode || Lorsque le site demandé par le paramètre link ne retourne pas de lien, affiche un lien entre parenthèses vers le site demandé. Par défaut : Wikipédia en anglais ou, si absent, Wikidata. La valeur "-" désactive le paramètre.
|-
| defaultlinkquery || snak (entité) || Lua || Lorsque le site demandé par le paramètre link ne retourne pas de lien, ce paramètre définit une requête que <code>recup.getClaims</code> utilise pour créer un lien. Par exemple, avec <code>|defaultlinkquery = {property = 'P279'}</code> le lien créé correspondra à celui fourni par l'élément utilisé dans la propriété {{WD P|279}}.
|-
| targetunit || snak (quantité) || Lua et Wikicode || Unité dans laquelle doivent être converties les données de type quantité. Les valeurs possibles sont visibles dans [[Module:Conversion/Données]], par exemple km ou km2.
|-
| showunit || snak (quantité) || Lua et Wikicode ||
Manière d'afficher l'unité demandée. Valeurs possibles :
* <code>'long'</code> : affiche le nom complet de l'unité (par exemple "12,7 mètres")
* <code>'short'</code> affiche l'abréviation conventionnellement utilisée ("12,7 m")
* <code>'-'</code> : aucune unité affichée
défaut : 'short'</code>
|-
| rounding || snak (quantité) nombre de chiffres || Lua et Wikicode || Nombre de chiffres significatifs à afficher dans les données de type quantité, après conversion éventuelle (défaut : dépend de la précision indiquée sur Wikidata)
|-
| urlpattern || snak (string) || Lua et wikicode || La valeur du paramètre est un chaîne représentant une URL, l'expression "$1" sera remplacée par la valeur Wikidata <br /> Avec la propriété {{WD P|214}} et la valeur de paramètre <nowiki>http://viaf.org/viaf/$1</nowiki>, la valeur de l'identifiant VIAF stockée sur Wikidata sera utilisée pour créer un lien externe..
|-
| text || snak (string) || Lua et wikicode || Texte à afficher lorsque la valeur crée un lien externe, c'est-à-dire pour les données de type chaîne avec <code>displayformat = "weblink"</code> ou avec le paramètre <code>urlpattern</code> renseigné. Par défaut : la valeur initiale de la déclaration. Utilisé sur [[Module:Site officiel]] [[Module:Bases archi]].
|-
| novaluelabel || snak (novalue) || Lua et wikicode || Libellé à retourner lorsque la valeur est de type "novalue". Par défaut : "-". <br />
En Lua, la valeur peut-être une fonction.
|-
| somevaluelabel || snak (somevalue) || Lua et wikicode || Libellé à retourner lorsque la valeur est de type "somevalue". Par défaut : "inconnu". <br />
En Lua, la valeur peut-être une fonction.
|-
| returnnumberofvalues || liste des déclarations || Lua || retourne en deuxième valeur le nombre de valeurs récupérées par getClaims (si la fonction est appelée depuis du Wikicode, le nombre sera concaténé au reste de la chaîne retournée
|}
== Exemples ==
=== Définition des liens ===
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}} || Capitale de l'Égypte, format standard
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}} || Capitale de l'Égypte, sans lien
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}} || Capitale de l'Égypte, avec lien vers Wikidata
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}} || Date de naissance d'Albert Einstein, en utilisant le format standard de Wikipédia en français
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = football }}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569 |linktopic = football }} || Date de naissance d'Einstein, avec liens spécialisés dans le football
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}} || Date de naissance d'Einstein, sans lien
|}
=== Rang ===
Il existe trois types de rang sur Wikidata : "normal", "preferred" et "deprecated". Le rang deprecated est réservé aux données que l'on sait fausse mais que l'on garde pour mémoire, par exemple pour documenter une croyance ancienne qui a été infirmée par des études plus récentes.
Par défaut, seul le rang "preferred" est récupéré, mais le paramètre "rank" permet de changer cela.
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}} || Matériau de la Joconde, affichage par défaut (donc seulement celles avec le rang "preferred" s'il y en a)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}} || rank = "valid" accepte les valeur de rang "normal" et "preferred" (par exemple, le matériau d'un chassis qui a été ajouté ultérieurement à la Joconde)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}} || rank = "normal" ne récupère que les données avec un rang "normal", et ignore celles avec un rang "preferred"
|}
=== Qualificatifs ===
Les qualificatifs sont des données supplémentaires intégrées à une affirmation Wikidata qu'elle permet de préciser.
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518}} || ne retient que les valeurs ayant un qualificatif {{WD P|518}}
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|qualifiervalue=Q1737943}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518|qualifiervalue=Q1737943}} || qualifiervalue définit la valeur que possède le qualificatif. Ici, {{WD Q|1737943}} précise que l'on demande la matériau du chassis. Notez qu'aucune valeur de rang "preferred" n'étant trouvé, un valeur de rang "normal" est retournée.
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}} || showqualifiers affiche la valeur des qualificatifs demandé entre parenthèse, après la valeur principale
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showdate = true|rank=valid}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid|showdate = true}} || si des qualificatifs indiquant la date sont fournis, ils sont affichées
|}
=== Affichage des sources ===
{| class="wikitable"
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}} ||
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}} ||
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}} || Montre seulement les valeurs données par la source
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}} ||
|}
<references />
=== Autres options ===
{| class="wikitable"
|-
! Code !! Rendu !! Remarques
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity = Q937 | property = P106|conjtype = new line|showdate= true}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity = Q1299 | property = P527|conjtype = new line|showdate=true}} || conjtype permet de définir le séparateur entre les valeurs (voir [[Module:Linguistique]]). Ici "<nowiki>new line</nowiki>" indique qu'il faut revenir à la ligne après chaque valeur.
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=chronological|conjtype =new line}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=chronological|showdate=true|conjtype = new line}} || sorttype = chronological tente de classer les valeurs par ordre chronologique (en se basant sur les qualificatifs). Ici : les événements principaux ([[:d:P:P793]]) dans l'histoire de l'ancien Stade d'Arsenal.
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=inverted|conjtype = new line}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=inverted|showdate=true|conjtype = new line}} || sorttype = inverted pour inverser l'ordre chronologique
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}} || affiche les identifiants des valeurs (essentiellement utile pour la programmation)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}} || retourne les numval première valeurs répondant au reste de la requête (utile notamment pour récupérer une image)
|-
| <nowiki>{{#invoke:Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }}</nowiki> || {{#invoke:Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }} || avec expl=, pour que la valeur soir retournée il faut value=<nowiki>{{WD}}</nowiki>
|-
|}
<includeonly>
{{Projet Scribunto}}
</includeonly>
<noinclude>
[[Catégorie:Documentation de module|{{BASEPAGENAME}}]]
</noinclude>