Gebruiksaanwijzing extensie External Data: verschil tussen versies

Huidige versie van 5 mei 2020 om 11:29

Je vindt hier de officiële gebruiksaanwijzing van de Extension:External_Data.

De extensie werkt in twee stappen:

1. Laad de gegevens uit externe bron met behulp van een #get - functie
2. Geef de gegevens weer op de pagina (of: sla de gegevens op met behulp van Semantic MediaWiki)

External Data biedt vijf verschillende manieren om externe gegevens in je wiki-pagina te laden:

<!-- Vanaf een webpagina, inclusief API -->
{{#get_web_data: }}
{{#get_soap_data: }}

<!-- Vanuit een locale file -->
{{#get_file_data: }}

<!-- Vanuit een database -->
{{#get_db_data: }}

<!-- Vanuit een LDAP-server -->
{{#get_ldap_data: }}

Voor het weergeven zijn de volgende opties beschikbaar:

<!-- Geef een waarde van een variabele weer -->
{{#external_value: }}

<!-- Doorloop alle verkregen waarden van een set variabelen en geef elke waarde met omvattende ("container"-) tekst weer - meestal als een tabel. -->
{{#for_external_table: }} 

<!-- Doorloop een tabel met waarden sla deze op als "semantische eigenschap" met behulp van de Semantics MediaWiki estiensie. Dit gebeurt door het voor iedere rij aanroepen van de #subobject functie van SMW. -->
{{#store_external_table: }}

<!-- Doorloop alle verkregen waarden voor een set van variabelen en geef iedere "rij" weer door middel van een sjabloon. -->
{{#display_external_table: }}

Een laatste commando is beschikbaar voor het wissen van gegevens:

<!-- wis de huidige set van verkregen waarden. -->
{{#clear_external_data: }} 

Externe data vanaf een webpagina

{{#get_web_data:
url=data source URL
|format={CSV|CSV with header|GFF|JSON|XML}
|delimiter=delimiter
|data=local_variable_name1=external_variable_name1, etc.
|filters=external_variable_name1=filter_value1, etc.
|use xpath
|post data=additional data
|cache seconds=number of seconds
}}

SOAP

{{#get_soap_data:
url=data source URL
|request=the function used to request data
|requestData=parameter1=value1, etc.
|response=the function used to retrieve data
|data=local_variable_name1=external_variable_name1, etc.
}}

Externe data vanuit een database

Dit voorbeeld moet nog worden uitgewerkt.

Externe data vanuit een LDAP server

Dit voorbeeld moet nog worden uitgewerkt.

Testcase 1 - Gebruik External Data via de API van adlib

Documentatie adlib: [1]

Voorbeeld: Search all records: return all records from collect.inf

http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&search=all

Code External Data:

{{#get_web_data:
url=http://test2.adlibsoft.com/api/wwwopac.ashx?database=collect.inf&search=all
|format=XML
|delimiter=10
|data=creatie=created,
modificatie=modification,
geselecteerd=selected,
administratie naam=administration_name,
maker=creator,
categorie=object_category,
object nummer=object_number,
reproductiereferentie=reproduction.reference,
titel=title, 
taal=lang,
invariant=invariant
|cache seconds=1500
}}

Opmerkingen:

1. Het attribuut / label (attribute, tag) priref is weggelaten, omdat het dubbel voorkomt. Het gebruik Xpath kan hiervoor een oplossing bieden.
2. Het importeren van de letter à - geen ASCII-character - geeft een fout, veroorzaakt door het ontbreken van de multibyte string PHP-extensie (zie: http://php.net/manual/en/book.mbstring.php).

Testcase Ib - Gegevens uit adlib TE

Error: No contents found at URL http://servicetin.adlibhosting.com/te4/wwwopac.ashx?database=perform&search=priref=52391&limit=4&xmltype=Grouped.

Testcase 2 - Gebruik External Data om gegevens uit Wikidata via API op te halen

Documentatie:

• https://www.wikidata.org/w/api.php?action=help&modules=wbgetentities
• https://www.mediawiki.org/wiki/Wikibase/API#wbgetclaims

Voorbeeld labels

https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q2155935&props=labels&languages=nl

Gebruik External data om het "label" (naam van de pagina op Wikipedia ?) op te vragen van het item "Q2155935" in Wikidata.org:

{{#get_web_data: url=https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q2155935&props=labels&languages=nl
&format=json
|format=JSON
|data= wikilabel=value
}}

{{#external_value:wikilabel}}

Resultaat: De Brakke Grond

Alternatief (beter?) is het gebruik "?action=query"

Resultaat: De Brakke Grond

Resultaat lijkt goed, maar query werkt niet en geeft fouten.

api.php?action=query&prop=wbentityusage&titles=Main%20Page|Malayan%20civet

Voorbeeld Aliases

Voorbeeld "Claims"

https://www.wikidata.org/w/api.php?action=wbgetclaims&entity=Q2155935

NB: De matching tussen Property en Value is nog niet correct in bovenstaand overzicht! Ook {{#if:{{{wikiclaims}}}|{{{wikiclaims}}} |Niet beschikbaar }} werkt niet Deze doet het ook: https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q2155935&props=claims

De resultaten van de bovenstaande call zijn pluriform: soms geeft de claim een "string", soms een "array" en soms een wikidata-d etc. Om goede resultaten te krijgen is het dus zaak de verschillende elementen filteren; daarvoor is Xpath het middel. De volgende combinatie Xpaths leidt tot alle waarden met interne claims (Qnummer-Pnummer-Q-nummer)

//api/claims/property/claim/mainsnak[@datatype="wikibase-item"]/@property
//api/claims/property/claim/mainsnak[@datatype="wikibase-item"]/datavalue/value/@id

Deze geeft dus wel de juiste resultaten (goed gesorteerd).

//api/claims/property/claim/mainsnak[@datatype="external-id"]/@property
//api/claims/property/claim/mainsnak[@datatype="external-id"]/datavalue/@value

P17: land

https://www.wikidata.org/w/api.php?action=query&prop=wbgetclaims&id=Q2155935

Bovenstaande geeft errors:

• wbgetclaims is niet goed
• id is niet goed

https://www.wikidata.org/w/api.php?action=query&prop=wbgetentities&id=Q2155935

Gebruik van Xpath om gegevens uit WikiData te halen

Dit is een voorbeeld om met behulp van ExternalData en Xpath informatie uit WikiData te importeren en weer te geven in een infobox. De informatie wordt gevonden op basis van het referentienummer ("Q-nummer"), dat semantisch wordt geregistreerd met Eigenschap:Wikidata_ID

Voorbeeld:

• Wikidata: https://www.wikidata.org/wiki/Q1325514 - Het Muziektheater
• Referentie op TE voor Het Muziektheater, Amsterdam: {{#show:Het Muziektheater, Amsterdam|?Wikidata_ID}}

Resultaat: Het Muziektheater

Eigenschap Sitelinks (links naar Wikipedia):

Gefilterde resultaten:

Het resultaat: Nationale Opera en Ballet kan omgevormd worden tot een link naar Wikipedia:

Als link: Opera en Ballet| |_}} Naar Wikipedia

Gebruik de functie: {{#replace:Dit is een url waarde| |_}}

Direct een link naar wikipedia opvragen kan ook met props=sitelinks/urls

Vervolgstap is de claims lezen: https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q1325514&props=claims&languages=nl&format=xml

Is het een optie hiervoor Xpath te gebruiken?? Jawel!!Zie:

Dit is een afbeelding van commons, via Wikidata

Meer interessante eigenschappen:

• Postcode: P281
• Openingsdatum: P1619
• Geolocatie: P625
• Commonscategorie: P373
• Gelegen in bestuurlijke eenheid: P131

Kun je al deze gegevens in 1 keer opvragen?

Amsterdam

Het Muziektheater Opera en Ballet| |_}} Naar Wikipedia
Info	Waarde
Afbeelding	Amsterdam - Stopera (30213475601).jpg
Postcode:	1017 SG
Openingsdatum:	23 sep 1986
Geolocatie:	kaart...
Commons categorie:	Stopera
Gelegen in:	Q9899 - Id van Amsterdam

Zie ook Plaatsen in Nederland; poging tot opvragen informatie uit Wikibase/Wikidata via het SPARQL-endpoint (niet werkend).

Link:

• https://www.wikidata.org/w/api.php?action=help&modules=wbgetentities
• https://www.wikidata.org/w/api.php?action=help&modules=wbsearchentities
• https://www.w3schools.com/xml/xpath_syntax.asp