From aeb0f92222bddc44f1ec88516c92f76f519d314f Mon Sep 17 00:00:00 2001 From: Rieks Date: Mon, 17 Jun 2024 07:59:01 +0200 Subject: [PATCH] making 'bodyFile' findable Signed-off-by: Rieks --- docs/specs/files/11-body-file.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/specs/files/11-body-file.md b/docs/specs/files/11-body-file.md index 0051b53d5a..eb3e17514a 100644 --- a/docs/specs/files/11-body-file.md +++ b/docs/specs/files/11-body-file.md @@ -12,4 +12,10 @@ A [body file](@) contains the [body](@) of a [curated text](@), i.e. the text th Typically, body files are pieces of documentation about a particular [concept](@) (or other kind of [semantic unit](@)) that already serve a purpose in some documentation set. For example, a set of documents that constitute, e.g., an architecture, or a specification, would contain files that specify a particular entity (e.g., a component, or a protocol). The contents of these files could then serve as the [body](@) of a [curated text](@) that documents that particular entity. -[Body files](@) are to be located within the [curatedir](@) of the [scope](@) of which they are part, so that the [TEv2 tools](@) can properly find and operate on them. \ No newline at end of file +## Where to store Body Files {#storage-location} + +[Body files](@) are to be located within the [curatedir](@) of the [scope](@) of which they are part, so that the [TEv2 tools](@) can properly find and operate on them. + +## How to reference Body Files in a Curated Text Header {#header-reference} + +If a [curated text](@) only contains the [header](@), it needs to contain a reference to the associated [body file](@). This is done using the `bodyFile` field in the header. Its value should contain the path, relative to the [scopedir](@), that contains the [body](@) of this [curated text](@). See also [Predefined TEv2 Header Fields](/docs/specs/files/curated-text-file#header-fields). \ No newline at end of file