13 lines
No EOL
1 KiB
Markdown
13 lines
No EOL
1 KiB
Markdown
# Reserved metadata fields
|
|
|
|
- `id` is used to locate the Session file, must match the first 8 characters of the filename, and must be systemwide unique.
|
|
- `module` and `session` are used to create a hierarchy for the Sessions, and to build the menu index:
|
|
- `module` designates the Module to which a Session belongs, and must correspond to a Module key in `module_map.yaml`.
|
|
- `session` designates the Session number.
|
|
- `title` is the name of the Session as shown in the sidebar menu
|
|
- `related_assets` (kv-pairs) make it possible to reference the assets by their keys instead of their full file paths.
|
|
- `related_references` (kv-pairs) make it possible to reference additional content.
|
|
- `related_form` identifies a format file that is used for getting user input.
|
|
- `related_automation` identifies an automation that can be initiated from the Session.
|
|
- `automation_depends_on` (kv-pairs) identifies Tasks required to have the 'Done' status before the automation can be initiated.
|
|
- `depends_on` _legacy, no longer in use._ |