docs: complete public documentation baseline
This commit is contained in:
+1
-2
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "govoplan-views"
|
||||
version = "0.1.18"
|
||||
version = "0.1.19"
|
||||
description = "Governed task-focused interface projections for GovOPlaN."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12"
|
||||
@@ -20,4 +20,3 @@ govoplan_views = ["py.typed"]
|
||||
|
||||
[project.entry-points."govoplan.modules"]
|
||||
views = "govoplan_views.backend.manifest:get_manifest"
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""GovOPlaN Views module."""
|
||||
|
||||
__version__ = "0.1.18"
|
||||
__version__ = "0.1.19"
|
||||
|
||||
@@ -12,6 +12,7 @@ from govoplan_core.core.module_guards import (
|
||||
)
|
||||
from govoplan_core.core.modules import (
|
||||
CapabilityDocumentation,
|
||||
DocumentationCondition,
|
||||
DocumentationLink,
|
||||
DocumentationTopic,
|
||||
FrontendModule,
|
||||
@@ -35,7 +36,7 @@ from govoplan_views.backend.dsar_provider import (
|
||||
|
||||
MODULE_ID = "views"
|
||||
MODULE_NAME = "Views"
|
||||
MODULE_VERSION = "0.1.18"
|
||||
MODULE_VERSION = "0.1.19"
|
||||
|
||||
DEFINITION_READ_SCOPE = "views:definition:read"
|
||||
DEFINITION_WRITE_SCOPE = "views:definition:write"
|
||||
@@ -348,6 +349,17 @@ manifest = ModuleManifest(
|
||||
layer="configured",
|
||||
documentation_types=("admin", "user"),
|
||||
audience=("user", "tenant_admin", "operator", "auditor"),
|
||||
translations={
|
||||
"de": {
|
||||
"title": "Datenschutzanfragen für Ansichten",
|
||||
"summary": "Persönliche Ansichten, Zuordnungen und Auswahlen exportieren oder löschen, ohne institutionelle Projektionen oder Fachdaten zu verändern.",
|
||||
"body": (
|
||||
"Views ordnet genau ein Konto im aktiven Mandanten zu und kann die Anfrage auf eine Definition, Zuordnung oder Einstellung begrenzen. Das Auskunftspaket enthält die begrenzte Darstellung persönlicher Definitionen und Revisionen, Benutzerzuordnungen sowie die aktive Ansichtsauswahl. "
|
||||
"Beliebige Zuordnungsmetadaten sind ausgeschlossen; Oberflächen werden nur als Kennungen ausgegeben und niemals bis in Fachdaten verfolgt. Von der betroffenen Person erstellte oder aktualisierte Mandanten- und Gruppenkonfiguration trägt nur minimierte Zuordnungsdaten bei, die als institutioneller Verantwortungsnachweis erhalten bleiben. Systemweite Ansichten liegen außerhalb mandantenbezogener Anfragen. "
|
||||
"Eine Löschung kann nach Prüfung von Zeitstempel, Revision, Eigentum und abhängigen Datensätzen eine genaue persönliche Auswahl, Benutzerzuordnung oder benutzereigene Definition entfernen. Eine persönliche Definition, von der ein anderes Konto abhängt, wird zur manuellen Prüfung weitergeleitet. Das Löschen einer Auswahl oder Zuordnung löscht niemals die referenzierte institutionelle Ansicht; wiederholte Ausführung verändert nichts."
|
||||
),
|
||||
}
|
||||
},
|
||||
related_modules=("core", "access", "quick_access"),
|
||||
metadata={
|
||||
"help_contexts": [
|
||||
@@ -405,18 +417,24 @@ manifest = ModuleManifest(
|
||||
documentation_types=("admin", "user"),
|
||||
audience=("administrator", "power_user", "workflow_designer"),
|
||||
related_modules=("access", "admin", "policy", "workflow_engine"),
|
||||
conditions=(
|
||||
DocumentationCondition(
|
||||
required_modules=("views", "access"),
|
||||
any_scopes=(
|
||||
SELECTION_READ_SCOPE,
|
||||
DEFINITION_READ_SCOPE,
|
||||
PERSONAL_DEFINITION_READ_SCOPE,
|
||||
),
|
||||
),
|
||||
),
|
||||
translations={
|
||||
"de": {
|
||||
"title": "Aufgabenbezogene Ansichten",
|
||||
"summary": "Die sichtbare Oberflaeche auf die fuer eine Aufgabe benoetigten Module und Funktionen begrenzen, ohne Berechtigungen zu aendern.",
|
||||
"summary": "Die sichtbare Oberfläche auf die für eine Aufgabe benötigten Module und Funktionen begrenzen, ohne Berechtigungen zu ändern.",
|
||||
"body": (
|
||||
"Ansichten sind versionierte Darstellungsprojektionen. Module melden ihre waehlbaren Oberflaechen ueber "
|
||||
"den Plattformvertrag. Eine Revision darf Schnellzugriffswerkzeuge empfehlen oder die Leiste auf eine "
|
||||
"aufgabenbezogene Teilmenge fokussieren. Das aendert nur die Darstellung: nicht verfuegbare, unpassende "
|
||||
"oder unberechtigte Werkzeuge bleiben verborgen; ein nicht nutzbarer Fokus faellt auf die normale wirksame "
|
||||
"Leiste mit einer Erklaerung zurueck. Alle verfuegbaren Werkzeuge stellt voruebergehend dieselbe "
|
||||
"berechtigungsabgeleitete Leiste wieder her, ohne die Ansicht zu aendern. Workflow erhaelt dasselbe Verhalten durch die genaue unveraenderliche Ansichtsversion. "
|
||||
"Ausgeblendete Funktionen bleiben durch ihre normalen Berechtigungspruefungen geschuetzt."
|
||||
"Ansichten sind versionierte Darstellungsprojektionen. Module melden ihre wählbaren Oberflächen über den Plattformvertrag. System- und Mandantenadministrationen können Ansichten veröffentlichen und sie auf System-, Mandanten-, Gruppen- und Benutzerebene als verfügbar, voreingestellt oder verpflichtend zuordnen. Verpflichtende Ansichten behalten Auswahl- und Administrationsauswege, damit sie stets geprüft und geändert werden können. "
|
||||
"Das Augensymbol in der Titelleiste öffnet die Auswahl und wird hervorgehoben, solange eine spezialisierte Ansicht aktiv ist. Ausgeblendete Funktionen bleiben durch ihre normalen Berechtigungsprüfungen geschützt. Eine Revision darf Schnellzugriffswerkzeuge empfehlen oder die Leiste auf eine aufgabenbezogene Teilmenge fokussieren. Das ändert nur die Darstellung: nicht verfügbare, unpassende oder unberechtigte Werkzeuge bleiben verborgen; ein unbrauchbarer Fokus fällt mit Erklärung auf die normale wirksame Leiste zurück. "
|
||||
"Alle verfügbaren Werkzeuge stellt vorübergehend dieselbe berechtigungsabgeleitete Leiste wieder her, ohne die Ansicht zu ändern oder eine Umgehung zu speichern. Workflow erhält dasselbe Verhalten durch Auflösung der genauen unveränderlichen Ansichtsrevision. Ist Policy aktiviert, liefert Views einen mandantenbezogenen und begrenzten Katalog von Definitionen, Aktionen und registrierten Oberflächen für Wirkungsvorschauen, ohne Zugriff auf Implementierungsdetails zu erteilen."
|
||||
),
|
||||
}
|
||||
},
|
||||
@@ -433,7 +451,7 @@ manifest = ModuleManifest(
|
||||
),
|
||||
),
|
||||
metadata={
|
||||
"kind": "guide",
|
||||
"kind": "workflow",
|
||||
"help_contexts": [
|
||||
"views.selector",
|
||||
"views.admin.system",
|
||||
@@ -441,6 +459,11 @@ manifest = ModuleManifest(
|
||||
"views.settings.personal",
|
||||
"views.admin.blocked",
|
||||
],
|
||||
"steps": [
|
||||
"Open the View selector and review the effective View and its source.",
|
||||
"Choose an available View or return to the permission-derived default.",
|
||||
"Use the administration escape when a required View must be inspected or changed.",
|
||||
],
|
||||
},
|
||||
order=18,
|
||||
),
|
||||
@@ -474,6 +497,17 @@ manifest = ModuleManifest(
|
||||
documentation_types=("admin",),
|
||||
audience=("administrator", "power_user", "workflow_designer"),
|
||||
related_modules=("access", "admin", "policy", "workflow_engine"),
|
||||
translations={
|
||||
"de": {
|
||||
"title": "Felder, Zuordnungen und Folgen von Ansichten",
|
||||
"summary": "Unveränderliche Revisionen, Zuordnungsrangfolge, Schutzvorgaben verpflichtender Ansichten und den Unterschied zwischen Sichtbarkeit und Zugriff verstehen.",
|
||||
"body": (
|
||||
"Eine Ansichtsdefinition enthält unveränderliche Revisionen sichtbarer Oberflächenkennungen und Darstellungsmetadaten. Durch Veröffentlichung wird die neueste Revision zuordenbar. Verfügbare Zuordnungen erlauben eine freiwillige Auswahl, Voreinstellungen gelten bis zu einer Änderung und verpflichtende Zuordnungen können nicht verlassen werden. Benutzer- und Gruppenzuordnungen haben Vorrang vor Mandanten- und Systemzuordnungen. "
|
||||
"Eine Fixierung bewahrt genau eine veröffentlichte Revision; eine nicht fixierte Zuordnung folgt späteren Veröffentlichungen. Verpflichtende Ansichten müssen Auswahl- und Administrationsauswege erhalten. Das Ausblenden einer Oberfläche erteilt oder entzieht niemals eine Berechtigung. Der Oberflächenkatalog ist durch die Modulfreigabe des aktiven Mandanten begrenzt; eine Ansicht kann daher kein systemseitig oder mandantenseitig deaktiviertes Modul freigeben. Gespeicherte Verweise bleiben in unveränderlichen Revisionen erhalten und werden als veraltet gemeldet. Geerbte Definitionen und Zuordnungen müssen in ihrer besitzenden Ebene geändert werden. "
|
||||
"Produktbereichsgruppen, Reihenfolge und Beschriftungen sind Darstellungsmetadaten derselben Revision und können weder verborgene Oberflächen freigeben noch Berechtigungen erteilen. Gruppierte Navigation ist die sinnvolle Voreinstellung; flache Navigation erhält die vollständige berechtigte Werkzeugleiste. Empfehlungen und Fokuskennungen für Schnellzugriff sind ebenfalls versionierte Darstellungsmetadaten. Der Ausweg Alle verfügbaren Werkzeuge kann nur Beiträge zeigen, die bereits Modulfreigabe, Richtlinie, Einstellung, Oberfläche, Kontext und Berechtigungsprüfung bestanden haben."
|
||||
),
|
||||
}
|
||||
},
|
||||
links=(
|
||||
DocumentationLink(
|
||||
label="Views administration",
|
||||
|
||||
@@ -37,6 +37,26 @@ class ViewsInterfaceDocumentationContractTests(unittest.TestCase):
|
||||
self.assertIn("views.action.publish", reference.metadata["help_contexts"])
|
||||
self.assertIn("required", reference.metadata["consequence_classes"])
|
||||
|
||||
self.assertTrue(
|
||||
all(
|
||||
all(
|
||||
topic.translations.get("de", {}).get(field)
|
||||
for field in ("title", "summary", "body")
|
||||
)
|
||||
for topic in topics.values()
|
||||
)
|
||||
)
|
||||
workflow = topics["views.interface-projections"]
|
||||
self.assertEqual("workflow", workflow.metadata["kind"])
|
||||
self.assertTrue(workflow.conditions)
|
||||
self.assertTrue(
|
||||
all(
|
||||
condition.required_scopes or condition.any_scopes
|
||||
for condition in workflow.conditions
|
||||
)
|
||||
)
|
||||
self.assertEqual("reference", reference.metadata["kind"])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@govoplan/views-webui",
|
||||
"version": "0.1.18",
|
||||
"version": "0.1.19",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "src/index.ts",
|
||||
|
||||
+1
-1
@@ -103,7 +103,7 @@ const viewsSettingsSections: SettingsSectionsUiCapability = {
|
||||
export const viewsModule: PlatformWebModule = {
|
||||
id: "views",
|
||||
label: "i18n:govoplan-views.views",
|
||||
version: "0.1.0",
|
||||
version: "0.1.19",
|
||||
optionalDependencies: ["access", "admin", "policy", "workflow"],
|
||||
translations: {
|
||||
en: generatedTranslations.en,
|
||||
|
||||
Reference in New Issue
Block a user