Modulo:Wikidata/man
Questa è la pagina di documentazione per Modulo:Wikidata
Il modulo Wikidata serve per leggere il valore delle proprietà di Wikidata, relative alla pagina corrente, cioè la pagina in cui è utilizzato il modulo. Sarà in futuro possibile leggere le proprietà anche di pagine diverse da quella corrente. Il modulo fornisce un utilizzo più avanzato, a volte senza alternativa, rispetto a quello che si può ottenere con la magic word: {{#property:NumProprietà}}.
Utilizzo[modifica]
Il modulo ha tre funzioni:
- formatStatements: restituisce il valore di una proprietà di Wikidata. Nel caso una proprietà ha più di un valore (statement) li può restituire tutti, separandoli con una virgola e inserendo la congiunzione "e" prima dell'ultimo, oppure filtrarli se si specifica un rank, un qualifier o un indice. Permette di formattare l'output attraverso delle opzioni (da qui il nome formatStatements). Se la pagina non ha un elemento su Wikidata, oppure non ha la proprietà specificata, oppure il valore della proprietà è a sua volta un elemento che non ha un'etichetta in italiano, non restituisce nulla. Se possibile, i valori delle proprietà sono restituiti con wikilink, compresa eventuale disambiguazione nascosta con la barra verticale (es. [[Savoia (dipartimento)|Savoia]]). Il nome italiano della voce viene ricavato dall'interlink del rispettivo elemento su Wikidata; se il soggetto non è presente su Wikidata, il valore viene restituito senza wikilink.
- getQualifier: restituisce il valore di un qualifier di una proprietà di Wikidata. Se la proprietà ha più statement e il qualifier è presente in più statement, oppure se il qualifier ha più valori, li può restituire tutti, oppure si possono filtrare in base a rank e indice (dello statement) come per la formatStatements.
- N: ritorna il numero di statement della proprietà richiesta
Parametri di formatStatements[modifica]
La funzione formatStatements ha i seguenti parametri, l'unico obbligatorio è property. Gli esempi utilizzati fanno riferimento alla voce Dante Alighieri (le cui proprietà su Wikidata sono queste: d:Q1067).
Parametri di selezione:
- property: il codice della proprietà
- rank: se valorizzato, il modulo ritorna solo gli statement che hanno un certo rank. I rank disponibili sono i tre definiti da Wikidata: deprecated, normal e preferred, più il tipo best. Con quest'ultimo vengono ritornati gli statement a partire dal rank più alto: i preferred se presenti altrimenti i normal.
- qualifier: codice di un qualifier di una proprietà. Verranno ritornati solo gli statement che posseggono quel qualifier.
- qualifiervalue: valore del qualifier specificato con il parametro qualifier. Verranno ritornati solo gli statement che posseggono quel qualifier e con il valore specificato con qualifiervalue.
- qualifiertype: ulteriore filtro sul qualifier specificato. Ha attualmente un unico valore accettato,
qualifiertype=latest: se il qualifier contiene un valore di tipo "time", verrà ritornato solo lo statement che possiede quel qualifier e con il valore più recente. - n: se la proprietà ha più statement ritorna l'n-esimo
- value: se valorizzato, il modulo ritorna il valore di questo parametro invece di quello su Wikidata, formattandolo eventualmente secondo il pattern se specificato. Serve quando si usa il modulo da un template, per dare la precedenza al valore passato al template rispetto a quello su Wikidata.
- esempio:
{{#invoke:Wikidata|formatStatements|property=p19|value={{{LuogoNascita|}}}}}ritornerà: il valore di LuogoNascita se valorizzato, altrimenti quello della proprietà p19 su Wikidata
- esempio:
- entityId: per ora NON FUNZIONANTE, quando sarà attivato permetterà di specificare un'entity di Wikidata relativa a una pagina diversa da quella in cui ci si trova
Parametri per la formattazione del risultato:
- separator: separatore tra valori multipli, se diverso da virgola_spazio
- conjunction: separatore tra gli ultimi due valori, se diverso da spazio_e_spazio
- pattern: pattern utilizzato per ogni statement, sia per le proprietà che per il parametro "value" quando presente. La stringa "$1" verrà rimpiazzata dal valore ritornato per ogni sua occorrenza.
- esempio:
{{#invoke:Wikidata|formatStatements|property=p18|pattern=[[File:$1|thumb|Il nome del file è $1]]}}ritornerà:[[File:Portrait de Dante.jpg|thumb|Il nome del file è Portrait de Dante.jpg]](d:P18 è l'immagine) - esempio con value:
{{#invoke:Wikidata|formatStatements|property=p18|value={{{Immagine|}}}|pattern=[[File:$1|thumb|Il nome del file è $1]]}}In un template, se il parametro Immagine fosse valorizzato a "Test.png" allora ritornerebbe[[File:Test.png|thumb|Il nome del file è Test.png]], altrimenti se Immagine non fosse valorizzato, lo stesso risultato dell'esempio precedente.
- esempio:
- list: formatta il risultato ritornato come lista non ordinata, si deve assegnargli un valore qualunque, es: "list=sì". Eventuali parametri separator e conjunction vengono ignorati.
- esempio:
{{#invoke:Wikidata|formatStatements|property=p106|list=1}}
- esempio:
- orderedlist: formatta il risultato ritornato come lista ordinata, si deve assegnargli un valore qualunque, es: "orderedlist=sì". Eventuali parametri separator e conjunction vengono ignorati. Se sono presenti entrambi i parametri list e orderedlist viene creata una lista non ordinata
- esempio:
{{#invoke:Wikidata|formatStatements|property=p106|orderedlist=1}}
- esempio:
- formatting: esegue formattazioni speciali, attulmente i valori consentiti sono:
formatting=latitudeeformatting=longitudeper ritornare solo latitudine o longitudine in caso di proprietà di tipo coordinata - value-module: nome di un modulo che effettua una formattazione speciale
- value-function: funzione nel modulo value-module
Parametri di getQualifier[modifica]
Parametri di selezione:
- gli stessi di formatStatements, con in più la differenza che i parametri obbligatori sono, oltre "property", anche "qualifier".
Parametri per la formattazione del risultato:
- gli stessi di formatStatements, ad eccezione di list e orderedlist.
Parametri di N[modifica]
La funzione N ha un unico parametro (ordinale) per specificare la proprietà.
- esempio:
{{#invoke:Wikidata|N|p40}}ritornerà: 2 (d:P40 è "figli")