docs: add documentation for adding vocabularies using thesaurus

German and English files now contain a documentation section for adding vocabularies using thesaurus. ING-4556
wetransform · Dec 6, 2024 · e411494 · e411494
1 parent 52c15b4
commit e411494
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/docs/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md b/docs/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md
@@ -2993,6 +2993,33 @@ JSON values can be added to string fields in the metadata editor. The JSON value
                        "value": "{\"id\":\"geoNutz/20130319\",\"name\":\"Nutzungsbestimmungen für die Bereitstellung von Geo-daten des Bundes\",\"url\":\"https://sg.geodatenzent-rum.de/web_public/gdz/lizenz/geonutzv.pdf\",\"quelle\":\"Quelle: © GeoBasis-DE / BKG (Jahr des letzten Datenbezugs)\"}"
                    }
 
+### Adding thesaurus keywords
+
+Adding thesaurus keywords to the metadata can be done by defining an `autofillRule` or `defaultValue` in the theme's metadata configuration. The autofill rule can be added as a JSON string with special characters escaped. After running the autofill workflow for a related dataset, it might be necessary to refresh the web page to see the string displayed in the respective fields in the UI. The same approach can be used for `defaultValue`.
+
+```json
+{
+      "name": "md-dataset.identification.keyword_thesaurus",
+      "required": false,
+      "minOccurs": 0,
+      "maxOccurs": -1,
+      "comment": "keyword_thesaurus",
+      "label": "Suchbegriffe Thesaurus",
+      "description": "Begriffe, unter denen der Datensatz gefunden werden soll.",
+      "type": "string",
+      "schema": null,
+      "defaultValue": null,
+      "autofillRule": "{ \"date\": \"2023-09-27\", \"datetype\": \"publication\", \"keywords\": [{\"keyword\": \"Erdbeobachtung und Umwelt\", \"keywordLink\": \"http://data.europa.eu/bna/c_dd313021\"}], \"title\": \"High-value dataset categories\", \"url\": \"http://data.europa.eu/bna/asd487ae75\"}",
+      "visibility": true,
+      "editable": true,
+      "targets": {
+         "bsp": "md-dataset.identification.keyword_thesaurus"
+      }
+}
+```
+
+In case that multiple keywords need to be defined, the notation requires square brackets around the JSON strings (see [Adding multiple autofill rules for one metadata field](#adding-multiple-autofill-rules-for-one-metadata-field)).
+
 ### Metadata configured to use one or more profiles
 
 hale»connect metadata profiles provide options for adding and removing additional metadata elements in the hale»connect auto-generated metadata. Metadata profiles are available in the dataset and service metadata configurations, as some options affect both dataset and service metadata. Metadata profiles are not mandatory and more than one metadata profile can be applied. The metadata elements that can be added to metadata are described below:

diff --git a/...nt-docs/current/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md b/...nt-docs/current/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md
@@ -2993,6 +2993,33 @@ JSON-Werte können im Metadaten-Editor zu String-Feldern hinzugefügt werden. Di
                          "value": "{\"id\":\"geoNutz/20130319\",\"name\":\"Nutzungsbestimmungen für die Bereitstellung von Geo-daten des Bundes\",\"url\":\"https://sg.geodatenzent-rum.de/web_public/gdz/lizenz/geonutzv.pdf\",\"quelle\":\"Quelle: © GeoBasis-DE / BKG (Jahr des letzten Datenbezugs)\"}"
                      }
 
+### Hinzufügen von Schlüsselwörtern mit Thesaurusangabe
+
+Schlüsselwörter mit Angabe eines Thesaurus können den Metadaten zugefügt werden, indem eine entsprechende Autofill-Regel (`autofillRule`) oder ein Default-Wert (`defaultValue`) in der Metadaten-Konfiguration des Themas definiert wird. Die Regel kann in Form eines JSON-Strings hinzugefügt werden, wobei Sonderzeichen mit einen Backslash (`\`) maskiert werden müssen. Nach Ausführen des Autofill-Workflows für einen zugehörigen Datensatz muss eventuell die Seite im Browser neu geladen werden, damit die Änderungen in der Oberfläche sichtbar sind. Das Vorgehen kann analog auch für `defaultValue` angewendet werden.
+
+```json
+{
+      "name": "md-dataset.identification.keyword_thesaurus",
+      "required": false,
+      "minOccurs": 0,
+      "maxOccurs": -1,
+      "comment": "keyword_thesaurus",
+      "label": "Suchbegriffe Thesaurus",
+      "description": "Begriffe, unter denen der Datensatz gefunden werden soll.",
+      "type": "string",
+      "schema": null,
+      "defaultValue": null,
+      "autofillRule": "{ \"date\": \"2023-09-27\", \"datetype\": \"publication\", \"keywords\": [{\"keyword\": \"Erdbeobachtung und Umwelt\", \"keywordLink\": \"http://data.europa.eu/bna/c_dd313021\"}], \"title\": \"High-value dataset categories\", \"url\": \"http://data.europa.eu/bna/asd487ae75\"}",
+      "visibility": true,
+      "editable": true,
+      "targets": {
+         "bsp": "md-dataset.identification.keyword_thesaurus"
+      }
+}
+```
+
+Für den Fall, dass mehrere Schlüsselwörter definiert werden sollen, müssen eckige Klammern um die JSON-Strings gesetzt werden (siehe [Hinzufügen mehrerer Autofill-Regeln für ein Metadatenfeld](#hinzuf%C3%BCgen-mehrerer-autofill-regeln-f%C3%BCr-ein-metadatenfeld)).
+
 ### Metadaten, die für die Verwendung eines oder mehrerer Profile konfiguriert sind
 
 hale»connect-Metadatenprofile bieten Optionen für das Hinzufügen und Entfernen zusätzlicher Metadatenelemente in den von hale»connect automatisch generierten Metadaten. Metadatenprofile sind in den Konfigurationen für Datensatz- und Dienst-Metadaten verfügbar, da einige Optionen sowohl Datensatz- als auch Dienst-Metadaten betreffen. Metadatenprofile sind nicht obligatorisch, und es kann mehr als ein Metadatenprofil angewendet werden. Die Metadatenelemente, die zu Metadaten hinzugefügt werden können, werden im Folgenden beschrieben: