Skip to content
NTsch edited this page Nov 25, 2022 · 7 revisions

Introduction

The SKOS-Editor-App allows users to modify SKOS files in the database with a simple user interface (currently only the Glossary of Illuminated Charters is supported, other files coming soon). SKOS (Simple Knowledge Organization System) is a W3C recommendation for the representation of controlled vocabularies such as glossaries, taxonomies, etc. Several such controlled vocabularies are available through the Monasterium index.

Usage

To use the SKOS-Editor, the user first has to select a controlled vocabulary via Search -> Index Search. On the home page of the vocabulary there is a Create Personal Copy-Button - clicking this button creates a copy of the vocabulary in the user's personal directory in the database (this is only possible as long as no other user is currently modifying the same vocabulary - when that is the case, the button is replaced by a message indicating who is currently using the vocabulary).

Screenshot from 2022-06-01 15-32-16

The vocabulary can now be accessed via MyArchive -> Saved Vocabularies. This view lists all of the user's saved vocabularies, which can be edited by clicking on 'Open Vocabulary in SKOS-Editor'. Saved vocabularies can also be deleted from here.

saved_vocab

open_editor

The editor lists all available concepts from the current SKOS files. The user can select a concept from the drop-down menu at the top or create a new concept.

Screenshot from 2022-06-01 16-15-17

The editor displays all available skos:prefLabel- and skos:broader-entries for the selected concept, i.e. preferred labels for the concept in different languages and umbrella terms. Such entries can be added or removed via the app. The description text can be modified in the editor window at the bottom. Changes to the text can be saved to the file by clicking on the Save-button on the bottom left.

When all desired changes have been made, the personal copy of the vocabulary can be published by clicking on the Publish-button on the bottom right. The changes are then reviewed by a moderator, and afterwards added to the public file.

Screenshot from 2022-06-01 16-17-33

Under the hood

The app is located under [...]/src/mom/app/skos-editor/. It consists of one widget, the main editor view, and separate services for adding, removing, and modifying the various SKOS elements, as well as copying the vocabulary file to the user directory and publishing it from there. The services are launched from the main widget via AJAX calls. my-collection-copy-skos.service begins by creating a subfolder for vocabularies in the user directory, if none exists, saving a copy of the selected vocabulary there, and adding an entry to the user-XML file in xrx.user, to show that the vocabulary is currently being worked on by this user. Those services that make modifications to the SKOS file use eXist-db's XQuery Update Extension. The editor used for modifying description texts is CKEditor, which comes included with mom-ca and is available through <script type="text/javascript" src="/bfResources/scripts/ckeditor/ckeditor.js"/>. Finally, publishing a vocabulary works essentially the same way as publishing a change to a charter, the publish-vocabulary.service is almost identical to the publish-charter.service.

Clone this wiki locally