QuickStart
Schnellstart-Anleitung: Co-Site Glossar
Ein System zur Erstellung und Verwaltung von Glossaren - mit strukturierter Datenspeicherung, halbautomatischer Veröffentlichung und FAIR-Data-Ausgabe. Erstellt mit einem offenen wissenschaftlichen Workflow unter Verwendung der "Semantic Glossar"-Software-Pipeline, als: Open Access, Open-Source-Software, FAIR-Data und mit integrierter Digitaler Souveränität.
Das System wird verwendet, weil es Folgendes ermöglicht: kollaborative Glossarerstellung, Glossarverwaltung, -veröffentlichung und -wiederverwendung sowie die Verwendung des Glossars als Daten für weitere Analysen, Literaturrecherchen oder auch die Indexierung von Publikationen oder Korpora.
Die Software-Pipeline "Semantic Glossar" stammt aus dem Dienst NextGen Books, der vom Open Science Lab der TIB bereitgestellt wird.
Erstellen und Veröffentlichen des Glossars
- Glossarbegriffe hinzufügen und bearbeiten: Verwenden Sie die Online-Formulare, um Glossarbegriffe hinzuzufügen und zu bearbeiten. Ein Sandbox-Glossar wird zum Erlernen der Nutzung des Systems bereitgestellt. Siehe unten für eine Kurzanleitung.
- Vorschau von Glossarbegriffen: Die letzten Bearbeitungen von Begriffen und den dazugehörigen Informationen ansehen. Bei der Erstellung des Glossars kann ein Überprüfungsverfahren hinzugefügt werden.
- Wikibase - erweiterte Ansicht und Bearbeitung von Glossarbegriffen: Glossarbegriffe können korrigiert und mit Linked Open Data ergänzt werden, z. B. Climate Change (IPCC). Auch Datenexporte sind möglich.
- Veröffentlichung des Glossars: Das Glossar wird in einem halbautomatischen Prozess durch einen Publikationsmanager in verschiedenen Formaten veröffentlicht. Die Veröffentlichung ist über Zenodo verfügbar, wo sie mit einem DOI versehen wird.
Anleitung zum Erstellen von Glossarbegriffen
1. Das Eingabeformular kann unter "Begriff hinzufügen" auf der Startseite oder in der Navigationsleiste am oberen Bildschirmrand erreicht werden.
2. Von allen Begriffen, die sich hinzufügen lassen, sind nur zwei notwendig, um einen Begriff anzulegen: Begriff und Beschreibung. Alle anderen sind optional. In die Felder, die mit (ItemID) versehen sind, muss die ID-Nummer ("Q-Nummer") der gewünschten Begriffe eingetragen werden, welche sich in der Glossarübersicht finden lassen.
- Mögliche Angaben für Begriffe:
- Beschreibung (Klartext): Hier kann eine einfachere Fassung des Beschreibungstextes eingetragen werden.
- Akronym: Für Abkürzungen.
- Tags (durch Komma getrennt): Für Schlagwörter, z.B. "Forschungsplattform" für den Begriff "Virtuelles Institut Smart Energy (VISE)".
- Ähnlich zu (ItemID): Begriffe, die mit diesem in Verbindung stehen, aber nicht bedeutungsgleich sind.
- Unterbegriff von (ItemID): Hierarchisch überstehende Begriffe, z.B. "blau-grüne Infrastruktur" für den Begriff "städtischer Wärmeinseleffekt".
- Synonym (ItemID): Bedeutungsgleiche Begriffe.
- Vokabular: "Co-Site" auswählen, um zum Co-Site-Glossar hinzuzufügen. "Sandbox" kann genutzt werden, um sich mit den Funktionen des Formulars vertraut zu machen.
- Status: Beim Erstellen sollten alle Begriffe zunächst als "Entwurf" gespeichert werden. Im Laufe der Bearbeitung der Begriffe kann der Status geändert werden.
- Beitragende/r: Es kann ein voreingestellter Name ausgewählt werden oder ein anonymer Beitrag verfasst werden.
3. Nachdem absenden des Formulars erscheint eine Erfolgsmeldung auf dem Bildschirm und die Eingabefelder leeren sich von selbst.
Anleitung zum Hinzufügen von Begriffseigenschaften
- In der Glossaransicht auf die ID („Q-Nummer“) des gewünschten Begriffs klicken
- in der Detailansicht ganz unten auf „Aussage hinzufügen“ gehen
- im Feld „Eigenschaft“ eine der Kategorien eingeben:
- „Tag“, „description_plain“ (Einfache Beschreibung), „Akronym“, „SimilarTo“, „Synonym“ oder „subCategoryOf“ (Unterbegriff)
- für Tags oder Akronyme Freitext eingeben
- für Ähnliche Begriffe, Synonyme oder Überbegriffe entweder die ID oder den Namen des Begriffs mit vorangestelltem „term_“ (also z.B. „term_Wissenschaftskommunikation“) eingeben – das Feld schlägt automatisch Begriffe vor, die sich dann auswählen lassen
- rechts vom Eingabefeld die Option „Speichern“ wählen
- weitere Werte lassen sich nach dem Speichern hinzufügen, dafür im jeweiligen Feld unten rechts „Wert hinzufügen“ auswählen
- alle eingetragenen Eigenschaften können nachträglich bearbeitet werden
Quick Start Guide: Co-Site Glossary
A system for glossary creation and management – with structured data storage, semi‑automated publishing, and with FAIR data outputs. Made using an open science workflow using "Semantic Glossar" software pipeline, as: Open access, open source software, FAIR data, and with digital sovereignty built-in.
The system is used as it allows for: collaborative glossary creation; glossary management, publishing, and reuse; and, the use of glossary as data to carry out further data analysis, literature searches, or indexing of publications or corpora.
"Semantic Glossar" software pipeline is from the NextGen Books service provided by Open Science Lab, TIB.
Creating and Publishing the Glossary
- Add and edit glossary terms: Use the web forms to add and edit glossary terms. A Sandbox glossary is provided for learning to use the system. See below for a short guide.
- Preview glossary terms: See the latest edits of terms and their related information. A review process can be added to the glossary creation.
- Wikibase - advanced view and editing of glossary terms: Glossary terms can be corrected and enhanced with 'linked open data', e.g., Climate Change (IPCC). Data exports are also possible.
- Glossary publication: The glossary is publishing as multi-format using a semi-automated process by a publication manager. The publication is available via Zenodo where it is assigned a DOI.
Guide to Creating Glossary Terms
1. The input form can be accessed under "Add term" on the start page or in the navigation bar at the top of the screen.
2. Of all the terms that can be added, only two are necessary to create a term: Name and Description. All others are optional. In the fields labelled (ItemID), the ID number ("Q number") of the desired terms must be entered, which can be found in the glossary overview.
- Optional Parameters for Terms:
- Description (plain text): A simpler version of the description text can be entered here.
- Acronyms: For abbreviations. These are plain text fields at present and not data nodes (this will be changed later).
- Tags (separated by a comma): For keywords, e.g. "research platform" for the term "Virtual Institute Smart Energy (VISE)". These are plain text fields at present and not data nodes (this will be changed later).
- Similar to (ItemID): Terms that are related to this one but do not have the same meaning.
- Subterm of (ItemID): Hierarchically overlapping terms, e.g. "blue-green infrastructure" for the term "urban heat island effect".
- Synonym (ItemID): Terms with the same meaning.
- Vocabulary: Select "Co-Site" to add to the So-Site glossary. "Sandbox" can be used to familiarise yourself with the functions of the form.
- Status: When creating, all terms should initially be saved as "Draft". The status can be changed as the terms are edited.
- Contributor: A pre-set name can be selected or an anonymous contribution can be created.
3. After submitting the form, a success message will appear on the screen and the input fields will clear automatically.
4. Edit glossary terms: Using the advanced editing interface you can edit existing entries and add more details such as Tags, Synonym etc.
In the glossary or glossary search view click on the ID (Q Number) of the term (e.g., Q2997) to access the advanced editing view.
There are then three edit functions: 1. Edit top right to edit the term title and description; 2. The adding values and editing existing values. Note: Abreviations and and acronyms are free text, where as adding relations to exsting terms is done using the ID (Q Numbers). 3. Add a statement. If a statement is not present then it needs to be added at the bottom of the page: acronym, tags, etc.
Images on GitHub: https://github.com/TIBHannover/semantic-glossar/tree/main/images