Archetype: doc_entity_org.org.mustache

Table of Contents

Literate codegen entity model (the org-migration story's format): frontmatter plus the section/table skeleton the org_loader parses. 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_entity_org.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: ores.codegen.entity
#+component: {{component}}
#+filetags: {{filetags}}
#+entity_singular: {{slug}}
#+entity_plural: {{entity_plural}}
#+entity_title: {{entity_title}}
#+brief: {{brief}}
#+created: {{date}}
#+updated: {{date}}

(One or two paragraphs describing the modelled entity itself — what it
represents in the domain, its key relationships, and any defining
invariants.)

* Flags
:PROPERTIES:
:schema:    public
:product:   ores
:component: {{component}}
:END:

* Primary key
:PROPERTIES:
:column:   id
:type:     uuid
:cpp_type: boost::uuids::uuid
:END:

(Description of the primary key.)

* Natural keys

* Columns

* SQL

** Flags
:PROPERTIES:
:tablename:
:END:

* C++

** Flags
:PROPERTIES:
:END:

** Repository
:PROPERTIES:
:entity_singular_short:
:entity_plural_short:
:entity_singular_words:
:entity_plural_words:
:END:

** Domain includes

#+begin_src cpp :name includes
#+end_src

** Entity includes

#+begin_src cpp :name includes
#+end_src

** Conventions
:PROPERTIES:
:iterator_var:
:END:

** Table display

| Column | Header |
|--------+--------|

** Qt
:PROPERTIES:
:END:

*** Detail fields

| Field | Label |
|-------+-------|

*** Columns (Qt model)

| Column | Header |
|--------+--------|

** Custom repository methods

See also

Emacs 29.1 (Org mode 9.6.6)