Modul:Wikidata/doc
Aceasta este pagina de documentație pentru Modul:Wikidata
Aceasta este pagina de documentație pentru Modul:Wikidata. Pagina descrie modul de folosire al formatului și conține categoriile de care acesta aparține, precum și orice altceva ce nu face parte din formatul propriu-zis. Ea poate fi editată modificând pagina Modul:Wikidata/doc |
Acest modul folosește pentru accesarea datelor din structurile de la Wikidata. Desigur, există {{#property:}} cu care se poate accesa o proprietate a itemului curent, dar de cele mai multe ori este nevoie de acțiuni mai complexe.
Convenții
modificareFuncțiile al căror nume începe cu get sunt dedicate formatelor și paginilor, și primesc ca argument un frame (care se transmite automat la apelul din pagini sau formate). Cele al căror nume începe cu find sunt dedicate celorlalte module, și primesc ca argumente direct valorile necesare. De regulă, cele din urmă doar extrag argumentele, apoi le apelează pe cele dintâi cu argumentele extrase.
Modificatori de formatare
modificareAnumite funcții apelate din formate permit următorii parametri ce modifică formatarea rezultatelor:
- ill: înlocuiește formatarea legăturilor către Wikidata folosită în infocasete cu folosirea formatului {{ill-wd}}.
- si: convertește „snak”-urile de tip cantitate la o unitate a Sistemului Internațional echivalentă.
Toți acești parametri pot avea orice valoare.
Funcții exportate
modificareFuncție | Argumente | Comportament | |
---|---|---|---|
descriptionIn |
frame cuprinzând ca argumente:
|
Extrage descrierea unui item într-o limbă. Limba este specificată de primul argument și poate lipsi, caz în care se folosește limba wikiului; id-ul itemului poate lipsi, caz în care se folosește itemul asociat paginii curente. | |
labelIn |
frame cuprinzând ca argumente:
|
Extrage eticheta unui item într-o limbă. Limba este specificată de primul argument și poate lipsi, caz în care se folosește limba wikiului; id-ul itemului poate lipsi, caz în care se folosește itemul asociat paginii curente. | |
getEntityId | Extrage id-ul entității curente. | ||
findLinkToItem |
|
Creează un link către articolul despre o altă entitate decât cea în pagina în care ne aflăm. Se poate cere scrierea etichetei linkului cu inițială majusculă (dacă regulile gramaticale o impun — cazul în care linkul se pune la începutul unui titlu sau al unei fraze); în forma de feminin (de exemplu, pentru meserii, dacă ele sunt referite ca practicate de o femeie); sau cu cea mai scurtă variantă posibilă (dacă se dorește o abreviere). Oricare din ultimele trei flaguri poate lipsi, caz în care ele sunt considerate a avea valoarea false. | |
findLinkToItemWithLabelFromClaim |
|
Ca și findLinkToItem, doar că generalizează modul de obținere a etichetei: se poate preciza o proprietate a entității de la care se va obține eticheta | |
findLinkToItemWithLabelFromAnyClaim |
|
Ca și findLinkToItemWithLabelFromClaim, doar că generalizează și mai mult modul de obținere a etichetei: se poate preciza o listă de proprietăți ale entității care sunt verificate pe rând până se găsește una care are o valoare | |
printSnak |
|
Afișează un „snak” (element polimorf din structura de date de la Wikidata). Este utilă atunci când într-un modul se procesează date preluate în mod direct din structurile de date de la Wikidata. Acest snak poate fi o dată calendaristică, id-ul unui alt item Wikidata, un șir de caractere etc. Funcția ia decizia a ce afișează în funcție de tipul snakului. | |
outputReferences | Creează note de subsol conținând referințele bibliografice asociate unei afirmații. Notele de subsol sunt evitate dacă referința este către un alt proiect Wikipedia. Numele refului se calculează automat pentru a putea fi reutilizat de la o instanță la alta. | ||
getValueList |
|
Întoarce un table format din toate valorile cu rang de la normal în sus pentru proprietatea și entitatea specificată. | |
getValueListLimited |
|
Întoarce un table cu cel mult limitVal elemente format din valori cu rang de la normal în sus pentru proprietatea și entitatea specificată și un int ce reprezintă numărul total de valori ce ar fi fost întoarse dacă nu exista limitVal | |
printTimestampForClaim | Întoarce, între paranteze, datele temporale asociate afirmației:
| ||
getTimestampedValueList |
|
Întoarce un table format din valorile pe care le-ar returna funcția getValueList, fiecare urmată de valoarea pe care ar returna-o, pentru fiecare, funcția printTimestampForClaim apelată cu claimul asociat fiecăreia. | |
findValueListWithQualifiersInBrackets |
|
Întoarce un table format din valorile pe care le-ar returna funcția getValueList, fiecare urmată de o paranteză conținând calificativele sale de la Wikidata formatate după template-ul specificat ca al patrulea parametru. | |
getValueListWithSeparator |
|
Returnează o listă ale cărei elemente sunt separate prin separatorul specificat, elementele fiind valorile pe care le-ar returna funcția getValueList apelată cu id-urile de proprietate și entitate specificate. | |
_getValueListWithSeparator | Ca și getValueListWithSeparator, doar că primește direct table-ul de argumente, nu frame-ul | Ca și getValueListWithSeparator. | |
getTimestampedValueListWithSeparator | Un frame, având pe prima poziție separatorul, pe a doua id-ul de proprietate și pe a treia id-ul de entitate | Returnează o listă ale cărei elemente sunt separate prin separatorul specificat, elementele fiind valorile pe care le-ar returna funcția getTimestampedValueList apelată cu id-urile de proprietate și entitate specificate. | |
_getTimestampedValueListWithSeparator | Ca și getTimestampedValueListWithSeparator, doar că primește direct table-ul de argumente, nu frame-ul | Ca și getTimestampedValueListWithSeparator. | |
getEntityIdsList |
|
Întoarce un table conținând id-urile de entitate, cu rank cel puțin normal, către care trimite proprietatea specificată a entității specificate. | |
getBestEntityIdsList |
|
Întoarce un table conținând id-urile de entitate, cu rank cel mai mare, către care trimite proprietatea specificată a entității specificate. | |
findClaimsForProperty |
|
Întoarce un table conținând claimurile pure ce reprezintă afirmațiile asociate proprietății specificate a entității specificate. | |
findBestClaimsForProperty |
|
Întoarce un table conținând claimurile pure ce reprezintă afirmațiile cu cel mai bun rang, asociate proprietății specificate a entității specificate. | |
findSortedClaimsForProperty |
|
Întoarce un table conținând claimurile pure ce reprezintă afirmațiile asociate proprietății specificate a entității specificate, sortate în funcție de calificatorul start time (P580) asociat lor. | |
findQualifierValueListForClaim |
|
Întoarce un table conținând reprezentarea valorilor asociate calificatorului specificat pentru claimul specificat. | |
getQualifierValue | Un frame conținând în tabelul args, în ordine, id-ul proprietății și id-ul calificatorului | Întoarce reprezentarea tuturor calificatorilor cu id-ul specificat pentru proprietatea cu id-ul specificat a entității curente. Calificatoarele sunt separate prin virgulă și spațiu. | |
getRawValue | Un frame având pe prima poziție a tabelului args valoare id-ului proprietății. | Întoarce reprezentarea dată de funcția formatPropertyValues a entitătii curente, apelată cu id-ul de proprietate specificat. | |
getRawQualifierValue | Un frame având pe prima poziție a tabelului args valoare id-ului proprietății și pe a doua id-ul unui calificator. | Întoarce reprezentarea simplă a valorii (dacă valoarea este id-ul unui alt element, aceasta este labelul acelui element) tuturor calificatoarelor cu id-ul specificat ale id-ului proprietății cu id-ul specificat a entității curente. Reprezentările sunt separate prin virgulă. | |
findDateValues |
|
Întoarce un table ale cărui elemente sunt la rândul lor table-uri reprezentând datele cu rangul cel mai bun asociate proprietății cu id-ul specificat al entității cu id-ul specificat. Proprietățile fiecărui element din table-ul ce reprezintă data sunt:
| |
getDateValue | Un frame conținând în tabelul args pe prima poziție id-ul de proprietate, pe a doua id-ul de entitate (nil înseamnă entitatea curentă), pe a treia un format de dată (implicit dmy) și pe a patra un sufix pentru datele dinaintea erei noastre | Întoarce o listă a datelor cu rang cel puțin normal asociate id-ului de proprietate și id-ului de entitate specificate, formatate după cum specifică formatul de dată și sufixul, separate prin virgulă și spațiu. | |
pageId | Întoarce id-ul din Wikidata al elementului asociat paginii curente | ||
getPreferredValue | Un frame conținând în tabelul args pe prima poziție id-ul de proprietate și pe a doua id-ul de entitate (nil înseamnă entitatea curentă) | Întoarce, separate prin virgulă, valorile cu rang preferred pentru entitatea și proprietatea specificate. | |
ViewSomething | Un frame conținând în tabelul args o serie de elemente care împreună constituie o cale de urmat prin modelul de date de la Wikidata | Întoarce data existentă pe calea specificată. | |
Dump | Un frame conținând în tabelul args o serie de elemente care împreună constituie o cale de urmat prin modelul de date de la Wikidata | Întoarce datele existente pe calea specificată; dacă datele sunt un tabel, el se expandează și se afișează toate datele din el. Funcția este de folosit pentru debug și pentru analiză | |
findOneValue |
|
Returnează o singură valoare din cele cu rangul cel mai înalt cu referințele corespunzătoare pentru o proprietate specificată, împreună cu note de subsol care reprezintă referințele bibliografice. Se apelează din alte module. | |
findOneValueNoRef |
|
Același lucru ca findOneValue, dar fără referințe bibliografice. | |
getOneValue |
|
Returnează o singură valoare din cele cu rangul cel mai înalt cu referințele corespunzătoare pentru o proprietate specificată, împreună cu note de subsol care reprezintă referințele bibliografice. | |
getOneValueNoRef | Un frame conținând în tabelul args pe prima poziție id-ul de proprietate și pe a doua id-ul de entitate (nil înseamnă entitatea curentă) | Același lucru ca getOneValue, dar fără referințe bibliografice. | |
getLatestQualifierDateValueForOneProperty | Un frame conținând în tabelul args pe prima poziție id-ul de proprietate și pe a doua id-ul qualifierului | Returnează valoarea cea mai recentă a qualifierului specificat pentru proprietea specificată a entității curente | |
findLatestQualifierDateValueForOneProperty |
|
Același lucru ca și getLatestQualifierDateValueForOneProperty, doar că de apelat din alte module | |
getReferenceForOneProperty | Un frame conținând în tabelul args pe prima poziție id-ul proprietății | Returnează un text ce conține referința pentru o proprietate a entității curente; de apelat din formate | |
findLabel |
|
Returnează labelul unei entități în limba specificată; dacă nu se găsește, atunci se încearcă în limba wikiului și apoi în limba engleză | |
getLabel | Un frame conținând în tabelul args pe prima poziție id-ul de entitate (nil înseamnă entitatea curentă) și pe a doua codul limbii | Ca și findLabel, dar apelabil din formate sau pagini | |
findBestValues |
|
Returnează o listă a valorilor cu rangul cel mai înalt cu referințele corespunzătoare pentru o proprietate specificată. Apelabil din module. | |
getBestValuesWithSeparator | Un frame conținând în tabelul args pe prima poziție un separator, pe a doua id-ul proprietății și pe a treia id-ul de entitate (nil înseamnă entitatea curentă). | Returnează valorile cu rangul cel mai înalt și cu referințele corespunzătoare pentru o proprietate specificată, despărțite prin separatorul specificat | |
findLanguageText |
|
Întoarce labelul unei entități asociate proprietății specificate a entității specificate, în limba specificată; dacă nu se specifică entityId, se folosește entitatea curentă; dacă nu se specifică langcode, se caută întâi în limba wikiului și apoi în limba engleză | |
getLanguageText | Un frame conținând în tabelul args pe prima poziție id-ul de proprietate, pe a doua codul limbii și pe a treia id-ul de entitate | Același lucru ca și findLanguageText, doar că apelabilă din formate și pagini | |
findClaimForTimestamp |
|
Claimul din entitatea specificată, corespunzător proprietății specificate, cu valori ale calificatorilor pentru proprietățile start time și end time care cuprind între ele data specificată de timestamp. Dacă timestamp lipsește, se returnează primul claim întâlnit cu rangul cel mai mare. | |
findOnlineLinks |
|
Un table ce conține legăturile web formatate cu tot cu titlu, pentru entitatea specificată | |
getOnlineLinks | Un frame ce conține pe pozițiile numerice valorile proprietăților de căutat, iar pe poziția qid ID-ul entității asociate; dacă nu este precizat, se consideră entitatea asociată paginii curente | Ca și findOnlineLinks, doar că lista este concatenată cu fiecare link pe câte o linie. | |
findTitleOfWork | entityId - id-ul entității | Titlul unei opere așa cum ar trebui afișat aici. Se caută, în ordine: eticheta în română, titlul în română, titlul în limba originară, eticheta în limba originară, eticheta în engleză | |
findTitlesOfWorksFromProperty |
|
Caută cu ajutorul funcției findTitleOfWork de mai sus titlurile unor opere listate în proprietatea specificată a entității specificate și le returnează ca intrări într-un table; titlurile sunt linkuri trimit spre articolul sau itemul wikidata corespunzător operei; | |
findBestValuesForLocalLanguage |
|
Returnează o listă a valorilor de cel mai mare rang asociate limbii române prin intermediul unui calificator cu proprietatea limba operei sau a denumirii (P407). | |
getBestValuesForLocalLanguageWithSeparator |
|
ca mai sus, doar că apelabilă din format; primește mai întâi un separator și apoi id-urile | |
getTitleOfWorkFromPropertyWithSeparator | Un frame ce conține următoarele argumente:
|
Ca și findTitlesOfWorksFromProperty, dar primește frame, returnează lista serializată cu separatori și cu titlurile italicizate | |
loadOneValueInChain | Un număr teoretic nelimitat de argumente înlănțuite care descriu o cale prin structurile Wikidata. Implicit, punctul de început este elementul Wikidata asociat paginii curente. Dacă un argument este un ID de element Wikidata, atunci acela este stabilit ca punct de început. Dacă este un ID de proprietate, atunci se trece la valoarea proprietății respective pentru elementul curent. Dacă este un ID de proprietate precedat de _ atunci se trece la calificatorul asociat proprietății respective asociate snakului curent. În cele două cazuri din urmă se folosește la fiecare pas doar un singur snak, de rangul cel mai mare. Vezi și {{Date înlănțuite de la Wikidata}}. | Forma textuală a snakului final de pe lanț; nil dacă nu există date sau lanțul nu poate fi parcurs până la destinație | |
getOneValueInChain | Ca și mai sus, doar că apelabil cu un frame | Ca și mai sus | |
isA |
|
true dacă entitatea cu id-ul entityId are unul din tipurile cu ID-ul din colecția typeIds sau unul din subtipurile directe sau indirecte ale acestuia; false altfel | |
formatExternalLink | Formatează o proprietate a cărei valoare este un link extern |
|
|
getFormattedExternalLink | Ca și mai sus, apelabilă cu un frame | Ca și mai sus, apelabilă cu un frame; pId poate fi dat ca primul parametru fără nume; qId poate fi dat ca al doilea parametru fără nume | |
findAnniversary |
|
Întoarce numărul de ani trecuți de la evenimentul descris în proprietate dacă acesta este multiplu de step, 0 altfel | |
getAnniversary | Ca și mai sus, doar că apelabil cu un frame | Ca și mai sus | |
getLocationChain |
|
Întoarce o listă de locații în care se află entitatea curentă |