Skip to content

Commit

Permalink
semantic encoding of errata in NIST: metanorma/metanorma-bsi#286
Browse files Browse the repository at this point in the history
  • Loading branch information
opoudjis committed Jan 3, 2024
1 parent b9279a9 commit e7e564b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
27 changes: 27 additions & 0 deletions author/nist/topics/markup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,33 @@ Errata tables must have a header row containing the headings _Date, Type, Change
|===
----

As an alternative to this markup, semantic markup of document history can be added to the document,
link:/author/topics/document-format/meta-attributes#doc-history-misc-container[using Misc container] [added in https://github.com/metanorma/metanorma-nist/releases/tag/v2.4.0].
The change type is represented as `amend` classification `type`. The foregoing example would be marked up as follows:

[source, asciidoctor]
----
[.preface]
== Misc container
=== document history
[source,yaml]
----
- date:
- type: updated
value: 2019-01-01
amend:
description: Repaginated
classification:
- key: type
value: Minor
location:
- page=1-12
|2019-01-01 |Minor |Repaginated |1-12
|===
----
== Clauses
=== Terms and definitions
Expand Down
5 changes: 3 additions & 2 deletions author/topics/document-format/meta-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Bedrock
Even the foregoing does not capture the full complexity of contributor metadata: individuals for example
can hold multiple affiliations. More complex contributor metadata is presented using YAML embedded in
the link:/author/topics/document-format/section#misc-container[`Misc-Container` clause] of the document,
in the subclause `contributor metadata` [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.7.6].
in the subclause `contributor metadata` [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.8.0].

The YAML is given as an array of objects, one for each contributor; it uses the foregoing document attributes as keys,
but in addition, organisational details are specified under an `affiliations` key, again as an array of objects.
Expand Down Expand Up @@ -298,6 +298,7 @@ There is limited support for metadata about document history in document attribu
can be given with link:/author/ref/document-attributes/#timestamps[`:*-date:`] attributes, and some flavours of Metanorma
allow the identifier of a prior version of the documemnt to be given under `:updated-by:`.

[[doc-history-misc-container]]
=== Misc container

Several flavours of Metanorma expect detailed document history to be specified for documents, and present that
Expand All @@ -312,7 +313,7 @@ related bibliographic items;

The two are represented with a modified version of the https://www.relaton.org/specs/relaton-yaml/[YAML format used by Relaton],
embedded in the link:/author/topics/document-format/section#misc-container[`Misc-Container` clause] of the document,
in the subclause `document history` [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.7.6].
in the subclause `document history` [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.8.0].

The following adjustments to the YAML are made:

Expand Down

0 comments on commit e7e564b

Please sign in to comment.