Add citation field to layers

VedaWebProject · Oct 4, 2023 · f498c35 · f498c35
1 parent d709900
commit f498c35
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 3 deletions.
diff --git a/Tekst-API/openapi.json b/Tekst-API/openapi.json
@@ -3507,6 +3507,19 @@
             "description": "Publication status of this layer",
             "default": false
           },
+          "citation": {
+            "anyOf": [
+              {
+                "type": "string",
+                "maxLength": 1000
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Citation",
+            "description": "Citation details for this layer"
+          },
           "meta": {
             "anyOf": [
               {
@@ -3642,6 +3655,19 @@
             "description": "Publication status of this layer",
             "default": false
           },
+          "citation": {
+            "anyOf": [
+              {
+                "type": "string",
+                "maxLength": 1000
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Citation",
+            "description": "Citation details for this layer"
+          },
           "meta": {
             "anyOf": [
               {
@@ -3755,6 +3781,17 @@
             "type": "boolean",
             "title": "Public"
           },
+          "citation": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Citation"
+          },
           "meta": {
             "anyOf": [
               {

diff --git a/Tekst-API/tekst/models/layer.py b/Tekst-API/tekst/models/layer.py
@@ -54,6 +54,10 @@ class LayerBase(ModelBase, ModelFactoryMixin):
     public: Annotated[
         bool, Field(description="Publication status of this layer")
     ] = False
+    citation: Annotated[
+        str | None,
+        Field(description="Citation details for this layer", max_length=1000),
+    ] = None
     meta: Annotated[Metadata | None, Field(description="Arbitrary metadata")] = None
     comment: Annotated[
         str | None,

diff --git a/Tekst-API/tekst/sample_data/_sample_data.py b/Tekst-API/tekst/sample_data/_sample_data.py
@@ -311,6 +311,7 @@
                 "language": "DE",
             },
             "comment": "This version includes repetition markers.",
+            "citation": "Anschütz, Ernst. Warnung. 1824.",
             "config": {
                 "deepl_links": {
                     "enabled": True,

diff --git a/Tekst-Web/src/components/browse/widgets/LayerInfoWidget.vue b/Tekst-Web/src/components/browse/widgets/LayerInfoWidget.vue
@@ -74,12 +74,19 @@ const coveragePercent = computed(
     </template>
 
     <template v-if="layer.comment">
-      <h3>{{ $t('models.meta.comment') }}</h3>
+      <h3>{{ $t('models.layer.comment') }}</h3>
       <div class="layer-comment">
         {{ layer.comment }}
       </div>
     </template>
 
+    <template v-if="layer.citation">
+      <h3>{{ $t('browse.units.widgets.infoWidget.citeAs') }}</h3>
+      <div>
+        {{ layer.citation }}
+      </div>
+    </template>
+
     <h3>{{ $t('browse.units.widgets.infoWidget.coverage') }}</h3>
     <template v-if="coverage">
       <p>

diff --git a/Tekst-Web/src/i18n/translations/deDE.yml b/Tekst-Web/src/i18n/translations/deDE.yml
@@ -121,6 +121,7 @@ browse:
         title: DeepL-Übersetzung öffnen
       infoWidget:
         title: Informationen zu dieser Datenschicht anzeigen
+        citeAs: Zitieren als
         coverage: Abdeckung
         coverageStatement: '{present} von {total} Knoten auf Ebene "{level}".'
       deactivateWidget:
@@ -198,6 +199,8 @@ models:
   layer:
     modelLabel: Datenschicht | Datenschichten
     layerType: Datenschicht-Typ
+    comment: Kommentar
+    citation: Zitation
   unit:
     modelLabel: Daten-Einheit | Daten-Einheiten
   meta:
@@ -206,7 +209,6 @@ models:
     year: Jahr
     language: Sprache
     layerType: '@:models.layer.layerType'
-    comment: Kommentar
     providedBy: Bereitgestellt von
     onLevel: auf Ebene "{level}"
 

diff --git a/Tekst-Web/src/i18n/translations/enUS.yml b/Tekst-Web/src/i18n/translations/enUS.yml
@@ -120,6 +120,7 @@ browse:
         title: Open DeepL translation
       infoWidget:
         title: Show information on this data layer
+        citeAs: Cite as
         coverage: Coverage
         coverageStatement: '{present} of {total} nodes on level "{level}".'
       deactivateWidget:
@@ -190,6 +191,8 @@ models:
   layer:
     modelLabel: Data layer | Data layers
     layerType: Datalayer Type
+    citation: Citation
+    comment: Comment
   unit:
     modelLabel: Data unit | Data units
   meta:
@@ -198,7 +201,6 @@ models:
     year: Year
     language: Language
     layerType: '@:models.layer.layerType'
-    comment: Comment
     providedBy: Provided by
     onLevel: on level "{level}"