(#24): design docs: 'todo' reporting (2)

univie-nutrition · Jun 18, 2024 · aa992cb · aa992cb
1 parent 68bbf47
commit aa992cb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/antora/modules/ROOT/nav.adoc b/antora/modules/ROOT/nav.adoc
@@ -12,5 +12,5 @@
 ** xref:designdocs/InterviewModel.adoc[Interview Model]
 ** xref:designdocs/CampaignManager.adoc[Campaign Manager]
 ** xref:designdocs/ConsumptionReporting.adoc[Consumption Reporting]
-** xref:designdocs/NutrientMapping.adoc[Nutrient Mapping]
+** xref:designdocs/NutrientMapping.adoc[Nutrient Mapping (Draft)]
 ** xref:designdocs/OntologyTermAndAnnotations.adoc[Ontology Term And Annotations (Draft)]
diff --git a/antora/modules/ROOT/pages/About.adoc b/antora/modules/ROOT/pages/About.adoc
@@ -15,7 +15,7 @@ Dita Source Code Repository: https://github.com/univie-nutrition/dita[GitHub]
 * xref:designdocs/InterviewModel.adoc[Interview Model]
 * xref:designdocs/CampaignManager.adoc[Campaign Manager]
 * xref:designdocs/ConsumptionReporting.adoc[Consumption Reporting]
-* xref:designdocs/NutrientMapping.adoc[Nutrient Mapping]
+* xref:designdocs/NutrientMapping.adoc[Nutrient Mapping (Draft)]
 * xref:designdocs/OntologyTermAndAnnotations.adoc[Ontology Term And Annotations (Draft)]
 
 == Schema URLs

diff --git a/antora/modules/ROOT/pages/designdocs/NutrientMapping.adoc b/antora/modules/ROOT/pages/designdocs/NutrientMapping.adoc
@@ -64,6 +64,7 @@ include::{includedir}/CompositionResolution.adoc[leveloffset=1]
 [source,yaml]
 .Qualified Map (Yaml)
 ----
+# qmap.yaml example
 qualifiedMapEntries:
 - source: "SID[GD-AT20240507,00010]"
   qualifier:
@@ -88,6 +89,10 @@ qualifiedMapEntries:
 
 === Mapping Todo Example (Todo Reporter)
 
+`NutriDb` is an external system that acts as _FCDB_ 
+and has a _nutrient mapping process_ implemented. 
+(Can create mapping-todo-tasks for humans to process.)
+
 [plantuml,fig-mapping-todo,svg]
 .Mapping Todo
 ----