Archetype: doc_facet_group.org.mustache
This library's group doc scaffold: generated * Facets inventory note and shared-conventions section. Self-hosting. Org-mode document scaffold generated from the entity meta-model. The produced `.org` file is tangled into the site build and kept in the org-roam graph.
See the Template variable reference for the complete list of available variables and their semantics.
Template
The full template source. Edit here and re-tangle with
compass build --direct tangle_codegen_templates to regenerate
library/templates/doc_facet_group.org.mustache.
{{! GENERATED FILE — tangled from projects/ores.codegen/library/templates/doc.org. Edit the org source. }}
:PROPERTIES:
:ID: {{id}}
:END:
#+title: {{title}}
#+description: {{description}}
#+type: facet_group
#+level: cross
#+filetags: {{filetags}}
#+created: {{date}}
#+updated: {{date}}
This page documents the ={{slug}}= group of the codegen template
library — the namespace that gathers related facets. Each facet is a
literate org document in this directory whose =mustache= blocks tangle
to the =.mustache= artefacts consumed by =generator.py=; this page
explains what the group's facets have in common and indexes them.
* Summary
(Three to five sentences: what kind of artefacts this group
generates, which model element drives them, and what the facets share
— common data, conventions, or Mustache constructs.)
* Facets
The table below is generated — run
=projects/ores.codegen/scripts/regenerate_facet_inventories.py= after
adding or changing facet docs; do not edit it by hand.
| Facet | Templates | Description |
|-------+-----------+-------------|
* Shared conventions
(Anything every facet in the group relies on: common model fields,
licence injection, naming conventions, Mustache constructs used
throughout. Facet docs link here instead of repeating it.)
* See also
- [[id:3B6B9F75-BDC9-4AE9-B16E-5A05FFC3A4B5][Codegen template library]] — the groups overview.
- [[id:A8145FD7-0651-40FD-857E-BC37C9320020][facet_catalogue.org]] — profile → template/output mapping.
See also
- Parent facet: Documentation templates
- Template variable reference