Semantic inline query: verschil tussen versies

Uit MediaWikiGids
Ga naar: navigatie, zoeken
(Nieuwe pagina aangemaakt met 'Zie ook: [https://www.semantic-mediawiki.org/wiki/Help:Inline_queries Documentatie op semantic-mediawiki.org]')
 
(→‎Opties - overzicht krijgen van de mogelijkheden)
 
(11 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 1: Regel 1:
−
Zie ook: [https://www.semantic-mediawiki.org/wiki/Help:Inline_queries Documentatie op semantic-mediawiki.org]
+
<span class="pull-right">{{Btn-handleiding-semantische-zoekopdrachten}}</span>Een '''semantic inline query''' (nl: "''inline"'' semantische zoekopdracht) biedt de mogelijkheid om een vaste zoekopdracht in de wikitekst op te nemen en de resultaten automatisch weer te geven. Op deze manier kunnen alle complexe semantische [[query|queries]] uitgevoerd worden, terwijl bezoekers van de wiki-pagina zien alleen de resultaten - een tabel, lijst of ander formaat - zullen zien.
 +
 
 +
== Toepassingen ==
 +
Hoewel de lijst van toepassingen erg lang is, een paar veel voorkomende situaties:
 +
* '''Genummerde of ongenummerde lijsten''' van pagina's die een bepaalde eigenschap hebben
 +
* '''Opnoeming''' van door komma's gescheiden resultaten
 +
* '''Sorteerbare tabellen''' met semantische gegevens in rijen en kolommen
 +
* '''Galerie met afbeeldingen''' die een bepaalde semantische eigenschap hebben
 +
* '''Export-file''' in diverse formaten (csv, csv, dsv, dsv, json, rdf, rdf) met gegevens die kunnen worden gedownload.
 +
Het aantal toepassingen kan met behulp van de extensie "Semantic Result Formats" aanzienlijk worden uitgebreid. Denk daarbij bijvoorbeeld aan: kalenders en tijdlijnen, geografische kaarten, diverse bestandsformaten, grafieken etc.
 +
 
 +
== Samenstelling van een inline query ==
 +
Een inline query is een formele, gestructureerde manier om een vraag te stellen aan Semantic MediaWiki. Een query bestaat in de basis uit drie onderdelen:
 +
# Het selecteren van de set van gegevens, eventueel te onderscheiden als:
 +
## Kies basis set van objecten; een categorie met pagina's
 +
## Filter de gewenste items uit de set op basis van eigenschappen
 +
# Het bepalen van de weer te geven informatie
 +
# Het bepalen van de vormgeving van de geselecteerde gegevens
 +
 
 +
Voorbeelden:
 +
# Selecteer de objecten (pagina's):
 +
## Uit de categorie "personen"
 +
## Filter alle personen waarvan de eigenschap "HeeftKleurOgen" is gelijk aan "blauw"
 +
# Geef van de geselecteerde personen weer, de waarden van de eigenschappen:
 +
## "HeeftVoornaam",
 +
## "HeeftAchternaam" en
 +
## "HeeftPasfoto"
 +
# In de vorm van een brede tabel, van hoogsten 20 regels
 +
 
 +
=== Syntax - schrijfwijze van een query ===
 +
Om een query in wikitekst te maken volg je de bovenstaand drie stappen. De query wordt omsloten door dubbele haken en voorafgegaan door een zogeheten "parserfunction": de opdracht om te zoeken:
 +
 
 +
<pre>
 +
{{#ask:
 +
[[Categorie:Personen]]                  <!-- basisset gegevens -->
 +
[[HeeftKleurOgen::Blauw]]                <!-- filter -->
 +
| ?HeeftVoornaam = Voornaam              <!-- weer te geven eigenschap, incl. "label" -->
 +
| ?HeeftAchternaam = Achternaam          <!-- idem -->
 +
| format = broadtable                    <!-- vorm van de gegevensuitvoer -->
 +
| Mainlabel = Personen met blauwe ogen  <!-- label voor de geselecteerde personen -->
 +
| limit = 20                            <!-- ten hoogste 20 regels -->
 +
}}
 +
</pre>
 +
 
 +
NB: Het is niet mogelijk om met VisualEditor queries te maken; gebruik de gewone teksteditor.
 +
 
 +
=== Opties - overzicht krijgen van de beschikbare gegevens en eigenschappen  ===
 +
 
 +
Voor de eerste twee onderdelen van een query - de selectie en filtering van de weer te geven data - is kennis nodig van de categorieën en eigenschappen op een wiki. Waar je deze informatie overzichtelijk kunt vinden, kan verschillen per wiki, maar je kunt in ieder geval terecht op de volgende pagina's:
 +
 
 +
* De speciale pagina '''speciaal:categorieën''', met [[Speciaal:Categorieën|de lijst van categorieën]], die op iedere MediaWiki-website beschikbaar is
 +
* De pagina '''<nowiki>Speciaal:Eigenschappen</nowiki>''' is beschikbaar op iedere Semantic MediaWiki-website geeft een lijst met alle eigenschappen op die wiki
 +
* De pagina '''<nowiki>Speciaal:OpEigenschapZoeken</nowiki>''' kan gebruikt worden om de (filter-)waarden van een bepaalde eigenschap te vinden.
 +
 
 +
Op de TheaterEncyclopedie is een pagina beschikbaar, waarop een overzicht van de gegevens wordt geboden. Zie [https://theaterencyclopedie.nl/wiki/TheaterEncyclopedie:Ontologie_van_de_TheaterEncyclopedie hier].
 +
 
 +
=== Opties - overzicht krijgen van de beschikbare presentatievormen (result formats)  ===
 +
 
 +
De meest gebruikte presentatievormen staan hieronder aangegeven.
 +
 
 +
{| class="wikitable"
 +
| <code> format = broadtable</code> || Laat het resultaat in een paginabrede tabel zien
 +
|-
 +
| <code> format =  table</code>  || Laat het resultaat in een tabel zien (standaard)
 +
|-
 +
| <code> format =  ol</code>  || Laat het resultaat in een genummerde lijst zien
 +
|-
 +
| <code> format = ul</code>  || Laat het resultaat in een ongenummerde lijst zien
 +
|-
 +
| <code> format = count</code>  || Laat het aantal gevonden resultaten zien
 +
|-
 +
|}
 +
 
 +
Er is een zeer groot aantal formaten beschikbaar! Zie hiervoor de [https://www.semantic-mediawiki.org/wiki/Help:Result_formats officiële documentatie].
 +
 
 +
== Voorbeelden ==
 +
 
 +
Eenvoudig voorbeeld:
 +
 
 +
<pre>
 +
{{#ask:
 +
[[Categorie:Stad]]
 +
[[Located in::Nederland]]
 +
|?Population
 +
|format=ul
 +
}}
 +
</pre>
 +
 
 +
Voor deze training voor de TheaterEncyclopedie, is een speciale pagina met voorbeelden beschikbaar. Je vindt deze [https://theaterencyclopedie.nl/wiki/TheaterEncyclopedie:Workshop_%22Semantische_queries%22_(2019)/voorbeelden hier].
 +
 
 +
== Overig ==
 +
Zie ook:
 +
* Deze pagina maakt deel uit van een handleiding: {{Btn-handleiding-semantische-zoekopdrachten}}
 +
* [https://www.semantic-mediawiki.org/wiki/Help:Inline_queries Documentatie op semantic-mediawiki.org]

Huidige versie van 22 jan 2019 om 17:56

Een semantic inline query (nl: "inline" semantische zoekopdracht) biedt de mogelijkheid om een vaste zoekopdracht in de wikitekst op te nemen en de resultaten automatisch weer te geven. Op deze manier kunnen alle complexe semantische queries uitgevoerd worden, terwijl bezoekers van de wiki-pagina zien alleen de resultaten - een tabel, lijst of ander formaat - zullen zien.

Toepassingen

Hoewel de lijst van toepassingen erg lang is, een paar veel voorkomende situaties:

  • Genummerde of ongenummerde lijsten van pagina's die een bepaalde eigenschap hebben
  • Opnoeming van door komma's gescheiden resultaten
  • Sorteerbare tabellen met semantische gegevens in rijen en kolommen
  • Galerie met afbeeldingen die een bepaalde semantische eigenschap hebben
  • Export-file in diverse formaten (csv, csv, dsv, dsv, json, rdf, rdf) met gegevens die kunnen worden gedownload.

Het aantal toepassingen kan met behulp van de extensie "Semantic Result Formats" aanzienlijk worden uitgebreid. Denk daarbij bijvoorbeeld aan: kalenders en tijdlijnen, geografische kaarten, diverse bestandsformaten, grafieken etc.

Samenstelling van een inline query

Een inline query is een formele, gestructureerde manier om een vraag te stellen aan Semantic MediaWiki. Een query bestaat in de basis uit drie onderdelen:

  1. Het selecteren van de set van gegevens, eventueel te onderscheiden als:
    1. Kies basis set van objecten; een categorie met pagina's
    2. Filter de gewenste items uit de set op basis van eigenschappen
  2. Het bepalen van de weer te geven informatie
  3. Het bepalen van de vormgeving van de geselecteerde gegevens

Voorbeelden:

  1. Selecteer de objecten (pagina's):
    1. Uit de categorie "personen"
    2. Filter alle personen waarvan de eigenschap "HeeftKleurOgen" is gelijk aan "blauw"
  2. Geef van de geselecteerde personen weer, de waarden van de eigenschappen:
    1. "HeeftVoornaam",
    2. "HeeftAchternaam" en
    3. "HeeftPasfoto"
  3. In de vorm van een brede tabel, van hoogsten 20 regels

Syntax - schrijfwijze van een query

Om een query in wikitekst te maken volg je de bovenstaand drie stappen. De query wordt omsloten door dubbele haken en voorafgegaan door een zogeheten "parserfunction": de opdracht om te zoeken: 

{{#ask:
[[Categorie:Personen]]                   <!-- basisset gegevens --> 
[[HeeftKleurOgen::Blauw]]                <!-- filter -->
| ?HeeftVoornaam = Voornaam              <!-- weer te geven eigenschap, incl. "label" -->
| ?HeeftAchternaam = Achternaam          <!-- idem -->
| format = broadtable                    <!-- vorm van de gegevensuitvoer -->
| Mainlabel = Personen met blauwe ogen   <!-- label voor de geselecteerde personen -->
| limit = 20                             <!-- ten hoogste 20 regels -->
}}

NB: Het is niet mogelijk om met VisualEditor queries te maken; gebruik de gewone teksteditor.

Opties - overzicht krijgen van de beschikbare gegevens en eigenschappen

Voor de eerste twee onderdelen van een query - de selectie en filtering van de weer te geven data - is kennis nodig van de categorieën en eigenschappen op een wiki. Waar je deze informatie overzichtelijk kunt vinden, kan verschillen per wiki, maar je kunt in ieder geval terecht op de volgende pagina's:

  • De speciale pagina speciaal:categorieën, met de lijst van categorieën, die op iedere MediaWiki-website beschikbaar is
  • De pagina Speciaal:Eigenschappen is beschikbaar op iedere Semantic MediaWiki-website geeft een lijst met alle eigenschappen op die wiki
  • De pagina Speciaal:OpEigenschapZoeken kan gebruikt worden om de (filter-)waarden van een bepaalde eigenschap te vinden.

Op de TheaterEncyclopedie is een pagina beschikbaar, waarop een overzicht van de gegevens wordt geboden. Zie hier.

Opties - overzicht krijgen van de beschikbare presentatievormen (result formats)

De meest gebruikte presentatievormen staan hieronder aangegeven.

format = broadtable Laat het resultaat in een paginabrede tabel zien
format = table Laat het resultaat in een tabel zien (standaard)
format = ol Laat het resultaat in een genummerde lijst zien
format = ul Laat het resultaat in een ongenummerde lijst zien
format = count Laat het aantal gevonden resultaten zien

Er is een zeer groot aantal formaten beschikbaar! Zie hiervoor de officiële documentatie.

Voorbeelden

Eenvoudig voorbeeld: 

{{#ask:
 [[Categorie:Stad]]
 [[Located in::Nederland]] 
 |?Population
 |format=ul
}}

Voor deze training voor de TheaterEncyclopedie, is een speciale pagina met voorbeelden beschikbaar. Je vindt deze hier.

Overig

Zie ook:

Overgenomen van "http://gids.wikiwerkers.nl/w/index.php?title=Semantic_inline_query&oldid=632"