57 lines
2.6 KiB
Markdown
57 lines
2.6 KiB
Markdown
# GovOPlaN Templates
|
|
|
|
<!-- govoplan-repository-type:start -->
|
|
**Repository type:** module (domain).
|
|
<!-- govoplan-repository-type:end -->
|
|
|
|
`govoplan-templates` owns reusable renderable template definitions and render
|
|
contracts for GovOPlaN. It is intentionally separate from reporting, DMS/files,
|
|
mail delivery, forms runtime, and workflow state.
|
|
|
|
The first operational slice provides:
|
|
|
|
- a scoped, versioned library for labels, label sheets, envelopes, serial and
|
|
form letters, list layouts, email, and generic templates;
|
|
- explicit usages, locales, required-field contracts, output profiles, and
|
|
compatibility diagnostics;
|
|
- safe deterministic HTML/text rendering from frozen caller-owned snapshots;
|
|
- immutable template/input/output hashes, renderer version, item/page counts,
|
|
diagnostics, and idempotent final-output evidence;
|
|
- optional managed artifact persistence through the Core Files contract, with
|
|
an actor-scoped bounded Templates download when Files is absent; and
|
|
- a full-height library/editor/preview WebUI using the shared rich-text editor.
|
|
|
|
The module has no hard dependency on its consumers or on Files.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
cd /mnt/DATA/git/govoplan-templates
|
|
/mnt/DATA/git/govoplan/.venv/bin/python -m unittest discover -s tests
|
|
PATH=/mnt/DATA/git/govoplan-core/webui/node_modules/.bin:$PATH tsc -p webui/tsconfig.json --noEmit
|
|
```
|
|
|
|
See [docs/TEMPLATE_BOUNDARY.md](docs/TEMPLATE_BOUNDARY.md) for the boundary
|
|
decision.
|
|
|
|
User and administrator procedures are in [docs/USER_GUIDE.md](docs/USER_GUIDE.md)
|
|
and [docs/ADMIN_GUIDE.md](docs/ADMIN_GUIDE.md).
|
|
|
|
## Git-source WebUI package
|
|
|
|
The repository root exposes `@govoplan/templates-webui` for Git-tagged release
|
|
dependencies. It mirrors the owning `webui/package.json` version, public
|
|
TypeScript/CSS exports and peer requirements, with entry paths under
|
|
`webui/src`. Consumers provide the shared Core/React peers; the facade runs no
|
|
development or install scripts. The source archive contains `webui/src`, this
|
|
README and any repository license file. Run module development checks from `webui/`; Python
|
|
installation remains governed by `pyproject.toml`.
|
|
|
|
Das Repository stellt `@govoplan/templates-webui` am Wurzelpfad für versionierte
|
|
Git-Abhängigkeiten bereit. Version, öffentliche TypeScript-/CSS-Exporte und
|
|
Peer-Anforderungen entsprechen `webui/package.json`; die Einstiegspfade liegen
|
|
unter `webui/src`. Gemeinsame Core-/React-Peers stellt die einbindende Anwendung
|
|
bereit. Die Fassade führt keine Entwicklungs- oder Installationsskripte aus.
|
|
Entwicklungsprüfungen bleiben in `webui/`, die Python-Installation weiterhin in
|
|
`pyproject.toml` definiert.
|