Modul:Wikidata2/dok

Modulen används för att hämta formaterad data från Wikidata.

Huvudfunktion

Anrop

Exempel:

{{#invoke:Wikidata2|formatStatements|property=p17}}
{{#invoke:Wikidata2|formatStatements|property=P242|enbarten=ja|noref=ja}}}
{{#invoke:Wikidata2|formatStatements|property=P127|conjunction=<br/>|separator=<br/>|avoidqualifier=P582|noref=noimport}}}}
{{#invoke:Wikidata2|formatStatements|property=P276|sortbytime=inverted|conjunction=<br/>|separator=<br/>|avoidqualifier=P582}}}}

Parametrar

• property = Nödvändig parameter som beskriver vilken property som ska hämtas. Exempel: property = P625.
  • om property anges som Pxxx/Pyyy/.../Pzzz traverseras alla P där alla utom det sista måste ge ett wikidataobjekt. Observera att endast det första påståendet på varje "nivå" beaktas.
  • om property anges som Pxxx:Qrrr,Qsss,.../Pyyy:Qttt,Quuu,.../..../Pzzz görs en filtrering så att endast objekt med P31=något av de angivna Q... på respektive nivå beaktas. Använd parametern getonly, se nedan, för att filtrera på den sista nivån.

• entityId = Det id-nummer den artikel har som du vill hämta property från.
• entity = Istället för att förse modulen med ett qid-nummer, kan man förse den med hela objektet. Denna parameter vill ha en tabell, varför den bara fungerar inom Lua.

• enbarten = När bara ett värde ska hämtas. Tex för att hämta bild på heraldiskt vapen, och då inte få tillbaka alla objekt.
• claimindex = Ger också bara ett värde, men det X:e i raden av befintliga värden.
• numberofclaims = Om parametern ges ett värde returneras enbart antalet värden.

• separator = När något annat än "," ska separera en lista på objekt. Tex separator=<br/> Se även conjunction
• conjunction = Som ovan, men påverkar bara den sista separatorn i en lista av objekt. Default är och.

• label = När man själv vill välja hur länken ska formateras. Tex [[Blekinge läns vapen|vapen]] fås av att ange label=vapen Den här parametern påverkar även enheter
  • koordlabel = När koordinater ligger i en qualifier, så styrs labeln för länken genom koordlabel-parametern.

• kortnamn = ger P1813 (kort namn) som label i de fall där det finns

• labelformatter = ändrar label efter vad som anges i Modul:Wikidata2/Aux2. labelformatter = demonym ändrar tex USA till amerikan

• labelgender = väljer label efter ett värde i det anropade objektet.
• labelgenderproperty = vilken property som det ska sökas i (default = P1549)
• labelgenderlangpref = vilket språk man ska föredra (default = sv)
• labelgenderqualifier = vilken qualifier man ska söka i (default = P518)

• labelfromnameproperty = för den property som anges i property väljs som label det namn (P2561) som har startdatum (P580) och/eller slutdatum (P582) som "gafflar in" den property som anges som parametervärde. Exempel på användning: property = P19, labelfromnameproperty = P569 för att få det namn (P2561) på födelseplats (P19) som gällde vid födelsedatum (P569).

• pattern = När man vill hämta en sträng och passa in den i ett mönster, exempelvis för att lägga in en kod av något slag istället för $1 i https://viaf.org/viaf/$1/.
  • pattern = auktoritetsdata är ett specialfall av ovanstående. Det "pattern" som används, är då det som är angivet i P1630 (format för URL) för den berörda propertyn.
  • pattern = auktoritetsdata2 kompletterar ovanstående och skapar en länk av typen [https://viaf.org/viaf/$1/ $1]

• rank = Bestämmer vilken typ av Claims som ska släppas igenom.
  • rank = all släpper igenom alla claims
  • rank = valid släpper igenom preferred och normal, men inte deprecated
  • rank = best (default) släpper igenom preferred, men om det inte finns släpps normal igenom
  • rank = preferred/normal/deprecated släpper igenom angiven rank, men ingen annan

• avoidqualifier = Sorterar bort värden som är associerade med en viss property i sin qualifier. Exempelvis avoidqualifier=P518 (berörd del) om man vill ha folkmängden för hela orten, inte bara de som är kvinnor eller den andel som bor i Haninge kommun.

• avoidstringpattern = Sorterar bort värden av typen "string" som innehåller ett visst "pattern". Se Lua reference manual för detaljer om "pattern".

• nolink = Något värde tar bort länkar, även länkar till enheter görs olänkade.
  • nounitlink = samma som ovan, men påverkar bara enheter.

• noshortunit = enheter förkortas inte med ett värde i denna parameter, d.v.s kilometer förkortas inte till km, vilket annars är standard.

• sortbytime = sorterar claims efter datum i qualifiers, detta system används med fördel tillsammans med parameter enbarten ovan
  • sortbytime = chronological sorterar claims i kronologisk ordning i qualifiers
  • sortbytime = inverted sorterar claims i omvänd kronologisk ordning i qualifiers

• sortnotimeas = möjliggör sortering av tidsvärden som saknas. För närvarande stöds endast parametervärdet maxtime.
• sortbyvalue = sorterar claims efter värde i qualifiers, detta system används med fördel tillsammans med parameter enbarten ovan
  • sortbyvalue = ascending sorterar claims i stigande ordning i qualifiers
  • sortbyvalue = descending sorterar claims i fallande ordning i qualifiers

• sortingproperty = Ange vilken property som ska stödas. Det går att lägga in en tabell i denna parameter, men då bara från en annan modul. Default är: 'P585','P571','P580','P569','P582','P570' i given ordning. Hittills stöds properties med datatype = time eller med datatype = value där värdet går att konvertera till ett tal.

• sortbyarbitrary = sorterar claims efter datum de objekt som länkas i de olika statementen, exempelvis födelsedag för en rad av "barn". Tillåtna värden är 'chronological' eller 'inverted'. Vilken property som ska sökas anges med parameter 'sortingproperty ovan'.

• langpref = I denna modul finns det ett filter som prioriterar claims som har qualifiern "språk = svenska". Ett värde på parameter langpref inaktiverar detta filter

• noref = Ange ett värde i denna parameter om du inte är intresserad av att ta med själva källhänvisningen, utan bara datan.
  • noref = noimport Gör att källor av typen "importerad från (P143)" inte visas.

• sources = basic lägger in ett krav att det ska finnas källor för att ett påstående ska kunna användas
  • sources = required diskvalificerar källor av typen "importerad från (P143)"

• sourcelimit = N Tillåter max N antal källhänvisningar till ett påstående. Default är 3
• norefrank = true En funktion som väljer bort "sämre" källor framför bättre är aktiv per default. Användandet av norefrank stänger av denna funktion.

• versalisering = För att ange vilken versalisering utdatan ska ha. Tillåtna värden är: lc/uc/lcfirst/ucfirst
  • firstversalisering = Samma som ovan, men påverkar bara det första i raden av värden

• av = Hämtar P642 som qualifier och skriver ut värdet av det som "Borgmästare av Gävle" om ett objekt har värdet "Borgmästare" P642 (av) "Gävle"
• avalt = Genom att ange ett annat värde här får man en annan preposition. avalt = i ger "Borgmästare i Gävle".

• modifytime = fixar med datumformat
  • modifytime = longdate skriver datum på formatet "21 januari 2026", dvs ner till datumnivå när så tillåts
  • modifytime = longdatelink, som longdate men med länkning av datum (eller månad) och år, alltså "21 januari 2026", "januari 2026 eller "2026".
  • modifytime = Y skriver datum på formatet "2026", dvs endast årtal.
  • modifytime = Ylink, som Y men med wikilänkning av årtalet, alltså "2026".
• modifyqualifiertime = Som ovan, men påverkar bara qualifiers

• withdate = lägger till (21 januari 2026) till det källbelagda värdet. Hämtas från Propertyn för tidpunkt.
• dateonly = ger enbart tidpunkten för ett claim, inte själva värdet.
• withintervall = lägger till (21 januari 2026-28 januari 2026) till det källbelagda värdet. Hämtas från Propertyn för startdatum och Propertyn för slutdatum.
  • withintervall = gift ger att intervallet skrivs ut med ett g. framför.
• withintervallformat = Y ger att endast årtalen för startdatum och slutdatum visas.
• withmandatperiod = lägger till mandatperiod om den är angiven. Hämtas från Propertyn för mandatperiod.

• lowesttimeprecision = skapar ett filter så att tider som är angivna med en timePrecision i Wikidata som under stiger värdet på denna parameter ignoreras. Kan till exempel användas om man inte vill visa datum med precisionen "århundrade" eller sämre där det är problem med hur sådana värden ska tolkas.

• getsimpleproperty = För att hämta information från det länkade objektet. Denna funktion tillåter ingen iteration, utan går bara en nivå.
  • getproperty = Här anger du vilken property du ska hämta med getsimpleproperty
  • getenbarten = Här anger du om en eller alla statements ska hämtas med getsimpleproperty
  • getmodifytime = Här anger du vilket tidsformat getsimpleproperty ska hämta
  • getraw = Som "raw" nedan

• raw = är en parameter som kan användas från andra moduler. Den resulterar i att utdatan kommer i en tabell.

• novalue = En parameter som styr hur "novalue" på Wikidata ska presenteras här. Tomt värde ger 'nil' som resultat
• somevalue = Som "novalue" ovan

• relevans = Objekt som saknar en sitelink till svwiki inte kommer att inkluderas.

• prefix = Text läggs in före svaret
• suffix = Text läggs in efter svaret

• getonly = Ett Qid. Hämtar bara objekt som uppfyller vissa krav. P31 = Q127448 för Sverige kommuner. Flera värden är möjliga, såsom Q127448,Q193556 för att få både svenska kommuner och landskap.
• getonlyproperty = Om en annan property än P31 efterfrågas

• preferqualifier = Ett Pid. Hämtar endast claims som använder Pid som qualifier.
• preferqualifiervalue = Specificerar vilket värde som passar till ovanstående. Stöder idag endast Qid.

• typen = För parameter "type:" för anropet till GeoHack i koordinater. Default värde är landmark
  • koordtypen = dito, men för när koordinaterna ligger i en qualifier.
• region = för parameter "region:" i anropet till Geohack i samma mall. Om parametern inte används, försöker modulen själv hitta en lämplig region med hjälp av Wikidata.

• grav = Lägger in qualifiers för gravid och koordinater till gravplatsen. grav=coordonly väljer att skriva ut bara koordinaterna.

• wdlink = Lägger in en länk efter påståendet till det objekt där påståendet är angivet. Funktionen är inte tillgänglig i kombination med parametern raw
  • wdlink = sup Formaterar länken som ^WD
  • wdlink = sub Formaterar länken som _WD
  • wdlink = small Formaterar länken som WD

• wdlinklabel = väljer vilken text som ska skrivas ut i länken. Default är: WD

• primary = väljer om en koordinat ska vara av typen "primary" enl mw:Extension:GeoData eller inte. Vilket ord som helst annat än primary = primary ger en secondary koordinat.
  • koordprimary = dito, men för qualifiers.

• nogeodataparser = väljer bort mw:Extension:GeoData helt och hållet. Kan vara lämpligt i en test eller projektsida.

• convertunit = Ger matematisk konvertering av en enhet till en annan (exv cm -> km). Ange ett qid för den data du vill konvertera till! Data som inte går att konvertera hamnar i Wikidata:Påståenden som inte går att konvertera.
• vardesiffror = När det saknas uppgift om precision i datan från WD, görs konverteringen med detta antal värdesiffror. Default = 3.
• withoutunit = Skriver inte ut enheten. Fungerar både med och utan konvertering.
• noformatera = Ger ingen formatering av siffrorna. De kommer ut råa, utan tusenavgränsare och med decimalpunkt isf komma.
• norounding = Skippa avrundning av värden även om de har upperBound och lowerBound som annars medför avrundning.

Övriga funktioner

• getEntityIdForCurrentPage - returnerar "id" (Q-numret) för den sida som anropet sker från.

• getcoord - returnerar latitud eller longitud för angivet objekts (qid) geografiska koordinater (P625).
  Anrop: {{#invoke:Wikidata2|getcoord|qid=<qid>|what=<lat|long>}}
• getcoordfromproperty - returnerar longitud eller latitud för en qualifier geografiska koordinater (P625) för en property för ett angivet objekt.
  Anrop: {{#invoke:Wikidata2|getcoordfromproperty|qid=<qid>|property=<property>|what=<lat|long>}}
• averagepropertyvalue> - returnerar medelvärdet av property Pzzz för alla objekt Pyyy där Pyyy nås via en kedja av properties från huvudobjektet <qid> via Pwww, Pxxx och så vidare där endast det första värdet/objektet på varje nivå beaktas. Ingen hänsyn tas till påståendenas rang.
  Anrop: {{#invoke:Wikidata2|averagepropertyvalue|qid=<qid>|property=<Pwww/Pxxx/.../Pyyy/Pzzz>|avoidqualifier=<avoidqualifier>|what=<lat|long>}}. Parametern avoidqualifier kan användas för att utesluta värden på Pzzz med angiven qualifier. Pzzz måste ha datatypen "quantity" eller "globe-coordinate". Parametern what används endast om Pzzz har typen "globe-coordinate".