From d5fb0be100d23fa9f7c67548ae8d52f82f722021 Mon Sep 17 00:00:00 2001 From: Nick Nicholas Date: Mon, 16 Sep 2024 15:18:39 +1000 Subject: [PATCH] version bump --- lib/metanorma/iec/basicdoc.rng | 1342 +++++++++++------- lib/metanorma/iec/biblio-standoc.rng | 107 +- lib/metanorma/iec/biblio.rng | 1207 +++++++++++----- lib/metanorma/iec/isodoc.rng | 1946 ++++++++++++++------------ lib/metanorma/iec/reqt.rng | 169 ++- lib/metanorma/iec/version.rb | 2 +- spec/metanorma/base_spec.rb | 632 +++++---- 7 files changed, 3294 insertions(+), 2111 deletions(-) diff --git a/lib/metanorma/iec/basicdoc.rng b/lib/metanorma/iec/basicdoc.rng index bad967a1..08b02415 100644 --- a/lib/metanorma/iec/basicdoc.rng +++ b/lib/metanorma/iec/basicdoc.rng @@ -1,18 +1,28 @@ - + + Document - + + A globally unique identifier for the document in an agreed identifier schema. The identifier is to be used for tracking interactions with the document without depending on formal document registries; it would be exemplified by a GUID, rather than a document registry identifier such as "`ISO 639`", which belongs to `bibdata` + - - + + A bibliographic description, capturing bibliographic metadata about the document itself, including authors, title, and date of production + + + Hierarchically arranged units of textual content within the document + - + + Bibliographic content + + Bibliographic description of a document, used as metadata, expressed in the Relaton model @@ -25,51 +35,71 @@ + Section: groups of blocks within text, which can also contain other sections - + + Sections contained within the current section. The relation is recursive, +so the hierarchical arrangement of sections can be arbitrarily deep + + + Two-letter language code taken from ISO 639, indicating the language in which the content is written + + + + Four-letter script code taken from ISO 15924, indicating the script in which the content is written + + + + (Two-letter) Country and country subdivisions identifier taken from ISO 3166, indicating the locale in which the content is written + + + Group of blocks within text, which is a leaf node in the hierarchical organisation of text (does not contain any sections of its own) + - - - - - - - - - - - - + + Title of the section + - + + Blocks, containing the textual content of the section +(but excluding subsections, which are only present in Hierarchical Sections) + + + + + + Sections containing zero or more bibliographical items (as described in Relaton), along with any prefatory text + - - - - - - + + Title of section + - + + Prefatory text + - + + Bibliographical items included in the References section + + Title of a section @@ -77,6 +107,7 @@ + Block of textual content @@ -99,6 +130,7 @@ + Block of textual content: optional ID attributes (for use in Relaton, metadata) @@ -121,17 +153,15 @@ + Block describing a change in a document, intended for human readers - - - - - + + The type of change described in this block add modify @@ -140,16 +170,26 @@ - + + The span within location where the change applies to, +if location defines a container larger than the scope of the change + - + + The end of the span within location where the change applies to, +if location defines a container larger than the scope of the change. +Applicable to modify and delete + - + + Optional caption of this block + + The location(s) in the original document which have undergone the change described in this block @@ -160,6 +200,7 @@ + Description of the change described in this block @@ -167,27 +208,33 @@ - - - - - + New content to be added to the document; applicable to add and modify + - + + Classification of the change + - + + Contributor responsible for the change + + Key-value classification of an entity - - + + Key for the classification + + + Value for the classification + @@ -201,11 +248,18 @@ + Default block of textual content. +Unlike the case for other document models, paragraphs _cannot_ +contain other blocks, such as lists, tables, or figures: they are modelled as a basic building block of text +Does not contain foonotes. While most paragraphs in a document can contain footnotes (paragraph-with-footnote), +the distinction is necessary, as footnotes are not appropriate for all instances of paragraph content +in a document (e.g. sourcecode annotations) + The alignment of the paragraph against the margins of the document left right @@ -214,85 +268,105 @@ + Mandatory anchor of element, to be used for cross-references within the document + Optional anchor of element - + + The alignment of the paragraph against the margins of the document - + + Inline elements constituting the content of the paragraph, excluding footnotes - + + Inline elements constituting the content of the paragraph + - + + Notes whose scope is the current block + + Inline elements constituting the content of the paragraph, including footnotes - - + + Inline elements constituting the content of the paragraph + + + Footnotes interspersed with paragraph content + - + + Notes whose scope is the current block + + Paragraph containing no footnotes: optional ID attributes (for use in Relaton, metadata) - + + A paragraph which may contain footnotes. - + + A paragraph which may contain footnotes: optional ID attributes (for use in Relaton, metadata) - + + Note block - + + Note block: optional ID attributes (for use in Relaton, metadata) - + - - + + @@ -305,126 +379,184 @@ + Block intended to capture reviewer comments about some text in the document - + + The party who has offered the comment + - + + The type of reviewer comment + + The date when the comment was made + Identifier for the start of the text or point in the text to which the comment applies. +If not provided, the comment applies in the vicinity of the place it has been inserted into the text + Identifier for the end of the text to which the comment applies - + + Reviewer comments content + + + + + Do not number this block in rendering + + + + + + Define a subsequence for numbering of this block; e.g. if this block would be numbered +as 7, but it has a subsequence value of XYZ, this block, and all consecutive blocks +of the same class and with the same subsequence value, will be numbered consecutively +with the same number and in a subsequence: 7a, 7b, 7c etc + + + + Block containing a mathematical expression or other formulas - + + Block containing a mathematical expression or other formulas: optional ID attributes (for use in Relaton, metadata) - + - - - - - - - - - + + + Indication that the formula is to be labelled as an Inequality, if inequalities are differentiated from equations - + + The content of the formula, as a mathematical expression + - + + A definitions list defining any symbols used in the formula + - + + Notes whose scope is the current block + - + + The content of the formula, as a mathematical expression + - + + A definitions list defining any symbols used in the formula + - + + Notes whose scope is the current block + + Block quotation, containing extensive textual content originally authored outside of the current document - + + Block quotation: optional ID attributes (for use in Relaton, metadata) - + - + + The alignment of the quote against the margins of the document - + + Bibliographic citation for the quotation + - + + Author of the quotation. The `author` attribute of the quotation is redundant with `source`, +since it restates information about the author that should be recoverable from the `source` citation. +It is included for convenience, in case processing the citation to extract the author is prohibitive for rendering tools + - + + Content of quote + - + + Notes whose scope is the current block + - + + Bibliographic citation for the quotation + - + + Author of the quotation. The `author` attribute of the quotation is redundant with `source`, +since it restates information about the author that should be recoverable from the `source` citation. +It is included for convenience, in case processing the citation to extract the author is prohibitive for rendering tools + - + + Content of quote + - + + Notes whose scope is the current block + @@ -438,187 +570,245 @@ + Block containing computer code or comparable text - + + Block containing computer code or comparable text: optional ID attributes (for use in Relaton, metadata) - + - + + - - + + The computer language or other notational convention that the source code is expressed in - - - - - - - + + The caption of the block + - - + + The computer code or other such text presented in the block, as a single unformatted string. +(The string should be treated as pre-formatted text, with whitespace treated as significant) + + + Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations + - + + Annotations to the source code; each annotation consists of zero or more paragraphs, +and is intended to be referenced by a callout within the source code + - + + Notes whose scope is the current block + - + + The caption of the block + - - + + The computer code or other such text presented in the block, as a single unformatted string. +(The string should be treated as pre-formatted text, with whitespace treated as significant) + + + Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations + - + + Annotations to the source code; each annotation consists of zero or more paragraphs, +and is intended to be referenced by a callout within the source code + - + + Notes whose scope is the current block + + Pre-formatted block. Wrapper for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. +They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some +standards documents), and computer output. In most cases, sourcecode blocks are more appropriate in markup, +as it is more clearly motivated semantically - + + Pre-formatted block: optional ID attributes (for use in Relaton, metadata) - + - + - + + Accessible description of the preformatted text + - + + The caption of the block + - + + The pre-formatted text presented in the block, as a single unformatted string. (Whitespace is treated as significant) + - + + Notes whose scope is the current block + - + + The caption of the block + - + + The pre-formatted text presented in the block, as a single unformatted string. (Whitespace is treated as significant) + - + + Notes whose scope is the current block + + Tabular arrangement of text - + + Tabular arrangement of text: optional ID attributes recursively (for use in Relaton, metadata) - + - + + - - + + Accessible description of the tabular text, in case the table cannot be rendered accessibly (HTML 5) - - - - - - - + + Alternative more extensive summary of table to be provided for accessibility purposes, +in case the table cannot be rendered accessibly (HTML 5) + + Online location of content of table (in case the table is available as a separate external document) (HTML 5) + Elements of table - + + Caption for the table + - + + Table rows constituting the table header + - + + Table rows constituting the table body + - + + Table rows constituting the table footer + - + + Definitions list defining any symbols used in the table + - + + Notes specific to this block + + Elements of table: optional ID attributes recursively (for use in Relaton, metadata) - + + Caption for the table + - + + Table rows constituting the table header + - + + Table rows constituting the table body + - + + Table rows constituting the table footer + - + + Definitions list defining any symbols used in the table + - + + Notes specific to this block + - - - - - - - - - - + @@ -667,16 +857,22 @@ + Sequence of cells to be displayed as a row in a table - - + + Data cells in a table row + + + Header cells in a table row + + Sequence of cells to be displayed as a row in a table: optional ID attributes recursively (for use in Relaton, metadata) @@ -687,26 +883,33 @@ + Textual content constituting a basic building block of a table: data cell - + + Data cell: optional ID attributes recursively (for use in Relaton, metadata) - + - + - + + Number of columns in the underlying table grid which the cell spans + - + + Number of rows in the underlying table grid which the cell spans + + Horizontal textual alignment of the cell against the underlying table grid left right @@ -716,6 +919,7 @@ + Vertical alignment of the cell against the underlying table grid top middle @@ -728,37 +932,49 @@ - + + Table cell is a block + + - + + Table cell contains a block + - + + Table cell is a block + + - + + Table cell contains a block + + Textual content constituting a basic building block of a table, treated as a header: header cell - + + Header cell: optional ID attributes recursively (for use in Relaton, metadata) - + - - + + @@ -767,35 +983,33 @@ + Block containing an example illustrating a claim made in the main flow of text - + + Example block: optional ID attributes recursively (for use in Relaton, metadata) - + - - - - - - - - - + + - + + The caption of the example + + Content of the example @@ -806,15 +1020,20 @@ - + + Notes whose scope is the current block + - + + The caption of the example + + Content of the example @@ -825,102 +1044,129 @@ - + + Notes whose scope is the current block + + A sidebar block outside of the main flow of text, conveying particular warnings or supplementary text to the reader - + + A sidebar block outside of the main flow of text: optional ID attributes recursively (for use in Relaton, metadata) - + - + + Subclass of admonition determining how it is to be rendered. +Distinct admonition types are often associated with distinct icons or rendering - + + Subclass of admonition, allowing different runs of admonitions to be labelled +and auto-numbered differently, even if they are of the same type. +Typically is a subclass of an admonition type + + Location where the content of the admonition is accessible as an external document - + + Caption of admonition + - + + Admonition content + - + + Notes whose scope is the current block + - + + Caption of admonition + - + + Admonition content + - + + Notes whose scope is the current block + + Subclass of admonition determining how it is to be rendered warning + Warning to reader, note of risk to be avoided note + Supplementary, explanatory information tip + Instructive information to assist in the fulfilment of tasks related to content important + Note to reader of something crucial to be borne in mind caution + Caution to reader, note of potential surprise or difficulty + Block containing a figure: a visual rather than textual asset, possibly with accompanying text - + + Block containing a figure: optional ID attributes recursively (for use in Relaton, metadata) - + - + + - - + + The semantic category of the figure. This is to allow different classes of figure (e.g. _Plate_, _Chart_, _Diagram_) +to be auto-numbered and captioned differently - - - - - - - - - - + + The caption of the block + + Content of the figure @@ -933,23 +1179,39 @@ - + + Footnotes specific to the figure + - + + An optional definitions list defining any symbols used in the figure + - + + Notes whose scope is the current block + + + + A URI or other reference intended to link to an externally hosted image (or equivalent) + + - + + A URI or other reference intended to link to an externally hosted image (or equivalent) + - + + The caption of the block + + Content of the figure @@ -962,16 +1224,24 @@ - + + Footnotes specific to the figure + - + + An optional definitions list defining any symbols used in the figure + - + + Notes whose scope is the current block + + Any inline element containing text and associated formatting information. +Includes inline elements that are identifiers or references to identifiers @@ -998,6 +1268,9 @@ + Inline element containing text and associated formatting information, +but which does not contain any associated identifiers or references to identifiers. +Restricted recursively to contain only other such inline elements with no identifiers or references to identifiers @@ -1011,27 +1284,35 @@ + + Contents of TextElement tags: leaves out tags that should occur only at top level of block: bookmark image hr pagebreak + + + + + + + + + + + + + Emphasised text. Corresponds to HTML `em`, `i` - - - - - - - - - + + Emphasised text for PureTextElement @@ -1039,21 +1320,15 @@ + Strong text. Corresponds to HTML `strong`, `b` - - - - - - - - - + + Strong text for PureTextElement @@ -1061,20 +1336,15 @@ + Monospace text. Corresponds to HTML `tt`, `code` - - - - - - - - + + Monospace text for PureTextElement @@ -1082,6 +1352,7 @@ + Keyword text @@ -1093,6 +1364,7 @@ + Subscript text. Corresponds to HTML `sub` @@ -1100,6 +1372,7 @@ + Superscript text. Corresponds to HTML `sup` @@ -1107,21 +1380,15 @@ + Strikethrough text. Corresponds to HTML 4 `s` - - - - - - - - - + + Strikethrough for PureTextElement @@ -1129,24 +1396,20 @@ + Underlined text. Corresponds to HTML 4 `u` - + + CSS style to apply to underline (intended for text-decoration-style attribute keyword values: solid double dotted dashed wavy) + - - - - - - - - - + + Underlined text for PureTextElement @@ -1157,21 +1420,15 @@ + Small caps text - - - - - - - - - + + Small caps text for PureTextElement @@ -1179,256 +1436,320 @@ + Text with Ruby annotations in East Asian languages. Corresponds to HTML `ruby` - - + + Ruby annotation giving pronunciation + + + Ruby annotation giving other (semantic) information + - - + + Ruby annotated text which contains no further annotations + + + Ruby annotated text which itself contains other Ruby annotations + + Ruby annotation giving pronunciation of text - - - - - - - + + Ruby annotation value + + + Ruby annotation giving information other than pronunciation of text - - - - - - - + + Ruby annotation value + + + Line break + Horizontal rule + Page break. Only applicable in paged layouts (e.g. PDF, Word), and not flow layouts (e.g. HTML) + Index term, defined as applying to the location in the text where the index element appears, as a milestone + A reference to an anchor element (typically a bookmark), +to indicate that the index range covers a range of locations between the current index element and the `to` anchor - - - - - - - - - - - - - - - - - - - + + Primary index term to be recorded at the current location + + + Secondary index term to be recorded at the current location + + + Tertiary index term to be recorded at the current + + A reference to an index term, cross-referenced within an index as an +alternative index entry, either as a "see" or a "see also" cross-reference. +The text in the inline element is the primary index term to be be cross-referenced + The cross-reference is to be treated as "see also" rather than as "see" - - - - - - - - - - - - - - - - - - - + + The primary index term to be cross-referenced + + + The secondary index term to be cross-referenced + + + The tertiary index term to be cross-referenced + + The index term to be cross-referenced to - + + + + + + + + + + + + + + + + + + + + + + Anchors within a block under the BasicDocument model cannot span across a number of inline elements; +bookmarks are intended as point anchors. For that reason, the Review block has a starting reference and an optional ending reference, +which can be bookmarks as well as block or section references - - - + + The type of Reference Element, prescribing how it is to be rendered external + Reference to an external document inline + Reference to another element in the same document footnote + Inline reference to a block to be rendered as a footnote callout + Inline reference to a block to be referenced as a sourcecode callout + An external reference to a bibliographic entity + + + Reference cross-reference: modelled as cross-reference to the corresponding bibliographical item in a References section + + + The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `<xx>my link text</xx>`) + + + + Whether the reference is to be treated as normative or informative, particularly in the context of normative documents such as standards - - - + + Form that the bibliographic citation should take when it is rendered - + + The type of Reference Element, prescribing how it is to be rendered + + + + + + Alternate text, used for accessibility + - - - - + A reference to an external document or resource - - - - - - - - - + - + + The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `<xx>my link text</xx>`) + + + + The location or online identifier of the external document or resource + + + + + The type of Reference Element, prescribing how it is to be rendered + + + + + + Alternate text, used for accessibility + + + + Inline element, which references an identifier of a document, a block in a document, or an element in a document - - - + + + + + + + The identifier of a section, block or inlined element being referenced + + + + The type of Reference Element, prescribing how it is to be rendered - - - - - - - + + + + Alternate text, used for accessibility + + + + + + + The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `<xx>my link text</xx>`) + + + + + + + The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `<xx>my link text</xx>`) + + + Inline reference to a paragraph or paragraphs, appearing as a footnote. +The target of a footnote is the location it is embedded in within the text - + + The number of the footnote, used to identify it visually + - + + The content of the footnote + - + Inline reference to a paragraph or paragraphs, appearing as annotation of source code + The target of the callout is understood to be the location of the callout within the source code; +the extent of the target is not expressed overtly - + + The label of the callout, used to identify its target within the source code + - + Container for image content - + + Container for image content: optional ID attributes recursively (for use in Relaton, metadata) - + - - - - - - - - + + + + Height of image + Width of image - - - - - - - - - - - + + + MIME encoding of media type + + Legal values for image height and width. +Attributes are realised as a real number, with optional percent sign, +or as the string "auto" \d+([.]\d+)?(%?) @@ -1437,180 +1758,202 @@ + Container for video content - + + Container for video content: optional ID attributes recursively (for use in Relaton, metadata) - + - - - - - - - - + + + - - - auto - + Width of video + - - - auto - - - - - - - - - - - - + Height of video + - + + Alternative files to use as media + + Container for audio content - + + Container for audio content: optional ID attributes recursively (for use in Relaton, metadata) - + - + + + + + + + + Alternative files to use as media + + + + + Alternative file to use as media + + + + + + URI of the media file - + + Type of the media file, in MIME + + - + + File name corresponding to the media, to which the media can be extracted if it is represented inline +(e.g. in Base64 encoding in the URI) + + + - + + Alternate text, supplied for accessibility + - + + Title, supplied for accessibility + + URI pointing to more extensive alternate text description, supplied for accessibility - - - - - - - - - - - - - - - - + Mathematically formatted text - - - MathML - AsciiMath - - + + The content of the mathematically formatted text + + + The notation used to mathematically format the text + + MathML + AsciiMath + LaTeX + + + - + + + + Unordered list block - + + Unordered list block: optional ID attributes recursively (for use in Relaton, metadata) - + - + - + + List items + - + + Notes whose scope is the current block + - + + List items + - + + Notes whose scope is the current block + + Item in a list block - + + Item in a list block: optional ID attributes recursively (for use in Relaton, metadata) - + - + @@ -1624,21 +1967,24 @@ + Ordered list, with numbering applied to the list items - + + Ordered list: optional ID attributes recursively (for use in Relaton, metadata) - + - + + Type of numbering to be applied to the list items roman alphabet @@ -1648,60 +1994,92 @@ - + + Starting value for numbering of the list items; is a number, regardless of the type, +and is mapped to the ordinal represented in the type + - + + List item + - + + Notes whose scope is the current block + - + + List item + - + + Notes whose scope is the current block + + Definition list, composed of definitions rather than list items - + + Definition list: optional ID attributes recursively (for use in Relaton, metadata) - + - - + + Entry-Definition pair used to constitute a definition list + + Entry being defined in the definition + + + Definition of the entry + + - + + Notes whose scope is the current block + - - + + Entry-Definition pair used to constitute a definition list + + Entry being defined in the definition + + + Definition of the entry + + - + + Notes whose scope is the current block + + Entry in a definition list @@ -1709,6 +2087,7 @@ + Definition in a definition list @@ -1716,6 +2095,7 @@ + Definition in a definition list: optional ID attributes recursively (for use in Relaton, metadata) diff --git a/lib/metanorma/iec/biblio-standoc.rng b/lib/metanorma/iec/biblio-standoc.rng index 23738651..70a05027 100644 --- a/lib/metanorma/iec/biblio-standoc.rng +++ b/lib/metanorma/iec/biblio-standoc.rng @@ -1,5 +1,5 @@ - + + The bibliographic description of a standardisation document - + + The extension point of the bibliographic description of a standardisation document + + Update to StandardReducedBibliographicItem - + @@ -47,34 +51,55 @@ + The extension point of the bibliographic description of a standardisation document - + + The version of the flavour-specific schema that this extension point conforms to + - + + Classification of the standardisation document that is treated as a distinct series by the +standards defining organization, and that is rendered in a distinct manner + - + + Subclass of the standardisation document, that is treated or processed differently +from other documents in the same doctype + - + + Groups associated with the production of the standards document, typically within +a standards definition organization + - + + Classification of the document contents taken from the International Classification of Standards + - + + Representation of the identifier for the standardisation document, giving its individual semantic components + + Classification of the standardisation document - + + Standard abbreviation for the doctype value used by the standards defining organization + - + + Name of the doctype + @@ -89,104 +114,142 @@ + A group associated with the production of the standards document, typically within +a standards definition organization - + + A technical committee associated with the production of the standards document + + Technical committee associated with the production of a standards document - + + Numeric identifier of the technical committee + - + + Type of the technical committee, used in identifying the technical committee + - + + Non-numeric, complete identifier of the technical committee + - + + Disambiguating prefix added to number to form the identifier of the technical committee, +typically indicating its type + - + + Name of the technical committee + + Classification taken from the International Classification of Standards. +ICS is defined by ISO here -- https://www.iso.org/publication/PUB100033.html + Classification code taken from the ICS + Text string associated with the classification code + Representation of the identifier for a standardisation document, giving its individual semantic components - + + Representation in the identifier of the type of standard document, corresponds to bibitem/ext/doctype + + Representation in the identifier of the agency responsible for the standard document + Representation in the identifier of the class of standard document (as a subclass of the document type), +corresponds to bibitem/item/docsubtype + Representation in the identifier of the (typically numeric) component uniquely identifying the document +or standard. If a document includes parts or supplements, the docnumber identifies the document as whole, +and not those document components + Representation in the identifier of the document part, if this is a document part. May be compound + Representation in the identifier of the document edition, if this is a published document + Representation in the identifier of the document version, which can include document drafts + Representation in the identifier of the type of document supplement, if this is a document supplement + Representation in the identifier of the document supplement, if this is a document supplement + Representation in the identifier of the document amendment, if this is a document amendment + Representation in the identifier of the document corrigendum, if this is a document corrigendum + Representation in the identifier of the language of the document + Representation in the identifier of the year of publication or issuance of the document @@ -195,13 +258,17 @@ - + + Description of changes specific to this document + - + + Description of changes specific to this document + diff --git a/lib/metanorma/iec/biblio.rng b/lib/metanorma/iec/biblio.rng index 7d8f7ab4..1a206da6 100644 --- a/lib/metanorma/iec/biblio.rng +++ b/lib/metanorma/iec/biblio.rng @@ -24,44 +24,62 @@ Somewhat dumbed down for XSD regex: --> + Date/Time conforming with ISO 8601 ([\+\-]?\d{4})((-?)((0[1-9]|1[0-2])((-?)([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([\.,]\d+)?)?((:?)[0-5]\d([.,]\d+)?)?([zZ]|([\+\-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)? + Date conforming with ISO 8601 ([\+\-]?\d{4})((-?)((0[1-9]|1[0-2])((-?)([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6]))))? - + The publication or preparation status of a document - + + The stage of the document status, e.g. "Published", "Unpublished", "Committee Draft", "Preprint" + - + + The substage of the document status. These are used particularly in Standards Defining Organizations + - + + The iteration of the given status that the document is currently in (e.g. "3" for a third draft) + + The stage of the document status, e.g. "Published", "Unpublished", "Committee Draft", "Preprint" - + + A canonical abbreviation of the document stage + - + + The name of the document stage + + The substage of the document status. These are used particularly in Standards Defining Organizations - + + A canonical abbreviation of the document substage + - + + The name of the documen substage + @@ -71,100 +89,84 @@ - + - ISO-639 - + - ISO-3166 - + - ISO-15924: Latn + Edition of a bibliographic item - + + Number of edition. +NOTE: The number attribute can be used to represent the numeric equivalent of the edition string + - + + Formatted, human-readable edition string + - + + multiple values are comma-delimited - - + + + - + + + - + + + - - - - - - - - - - - - - + + - - - + + + - + - - - - - - - - - - + - - - - - - text/plain - text/html - application/docbook+xml - application/tei+xml - text/x-asciidoc - text/markdown - application/x-metanorma+xml - - - - - - - - - + + + @@ -172,27 +174,43 @@ - - - - - - - - - - + + String which is formatted according to conventions specified in a named MIME type + + MIME type for string (defailts to text/plain). +NOTE: `docbook`, `AsciiDoc`, `Metanorma` are not registered IANA Media Types + + String + + Description of a contributor to the production of the bibliographic item - + + A description of the role of the contributor in the production of the bibliographic item + - + + The contributor involved in the production of the bibliographic item. +May be either a person or an organization + + A description of the role of the contributor in the production of a bibliographic item + The broad class of role of the contributor. Mandatory in order to enforce orderly management of contributors. +Detailed in https://www.relaton.org/model/creator/ author performer @@ -209,7 +227,9 @@ - + + A more detailed description of the role of the contributor + @@ -225,25 +245,37 @@ + Person associated with a bibliographic item - + + The name of the person + - + + Credentials given for the person postnominally, e.g. "PhD" + - + + The affiliation of the person within an organization + - + + An identifier of the person according to an international identifier scheme + - + + Contact information for the person, including URI, address, phone number, and email + + The name of a person @@ -255,31 +287,56 @@ - + + The initials of the person, used as an abbreviation for the person, and including the +surname. Can be used instead of the complete name. Distinct from formatted-initials, +which are the initials only of the forenames of the person + - - - - - - - - - - - - - - - - - - + + + + A prefixed addition to the name of the person, such as "Dr" + + + + + A forename or given name of the person. Includes middle names + + + + + The initials of the person, as a formatted string, including punctuation, dropping +punctuation as desired, and including hyphens where necessary. For example, +the initial set for Jean-Paul would be J, P; the formatted initials would be "J.-P." +or "J-P.". Can be used instead of forenames + + + + + The surname, family name, or equivalent of the person + + + + + A suffixed addition to the name of the person, such as "Jr" + + + + + A preformatted version of the name of the person, not broken down into its component parts + + + - + + An additional note about the name of the person + - + + A variant name of the person + @@ -308,11 +365,19 @@ + A forename of a person - + + An individual initial of the person, corresponding to the given forename. +Does not include final punctuation, but can include hyphens. +Can be used instead of forenames, if formatted-initials are not provided +(in which case each initial will be punctuated following local practice). + - + + A forename or given name of the person. Includes middle names + @@ -321,21 +386,34 @@ + A variant name of a person - - + + The type of variant name for the person. Examples include pseudonyms; user names (online); +real names (if the person is named with a pseudonym or user name); previous legal names + + + The variant name itself + + The affiliation of a person with an organization - + + The name of the affiliation of the person with the organization; typically a position title + - + + A more detailed description of the affiliation of the person + - + + The organization with which the person is affiliated + @@ -350,47 +428,64 @@ + Organization associated with a bibliographic item - + + The name of the organization + - + + The subdivision of the organization directly involved with the production of the bibliographic item + - + + Abbreviation under which the organization is known + - - - - + + An identifier of the organization according to an international identifier scheme + - + + Contact information for the organization, including address, phone number, and email + - + + A logo for the organization + - - - - + + + Type of organisation name, to differentiate variant names + + + + Subdivision of organization associated with a bibliographic item - + + The type of subdivision + - + + The subdivision, modelled recursively as an organization + @@ -399,51 +494,52 @@ + Depiction of the bibliographic item - + + Description of what is being depicted + - + + A visual depiction of the bibliographic item + - - - - - - - - - - - - - - - - - - - - - + + URI associated with a type - + + The types of URI are open-ended, but include the IANA link relations specified in RFC 8288 + - + + + URI content + + Contact information for a person or organization @@ -452,37 +548,58 @@ + The phone number associated with a person or organization - + + The type of phone number; can include "Fax" and "Mobile" + - + + The phone number itself + + Email address + An address for a person or organization - + - - - - - - - - - - - - - - - + + The street and street number or equivalent in the address, as one or more lines of text + + + + + The settlement or municipality in the address + + + + + The region of the country in the address + + + + + The country in the address + + + + + The postal code or equivalent in the address + + + + + Preformatted version of the address, not decomposed into its component parts + + @@ -512,48 +629,77 @@ - + + + + + + + An identifier of a person according to an international identifier scheme - - isni - orcid - uri - + The international identifier scheme for the identifier of the person. +Examples include "isni", "orcid", "uri" - + + The identifier value + + An identifier of an organization according to an international identifier scheme - - - - + + + The international identifier scheme for the identifier of the organization. +Examples include GRID, LEI, CrossRef, and Ringgold + + + + The identifier value + + Representation of a citation of a bibliographic item, typically within a document + Bibliographic item that the citation applies to, referenced as the anchor of a bibliographic description - + + Describes the location of the cited information resource within the subject of the bibliographic item. +Multiple ``bibLocality``s are interpreted as discontinuous references. + - + + Describes the location of the cited information resource within the subject of the bibliographic item in a multi-level manner. +For example, the hierarchical specification "Part IV, Chapter 3, Paragraphs 22-24" +is represented as a single `bibLocalityStack`, composed of those three localities +(as opposed to three `bibLocality` references, which would be treated as three discontinuous references). +Multiple ``bibLocalityStack``s are themselves interpreted as discontinuous references + - + + Date of the citation, typically date of publication. +A combination of the date time elements year, month and day should be specified. +Specification of month and day are optional. +This date is not intended for disambiguation, since `bibitemid` +already identifies the source unambiguously; it is added for ease of processing, in case author-date +citations cannot straightforwardly extract the date from the bibliographic source + @@ -562,14 +708,20 @@ + The extent or location of a bibliographic item being referred to. +A sequence of locality elements is meant to indicate hierarchical ordering, from greater to smaller. +e.g. Chapter, then page, then paragraph. +A discontinuous range can be represented by using two adjacent localities with the same type + Hierarchical arrangement of bibliographic localities, to refer to a single span of text in a bibliographic item + Logical connective linking localities. If not supplied, "and" is understood and or @@ -580,16 +732,23 @@ - + + Component bibliographic localities which group together to designate a single span of text. +Earlier localities are assumed to include later localities, and be of different types; +e.g. "Chapter 7, paragraph 9–11" + + The extent or location of a source bibliographic item being related to a target bibliographic item + Hierarchical arrangement of bibliographic localities, to refer to a single span of text in a source bibliographic item, +being related to a target bibliographic item @@ -609,16 +768,30 @@ + The type of extent of a locality (e.g. section, clause, page) - + + The starting value of the extent, or point location + - + + The end value of the extent as a range, if applicable + + Type of indicator of a location or extent within a bibliographic item. +When the value `whole` or `title` is used, the corresponding `BibItemLocality` +attribute `identifier` should be empty +`whole` refers to the entire document. +`list` is used for ordered lists in standards documents +`time` is used for timestamps in audio and visual media +`anchor` is used for locations within web pages +`line` is a line number, dependent on printed form of document +`locality:...` is an extension point: it allows a free-form text string that is human-readable section|clause|part|paragraph|chapter|page|title|line|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+ @@ -635,6 +808,7 @@ + Description of a bibliographic item @@ -643,162 +817,310 @@ + Description of a bibliographic item: no ID attribute (for use in Relaton, metadata) + Used to present a group of bibliographic items as a single group; +e.g. when summarising the collection of standards created by a standards body. +A collection may be used for bibliographic exchange but is typically not necesary for citation purposes - + + The type of grouping of bibliographic items + - + + The title given to the grouping of bibliographic items + - + + Contributors to the production of the bibliographic items as a grouping, +with corporate responsibility for all the items in the group +(e.g. as compilers of a collection or corporate authors) + - + + The individual items which constitute the group, expressed as relations to the +document group. The `type` attribute of each relation is expected to be either `includes` or `hasPart`, +depending on whether the items exist as independent documents, or are parts of a multi-part document + + Type of bibliographic item. +The value list complies with the types provided in ISO 690:2021. +NOTE: These values represent a strict superset to BibTeX +publication types, and therefore any BibTeX type value can be +mapped to these values. Some values here do not have a corresponding +entry in BibTeX, for instance, "standard" and "website". article + An article from a journal or magazine book + A monograph booklet + A booklet or pamphlet. The distinction between book and booklet is not made frequently manual + A manual proceedings + A conference proceedings presentation + A presentation given in a formal meeting thesis + A dissertation given in an academic institution, as a summation of research techreport + A technical report standard + A standard, a document issued by a Standards Defining Organization unpublished + An intellectual creation which has not been published, e.g. a manuscript. +NOTE: Properly this does not represent a distinct bibliographic type, and it +should be avoided in favour of using the `status` element of `BibliographicItem` map + A map or other cartographic resource electronic resource + A resource avaiulable in digital form +NOTE: The overloaded type `electronicResource` should be avoided where possible, particularly if the +resource corresponds closely to a paper bibliographic type, such as `book` or `article`. +The distinction between offline and online resources should be made through `medium` (electronic vs physical). +Specialisations of `electronicResource` include `dataset`, `webResource`, `website`, +`socialMedia`, and `software`. audiovisual + An audiovisual resource. Is a superclass of other types such as `video` and `music` film + A film video + A video broadcast + A broadcast made through mass media, including radio and television software + Computer executable code, not itself human-readable text (though it may generate such text) graphic_work + A graphic work, a work with two-dimensional or three-dimensional content music + A musical work. Includes both notated music and music performances: +The two are differentiated through `BibliographicItem/medium/content` as "notated music" vs "performed music" patent + A patent inbook + A (typically untitled) part of a book. May be a chapter (or section, etc.) and/or a range of pages incollection + A part of a book having its own title, and typically having distinct authorship inproceedings + An article in a conference proceedings journal + A journal or periodical publication website + A collection of web resources, presented under the same URL domain and under the same (individual or corporate) authorship webresource + A human-readable or consumable web resource, a single item accessible online via a web browser, +which is not composed of components all of which can be accessed in the same way. +Includes media files, as well as individual web pages dataset + An electronic dataset, a collection of data that is not meant to be human-readable, and which is typically only machine readable archival + A instance of a resource curated and preserved in an archive, which mediates any access to it. +Typically it is physical, unique, and unpublished. + NOTE: The content of the resource may be published separately, + but that makes it a distinct bibliographic item, as access to it is no longer mediated through the archive social_media + One or more resources within a collection that is typically collectively authored by member users. +Includes blog posts, forum posts, social media posts, tweets. Is usually a `webResource`, +but not always (e.g. blogs on WeChat are only accessible within the WeChat app.) alert + A single communication intended for multiple persons, and publicly accessible. +May be electronic (e.g. Facebook status update) or voice (e.g. evacuation alert), but is typically not print message + A single communication intended for a restricted number of authorised persons (typically one). +May be electronic (e.g. Twitter direct message, email) or voice (e.g. a remark made to someone, +typically cited as "personal communication") conversation + An exchange of messages between two or more persons. May be electronic (e.g. web chat) or voice (e.g. phone call) misc + Bibliographic type not adequately described in the foregoing + Description of a bibliographic resource + The type of the bibliographic item - + + The version of the Relaton schema that this description conforms to + - + + The date at which the bibliographic item was last updated + - + + A pre-formatted version of the full bibliographic item reference, +rendered for human reading, and used to sidestep the rendering of the reference out of its component parts + - + + The title(s) of the bibliographic item + - + + The URI(s) associated with the bibliographic item + - + + The identifier(s) of the bibliographic item in an international standard scheme + - + + Unprefixed, preferably numeric version of an identifier of the bibliographic item, intended for sorting of bibliography + - + + One or more date-times associated with the production of or access to the bibliographic item + - + + Contributors to the production of the bibliographic item + - + + The edition of the bibliographic item + - + + The version of the bibliographic item (within an edition). Can be used for drafts. +Can be more than one, in case of multiple versioning schemes + - + + Note(s) associated with the bibliographic item + - + + The language(s) in which the bibliographic item is expressed + - + + The locale(s) in which the bibliographic item is expressed + - + + The script(s) in which the bibliographic item is written + - + + The abstract of the bibliographic item + - + + The publication or preparation status of the bibliographic item + - + + The copyright status of the bibliographic item + - + + The relation(s) of the bibliographic item to other bibliographic items + - + + The series of the bibliographic item + - + + The medium the subject is realized on. +Medium can be used to differentiate between "electronic" and "physical" manifestations of an information resource. + - + + The geographic location associated with the production of the bibliographic item + - + + The price set on accessing the bibliographic item. +The price should be treated as nominal, rather than capturing all possible pricings at a given time + - + + The extent of the bibliographic item, if reference is not being made to the entirety of the item described. +Repeats for different levels of granularity (e.g. volume number, page number), or for discontinuous ranges +(e.g. multiple page ranges, pages plus plates) + - + + The bibliographic size of the bibliographic item, measured in the same units as extent (i.e. pages, volumes, +megabytes, hours, rather than cm^2.) Distinct from the physical size of the bibliographic item, captured in medium/size + - + + The location where the bibliographic item may be accessed. +Used for archival resources. Also used for pathways to access digital resources, where a URI is not practical + - + + A license under which the bibliographic item has been issued. +NOTE: This should preferably be encoded as a URI or short identifier, rather than descriptive text + - + + The classification of the bibliographic item according to a standard classification scheme + - + + Keyword(s) for the bibliographic item + - + + Information about how long the current description of the bibliographic item is valid for + - + + Depiction of the bibliographic item, typically an image + + Reduced description of a bibliographic resource, without mandatory title and docidentifier, used for document relations +Refer to `BibliographicItem` for definitions @@ -899,6 +1221,7 @@ + A title of a bibliographic item, associated with a type of title @@ -926,15 +1249,23 @@ + The time interval for which a bibliographic item is determined valid, and the associated revision date - + + The date and time when this bibliographic item becomes valid + - + + The date and time when this bibliographic item becomes invalid + - + + The date and time of issuance of the version of the document +for which this claim of validity is made, if applicable + @@ -955,80 +1286,130 @@ - + + Type of title given to a bibliographic item. Indicative values include: +"alternative": alternate title for the item +"original": The original title of the item. Includes the source language title of a translated item +"unofficial": A title that has become prevalent but has never been the official or intended title of the item +"subtitle": Subsidiary title of the item +"main": The default title of the item, privileged in citation + + + + + (legacy attribute) format; can have value text/plain + - + + Content of title + + URI with type - - - - - - - - - - + + Type of URI + + + Type which allows date and time to be specified as either a Gregorian +date and time, as specified in ISO 8601, as text, or as both - + + Date and time, as specified in text + - + + Gregorian date and time, as specified in ISO 8601. Can be used +as a canonical interpretation of the date and time given in `text` + + + Indicates type of date within a bibliographic lifecycle. +NOTE: Typically only the `published` date is of interest published + The date on which the document was published (distributed by the publisher) accessed + Date a document was last accessed by the compiler of the bibliographic record; routinely used for online publications. +NOTE: Unlike in ISO 690:2021, no distinction is made between +"viewed" and "accessed" based on whether the resource is human-readable or machine-readable.) created + The date on which the first version of the document was created implemented + The date on which the document takes effect. Applies to normative documents obsoleted + The date on which the document was obsoleted/ confirmed + The date on which the document was reviewed and approved by the issuing authority updated + The date on which the current version of the document was updated corrected + The date on which the current version of the document was corrected, without that correction considered to amount to a full document update issued + The date on which the document was issued (authorised for publication by the issuing authority). +Is typically differentiated from `published` for normative documents, such as standards and legislation transmitted + The date on which the document was broadcast copied + The date on which the document physically copied, or recreated without any substantial change in content (allowing for change in medium) unchanged + The date on which the document was last renewed or reprinted without any changes in content circulated + The date on which the unpublished document was last circulated officially as a preprint. +For standards, this is associated with the latest transition to a formally defined preparation stage, +such as Working Draft or Committee Draft adapted + The date on which a document adapted for a new purpose or audience, with some change in content (includes translation) vote-started + The date on which a formal process for approval of a document was initiated. Typically applies to standards documents in draft vote-ended + The date on which a formal process for approval of a document was closed. Typically applies to standards documents in draft announced + The date on which the existence of a document is made public. +Applies whether the resource has already been created or not, and whether it is to be published or not stable-until + The document is guaranteed not to be changed or updated until this date + Significant date in the lifecycle of the bibliographic item, including its production and its access + The phase of the production of or access to a bibliographic item - + + An optional textual description of the date, especially when a Gregorian date is not applicable + + The start of the date range described + The end of the date range described + The point date described @@ -1036,21 +1417,34 @@ + An identifier of a bibliographic item in an international standard scheme - - - - - - - - - - - - + + + + + The scheme or namespace of the identifier + + + + + The scope of the identifier, in case the identifier does not apply to the document +but to a superset or subset of entities; or in case the identifier +is for a particular instance of the document, e.g. for a particular format or edition of the document + + + + + This is a primary identifier for the item, to be used in citation + + + + + The identifier string + + @@ -1058,26 +1452,37 @@ - - - - + + Place associated with the production of a bibliographic item - - - - - - - - - - - - + + + City + + + + + Region that city is located in, given for disambiguation purposes. + + + + + Country that city is located in, given for disambiguation purposes. + + + + + Name of the place, not broken down semantically + + + + + URI in a geographical registry identifying the place + + @@ -1085,6 +1490,11 @@ + + + + + @@ -1096,41 +1506,90 @@ + Encoding of region in bibliographic `place`. ISO 3166 encoding is recommended - + + ISO 3166 encoding + + Whether the region should be included in rendering of the place, for disambiguation + + + Name of the region + + + + + Code for currencies, taken from ISO 4217 + The price set on accessing the bibliographic item - - + + The currency denomination for the price + + + + The currency amount for the price + + Information about the medium and transmission of a bibliographic item - + + The content type of the bibliographic item, reflecting the form of +communication with which it is expressed and perceived. For example, +`text`, `video`, `audio`. + NOTE: This field is intended to convey the +Content attribute of the MARC and Resource Description and Access +standards, although its values are not restricted to that +vocabulary; see http://www.loc.gov/standards/valuelist/rdacontent.html + - + + The genre of the bibliographic item, as a classification of the +type of communication it represents that is more specific than `content` or `BibliographicItem/type`. +For example, "statistical dataset" + - + + The media type of the bibliographic item, used to access the content +of the item, including file format for electronic media. + NOTE: This field is intended to convey the +Media attribute of the MARC and Resource Description and Access +standards, although its values are not restricted to that +vocabulary; see http://www.loc.gov/standards/valuelist/rdamedia.html +IANA Media Types are recommended for electronic resources + - + + The storage medium of the physical representation of the bibliographic item. + NOTE: This field is intended to convey the +Carrier attribute of the MARC and Resource Description and Access +standards, although its values are not restricted to that +vocabulary; see https://www.loc.gov/standards/valuelist/rdacarrier.html + - + + The size of the physical representation of the bibliographic item + - + + The scale of the cartographic material in the bibliographic item + @@ -1170,9 +1629,19 @@ + The size of a bibliographic item being referred to. +A sequence of sizes can be used to indicate different numberings, e.g. xii + 40 pp., +or different kinds of measures, e.g. pages + plates - - + + The type of size. Recommended values: page, volume, time (in ISO 8601 duration values), +data (including unit), value (free-form string) + + + + The quantity of the size + + @@ -1195,48 +1664,80 @@ + Series to which a bibliographic item belongs. Series is to be understood broadly, +and it includes monograph series, journals, newspapers, and report series within +which the bibliographic item has appeared + The type of series description expressed in this container - + + A pre-formatted version of the series description, incorporating +all needed disambiguating information in human-readable format + - + + The title of the series + - + + The place where the series is issued; used for disambiguation + - + + The organization issuing the series; used for disambiguation + - + + The abbreviation under which the series is known + - + + The start of the date range when the series has been known under the given title + - + + The end of the date range when the series has been known under the given title + - + + The number of the bibliographic item within the series + - + + The part-number of the bibliographic item within the series. For example, +if the series is a journal, the number is the volume number, and the partnumber is the issue number + - + + An iteration of numbering of the series, if the series has restarted numbering +(as occurs in some journals); referred to as "series" in the context of journals. +For example, "n.s." (new series) or "2" indicates +that the `number` given for the series applies to the second iteration of numbering + + The type of series description given main + Default type: The current, authoritative series description alt + An alternative, potentially historical series description @@ -1271,40 +1772,63 @@ + A note associated with the bibliographic item - + + The class of the note associated with the bibliographic item. +May be used to differentiate rendering of notes in bibliographies + - + + The content of the note + + Abstract of bibliographic item - + - + + Multiple blocks of content + - + + Single block of content + + The copyright status of a bibliographic item. - + + The copyright date of the bibliographic item + - + + The date when the copyright of the bibliographic item expires + - + + The copyright owner for the bibliographic item. + - + + The extent of the bibliographic item, or contexts of use, for which this +assertion of copyright applies. For example, this description may only apply +to the preface of a book + + @@ -1321,11 +1845,14 @@ + Copyright owner + Type of the relationship between a main document (described in `BibliographicItem`) and a target document +Detailed in https://www.relaton.org/model/relations/ includes includedIn @@ -1387,19 +1914,25 @@ + Relation between a bibliographic item and another bibliographic item + The type of document relation described, using a controlled vocabulary + A more complete description of the type of document relation described + The target bibliographic item to which this bibliographic item is described as related to + The extent of the target bibliographic item which is related to this bibliographic item, +provided that it is not the entire bibliographic item that is so related @@ -1408,6 +1941,8 @@ + The extent of this bibliographic item which is related to the target bibliographic item, +provided that it is not the entire bibliographic item that is so related @@ -1418,12 +1953,17 @@ + A version of the bibliographic item (within an edition). Can be used for drafts - + + The date at which the current version of the bibliographic item was produced + - + + The identifier for the current draft of the bibliographic item + @@ -1442,46 +1982,63 @@ + + Keyword for a bibliographic item - - - - - - - - - - - - - - - - - - - - - + + + The keyword as a single, controlled or uncontrolled vocabulary item + + + + + + The keywords as a hierarchical taxonomy. For example, the sequence of `taxon` elements +`pump`, `centrifugal pump`, `line shaft pump` represents a taxonomic classification + + + + + + Identifiers for the keyword as a controlled vocabulary + + + Item in a controlled vocabulary - + + A label for the controlled vocabulary + + A URI for the controlled vocabulary item + The code or identifier for the controlled vocabulary item + The term itself for the controlled vocabulary item diff --git a/lib/metanorma/iec/isodoc.rng b/lib/metanorma/iec/isodoc.rng index 4835b176..efd04351 100644 --- a/lib/metanorma/iec/isodoc.rng +++ b/lib/metanorma/iec/isodoc.rng @@ -17,200 +17,107 @@ these elements; we just want one namespace for any child grammars of this. --> - + + Block expressing a machine-readable change in a document - + + Specification of how blocks of a given class should be autonumbered within an AmendBlock newContent element + - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + - - - warning - note - tip - important - caution - statement - editorial - box - + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + Title(s) of a clause + Title proper for a clause + Alternate title for a clause - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - capital - lowercase - - - - - - - - - - - - - - - - - - - - + + Caption of list + - + + List items + - + + Notes whose scope is the current block + - + + Caption of list + - + + List items + - + + Notes whose scope is the current block + - + + NOTE: `start` attribute is not included by default, because of problems it raises with DOC output + Type of numbering to be applied to the list items roman alphabet @@ -221,54 +128,63 @@ - + + This definition list is the key of a figure or formula - + + Caption of the list + - - + + Entry-Definition pair used to constitute a definition list + + Entry being defined in the definition + + + Definition of the entry + + - + + Notes whose scope is the current block + - + + Optional identifier for definition term (enabling crossreferencing of definitions) + - + + Entry being defined in the definition + - - - - - - - - - - - - + + - + + The caption of the example + + Content of the example @@ -280,201 +196,87 @@ - + + Notes whose scope is the current block + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + The widths of the columns in the table + - + + Caption for the table + - + + Table rows constituting the table header + - + + Table rows constituting the table body + - + + Table rows constituting the table footer + - + + Definitions list defining any symbols used in the table + - + + Notes specific to this block + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + A source for the table + - + + The caption of the block + - - - - + + The computer code or other such text presented in the block, as a single unformatted string. +(The string should be treated as pre-formatted text, with whitespace treated as significant) + + + Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations + + + Hyperlink of code segment to another part of the document + + + Hyperlink of code segment to external bibliographic resource + - + + Annotations to the source code; each annotation consists of zero or more paragraphs, +and is intended to be referenced by a callout within the source code + - + + Notes whose scope is the current block + + + A source for the block + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -489,68 +291,39 @@ + Bibliography clause. It is used to collate references within the document, where +there could be one or more of such sections within a document. For example, some standardization documents differentiate +normative or informative references, some split references into sections organized by concept relevance. - - - - - - - - - normative - informative - - - - - - + + - + + Prefatory text + - + + Bibliographic item cited in the document + - + + Annotation of the bibliographic item + - + + Recursive references section + - - - - - - - - - - - - - - - - - - - - - - - - - - - + Content of note @@ -564,29 +337,16 @@ + Group of blocks within text, which is a leaf node in the hierarchical organisation of text (does not contain any sections of its own) + - - - - - - - - - - - - - - normative - informative - - - - - + + Title of the section + + Blocks, containing the textual content of the section +(but excluding subsections, which are only present in Hierarchical Sections) @@ -615,12 +375,14 @@ + Table cell is a block + Table cell contains a block @@ -634,140 +396,28 @@ + Table cell is a block - + + Table cell contains a block + - - - - - - - - - - - - - MathML - AsciiMath - LatexMath - - - - - - - - + - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Subscript text. Corresponds to HTML `sub @@ -778,6 +428,7 @@ + Superscript text. Corresponds to HTML `sup` @@ -788,9 +439,12 @@ + Page break. Only applicable in paged layouts (e.g. PDF, Word), and not flow layouts (e.g. HTML) + Orientation of pages in a section of text in paged media following this page break, applicable until the next page break that +gives an explicit page orientation landscape portrait @@ -799,20 +453,218 @@ + + + + Description of location in a reference, which can be combined with other locations in a single citation + + + + + The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `<xx>my link text</xx>`) + + + + + + + Override the numbering of this block in numbering + + + + + + + Display the admonition on the document cover page + + + + + + Do not insert text labelling the type of admonition in rendering + + + + + + + statement + Intended for typographically separate statements in mathematics, such as propositions, proofs, or theorems. Statement conflates all of these for rendering, while Proposition, Proof, Theorem etc. can be treated as distinct classes + editorial + Annotation by document editors, intended for all readers of the document and not just its authors + box + Box annotation, intended as standalone sidebar element which can be referenced from within the document + + + + + + Update link file suffix to match rendered file output (HTML > HTML, PDF > PDF) + + + + + + Style of hyperlink rendering + + + + + + + Casing of the autogenerated label of the cross-reference (typically the name of the class of element referenced): +titlecase, or lowercase + + capital + lowercase + + + + + + Do not include the autogenerated label of the cross-reference in rendering + + + + + + Style of how a citation is to be rendered + + + + + + + + + + Width of the table block in rendering + + + + + + + + Width of the figure block in rendering + + + + + + + + + Render the sourcecode block with line numbering. Default value is false + + + + + + + + + + + Semantic classification of paragraph + + + + + + + + + + + Semantic classification of note + + + + + Display the note on the document cover page + + + + + + Do not insert text labelling the note as a note in rendering + + + + + + + + + Numeric formatting directives to apply to mathematically formatted text + + + + Whether to treat the expression as a block or as an inline element, for display purposes + + + + + + + If the cross-reference is to a range of text defined as a span between two identified elements, +provide the identifier of the end element of the span + + \i\c*|\c+#\c+ + + + + + + Casing of the autogenerated label of the cross-reference (typically the name of the class of element referenced): +titlecase, or lowercase + + capital + lowercase + + + + + + Do not include the autogenerated label of the cross-reference in rendering + + + + + + Style of cross-reference rendering (title vs numbering) + + + + + + Substitute the expected label of the item being cross-referenced with a custom label (e.g. "subclause" instead of "clause") + + + + + The force of a clause in a standard document: whether it has normative or informative effect + + normative + informative + + + Standardisation document representation of bibliographic entry - - - + + Suppress from dislay in rendered document + Suppress document identifier from item rendering @@ -821,6 +673,7 @@ + Add svg mark up to image @@ -833,16 +686,22 @@ + Indication of a break in text rendered as columns + How a block element may be rendered in a multilingual document, with a column for each language common + Block is shared across all languages all-columns + Block spans all columns of text, and versions in different languages are displayed consecutively parallel + Block is to be aligned to the block occupying the same position in the document hierarchy tag + Block is to be aligned to all blocks sharing the same `tag` attribute as this block @@ -854,11 +713,14 @@ - + + The width of an individual table column + internal + Internal reference (for Metanorma document collections) @@ -873,106 +735,120 @@ + + + + Inline text not to be processed semantically, and left in the markup of a target rendering language (e.g. raw HTML) - + + List of the target formats for which the markup is intended, comma-delimited + - + + + Markup specific to a target rendering language + + + + + Indication of text added through editorial intervention - - - - - - - - - - - + + + + Indication of text deleted through editorial intervention - - - - - - - - - - - + + + + Semantic or formatting markup for inline elements - + + Class of the inline span, as semantic markup + - + + CSS style directive for the inline span. Is intended to be the same as HTML style attribute + - + + Character set that the contained text belongs to; +is used in particular to capture mutually agreed definitions of codepoints in Unicode Private Use Area + - + + Textual content of span + + Localisable rendering of a date - - - - - - - - - - + + + Date to be rendered, in ISO 8601 format + + - + + Format to be used to render date, as a strftime formatting string + + Formally defined concept used in a standardisation document, aligned to a definition. +That concept may be defined as a term within the current document, or it may be defined externally + Render the term in the concept in boldface + Render the term in the concept in italics + Render a reference to a definition for the concept, e.g. "widgets (3.1)" + Hyperlink the mention of the term to the definition for the concept + Hyperlink the reference for the term to the definition for the concept + The canonical name of the concept being defined @@ -985,6 +861,7 @@ + The rendering to be used for the concept @@ -996,10 +873,18 @@ - - - - + + Link to a definition of the term in a bibliographic entry + + + Stack of links to a definition of the term in a bibliographic entry + + + Link to a definition of the term in an element of the current document + + + Link to a definition of the term in a termbase + @@ -1016,102 +901,143 @@ + Table of contents, represented as a list of crossreferences, each with textual content - + + List of crossreferences + + + Wrapper around raw markup to be transferred into one or more nominated output formats during processing - + + Format of markup to be transferred, comma-delimited + - + + + Markup to be transferred + + + + + Input form, for use under HTML - - + + + Name of the input form block + + + Action to be taken on submission of the input form - - - + + Class of input form + + + + Input element for forms, associated with name/value pair to be submitted - + + + + Name of value of input element to be submitted + + + + + Preset or default of value of input element to be submitted + + + + Type of simple Input element button + Input element is a button checkbox + Input element is a checkbox date + Input element contains date file + Input element selects file for upload password + Input element is a password field radio + Input element is a radio button submit + Input element is a submit button text + Input element contains text + Input involving simple text + Type of input element + Input element is checkbox, and has checked value + Input element is disabled + Input element is read-only + Maximum length of input in characters, for character input + Minimum length of input in characters, for character input - - - - - - - - - - - + + + Label associated with form input element + @@ -1121,79 +1047,78 @@ + Input allowing the selection of a value from a list of values. The value attribute is used instead of a selected +attribute on a component option - - - - - - - - - - - + + + Input is disabled + Input can return multiple option values + Suggested number of options to display - + + Options to select from as value of the input + + Option of a Select input + Option is disabled - + + Value associated with this option + - + + Display text associated with this option + + Input involving extended text. The value attribute is used instead of text area content - - - - - - - - - - - + + + Suggested number of rows for the input area + Suggested number of columns for the input area + Bibliographic references @@ -1204,47 +1129,57 @@ + - - + + Render the section number and title (if present) inline with the first paragraph of the section + - + + Value of number to be used for numbering of section, overriding any autonumbering in rendering. +The section number is still formed by appending this number to the hierarchical set of parent section numbers, +e.g. a number "3a" under Clause 1 subclause 2 will be numbered as 1.2.3a + - + + Value of number to be used for numbering of section, overriding any autonumbering in rendering, +and the hierarchy of parent section numbers. This attribute is mutually exclusive with `number`. +So under Clause 1 subclause 2, sub-subclause 3 is numbered as 1.2.3. If the following sub-subclause +is given a branch-number "7.2.1.5", that will be the overall section number given, ignoring the parent section +numbers + - + + Do not apply numbering to this clause - - - - - - + + - - normative - informative - + + References clause with recursive nesting - + + Prefatory text + + Recursion of reference clauses @@ -1255,9 +1190,16 @@ - - + Attributes on document root + + Version number of the gem used to generate this document + + + Version number of the schema that this document is aligned to + + Type of standards document representation. "Semantic" is the core representation of content. +"Presentation" manipulates and enhances the representation for rendering needs. semantic presentation @@ -1265,34 +1207,54 @@ + Representation of a standardisation document - + + Bibliographic description of the document itself, expressed in the Relaton model + - + + Extension point for extraneous elements that need to be added to standards document as data + - + + Front matter that is repeated at the start of documents issued from an SDO, with content not specific to the document + - + + Prefatory sections + - + + Main body of document + - + + Annex sections + - + + Bibliographic sections + - + + Index of the document + - + + Colophon or postface material + + Elements added to metanorma-extension are open-ended, and constitute source data @@ -1320,11 +1282,13 @@ + Foreword of document + Introduction of document @@ -1335,18 +1299,27 @@ + Content addressing legal and licensing concerns around the document, outside of the main flow of document content - + + Preset templated text provided by the standardization body, describing the copyright status of the document + - + + Preset templated text provided by the standardization body, providing the licensing terms for the document content + - + + Preset templated text provided by the standardization body, providing the legal constraints and considerations around use of the document + - + + Preset templated text provided by the standardization body, providing information on where feedback on the document may be addressed to + @@ -1371,37 +1344,36 @@ + One or more definition lists, used to define symbols and abbreviations used in the remainder of the document. +These can also be used as glossaries, with simple definitions, in contrast to the more elaborate definitions given in +terms sections + + - - + + Semantic class of clause - - - - - - - - - - - normative - informative - + - + + Title of section + - + + Prefatory material, may be specific to each definition list + - + + Definition list containing symbols and abbreviations + @@ -1411,11 +1383,13 @@ + Abstract of a document, presented as a clause + Acknowledgements of a document, presented as a clause @@ -1426,12 +1400,17 @@ + Unnumbered clause with no semantic specialisation, used in preface of document - + + Semantic class of clause + - + + Title of section + @@ -1448,22 +1427,34 @@ + Strictly hierarchical clause: all textual content belongs in a strict clause hierarchy. such that no blocks of text +are siblings to subclauses (hanging paragraphs) - + + Semantic class of the clause, e.g. "scope" + - + + Title of section + - + + Block content, mutually exclusive with subclauses + - + + Specification of machine-readable change outlined in this section, +used in document amendments + + Subclauses, can include terms and definitions @@ -1473,48 +1464,38 @@ - + Clause constituting an annex or appendix + - - - - - - - - - - - - + + + Render the section number and title (if present) inline with the first paragraph of the section - - - normative - informative - + + Semantic class of clause - - - - + + Title of clause + + Hanging paragraphs: Annexes permit top-level blocks that are not part of a subsection + Subclauses of the annex: these can include terms, definitions, and references @@ -1540,16 +1521,23 @@ + Terms sections give elaborated definitions of terms used in a standardization document - + + Semantic class of clause + - + + Title of clause + - + + Prefatory material + @@ -1570,49 +1558,60 @@ + Terminology entry with its definition - - - - - - - - - - - + + - + + One or more names under which the term being defined is canonically known + - + + Zero or more names which are acceptable synonyms for the term being defined + - + + Zero or more names which are deprecated synonyms for the term being defined + - + + Zero or more names which are related to the term being defined. + - + + An optional semantic domain for the term being defined, + in case the term is ambiguous between several semantic domains + - + + Subject of the term + - + + The definition of the term applied in the current document + - - - - + + Zero or more notes about the term + - + + Zero or more examples of how the term is to be used + + + Bibliographic references for the managed term + @@ -1626,32 +1625,53 @@ + Term related to the current term + Type of relation of term applicable + Preferred designation of the term related to the current term - - - - + + Link to a definition of the term in a bibliographic entry + + + Stack of links to a definition of the term in a bibliographic entry + + + Link to a definition of the term in an element of the current document + + + Link to a definition of the term in a termbase + + The relation of a term to the current term deprecates + The current term deprecates the related term supersedes + The current term supersedes the related term narrower + The current term is narrower in denotation than the related term broader + The current term is broader in denotation than the related term equivalent + The current term is equivalent in denotation to the related term compare + The current term may be compared to the related term contrast + The current term is understood in contrast to the related term see + For a better understanding of the current term, one should see the related term seealso + For a better understanding of the current term, one should also see the related term @@ -1660,28 +1680,42 @@ + A name under which a managed term is known + Indication that the term designation is missing - + + The geographic area in which the managed term is known under this designation + - - - + + Realisation of a designation as a linguistic form + + + Realisation of a designation as a letter or symbol + + + Realisation of a designation as a graphical rendering + - + + Information about what field/domain the designation is specifically applied to + - + + Information about how the designation is to be used + - - - + + Bibliographic references for this designation of the managed term + @@ -1698,23 +1732,22 @@ + Designation realised as a letter, symbol, formula, equation + Whether the designation is the same across languages, or language-specific - - letter - symbol - formula - equation - + Type of symbolic designation + + The symbolic form of the designation @@ -1724,139 +1757,183 @@ + + The type of a symbol-like designation + + letter + A letter, possibly subscripted or superscripted, intended to denote some property that it abbreviates + symbol + A non-letter, intended to represent some property + formula + A mathematical formula + equation + A mathematical equation (or inequation) + + + Designation realised as a graphical symbol + Whether the designation is the same across languages, or language-specific - + + The graphical form of the designation + + A designation realised as a linguistic form - - - ISO-639 - - - - - ISO-15924 - - + + The type of linguistic form used as designation + Whether the designation (typically an abbreviation) is the same across languages, or language-specific + The textual form of the designation + + Type of abbreviation that constitutes the designation, according to how it is formed + A pronunciation guide to the designation + Grammatical information about the designation + Type of linguistic form used as designation prefix + The form is a prefix suffix + The form is a suffix abbreviation + The form is an abbreviation full + The form is a self-standing linguistic expression + Type of abbreviation, according to how it is formed truncation + Abbrevation formed by truncating constituent words acronym + Abbrevation formed from the initials of its constituent words, and pronounced as a new word initialism + Abbrevation formed from the initials of its constituent words, and pronounced as a sequence of letters + Grammatical information about a designation + The grammatical gender of the designation + The grammatical number of the designation + The designation is a preposition + The designation is a participle + The designation is an adjective + The designation is a verb + The designation is an adverb + The designation is a noun + Miscellaneous grammatical information + The grammatical gender of the designation masculine + Masculine gender feminine + Feminine gender neuter + Neuter gender common + Masculine + Feminine gender + The grammatical number of the designation singular + Singular number dual + Dual number plural + Plural number @@ -1874,13 +1951,20 @@ + The definition of a term applied in the current document - + + Type of definition, used to differentiate it from other definitions of the same term if present + - - + + The content of the definition of the term applied in the current document + + + Non-verbal representation of the term applied in the current document + @@ -1892,6 +1976,7 @@ + Content of the verbal representation of the term @@ -1901,44 +1986,35 @@ - - - + + Bibliographic references for this designation of the managed term + + Non-verbal representation of the term + Content of the non-verbal representation of the term - - - + + Bibliographic references for this designation of the managed term + - - - - - - - - - - - - - - + + + Content of the term note @@ -1950,12 +2026,11 @@ - - - + + Content of the term example @@ -1969,32 +2044,56 @@ + The bibliographic source where a term is defined in the sense applicable in this standardisation document + The status of the term as it is used in this document, relative to its definition in the original document - - authoritative - lineage - + The type of the managed term in the present context + - + + The original document and location where the term definition has been obtained from + - + + Any changes that the definition of the term has undergone relative to the original document, +in order to be applicable in this standardisation document + + The status of a term as it is used in this document, relative to its definition in the original document identical + The managed term in the present context is identical to the term as found in the bibliographic source modified + The managed term in the present context has been modified from the term as found in the bibliographic source adapted + The managed term in the present context has been modified from the term as found in the bibliographic source, in order +to better fit some local requirement, though still with the intent of retaining the original meaning as much as possible restyled + The managed term in the present context has been restyled from the term as found in the bibliographic source context-added + The managed term in the present context has had context added to it, relative to the term as found in the bibliographic source generalisation + The managed term in the present context is a generalisation of the term as found in the bibliographic source specialisation + The managed term in the present context is a specialisation of the term as found in the bibliographic source unspecified + The managed term in the present context is in an unspecified relation to the term as found in the bibliographic source + + + + The type of the managed term in the present context + + authoritative + The managed term is authoritative in the present context + lineage + The managed term constitutes lineage in the present context @@ -2011,45 +2110,37 @@ + Cross-reference to a term defined within a termbase - - - - - + + Identifier of the termbase + + + Identifier of the term within the termbase + + + + Text to display for the cross-reference to the term + + - - - - - - - - - - - + + Render the section number and title (if present) inline with the first paragraph of the section - - - - normative - informative - - - - + + Prefatory text + @@ -2066,8 +2157,10 @@ + Specification of how blocks of a given class should be autonumbered within an AmendBlock newContent element + The class of block to apply autonumbering to, within an AmendBlock newContent element requirement recommendation @@ -2081,88 +2174,119 @@ note - + + The starting value of numbering for the blocks with that class + + Wrapper around an image file, to specify an image map, with areas of an image being hyperlinked - + + the image to be hyperlinked + - - - - rect - circle - ellipse - poly - + + Specification of an area of an image to be hyperlinked, as part of an image map + + + + + + Specification of an area of an image to be hyperlinked, as part of an image map + + + Type of an image map area of an image that is hyperlinked + + rect + circle + ellipse + poly + + + + Element that this image map area links to + + + + + + + + Polygon defined shape of the image map area + + X-coordinate of a coordinate point + + + + Y-coordinate of a coordinate point + + + + + + + Radius-defined shape of the image map area + + X-coordinate of the center of a circle area within the image map + - - - - - - - - - - - - - - - - - - - - - - - - - - + + Y-coordinate of the center of a circle area within the image map + + - + + Wrapper around an SVG file, to update its hyperlinks with potentially document-specific +links, so that the SVG file can hyperlink to anchors within the document - + + The SVG file to be updated + - - - - - - - - - - - + + Specification of the cross-references to update the SVG file with + + + Specification of (potentially document-specific) cross-references, to overwrite the +links within an SVG file, so that the SVG file can hyperlink to anchors within the document + + + The value of the `href` attribute in the SVG file to be overwritten + + + + The cross-reference or hyperlink, whose value is to overwrite the value of the `href` attribute in the SVG file + + + + + + + + Unorderd list item for standards documents - - - - - + + Include a checkbox for the list item + Check the checkbox for the list item @@ -2172,70 +2296,22 @@ + A floating title, outside of the clause hierarchy of the document - - - + + The ostensive depth of the floating title in the clause hierarchy: which level heading it should be presented as - + + Textual content of the floating title + - - - - \i\c*|\c+#\c+ - - - - - - \i\c*|\c+#\c+ - - - - - - - - - - - - - - - capital - lowercase - - - - - - - - - - - - - - - - - - - - - - - - - + Connective linking the current cross-reference target to its predecessor and or @@ -2245,38 +2321,52 @@ + Description of location in a reference, which can be combined with other locations in a single citation + Anchor within the document to point to \i\c*|\c+#\c+ + Connective linking this location to its predecessor. _from/to_ are presumed to nest more closely than _and_ or _or_ + Style of how a cross-reference is to be rendered basic + Render cross-reference only through the title of the element (e.g. "The hunting of the snark" full + Render cross-reference as a combination of title and the numbering and type of the element (e.g. Chapter 3, "The hunting of the snark") short + Default style: render cross-reference only through the numbering and type of the element (e.g. Chapter 3) id - + Render cross-reference as the anchor or identifier used to identify the target + + Extension point: User-defined rendering style (e.g. "modspec" for cross-references compliant to the OGC Modspec model of cross-referencing requirements from other requirements, independent of how those requirements are cross-referenced within a standards document.) + + Cross-reference to an bibliographic reference within a standardisatin document, with a connective + Connective linking this location to its predecessor. _from/to_ are presumed to nest more closely than _and_ or _or_ + Set of cross-references to bibliographic references within a standardisation document, joined with connectives + Cross-reference to a bibliographic reference @@ -2285,25 +2375,51 @@ + Keep this block on the same page as the following block in paged media + Do not permit a page break between the lines of the block in paged media - + + Non-unique identifier within document. Used to align two blocks in different languages in a multilingual document + + Specification of how a block element may be rendered in a multilingual document - + + Set the columns display of the current block, overriding the display inherited from the document. +For example, if the document is set to two-column, this attribute would be used to set the block +to span across both columns + + + + + + + + + + Whether this is a normative references section or informative (bibliography). Not the same as obligation: +Normative References contents contain normative references, but as a clause in the document, they are informative. + + + + + + + diff --git a/lib/metanorma/iec/reqt.rng b/lib/metanorma/iec/reqt.rng index 3d591b26..1a829536 100644 --- a/lib/metanorma/iec/reqt.rng +++ b/lib/metanorma/iec/reqt.rng @@ -1,20 +1,27 @@ - + + Specification of an attribute of a subject that is required. +NOTE: A requirement can contain other requirements + Specification of an attribute of a subject that is recommended + Specification of an attribute of a subject that is permitted @@ -22,83 +29,101 @@ - - - - - - - - - - - - - - - - - - - - - - + An attribute that may be used to override the obligation represented in +the tag name of the top level containers + + + - - - - - - - + + File name of the requirement model when exported + - + + Model of requirements realised by this requirement, e.g. "ogc" for Modspec + - - + + Type of requirement; does not override labelling, unlike `class` - + + Class of provision, used to sequence and label that class separately. +By default, provisions are sequenced and labelled as requirements, recommendations, or +permissions, by obligation; the class overrides that + - + + Human-readable title of the requirement + - + + Formal identifier with which the requirement is referenced + - + + The party subject to the obligation stated in the requirement + - + + Reference to the identifier of another requirement, of which this requirement +is a subclass, and from which it inherits attributes + - + + Key/Value pairs of metadata used to describe the requirement. +A key can be associated with multiple values + - - - - - - + + Quantitative statement of metrics that the requirement realises + + + Formal specification of the requirement. Expected to be machine-readable + + + Processes or code used to verify that the requirement is being complied +with. Can be a test (including test code), or a compliance statement + + + A reference to source code or a statement of prerequisites which is defined elsewhere + + + Descriptive statement of the content of the requirement. Is expected to +be human-readable, and to contain formatting markup following Metanorma +conventions. Is expected to be discursive, and be resumed after +interruption by other sub-containers + + + Provisions nested within this provision, which cannot be referenced autonomously and have +subclasses specific to the parent provision. Not expressed with provision metadata + - + + A list of references for the requirement, following the Relaton model + + Provisions nested within this provision, which are self-standing and do not have +subclasses specific to the parent provision @@ -107,10 +132,10 @@ - + - + @@ -158,7 +183,9 @@ - + + Class of component + @@ -170,44 +197,36 @@ - - - - - - + A subcontainer can be either machine-readable or human-readable, or a +mixture of the two. +A machine-readable component can be included as source code with +nomination of the language + + + Type of sub-container. +For example a `verification[@type = "unit-test"]` contains a unit test of a single +feature, and is to be treated differently from +`verification[@type = "comprehensive"]`, which represents a comprehensive test suite - - - - - - + + Indicates that the current sub-container is only intended to be +machine-readable, and is not to be rendered as document output - - - - - - - - + + Content of subpart: blocks, rather than provisions - - - requirement - recommendation - permission - + + Values are "requirement", "recommendation", "permission"; multiple values can be comma-delimited + diff --git a/lib/metanorma/iec/version.rb b/lib/metanorma/iec/version.rb index e3658356..343b1aa7 100644 --- a/lib/metanorma/iec/version.rb +++ b/lib/metanorma/iec/version.rb @@ -1,6 +1,6 @@ module Metanorma module Iec - VERSION = "2.5.2".freeze + VERSION = "2.5.3".freeze end end diff --git a/spec/metanorma/base_spec.rb b/spec/metanorma/base_spec.rb index fad46b16..45e8b81e 100644 --- a/spec/metanorma/base_spec.rb +++ b/spec/metanorma/base_spec.rb @@ -100,300 +100,344 @@ output = <<~OUTPUT - - Introduction — Main Title — Title — Title Part - Introduction - Main Title — Title - Title Part - Introduction Française — Titre Principal — Part du Titre - Introduction Française - Titre Principal - Part du Titre - IEC PNW 1000-1 ED2 - IEC PNW 1000-1:2023 ED2(en) - IEC PNW 1000-1:2000-01 ED2(en) - urn:iec:std:iec:1000:-1:2023:stage-10.20:ed-2:en - IEC PNW 1000-1 ED2 - IEC PNW 1000-1 ED2(en) - 1000 - - - - International Electrotechnical Commission - IEC - - - - - Technical committee - - - International Electrotechnical Commission - TC - A 1 - - - - - Technical committee - - - International Electrotechnical Commission - TC1 - A1 11 - - - - - Subcommittee - - - International Electrotechnical Commission - SC - B 2 - - - - - Subcommittee - - - International Electrotechnical Commission - SC1 - B1 21 - - - - - Workgroup - - - International Electrotechnical Commission - WG - C 3 - - - - - Workgroup - - - International Electrotechnical Commission - WG1 - C1 31 - - - - - Agency - - - International Electrotechnical Commission - IEC - - - - - - International Electrotechnical Commission - IEC - - - - - Technical committee - - - International Electrotechnical Commission - TC - A 1 - - - - - Technical committee - - - International Electrotechnical Commission - TC1 - A1 11 - - - - - Subcommittee - - - International Electrotechnical Commission - SC - B 2 - - - - - Subcommittee - - - International Electrotechnical Commission - SC1 - B1 21 - - - - - Workgroup - - - International Electrotechnical Commission - WG - C 3 - - - - - Workgroup - - - International Electrotechnical Commission - WG1 - C1 31 - - - 2 - - 2000-01-01 - 0.3.4 - - en - - - 10 - 20 - - - 2023 - - - International Electrotechnical Commission - IEC - - - - - - -- - ABC - - - - - -- - DEF - - - - standard - - IEC - TC - TC1 - SC - SC1 - WG - WG1 - SECRETARIAT - - - 1000 - - New work item proposal International Standard - true - XC - true - Fred Nerk - TC 6121, SC 12 - - - - - TOC Heading Levels - 2 - - - HTML TOC Heading Levels - 2 - - - DOC TOC Heading Levels - 3 - - - PDF TOC Heading Levels - 3 - - - - - -

Copyright © 2023 International Electrotechnical Commission, IEC. - All rights reserved. It is permitted to download this electronic file, to make a copy and to - print out the content for the sole purpose of preparing National Committee positions. You - may not copy or “mirror” the file or printed version of the document, or any part of it, - for any other purpose without permission in writing from IEC.

- - - - -
    -
  1. -

    The International Electrotechnical Commission (IEC) is a worldwide organization for standardization comprising all national electrotechnical committees (IEC National Committees). The object of IEC is to promote international co-operation on all questions concerning standardization in the electrical and electronic fields. To this end and in addition to other activities, IEC publishes International Standards, Technical Specifications, Technical Reports, Publicly Available Specifications (PAS) and Guides (hereafter referred to as “IEC Publication(s)”). Their preparation is entrusted to technical committees; any IEC National Committee interested in the subject dealt with may participate in this preparatory work. International, governmental and non-governmental organizations liaising with the IEC also participate in this preparation. IEC collaborates closely with the International Organization for Standardization (ISO) in accordance with conditions determined by agreement between the two organizations.

    -
    2. -
  2. -

    The formal decisions or agreements of IEC on technical matters express, as nearly as possible, an international consensus of opinion on the relevant subjects since each technical committee has representation from all interested IEC National Committees.

    -
    3. -
  3. -

    IEC Publications have the form of recommendations for international use and are accepted by IEC National Committees in that sense. While all reasonable efforts are made to ensure that the technical content of IEC Publications is accurate, IEC cannot be held responsible for the way in which they are used or for any misinterpretation by any end user.

    -
    4. -
  4. -

    In order to promote international uniformity, IEC National Committees undertake to apply IEC Publications transparently to the maximum extent possible in their national and regional publications. Any divergence between any IEC Publication and the corresponding national or regional publication shall be clearly indicated in the latter.

    -
    5. -
  5. -

    IEC itself does not provide any attestation of conformity. Independent certification bodies provide conformity assessment services and, in some areas, access to IEC marks of conformity. IEC is not responsible for any services carried out by independent certification bodies.

    -
    6. -
  6. -

    All users should ensure that they have the latest edition of this publication.

    -
    7. -
  7. -

    No liability shall attach to IEC or its directors, employees, servants or agents including individual experts and members of its technical committees and IEC National Committees for any personal injury, property damage or other damage of any nature whatsoever, whether direct or indirect, or for costs (including legal fees) and expenses arising out of the publication, use of, or reliance upon, this IEC Publication or any other IEC Publications.

    -
    8. -
  8. -

    Attention is drawn to the Normative references cited in this publication. Use of the referenced publications is indispensable for the correct application of this publication.

    -
    9. -
  9. -

    Attention is drawn to the possibility that some of the elements of this IEC Publication may be the subject of patent rights. IEC shall not be held responsible for identifying any or all such patent rights.

    -
    10. -
- - - - -

This document is still under study and subject to change. It should not be used for reference purposes. - until published as such.

-

Recipients of this document are invited to submit, with their comments, notification of any relevant - patent rights of which they are aware and to provide supporting documentation.

- - - - - Attention IEC-CENELEC parallel voting -

The attention of IEC National Committees, members of CENELEC, is drawn to the fact that this

-

(PNW) - is submitted for parallel voting.

-

The CENELEC members are invited to vote through the CENELEC voting system.

- - - - + + Introduction — Main Title — Title — Title Part + Introduction + Main Title — Title + Title Part + Introduction Française — Titre Principal — Part du Titre + Introduction Française + Titre Principal + Part du Titre + IEC PNW 1000-1 ED2 + IEC PNW 1000-1:2023 ED2(en) + IEC PNW 1000-1:2000-01 ED2(en) + urn:iec:std:iec:1000:-1:2023:stage-10.20:ed-2:en + IEC PNW 1000-1 ED2 + IEC PNW 1000-1 ED2(en) + 1000 + + + + International Electrotechnical Commission + IEC + + + + + Technical committee + + + International Electrotechnical Commission + + + TC + A 1 + + + + + + + Technical committee + + + International Electrotechnical Commission + + + TC1 + A1 11 + + + + + + + Subcommittee + + + International Electrotechnical Commission + + + SC + B 2 + + + + + + + Subcommittee + + + International Electrotechnical Commission + + + SC1 + B1 21 + + + + + + + Workgroup + + + International Electrotechnical Commission + + + WG + C 3 + + + + + + + Workgroup + + + International Electrotechnical Commission + + + WG1 + C1 31 + + + + + + + Agency + + + International Electrotechnical Commission + IEC + + + + + + International Electrotechnical Commission + IEC + + + + + Technical committee + + + International Electrotechnical Commission + + + TC + A 1 + + + + + + + Technical committee + + + International Electrotechnical Commission + + + TC1 + A1 11 + + + + + + + Subcommittee + + + International Electrotechnical Commission + + + SC + B 2 + + + + + + + Subcommittee + + + International Electrotechnical Commission + + + SC1 + B1 21 + + + + + + + Workgroup + + + International Electrotechnical Commission + + + WG + C 3 + + + + + + + Workgroup + + + International Electrotechnical Commission + + + WG1 + C1 31 + + + + + 2 + + 2000-01-01 + 0.3.4 + + en + + + 10 + 20 + + + 2023 + + + International Electrotechnical Commission + IEC + + + + + + -- + ABC + + + + + -- + DEF + + + + standard + + IEC + TC + TC1 + SC + SC1 + WG + WG1 + SECRETARIAT + + + 1000 + + New work item proposal International Standard + true + XC + true + Fred Nerk + TC 6121, SC 12 + + + + + TOC Heading Levels + 2 + + + HTML TOC Heading Levels + 2 + + + DOC TOC Heading Levels + 3 + + + PDF TOC Heading Levels + 3 + + + + + +

+ Copyright © 2023 International Electrotechnical Commission, IEC. + All rights reserved. It is permitted to download this electronic file, to make a copy and to print out the content for the sole purpose of preparing National Committee positions. You may not copy or “mirror” the file or printed version of the document, or any part of it, for any other purpose without permission in writing from IEC. +

+ + + + +
    +
  1. +

    The International Electrotechnical Commission (IEC) is a worldwide organization for standardization comprising all national electrotechnical committees (IEC National Committees). The object of IEC is to promote international co-operation on all questions concerning standardization in the electrical and electronic fields. To this end and in addition to other activities, IEC publishes International Standards, Technical Specifications, Technical Reports, Publicly Available Specifications (PAS) and Guides (hereafter referred to as “IEC Publication(s)”). Their preparation is entrusted to technical committees; any IEC National Committee interested in the subject dealt with may participate in this preparatory work. International, governmental and non-governmental organizations liaising with the IEC also participate in this preparation. IEC collaborates closely with the International Organization for Standardization (ISO) in accordance with conditions determined by agreement between the two organizations.

    +
    2. +
  2. +

    The formal decisions or agreements of IEC on technical matters express, as nearly as possible, an international consensus of opinion on the relevant subjects since each technical committee has representation from all interested IEC National Committees.

    +
    3. +
  3. +

    IEC Publications have the form of recommendations for international use and are accepted by IEC National Committees in that sense. While all reasonable efforts are made to ensure that the technical content of IEC Publications is accurate, IEC cannot be held responsible for the way in which they are used or for any misinterpretation by any end user.

    +
    4. +
  4. +

    In order to promote international uniformity, IEC National Committees undertake to apply IEC Publications transparently to the maximum extent possible in their national and regional publications. Any divergence between any IEC Publication and the corresponding national or regional publication shall be clearly indicated in the latter.

    +
    5. +
  5. +

    IEC itself does not provide any attestation of conformity. Independent certification bodies provide conformity assessment services and, in some areas, access to IEC marks of conformity. IEC is not responsible for any services carried out by independent certification bodies.

    +
    6. +
  6. +

    All users should ensure that they have the latest edition of this publication.

    +
    7. +
  7. +

    No liability shall attach to IEC or its directors, employees, servants or agents including individual experts and members of its technical committees and IEC National Committees for any personal injury, property damage or other damage of any nature whatsoever, whether direct or indirect, or for costs (including legal fees) and expenses arising out of the publication, use of, or reliance upon, this IEC Publication or any other IEC Publications.

    +
    8. +
  8. +

    Attention is drawn to the Normative references cited in this publication. Use of the referenced publications is indispensable for the correct application of this publication.

    +
    9. +
  9. +

    Attention is drawn to the possibility that some of the elements of this IEC Publication may be the subject of patent rights. IEC shall not be held responsible for identifying any or all such patent rights.

    +
    10. +
+ + + + +

This document is still under study and subject to change. It should not be used for reference purposes. until published as such.

+

Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.

+ + + + + Attention IEC-CENELEC parallel voting +

The attention of IEC National Committees, members of CENELEC, is drawn to the fact that this

+

(PNW) is submitted for parallel voting.

+

The CENELEC members are invited to vote through the CENELEC voting system.

+ + + + OUTPUT expect(Xml::C14n.format(strip_guid(Asciidoctor.convert(input, *OPTIONS))))