From 96b5e86f236986a609359b3f35abbcc0336ac8f7 Mon Sep 17 00:00:00 2001 From: Ronald Tse Date: Wed, 6 Mar 2024 17:16:53 +0800 Subject: [PATCH] chore: fix up IEC doc attributes formatting --- author/iec/ref/document-attributes.adoc | 57 +++++++++++-------------- 1 file changed, 26 insertions(+), 31 deletions(-) diff --git a/author/iec/ref/document-attributes.adoc b/author/iec/ref/document-attributes.adoc index 4ae6c199..fff2f4ec 100644 --- a/author/iec/ref/document-attributes.adoc +++ b/author/iec/ref/document-attributes.adoc @@ -7,15 +7,21 @@ layout: iec-flavor [[note_general_doc_ref_doc_attrib_iec]] [NOTE] ==== -Below are listed document attributes that are unique to Metanorma's processing of IEC documents. +Below are listed document attributes that are unique to Metanorma's processing +of IEC documents. Generally, _document attributes for ISO_ also apply: refer to link:/author/iso/ref/document-attributes[Metanorma-ISO document attributes] for a detailed listing of attributes it shares with IEC. -For _common document attributes_, see link:/author/ref/document-attributes/[Document attributes reference] in general Metanorma author's documentation. That page describes attributes that apply to all Metanorma flavors, not just IEC. +For _common document attributes_, see +link:/author/ref/document-attributes/[Document attributes reference] in general +Metanorma author's documentation. That page describes attributes that apply to +all Metanorma flavors, not just IEC. -For an _introduction to Metanorma AsciiDoc document attributes_ and how Metanorma uses them, see link:/author/topics/document-format/meta-attributes/[the corresponding topic]. +For an _introduction to Metanorma AsciiDoc document attributes_ and how +Metanorma uses them, see +link:/author/topics/document-format/meta-attributes/[the corresponding topic]. ==== NOTE: Document requirements stated in ISO/IEC Directives, Part 2:2018 @@ -48,42 +54,31 @@ See link:/author/ref/document-attributes[general Metanorma document attributes] == Document type -`:doctype:`:: type of document. +`:doctype:`:: type of document. The permitted types are as follows. + --- -The permitted types are: - -* `international-standard` -* `technical-specification` -* `technical-report`, -* `publicly-available-specification` -* `guide` -* `interpretation-sheet`. - -Unlike ISO, IEC does not have `international-workshop-agreement`, +NOTE: Unlike ISO, IEC does not have `international-workshop-agreement`, and does have `interpretation-sheet`. --- + +`international-standard`::: International Standard +`technical-specification`::: Technical Specification +`technical-report`::: Technical Report +`publicly-available-specification`::: Publicly Available Specification +`guide`::: Guide +`interpretation-sheet`.::: Interpretation Sheet `:function:`:: function of document [added in https://github.com/metanorma/metanorma-iec/releases/tag/v1.2.9]. -Most documents do not have a category. -+ --- -The permitted types are: +Most documents do not have a category. The permitted types are as follows. -* `emc` -* `safety` -* `environment` -* `quality-assurance` --- +`emc`::: EMC +`safety`::: Safety +`environment`::: Environment +`quality-assurance`::: Quality assurance `:horizontal:`:: whether the document is a horizontal standard [added in https://github.com/metanorma/metanorma-iec/releases/tag/v1.2.9]. -+ --- -The permitted types are: +Allowed values below. -* `true` -* `false` (default) --- +`true`::: Horizontal standard +`false`::: (default) Non-horizontal standard == Project stage and substage of document