36 lines
2.6 KiB
Markdown
36 lines
2.6 KiB
Markdown
# Metadata in YAML
|
||
|
||
## For session files
|
||
|
||
| Required | Key | Value | Example | Explanation |
|
||
| ------------ | -------------- | --------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------ |
|
||
| * | id | string | m123s456 | 123 denotes Module, 456 denotes Session |
|
||
| * | module | string | 123 | Module id |
|
||
| * | session | string | 456 | Session id |
|
||
| * | title | string | Establishing Objectives | Module title as displayed on screen |
|
||
| | implements | list of strings | ISO27001:2022:C.6.2 | Reference to norm articles; C is Clause and A is Annex (i.e. control) |
|
||
| | feeds_into | list of strings | m200s030 | Outcomes of the current session are inputs for the denoted session - not processed, for oversight only |
|
||
| | depends_on | list of strings | m100s010 | Module+Session id from which the outcomes are input for the current session |
|
||
| * | related_form | *tbd* | *tbd* | Denotes Formdown file for session |
|
||
| | related_assets | list of strings | m123s456-objectives-examples | Denotes related asset-files |
|
||
|
||
- Key-value pairs may be included in any order, as long as the required keys are there
|
||
- Additional key-value pairs can be added as you see fit – AuditGlue will ignore them
|
||
- Filenames for content and assets can be chosen freely: AuditGlue uses the metatada to weave it's magic
|
||
|
||
|
||
### Source example (for copy-paste)
|
||
---
|
||
id: m300s100
|
||
module: 300
|
||
session: 100
|
||
title: Establishing Objectives
|
||
implements:
|
||
- ISO27001:2022:C.6.2
|
||
feeds_into:
|
||
depends_on:
|
||
related_form:
|
||
related_assets:
|
||
- m300s100-objectives-examples
|
||
---
|
||
|