BegrippenEditorHelp nl
Dit is de helppagina voor het gebruik van de BegrippenEditor op basis van NL-SBB.
Inleiding
De standaard voor het beschrijven van begrippen NL-SBB geeft aan hoe begrippen in een begrippenlijst, taxonomie of thesaurus eenduidig worden beschreven. Er is aandacht voor uitleg in begrijpelijke taal (B1 niveau) en de verwijzing naar de (juridische) grondslag van een begrip in een geschreven bron of een bron op het internet (zoals wetten.nl). De standaard kent een taalbinding waarmee een begrippenkader als Linked data kan worden gepubliceerd. Daarbij wordt gebruik gemaakt van met name SKOS, maar de standaard kan ook worden gebruikt zonder gebruik te maken van Linked data. Daarmee kunnen organisaties los van de door hen gebruikte technologie de standaard toepassen als stap op weg naar semantische interoperabiliteit (bron: NL-SBB).
Kennismodel
Het kennismodel van NL-SBB in deze wiki is gebaseerd op de standaard en is in te zien op Categorie:Kennismodel_NL-SBB.
Het beheer van dit kennismodel ligt bij ArchiXL. Het is niet de bedoeling dat in deze wiki dit model wordt aangepast of uitgebreid. Bij aanpassingen wordt dit model namelijk overschreven en zijn gedane uitbreidingen niet meer beschikbaar. Het model is wel uitbreidbaar. Zie de volgende paragraaf hoe het het NL-SBB kan worden aangevuld met specifieke eigenschappen of relaties.
Kennismodel uitbreiden
Als het kennismodel moet worden uitgebreid omdat er extra gegevens nodig zijn, of omdat er extra functionaliteit nodig is, ga dan naar het betreffende elementtype in het , bijvoorbeeld Begrip en klik onderaan de pagina op de knop Maak uitbreiding of Bewerk uitbreiding aan de onderkant van de beheerpagina van Begrip.
Als je klikt op Bewerk uitbreiding kom je in onderstaand scherm uit
Extra functionaliteit
Automatische paginanamen
Hiermee wordt bepaald welke paginanamen automatisch worden aangemaakt.
Paginanamen moeten uniek zijn, namen van begrippen zijn dat echter niet. Om tot die uniciteit te komen zijn verschillende strategieën mogelijk.
- Geen/onbekend. De naam van het begrip is tevens ook de naam van de pagina. Elk begrip heeft een unieke naam. Dus als er sprake is van een homoniem (zelfde begrip, verschillende betekenis) moet in de naam toch een duiding zijn om de paginanaam uniek te maken.
- Sequentieel. Elk begrip heeft een unieke ID d.m.v. een volgnummer
Het doet er niet toe wat voor type unieke ID gebruikt worden. Met een volgnummer is het altijd uniek. Nadeel is dat bij meerdere begrippenkaders hetzelfde nummer in verschillende begrippenkaders kan voor komen.
- GUID. Elk begrip heeft een unieke ID d.m.v. een GUID (Global Unique Identifier). Dit is een veilige manier om unieke ID's te maken voor paginanamen. Dit ID volgt het patroon
id-xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx. Het nadeel is dat het niet gebruikersvriendelijk is. - UUIDv4. Elk begrip heeft een unieke ID d.m.v. een UUID (Universally Unique Identifier, versie 4). Deze lijkt heel sterk op een GUID. UUID's zijn echter breder gestandaardiseerd, hoewel vrijwel identiek aan GUIDs. Beiden voldoen aan de standaard RFC 4122.
Eigenschappen toevoegen
Vanuit het kennismodel kunnen lokale eigenschappen worden gedefinieerd. Definieer eerst de eigenschappen in het juiste kennismodel. Overzicht van kennismodellen en kies het juiste kennismodel uit, of creëer een nieuwe.
Klik op Maakt nieuwe bij het betreffende onderdeel, bv Elementeigenschappen. Daarmee kom je in een definitiescherm voor het definieren van eigenschappen.
De opties voor een eigenschap zijn:
- Naam: De naam van de elementeigenschap wordt tevens de paginanaam in de wiki. Gebruik daarom geen komma's in de naam
- Kennismodel: Het kennismodel waaronder deze elementeigenschap valt.
- Type eigenschap: U kunt hier het het type van de elementeigenschap invoeren.
- Geldige waarden: U kunt hier aangeven of de elementeigenschap meerdere waarden tegelijk kan bevatten
- Weergave op formulieren: U kunt hier kiezen op welke wijze de eigenschap op invulformulieren moet worden weergegeven. NB. Gebruik 'Checkbox' alleen voor booleaanse eigenschappen.
- Initiële waarde: U kunt hier een initiële waarde opgeven, dat wil zeggen de waarde die op formulieren vooringevuld wordt.
- Verplicht veld: U kunt hier aangeven of de eigenschap op formulieren verplicht ingevuld moet worden. Maak radiobuttons altijd verplicht
- Toelichting op formulier: U kunt hier een tekst opgeven die als tooltip getoond zal worden op het invulformulier waar deze eigenschap aan een element toegekend kan worden.
- Subeigenschap van: U kunt hier invoeren dat deze eigenschap een verbijzondering is van een andere eigenschap.
- Geïmporteerd uit: U kunt hier een eigenschap uit een externe vocabulaire invoeren waarmee deze eigenschap overeenkomt.
- Formatteerfunctie extern URI: U kunt hier een formatteerfunctie invoeren om toe te passen op externe URI's, bv. https://www.wikidata.org/entity/$1. NB. Dit werkt alleen in combinatie met datatype 'externe identificator'.
Als de eigenschap bestaat kan deze worden gebruikt in de uitbreiding van het kennismodel.
Voor relaties geldt dezelfde aanpak. Eerst aanmaken via het kennismodel. De opties voor de vastlegging zijn:
- Naam: De naam van de elementeigenschap wordt tevens de paginanaam in de wiki. Gebruik daarom geen komma's in de naam
- Kennismodel: Het kennismodel waaronder deze elementeigenschap valt.
De eigenschappen Pijlpunt, Pijlstaart en Lijnstijl kunt u negeren. Deze hebben geen functie in deze omgeving.
Eigenschapgroepen
Hiermee kan men een tabblad met eigenschappen toevoegen aan het invulformulier en opmaaksjabloon. De standaardtabbladen volgen NL-SBB-standaard, maar kunnen als een aanvulling worden gedefinieerd en getoond tijdens invoer en tonen. Voor elk tabblad kan de naam en de te tonen of te bewerken eigenschappen worden gedefinieerd.
Bij updates van het NL-SBB-model, blijven de lokale uitbreidingen in tact.
Begrippenkader
Het kennismodel voor NL-SBB model bevat vier elementtypen Begrippenkader, Collectie, Begrip en Brondocument. Hieronder wordt per elementtype aangegeven hoe deze kunnen worden aangemaakt en beheerd. Ook de mogelijkheid om elementtypen in Bulk te bewerken, wordt ondersteund, zie ook Speciaal:BulkBewerken/help.
Aanmaken en bewerken
Elk elementtype kan worden beheerd door naar het betreffende begrip te gaan en dan te kiezen voor Bewerken. De te bewerken eigenschappen zijn in overeenstemming met de NL-SBB-standaard.
- Begrippenkader conform NL-SBB, Begrippenkader in deze wiki
- Collectie conform NL-SBB, Collectie in deze wiki
- Begrip conform NL-SBB, Begrip in deze wiki
- Brondocument conform NL-SBB, Brondocument in deze wiki
Verwijderen
Voor het verwijderen van een begrippenkader en of collecties is extra functionaliteit toegevoegd. Dit betekent dat als een begrippenkader wordt verwijderd, ook de mogelijkheid wordt geboden dit te doen inclusief de alle bijbehorende begrippen. De andere optie is om alleen de pagina zelf te verwijderen.
Exporteren en Importeren
- Met behulp van Speciaal:SmartRDFExport en Speciaal:SmartRDFImportkunt u een begrippenkader exporteren in TTL-formaat. Voor deze opties is grondige kennis van de RDF-standaard vereist.
- Met behulp van Speciaal:BegrippenExporteren en Speciaal:BegrippenImporteren kunt u conform NL-SBB begrippenkaders of collecties importeren en exporteren in het CSV-formaat.
- Exporteren. Via de pagina Speciaal:BegrippenExporteren kunt u een keuze maken tussen de typen export:
Kies exportformaat en -type - Lege CSV genereren. Dit biedt de mogelijkheid om een lege CSV te vullen met gegevens conform NL-SBB-standaard
- 'Begrippenkader als CSV exporteren. Hiermee wordt een CSV aangemaakt conform de standaard en gevuld met alle begrippen uit een te kiezen begrippenkader
- 'Begrippenkader als TTL exporteren. Hiermee wordt een RDF/TTL aangemaakt conform de standaard en gevuld met alle begrippen uit een te kiezen begrippenkader
- 'Collectie als TTL exporteren. Hiermee wordt een RDF/TTL aangemaakt conform de standaard en gevuld met alle begrippen uit een te kiezen collectie. Deze kan meerdere begrippenkaders betreffen.
- Voor de drie laatste opties wordt ook om een bestand gevraagd waar de resultaten naar toe geschreven kunnen worden.
Kies bestand en exporteer - Importeren. Via de pagina Speciaal:BegrippenImporteren kunt u een keuze maken tussen de verschillende acties:
Kies importformaat en -type - Kies vervolgens een bestand en bepaal of er een preview moet worden getoond door te klikken op dry-run
Kies bestand en preview - Bij de import wordt altijd een aantal controles uitgevoerd, om te controleren of het een juist bestand betreft met de juiste data
- Indien er voor eigenschappen van het type "taalspecifieke waarde" geen taal wordt aangegeven, wordt de taal van de wiki als standaard gebruikt
- Als je voor GUID's of UUIDv4 hebt gekozen voor paginanamen en je wil nieuwe begrippen in de CSV aanleveren, dan is het niet nodig om een Title-eigenschap toe te voegen. De importmodule zal zelf een GUID of UUIDv4 genereren.
- LET OP: Het importeren van CSV's heeft altijd risico's. De NL-SBB-importmodule zal een aantal controles uitvoeren, zoals het wel of niet voorkomen van verplichte waarden, of het juiste aantal eigenschappen. Dus maak altijd gebruik van de optie 'dry-run'(voorvertoning). Maar houdt er rekening mee dat alle pagina's worden aangepast of toegevoegd als het conform CSV is aangeleverd. Herstelacties kunnen ingewikkeld zijn. TIP: maak eerst een CSV-export als backup, voordat er een nieuwe dataset wordt aangeleverd.
- De tekenset waarin de CSV moet worden aangeleverd is UTF-8. Dit is belangrijk om dat in sommige gevallen, met name als Windows wordt gebruikt, de tekenzet ANSI is. Dat kan leiden tot een verkeerde omzetting van diacrieten. Let hier op bij de import. Wij raden aan om hiervoor niet Excel, maar LibreOffice te gebruiken voor het bewerken en bewaren van een CSV met de juiste instellingen (UTF-8).
- Voor het werken met CSV's raden wij aan om gebruik te maken van LibreOffice.
- Voor het gebruik van Excel kan de optie 'Excel' als bestandsformaat worden geselecteerd bij het exporteren of importeren van begrippen.
Ondersteunende tooling voor CSV-export/import
Overzichten
Op deze omgeving zijn diverse manieren beschikbaar om het begrippenkader te bevragen en rapportages te maken.
Alle begrippen
Op deze pagina wordt een tabel getoond met alle begrippen in een tabel. Vanaf deze pagina, kunne ook nieuwe begrippen worden aangemaakt.
Zoeken
Zoeken werkt als volgt:
- Voer een term in, en kies vervolgens in welke velden (eigenschappen van begrippen) u deze term wilt zoeken.
- Bij het uitvoeren van de zoekactie worden alle begrippen getoond waar de zoekterm in minimaal één veld is gevonden.
- Er dient minimaal één veld gekozen te worden om in te zoeken.
Uitgebreid zoeken
Uitgebreid zoeken werkt als volgt:
- Per eigenschap kunt u een zoekterm invullen.
- Als u de zoekopdracht uitvoert, wordt er naar begrippen gezocht die elk van de zoektermen bevat in de respectievelijke eigenschap. Bijvoorbeeld: als u in het veld "definitie" de waarde "niveau" opgeeft, en bij "toelichting" de waarde "kader, dan worden er alleen begrippen getoond waarbij zowel "niveau" voorkomt in de definitie, als "kader" in de toelichting.
- Als u een veld leeglaat, dan wordt er niet in dat veld gezocht. Er dient minimaal één veld een zoekterm te bevatten.
Kaders en collecties
Op deze pagina staat een overzicht van de begrippenkaders en collecties die in deze omgeving beschikbaar zijn.
Vanuit elk gekozen kader en collectie kan door een alfabetsche lijst gebladerd worden.
Dit is ook de pagina van waaruit naar de Categorie-pagina's kan worden genavigeerd (via de links begrippenkaders en collecties), om van daaruit een nieuw begrippenkader en/of collectie te wijzigen of toe te voegen.
Filteren
In dit scherm is het mogelijk om één of meerdere begrippen te selecteren om het aantal gevonden begrippen te verkleinen.
Statistieken
Op deze pagina staat een rapportage gebaseerd op tellingen van diverse onderwerpen.
