Skip to content

Commit

Permalink
making 'bodyFile' findable
Browse files Browse the repository at this point in the history
Signed-off-by: Rieks <[email protected]>
  • Loading branch information
RieksJ committed Jun 17, 2024
1 parent cb29000 commit aeb0f92
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/specs/files/11-body-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
## 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).

0 comments on commit aeb0f92

Please sign in to comment.