fix(ui): align contextual documentation with headings
Verified with the coordinated workspace changes by devkit full run 2026-09-08T225814-186389-0000-3e3ed7cd (all seven phases passed). This shared UI pass does not mark the individual module reviews complete.
This commit is contained in:
@@ -269,7 +269,10 @@ manifest = ModuleManifest(
|
||||
id="organizations.workspace-layout",
|
||||
title="Organizations workspace layout",
|
||||
summary="Find workspace actions and read consistently arranged content.",
|
||||
body="Organization model tables use the complete card width; headings and creation actions stay in the card header, while the shared DataGrid owns filtering, sizing, pagination, and row actions. Unit types, structures, relation types, function types, units, relations, and functions follow the same layout. Model upgrades keep their meaningful version and decision context separate from the result table. Administrators and configurators must use Core's table-card layout instead of local padding or width overrides. The change does not modify model permissions, effective dates, or template-copy semantics.",
|
||||
body="Documentation books sit immediately beside the visible heading or contextual label for "
|
||||
"Organizations, organization settings and record dialogs, not among operational action "
|
||||
"buttons. Field help remains beside its label. "
|
||||
"Organization model tables use the complete card width; headings and creation actions stay in the card header, while the shared DataGrid owns filtering, sizing, pagination, and row actions. Unit types, structures, relation types, function types, units, relations, and functions follow the same layout. Model upgrades keep their meaningful version and decision context separate from the result table. Administrators and configurators must use Core's table-card layout instead of local padding or width overrides. The change does not modify model permissions, effective dates, or template-copy semantics.",
|
||||
layer="static",
|
||||
documentation_types=("user", "admin"),
|
||||
audience=("user", "module_admin", "operator"),
|
||||
@@ -277,7 +280,10 @@ manifest = ModuleManifest(
|
||||
translations={"de": {
|
||||
"title": "Organisationen: Aufbau des Arbeitsbereichs",
|
||||
"summary": "Arbeitsbereichsaktionen finden und einheitlich angeordnete Inhalte lesen.",
|
||||
"body": "Tabellen des Organisationsmodells nutzen die gesamte Kartenbreite. Überschrift und Anlegen-Aktionen bleiben im Kartenkopf; das gemeinsame DataGrid übernimmt Filter, Größe, Seitennavigation und Zeilenaktionen. Einheitentypen, Strukturen, Beziehungstypen, Funktionstypen, Einheiten, Beziehungen und Funktionen folgen demselben Layout. Modell-Upgrades behalten ihren relevanten Versions- und Entscheidungskontext getrennt von der Ergebnistabelle. Administratoren und Konfiguratoren verwenden Cores Tabellenkartenlayout statt lokaler Innenabstands- oder Breitenregeln. Rechte, Gültigkeitsdaten und das Kopierprinzip der Vorlagen ändern sich dadurch nicht.",
|
||||
"body": "Dokumentationsbücher stehen unmittelbar neben der sichtbaren Überschrift oder "
|
||||
"Kontextbezeichnung für Organisationen, Organisationseinstellungen und Eintragsdialoge, nicht "
|
||||
"zwischen ausführbaren Aktionsschaltflächen. Feldhilfe bleibt neben der Feldbezeichnung. "
|
||||
"Tabellen des Organisationsmodells nutzen die gesamte Kartenbreite. Überschrift und Anlegen-Aktionen bleiben im Kartenkopf; das gemeinsame DataGrid übernimmt Filter, Größe, Seitennavigation und Zeilenaktionen. Einheitentypen, Strukturen, Beziehungstypen, Funktionstypen, Einheiten, Beziehungen und Funktionen folgen demselben Layout. Modell-Upgrades behalten ihren relevanten Versions- und Entscheidungskontext getrennt von der Ergebnistabelle. Administratoren und Konfiguratoren verwenden Cores Tabellenkartenlayout statt lokaler Innenabstands- oder Breitenregeln. Rechte, Gültigkeitsdaten und das Kopierprinzip der Vorlagen ändern sich dadurch nicht.",
|
||||
}},
|
||||
),
|
||||
DocumentationTopic(
|
||||
|
||||
@@ -45,7 +45,13 @@ class OrganizationsInterfaceDocumentationContractTests(unittest.TestCase):
|
||||
|
||||
def test_german_reference_documentation_is_complete(self) -> None:
|
||||
topics = manifest.documentation
|
||||
self.assertEqual(4, len(topics))
|
||||
self.assertEqual({
|
||||
"organizations.workspace-layout",
|
||||
"organizations.privacy.data-subject-requests",
|
||||
"organizations.template-upgrades",
|
||||
"organizations.model",
|
||||
"organizations.reference.fields-and-consequences",
|
||||
}, {topic.id for topic in topics})
|
||||
for topic in topics:
|
||||
translation = topic.translations.get("de", {})
|
||||
self.assertTrue(translation.get("title"), topic.id)
|
||||
|
||||
@@ -111,7 +111,7 @@ export default function OrganizationsAdminPanel({ settings, auth }: { settings:
|
||||
|
||||
return (
|
||||
<AdminPageLayout
|
||||
title="i18n:govoplan-organizations.organization_settings.c9ab9829"
|
||||
title="i18n:govoplan-organizations.organization_settings.c9ab9829" titleHelp={<DocumentationHelpLink reference={ORGANIZATIONS_DOCUMENTATION} />}
|
||||
description="i18n:govoplan-organizations.organization_settings_description.35dc9f10"
|
||||
loading={loading}
|
||||
loadingLabel="i18n:govoplan-organizations.loading_organization_settings.c6008db8"
|
||||
@@ -119,7 +119,7 @@ export default function OrganizationsAdminPanel({ settings, auth }: { settings:
|
||||
success={success}
|
||||
actions={(
|
||||
<>
|
||||
<DocumentationHelpLink reference={ORGANIZATIONS_DOCUMENTATION} />
|
||||
|
||||
<Button
|
||||
onClick={() => requestDiscard(() => void load())}
|
||||
disabled={Boolean(reloadDisabledReason)}
|
||||
|
||||
@@ -1002,7 +1002,7 @@ export default function OrganizationsPage({
|
||||
<>
|
||||
<PageLayout
|
||||
archetype="workspace"
|
||||
title={title}
|
||||
title={title} titleHelp={<DocumentationHelpLink reference={ORGANIZATIONS_DOCUMENTATION} />}
|
||||
description={description}
|
||||
actions={<PageActionBar
|
||||
variant="workspace"
|
||||
@@ -1013,7 +1013,7 @@ export default function OrganizationsPage({
|
||||
disabledReason: reloadDisabledReason,
|
||||
title: "i18n:govoplan-organizations.reload.cce71553"
|
||||
}}
|
||||
helpAction={<DocumentationHelpLink reference={ORGANIZATIONS_DOCUMENTATION} />}
|
||||
|
||||
/>}
|
||||
mode={mode === "workspace" ? "workspace" : "embedded"}
|
||||
headerLoading={loading}
|
||||
@@ -1226,7 +1226,7 @@ export default function OrganizationsPage({
|
||||
return (
|
||||
<Dialog variant="administration" size="wide"
|
||||
open={Boolean(activeEditor)}
|
||||
title={editorTitle()}
|
||||
title={editorTitle()} titleHelp={<DocumentationHelpLink reference={ORGANIZATIONS_FIELD_DOCUMENTATION} />}
|
||||
onClose={() => {
|
||||
if (busy) return;
|
||||
if (hasDirtyDraft) requestDiscard(discardDrafts);
|
||||
@@ -1256,9 +1256,7 @@ export default function OrganizationsPage({
|
||||
</>
|
||||
)}
|
||||
>
|
||||
<div className="button-row organizations-dialog-help">
|
||||
<DocumentationHelpLink reference={ORGANIZATIONS_FIELD_DOCUMENTATION} />
|
||||
</div>
|
||||
|
||||
<FormLayout columns={2} gap="small" collapseAt="workspace" id={formId} className="" onSubmit={(event) => void submit(event)}>
|
||||
{renderEditorFields()}
|
||||
</FormLayout>
|
||||
|
||||
Reference in New Issue
Block a user