Migrate Templates interface patterns
This commit is contained in:
@@ -85,7 +85,15 @@ DOCUMENTATION = (
|
||||
layer="available",
|
||||
documentation_types=("admin", "user"),
|
||||
audience=("operator", "module_admin", "product_owner"),
|
||||
metadata={"seed": True},
|
||||
metadata={
|
||||
"seed": True,
|
||||
"help_contexts": [
|
||||
"templates.page",
|
||||
"templates.library",
|
||||
"templates.editor",
|
||||
"templates.state.read-only",
|
||||
],
|
||||
},
|
||||
),
|
||||
DocumentationTopic(
|
||||
id="templates.printable-output",
|
||||
@@ -101,7 +109,51 @@ DOCUMENTATION = (
|
||||
documentation_types=("admin", "user"),
|
||||
audience=("operator", "module_admin", "product_owner"),
|
||||
related_modules=("files", "dist_lists", "campaigns", "audit"),
|
||||
metadata={"seed": True},
|
||||
metadata={
|
||||
"seed": True,
|
||||
"help_contexts": [
|
||||
"templates.preview",
|
||||
"templates.action.validate-preview",
|
||||
"templates.action.render-final",
|
||||
"templates.evidence.render",
|
||||
],
|
||||
},
|
||||
),
|
||||
DocumentationTopic(
|
||||
id="templates.reference.fields-and-consequences",
|
||||
title="Template fields and lifecycle consequences",
|
||||
summary="Scope, usage, data contract, publication, rendering, and deletion semantics for reusable Templates.",
|
||||
body=(
|
||||
"Visibility determines which tenant, group, or user scope may discover the Template; inherited Templates may be read-only. "
|
||||
"Usages are capability contexts that constrain where a Template may be selected. Required fields form the compatibility "
|
||||
"contract checked against supplied data before rendering. Saving creates a new immutable revision. Publishing marks one "
|
||||
"revision as available for final output without rewriting older revisions or evidence. Preview validates and renders bounded "
|
||||
"sample output; final rendering requires the published revision and records template, input, and output hashes plus renderer "
|
||||
"evidence. Files may retain the artifact when its optional capability is available. Deletion removes the Template from future "
|
||||
"selection but does not rewrite retained render evidence."
|
||||
),
|
||||
layer="available",
|
||||
documentation_types=("admin", "user"),
|
||||
audience=("operator", "module_admin", "product_owner"),
|
||||
related_modules=("files", "dist_lists", "campaigns", "audit", "policy"),
|
||||
metadata={
|
||||
"seed": True,
|
||||
"help_contexts": [
|
||||
"templates.field.type",
|
||||
"templates.field.locale",
|
||||
"templates.field.visibility",
|
||||
"templates.field.usages",
|
||||
"templates.field.required-data",
|
||||
"templates.action.publish",
|
||||
"templates.action.delete",
|
||||
],
|
||||
"consequence_classes": {
|
||||
"save_revision": "Creates a new immutable Template revision.",
|
||||
"publish_revision": "Makes the selected immutable revision eligible for final consumer output.",
|
||||
"render_final": "Creates retained render evidence and may persist an artifact through Files.",
|
||||
"delete_template": "Prevents future selection without rewriting retained revisions or render evidence.",
|
||||
},
|
||||
},
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user