Skip to content

Commit

Permalink
chore: fix up IEC doc attributes formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Mar 6, 2024
1 parent b10bf40 commit 96b5e86
Showing 1 changed file with 26 additions and 31 deletions.
57 changes: 26 additions & 31 deletions author/iec/ref/document-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 96b5e86

Please sign in to comment.