docs(records): complete German reference coverage
Module Package Release / publish-packages (push) Successful in 11s

This commit is contained in:
2026-08-23 19:31:24 +02:00
parent a5eee2c23f
commit 312a8e281e
5 changed files with 42 additions and 4 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/records", "name": "@govoplan/records",
"version": "0.1.20", "version": "0.1.21",
"private": true, "private": true,
"description": "GovOPlaN eAkte and institutional records module.", "description": "GovOPlaN eAkte and institutional records module.",
"type": "module", "type": "module",
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "govoplan-records" name = "govoplan-records"
version = "0.1.20" version = "0.1.21"
description = "GovOPlaN eAkte and institutional records module." description = "GovOPlaN eAkte and institutional records module."
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
+25 -1
View File
@@ -16,6 +16,7 @@ from govoplan_core.core.module_guards import (
) )
from govoplan_core.core.modules import ( from govoplan_core.core.modules import (
CapabilityDocumentation, CapabilityDocumentation,
DocumentationCondition,
DocumentationLink, DocumentationLink,
DocumentationTopic, DocumentationTopic,
FrontendModule, FrontendModule,
@@ -52,7 +53,7 @@ from govoplan_records.backend.archive import (
MODULE_ID = "records" MODULE_ID = "records"
MODULE_NAME = "Records" MODULE_NAME = "Records"
MODULE_VERSION = "0.1.20" MODULE_VERSION = "0.1.21"
READ_SCOPE = "records:workspace:read" READ_SCOPE = "records:workspace:read"
WRITE_SCOPE = "records:workspace:write" WRITE_SCOPE = "records:workspace:write"
ADMIN_SCOPE = "records:workspace:admin" ADMIN_SCOPE = "records:workspace:admin"
@@ -222,11 +223,31 @@ DOCUMENTATION = (
), ),
), ),
metadata={ metadata={
"kind": "reference",
"help_contexts": [ "help_contexts": [
"records.data-subject-requests", "records.data-subject-requests",
"records.lifecycle", "records.lifecycle",
], ],
}, },
translations={
"de": {
"title": "Datenschutzanfragen zur eAkte",
"summary": (
"Minimierte Aktenmetadaten ausgeben und dabei Aufbewahrungs-, Sperr-, Aussonderungs- und Archivnachweise bewahren."
),
"body": (
"Records gleicht innerhalb eines Mandanten exakte Verweise auf Akte, Revision, Eintrag, Band, Chronologie, "
"Sperre, Aussonderung, Übergabepaket und anbietergeführte Quellen ab. Konto-, Identitäts- und "
"Mitgliedschaftsselektoren zeigen Verantwortungszuordnungen von Beschäftigten, bedeuten aber niemals, dass die "
"beschäftigte Person Gegenstand einer Akte ist. Eine Auskunft zur aktenbetroffenen Person erfordert deshalb eine "
"führende Akten- oder Quellverknüpfung. Die Ausgabe enthält begrenzte Metadaten zu Akte, Veraktung, Chronologie, "
"Sperre, Aussonderung und Übergabe. Quellinhalt, Schnappschüsse, Suchtext, undurchsichtige Kontexte und Nutzdaten, "
"Prüfsummen, Wiederholungsschlüssel, Start-URLs, Archivmanifeste und -belege, Genehmigungskennungen und fremde "
"Akten bleiben ausgeschlossen. Unveränderliche Nachweise werden aufbewahrt. Der aktuelle Aktenfakt erhält eine "
"nicht ausführbare manuelle Prüfung und kann nur über den gesteuerten eAkte-Lebenszyklus verändert werden."
),
}
},
), ),
DocumentationTopic( DocumentationTopic(
id="records.workspace", id="records.workspace",
@@ -243,6 +264,7 @@ DOCUMENTATION = (
layer="configured", layer="configured",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("user", "records_manager", "operator", "module_admin", "auditor"), audience=("user", "records_manager", "operator", "module_admin", "auditor"),
conditions=(DocumentationCondition(required_scopes=(READ_SCOPE,)),),
order=100, order=100,
related_modules=OPTIONAL_DEPENDENCIES, related_modules=OPTIONAL_DEPENDENCIES,
links=( links=(
@@ -267,6 +289,7 @@ DOCUMENTATION = (
} }
}, },
metadata={ metadata={
"kind": "workflow",
"help_contexts": [ "help_contexts": [
"records.workspace", "records.workspace",
"records.file-plan", "records.file-plan",
@@ -329,6 +352,7 @@ DOCUMENTATION = (
} }
}, },
metadata={ metadata={
"kind": "reference",
"help_contexts": [ "help_contexts": [
"records.action.file", "records.action.file",
"records.field.source-module", "records.field.source-module",
+14
View File
@@ -0,0 +1,14 @@
from __future__ import annotations
from govoplan_records.backend.manifest import manifest
def test_records_german_workflow_and_reference_are_complete() -> None:
topics = {topic.id: topic for topic in manifest.documentation}
assert len(topics) == 5
for topic in topics.values():
assert all(topic.translations["de"].get(key) for key in ("title", "summary", "body"))
workflow = topics["records.workspace"]
assert workflow.metadata["kind"] == "workflow"
assert workflow.conditions
assert topics["records.filing"].metadata["kind"] == "reference"
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/records-webui", "name": "@govoplan/records-webui",
"version": "0.1.20", "version": "0.1.21",
"private": true, "private": true,
"type": "module", "type": "module",
"main": "src/index.ts", "main": "src/index.ts",