Archetype: doc_component.org.mustache
Component component_overview.org: #+component_name / #+brief keywords read back by codegen, plus the standard overview sections. 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_component.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: component
#+level: cross
#+filetags: {{filetags}}
#+created: {{date}}
#+updated: {{date}}
#+name: {{{component_name}}}
#+full_name: {{{title}}}
#+brief: {{{brief}}}
* Diagram
#+attr_html: :width 100% :alt {{title}} component diagram
#+caption: {{title}}
[[file:{{title}}.png][file:{{title}}.png]]
* Summary
(Three to five sentences: what this component does and why it exists.)
* Inputs
-
* Outputs
-
* Entry points
-
* Dependencies
-
* See also
-
See also
- Parent facet: Documentation templates
- Template variable reference