BegrippenEditorHelp en
This is the help page for using the BegrippenEditor (Concept Editor) based on NL-SBB.
Introduction[bewerken]
The standard for describing concepts NL-SBB defines how concepts in a glossary, taxonomy, or thesaurus are described unambiguously. The standard emphasizes plain language (B1 level) and referencing the (legal) basis of a concept, either in a written source or an online source (such as wetten.nl). The standard includes a language binding that allows a concept framework to be published as Linked Data. It primarily uses SKOS, but the standard can also be used without Linked Data. This allows organizations to apply the standard independently of the technologies they use, as a step towards semantic interoperability (source: NL-SBB).
Knowledge model[bewerken]
The NL-SBB knowledge model in this wiki is based on the standard and can be viewed at Category:Kennismodel_NL-SBB.
The management of this knowledge model lies with ArchiXL. It is not intended that this model be modified or extended in this wiki. Updates would overwrite any additions, making them unavailable. However, the model can be extended. See the following section on how to supplement NL-SBB with specific properties or relationships.
Extending the knowledge model[bewerken]
If the knowledge model needs to be extended because additional data or functionality is required, go to the relevant element type in the , for example Begrip, and click the Create extension or Edit extension button at the bottom of the management page of Begrip.
Clicking Edit extension will bring you to the following screen:
Additional functionality[bewerken]
Automatic page names[bewerken]
This determines how page names are automatically created.
Page names must be unique, but concept names are not necessarily unique. To ensure uniqueness, several strategies are possible:
None/unknown. The name of the concept is also the name of the page. Each concept has a unique name. So in the case of a homonym (same concept name, different meaning), the name must include a disambiguation.
Sequential. Each concept has a unique ID via a sequence number. The ID is always unique, but the same number may occur in different concept frameworks.
GUID. Each concept has a unique ID via a GUID (Global Unique Identifier). This is a reliable way to generate unique IDs for page names. The ID follows the pattern id-xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx. The downside is that it is not user-friendly.
UUIDv4. Each concept has a unique ID via a UUID (Universally Unique Identifier, version 4). This is very similar to a GUID. UUIDs are more broadly standardized and are effectively equivalent to GUIDs. Both conform to RFC 4122.
Adding properties[bewerken]
From the knowledge model, local properties can be defined. First define the properties in the correct knowledge model. Go to Category:Kennismodellen and choose the correct model, or create a new one.
Click "Create new" at the relevant section, e.g., Element properties. This will open a definition screen for setting up properties.
The options for a property are:
Name: The name of the element property also becomes the page name in the wiki. Therefore, do not use commas in the name.
Knowledge model: The knowledge model under which this property falls.
Property type: Enter the type of the property.
Valid values: Specify whether the property can contain multiple values.
Form display: Choose how the property should appear in forms. Note: Use 'Checkbox' only for boolean properties.
Initial value: You can enter a default value that will be pre-filled in forms.
Required field: Indicate whether the property must be filled in on forms. Radio buttons should always be required.
Form help text: You can specify text to be shown as a tooltip on the form where the property is used.
Subproperty of: Indicate if this property is a specialization of another property.
Imported from: Link this property to an equivalent one in an external vocabulary.
Formatter function for external URI: Enter a formatting function for external URIs, e.g., https://www.wikidata.org/entity/$1. Note: This only works with datatype 'external identifier'.
If the property exists, it can be used in the extension of the knowledge model.
For relationships, the same process applies. First create them via the knowledge model. The available options are:
Name: The name of the relationship also becomes the wiki page name. Avoid commas.
Knowledge model: The model under which this relationship falls.
The properties Arrowhead, Arrowtail, and Line style can be ignored. These have no function in this environment.
Property groups[bewerken]
This allows you to add a tab with grouped properties to the input form and formatting template. The standard tabs follow the NL-SBB model but can be extended. Each tab can have its own name and a list of properties to show or edit.
When the NL-SBB model is updated, local extensions remain intact.
Overviews[bewerken]
This environment provides various ways to query the concept framework and generate reports.
All concepts[bewerken]
This page displays a table of all available concepts. New concepts can also be created from here.
Search[bewerken]
Search works as follows:
Enter a term and select the fields (properties of concepts) to search within.
The result will display all concepts where the term was found in at least one field.
At least one field must be selected to perform a search.
Advanced search[bewerken]
Advanced search works as follows:
You can enter a search term per property.
Results will only include concepts where each search term is found in the respective property. For example: if you enter "level" under "definition" and "framework" under "explanation", only concepts meeting both will be shown.
Leave fields empty to exclude them from the search.
Frameworks and collections[bewerken]
This page shows an overview of all concept frameworks and collections available in this environment.
From each selected framework or collection, you can browse through an alphabetical list of concepts.
This page also links to the category pages concept frameworks and collections, from where you can edit or add new frameworks and collections.
Filtering[bewerken]
On this screen, you can filter one or more concepts to narrow down the search results.
Statistics[bewerken]
This page displays a report based on counts of various components.
Creating and editing[bewerken]
Each element type can be managed by navigating to the relevant concept and clicking Edit. The editable properties conform to the NL-SBB specification:
Concept Framework – Begrippenkader in this wiki
Collection – Collectie in this wiki
Source Document – Brondocument in this wiki
Deleting[bewerken]
Special functionality is available to delete a concept framework or collection. When deleting a framework, you can choose whether to also delete all associated concepts, or just the main page.
Exporting and Importing[bewerken]
- Using Speciaal:SmartRDFExport and Speciaal:SmartRDFImport, you can export a concept framework in TTL format. These options require thorough knowledge of the RDF standard.
- Using Speciaal:BegrippenExporteren and Speciaal:BegrippenImporteren, you can import and export concept frameworks or collections in CSV format according to the NL-SBB standard.
- Exporting. On the page Speciaal:BegrippenExporteren you can choose the type of export:
- Generate empty CSV. This allows you to create an empty CSV that you can fill in according to the NL-SBB standard.
- Export concept framework as CSV. This creates a CSV file according to the standard and filled with all concepts from a selected concept framework.
- Export concept framework as TTL. This creates an RDF/TTL file according to the standard and filled with all concepts from a selected concept framework.
- Export collection as TTL. This creates an RDF/TTL file according to the standard and filled with all concepts from a selected collection. This may involve multiple concept frameworks.
- For the last three options, you will also be asked for a file to write the results to.
- Importing. On the page Speciaal:BegrippenImporteren you can choose between different actions:
- Then select a file and choose whether a preview should be shown by clicking on dry-run.
- During import, several checks are always performed to ensure the file and data are valid.
- If no language is specified for properties of type "language-specific value", the wiki's default language will be used.
- If you’ve chosen to use GUIDs or UUIDv4 for page names and want to supply new concepts via CSV, you do not need to include a Title property. The import module will generate a GUID or UUIDv4 automatically.
- NOTE: Importing CSV files always carries risks. The NL-SBB import module will perform a number of checks, such as the presence of required values or the correct number of properties. So always use the 'dry-run' option (preview). But keep in mind that all pages will be modified or added if the CSV is valid. Undoing changes can be complex.
TIP: always create a CSV export as a backup before uploading a new dataset.
- The character encoding of the CSV must be UTF-8. This is important because, in some cases—especially when using Windows—the encoding may default to ANSI, which can lead to incorrect conversion of diacritics. Be mindful of this during import. We recommend using LibreOffice instead of Excel to edit and save the CSV with the correct UTF-8 settings.
Overviews[bewerken]
This environment offers various ways to query the concept framework and generate reports.
All concepts[bewerken]
This page displays a table containing all the concepts. From this page, new concepts can also be created.
Search[bewerken]
Searching works as follows:
Enter a term, and then choose which fields (properties of concepts) you want to search in.
When executing the search, all concepts are displayed in which the search term is found in at least one field.
At least one field must be selected for searching.
Advanced search[bewerken]
Advanced search works as follows:
You can enter a search term for each property.
When you execute the search, it will look for concepts that contain each of the search terms in the corresponding property. For example: if you enter the value "level" in the "definition" field, and "framework" in the "clarification" field, only concepts will be shown where "level" appears in the definition and "framework" in the clarification.
If you leave a field empty, it will not be searched. At least one field must contain a search term.
Frameworks and collections[bewerken]
This page provides an overview of the concept frameworks and collections available in this environment.
From each selected framework and collection, you can browse through an alphabetical list.
This is also the page from which you can navigate to the Category pages (via the links concept frameworks and collections) to edit or add a new concept framework and/or collection.
Filtering[bewerken]
In this screen, it is possible to select one or more concepts to reduce the number of results.
Statistics[bewerken]
This page presents a report based on counts of various topics.