Module:Wikidata/Documentation
Apparence
Module permettant d'utiliser de récupérer et de mettre en forme des données issues de Wikidata. Ce module ne gère que les fonctions de relativement "bas-niveau", et ne peut être appelé que depuis un autre module. Pour les fonctions de plus "haut-niveau", ou pour utiliser le module depuis du Wikitexte, passez par Module:Interface 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.
Pour les divers arguments à utiliser pour les fonctions comme formatStatements
, voir Projet:Wikidata/Atelier/Manuel
Fonctions exportables
Nom | Arguments | Descriptions |
---|---|---|
isSpecial | snak |
retourne true si un snak est une valeur spéciale (novalue ou somevalue)
|
getId | snak |
retourne l'identifiant Qdd de l'élément utilisé comme valeur d'un snak |
getNumericId | snak |
retourne l'identifiant numérique de l'élément utilisé comme valeur d'un snak |
getMainId | claim |
retourne l'identifiant Qdd de l'élément utilisé comme valeur du "mainsnak" d'une déclaration |
getEntity | str |
retourne la table de données correpondant à un identifiant (inverse de getEntityId) |
getEntityId | str |
retourne l'identifiant d'une entité Wikidata passée sous la forme d'une table de données (inverse de getEntity) |
getValue | snak |
retourne la valeur d'un snak |
splitStr | str |
transforme en table une chaîne de valeurs en utilisant les virgules comme séparateurs |
isHere | searchset, val |
retourne true si la chaîne val se trouve dans la table searchset
|
addnewvalues | old, new |
ajoute les de nouvelles valeurs à une table, seulement si elles ne s'y trouvent pas déjà |
siteLink | entity, lang, project |
retourne un lien vers la page projet demandé ('wikipedia', 'wikivoyage', 'commons') etc. lié à l'entité Wikidata indiquée, dans la langue demandée (si le projet n'est pas indiqué, on considère qu'il s'agit de Wikipédia) |
isHere | searchset, val |
retourne true si la chaîne val se trouve dans la table searchset
|
getEntityPagename | entity |
|
sitelink | qid |
retourne true si l'identifiant indiqué en paramètre correspond à celui de la page Wikipédia sur laquelle on se trouve
|
hasqualifiers | claim, acceptedqualifs, acceptedvals, excludequalifiervalues |
retourne true 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.
|
sortclaims | claims |
Met en ordre une série de valeurs. L'ordre choisit peut être 'chronological' ou 'inverted' (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 sorttype de wd.formatGetClaims et donc aussi de wd.formatStatements
|
filterClaims | claims, args |
Prend une table d'affirmations, et exclut celles qui ne correspondent pas aux critères donnés dans la table args . Pour la liste de ces arguments, voir l'aide ci dessous
|
getClaims | args |
Récupère les valeurs indiquées dans l'entité indiquée par la clé entity |
getLabel | entity, lang, labelformat |
|
formatEntity | entity, params |
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. |
addtrackingcat | property, cat |
catégorise dans [[Catégorie:Page utilisant $property]] |
tableToText | NE SERT A RIEN à remplacer par linguistic.conj | |
rangeobject | à transformer en fonction locale ? | |
dateobject | à transformer en fonction locale ? | |
getDate | statement |
|
getFormattedDate | statement, params, useallqualifiers |
|
sortDateClaims |
|
|
wikidataDate |
|
|
getReferences | statement |
|
getDatavalue |
|
|
stringTable |
|
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 args. |
getQualifiers |
|
|
getQualifiers |
|
|
getFormattedQualifiers |
|
|
showQualifiers |
|
|
sourceStr |
|
|
formatStatement |
|
Transforme une déclaration individuelle en chaîne wikitexte, selon les mêmes paramètres que stringTable. |
formatSnak |
|
Même logique que formatStatement, mais concerne seulement un snak. |
getDescription |
|
|
addLinkback |
|
|
addRefAnchor |
|
|
formatStatements |
|
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 conjtype qui utilise Module:Linguistique. Si les paramètres linkback et addcat sont activés, un rétrolien et une catégorie de maintenance peuvent également être ajoutés.
|
showQualifier | statement, args |
Même logique que formatStatement , mais affiche un qualificatif au lieu d'une déclaration entière.
|
formatAndCat |
|
|
getTheDate |
|
|
getids |
|
|
Dump |
|
|
groupedStatements |
|