From cfcd7234966dad134038401223971c3f1a98022a Mon Sep 17 00:00:00 2001 From: Albrecht Degering Date: Mon, 24 Aug 2026 01:15:34 +0200 Subject: [PATCH] docs: complete German structured documentation --- pyproject.toml | 2 +- src/govoplan_forms/__init__.py | 2 +- .../german_structured_documentation.py | 84 +++++++++++++++++++ src/govoplan_forms/backend/manifest.py | 10 ++- webui/package.json | 2 +- 5 files changed, 96 insertions(+), 4 deletions(-) create mode 100644 src/govoplan_forms/backend/german_structured_documentation.py diff --git a/pyproject.toml b/pyproject.toml index f7d7e75..11493d1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "govoplan-forms" -version = "0.1.21" +version = "0.1.22" description = "Immutable reusable form definitions for GovOPlaN." readme = "README.md" requires-python = ">=3.12" diff --git a/src/govoplan_forms/__init__.py b/src/govoplan_forms/__init__.py index d19d77b..0fb6ff4 100644 --- a/src/govoplan_forms/__init__.py +++ b/src/govoplan_forms/__init__.py @@ -1,3 +1,3 @@ """GovOPlaN Forms module.""" -__version__ = "0.1.21" +__version__ = "0.1.22" diff --git a/src/govoplan_forms/backend/german_structured_documentation.py b/src/govoplan_forms/backend/german_structured_documentation.py new file mode 100644 index 0000000..6880ad2 --- /dev/null +++ b/src/govoplan_forms/backend/german_structured_documentation.py @@ -0,0 +1,84 @@ +"""German translations for public structured documentation metadata.""" + +from __future__ import annotations + +from typing import Any + + +GERMAN_STRUCTURED_TRANSLATIONS: dict[str, dict[str, Any]] = {'forms.data-subject-requests': {'consequence_classes': {'exclude_form_semantics': 'Gibt keinen ' + 'Schema-, Feld- ' + 'oder ' + 'Submission-Value-Inhalt ' + 'zurück.', + 'export_definition_attribution': 'Returns ' + 'minimierten ' + 'die ' + 'unveränderliche ' + 'Revisionsaktivität.'}}, + 'forms.definitions': {'privacy_notes': ['Definitionskataloge enthalten Schemata und ' + 'Richtlinienreferenzen, keine eingereichten ' + 'Formularwerte.', + 'Die Paketbewertung gewährt keinen Zugriff auf ' + 'referenzierte Laufzeiteinreichungen oder externe ' + 'Anbieter.', + 'Veröffentlichte Zugänglichkeits- und ' + 'Lokalisierungsinhalte sind überall dort sichtbar, wo die ' + 'genaue Definition autorisiert ist.']}, + 'forms.reference.fields-and-consequences': {'consequence_classes': {'import_package': 'Erstellt ' + 'einen ' + 'lokalen ' + 'Entwurf ' + 'und behält ' + 'die ' + 'Herkunft ' + 'des Pakets ' + 'ohne ' + 'automatische ' + 'Veröffentlichung.', + 'publish': 'Macht die genaue ' + 'Revision für ' + 'zukünftige ' + 'autorisierte ' + 'Instanzen ' + 'verfügbar.', + 'retire': 'Stoppt die ' + 'zukünftige ' + 'Nutzung, während ' + 'Definitionen und ' + 'genaue ' + 'Laufzeitreferenzen ' + 'beibehalten ' + 'werden.', + 'save_revision': 'Erstellt ' + 'eine ' + 'unveränderliche ' + 'Definitionsrevision ' + 'mit einem ' + 'Änderungsgrund.'}, + 'limitations': ['Der Paketimport veröffentlicht ' + 'niemals automatisch eine ' + 'Formularrevision.', + 'Laufzeiteingaben und eingereichte ' + 'Werte werden niemals als ' + 'Definitionskonfiguration exportiert.', + 'Generische Paket-Rollback erfordert ' + 'die Voranwendung Datenbank Snapshot ' + 'beibehalten.'], + 'operational_consequences': ['Preserve blockiert eine ' + 'widersprüchliche lokale ' + 'Definition; new ' + 'revision muss explizit ' + 'überprüft werden.', + 'Das erneute Anwenden ' + 'eines identischen ' + 'Quell-Digests ist ' + 'idempotent und erzeugt ' + 'keine Revision.', + 'Importierte ' + 'Definitionen erfordern ' + 'eine normale ' + 'Überprüfung und ' + 'Veröffentlichung von ' + 'Formularen vor der ' + 'Verwendung zur ' + 'Laufzeit.']}} diff --git a/src/govoplan_forms/backend/manifest.py b/src/govoplan_forms/backend/manifest.py index 737f9ec..e70d74a 100644 --- a/src/govoplan_forms/backend/manifest.py +++ b/src/govoplan_forms/backend/manifest.py @@ -1,5 +1,8 @@ from __future__ import annotations +from govoplan_core.core.modules import with_documentation_structured_translations +from govoplan_forms.backend.german_structured_documentation import GERMAN_STRUCTURED_TRANSLATIONS + from pathlib import Path from govoplan_core.core.access import ( @@ -48,7 +51,7 @@ from govoplan_forms.backend.semantic_subjects import ( MODULE_ID = "forms" MODULE_NAME = "Forms" -MODULE_VERSION = "0.1.21" +MODULE_VERSION = "0.1.22" READ_SCOPE = "forms:definition:read" WRITE_SCOPE = "forms:definition:write" ADMIN_SCOPE = "forms:definition:admin" @@ -523,5 +526,10 @@ manifest = ModuleManifest( ) +manifest = with_documentation_structured_translations( + manifest, locale="de", translations=GERMAN_STRUCTURED_TRANSLATIONS +) + + def get_manifest() -> ModuleManifest: return manifest diff --git a/webui/package.json b/webui/package.json index bfbe72e..610b9d2 100644 --- a/webui/package.json +++ b/webui/package.json @@ -1,6 +1,6 @@ { "name": "@govoplan/forms-webui", - "version": "0.1.21", + "version": "0.1.22", "private": true, "type": "module", "main": "src/index.ts",