metanorma-document 0.2.6 → 0.2.8

data/lib/metanorma/standard_document/sections/definition_section.rb

@@ -3,71 +3,68 @@
 module Metanorma
   module StandardDocument
     module Sections
-      # Definition sections consist of one or more definition lists (`DefinitionCollection`),
-      # are used to define symbols and
-      # abbreviations used in the remainder of the document.
+      # Definition sections consist of one or more definition lists,
+      # used to define symbols and abbreviations used in the remainder of
+      # the document.
       #
-      # They can also be used as glossaries, with simple definitions,
-      # in contrast to the more elaborate definitions given in
-      # terms sections.
-      #
-      # In addition to allowing prefatory text per section, each definition list
-      # within each definition section can also be preceded by prefatory text.
-      class DefinitionSection < Metanorma::StandardDocument::Sections::ClauseSection
-        attribute :definitions, DefinitionSection, collection: true
+      # Corresponds to isodoc.rnc:
+      #   definitions = element definitions {
+      #     Section-Attributes,
+      #     ( (BasicBlock+) | (dl+) )?,
+      #     definitions*
+      #   }
+      class DefinitionSection < Lutaml::Model::Serializable
+        include Metanorma::StandardDocument::PresentationAttributes
+
+        attribute :id, :string
         attribute :type, :string
+        attribute :number, :string
         attribute :obligation, :string
+        attribute :inline_header, :string
+        attribute :unnumbered, :string
+        attribute :toc, :string
+        attribute :class_attr, :string
+        attribute :title,
+                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
 
         # Block content
-        attribute :id, :string
-        attribute :anchor, :string
-        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
         attribute :paragraphs,
                   Metanorma::Document::Components::Paragraphs::ParagraphBlock,
                   collection: true
-        attribute :definition_lists,
-                  Metanorma::Document::Components::Lists::DefinitionList,
-                  collection: true
         attribute :unordered_lists,
                   Metanorma::Document::Components::Lists::UnorderedList,
                   collection: true
-        attribute :example,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-        attribute :table,
+        attribute :tables,
                   Metanorma::Document::Components::Tables::TableBlock,
                   collection: true
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
-
-        # Presentation-specific
-        attribute :fmt_title, Metanorma::Document::Components::Inline::FmtTitleElement
-        attribute :fmt_xref_label, Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+        attribute :definition_lists,
+                  Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
+        attribute :examples,
+                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
                   collection: true
 
+        # Recursive definitions
+        attribute :definitions, DefinitionSection, collection: true
+
         xml do
           element "definitions"
           ordered
-          map_attribute "id", to: :id
-          map_attribute "anchor", to: :anchor
-          map_attribute "type", to: :type
-          map_attribute "obligation", to: :obligation
-          map_element "title", to: :title
-          map_element "p", to: :paragraphs
-          map_element "dl", to: :definition_lists
-          map_element "ul", to: :unordered_lists
-          map_element "example", to: :example
-          map_element "table", to: :table
-          map_element "definitions", to: :definitions
-          map_element "fmt-title", to: :fmt_title
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
+
+          map_element "title",          to: :title
+          map_element "variant-title",  to: :variant_title
+          map_element "p",              to: :paragraphs
+          map_element "ul",             to: :unordered_lists
+          map_element "table",          to: :tables
+          map_element "dl",             to: :definition_lists
+          map_element "example",        to: :examples
+          map_element "definitions",    to: :definitions
+          map_element "fmt-title",      to: :fmt_title
           map_element "fmt-xref-label", to: :fmt_xref_label
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
+          map_element "fmt-annotation-start", to: :fmt_annotation_start
+          map_element "fmt-annotation-end",   to: :fmt_annotation_end
         end
       end
     end

data/lib/metanorma/standard_document/sections/floating_section_title.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # A floating section title used in BSI and JIS documents.
+      # Differs from FloatingTitle: uses element name "section-title",
+      # has id (not derived from StandardBlockNoNotes), and contains TextElement.
+      class FloatingSectionTitle < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :depth, :integer
+        attribute :text, :string, collection: true
+
+        xml do
+          element "section-title"
+          map_attribute "id", to: :id
+          map_attribute "depth", to: :depth
+          map_content to: :text
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/foreword.rb

@@ -4,10 +4,8 @@ module Metanorma
   module StandardDocument
     module Sections
       # Foreword of document.
-      class Foreword < Metanorma::StandardDocument::Sections::StandardContentSection
-        attribute :semx_id, :string
+      class Foreword < Metanorma::StandardDocument::Sections::ContentSection
         attribute :original_id, :string
-        attribute :displayorder, :integer
         xml do
           element "foreword"
 

data/lib/metanorma/standard_document/sections/introduction.rb

@@ -4,11 +4,8 @@ module Metanorma
   module StandardDocument
     module Sections
       # Introduction of document.
-      class Introduction < Metanorma::StandardDocument::Sections::StandardContentSection
-        attribute :semx_id, :string
+      class Introduction < Metanorma::StandardDocument::Sections::ContentSection
         attribute :original_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
         xml do
           element "introduction"
 

data/lib/metanorma/standard_document/sections/misc_container.rb

@@ -5,8 +5,11 @@ module Metanorma
     module Sections
       # Extension point for extraneous elements that need to be added to standards document
       # from other schemas, e.g. UnitsML.
+      #
+      # Content is stored as raw XML text since the children come from external
+      # vocabularies not defined in the metanorma schema.
       class MiscContainer < Lutaml::Model::Serializable
-        attribute :element, Object, collection: true
+        attribute :content, :string
 
         attribute :semx_id, :string
         attribute :original_id, :string
@@ -14,7 +17,7 @@ module Metanorma
 
         xml do
           element "misc-container"
-          map_element "element", to: :element
+          map_content to: :content
 
           map_attribute "semx-id", to: :semx_id
           map_attribute "original-id", to: :original_id

data/lib/metanorma/standard_document/sections/preface.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Container for preface sections.
+      # Corresponds to isodoc.rnc:
+      #   preface = element preface {
+      #     ( content | abstract | foreword | introduction |
+      #       acknowledgements | executivesummary )+
+      #   }
+      class Preface < Lutaml::Model::Serializable
+        attribute :abstract, ContentSection
+        attribute :foreword, ContentSection
+        attribute :introduction, ContentSection
+        attribute :acknowledgements, ContentSection
+        attribute :executivesummary, ContentSection
+        attribute :content, ContentSection, collection: true
+
+        # Presentation-specific attributes
+        attribute :semx_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "preface"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_elements(self)
+          map_element "clause", to: :content
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/sections.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Container for the main body sections of a document.
+      # Corresponds to isodoc.rnc:
+      #   sections = element sections {
+      #     ( clause | terms | term-clause | definitions | floating-title )+
+      #   }
+      class Sections < Lutaml::Model::Serializable
+        attribute :clause, ClauseSection, collection: true
+        attribute :terms,
+                  Metanorma::StandardDocument::Sections::TermsSection,
+                  collection: true
+        attribute :definitions,
+                  Metanorma::StandardDocument::Sections::DefinitionSection,
+                  collection: true
+        attribute :floating_title,
+                  Metanorma::StandardDocument::Sections::FloatingTitle,
+                  collection: true
+        attribute :references,
+                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
+                  collection: true
+
+        # Presentation-specific attributes
+        attribute :semx_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "sections"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/standard_content_section.rb

@@ -3,23 +3,37 @@
 module Metanorma
   module StandardDocument
     module Sections
-      # An unnumbered clause, outside the main body of text of a _StandardDocument_.
-      class StandardContentSection < Metanorma::StandardDocument::Sections::StandardHierarchicalSection
+      # A content section used for preface elements (abstract, foreword,
+      # introduction, acknowledgements, executivesummary) and generic clauses
+      # within preface.
+      # Corresponds to isodoc.rnc `Content-Section`:
+      #   Section-Attributes, type?, title?,
+      #   ( BasicBlock*, content-subsection* )
+      class ContentSection < Lutaml::Model::Serializable
+        include Metanorma::StandardDocument::BlockAttributes
+        include Metanorma::StandardDocument::PresentationAttributes
+
+        # Section identity
+        attribute :id, :string
         attribute :type, :string
+        attribute :number, :string
+        attribute :obligation, :string
+        attribute :inline_header, :string
+        attribute :unnumbered, :string
+        attribute :toc, :string
+        attribute :class_attr, :string
+        attribute :title,
+                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
 
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
+        # Nested content subsections (recursive)
+        attribute :subsection, ContentSection, collection: true
 
         xml do
-          element "standard-content-section"
-          map_attribute "type", to: :type
+          element "clause"
+          ordered
 
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
         end
       end
     end

data/lib/metanorma/standard_document/sections/terms_section.rb

@@ -3,25 +3,57 @@
 module Metanorma
   module StandardDocument
     module Sections
-      # Term sections give elaborated definitions of terms used in a standardization document.
-      # The <terms> element contains <title>, <p>, <ul>, <term> children.
-      class TermsSection < Metanorma::StandardDocument::Sections::ClauseSection
-        attribute :terms, Metanorma::StandardDocument::Terms::Term,
+      # Term sections give elaborated definitions of terms used in a
+      # standardization document.
+      #
+      # Corresponds to isodoc.rnc:
+      #   terms = element terms {
+      #     Section-Attributes, title?,
+      #     ( paragraph | ul )*,
+      #     term+
+      #   }
+      class TermsSection < Lutaml::Model::Serializable
+        include Metanorma::StandardDocument::PresentationAttributes
+
+        attribute :id, :string
+        attribute :type, :string
+        attribute :number, :string
+        attribute :obligation, :string
+        attribute :inline_header, :string
+        attribute :unnumbered, :string
+        attribute :toc, :string
+        attribute :class_attr, :string
+        attribute :title,
+                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+
+        # Prefatory paragraphs before term entries
+        attribute :paragraphs,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+        attribute :unordered_lists,
+                  Metanorma::Document::Components::Lists::UnorderedList,
                   collection: true
 
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
+        # Term entries
+        attribute :terms,
+                  Metanorma::StandardDocument::Terms::Term,
+                  collection: true
 
         xml do
           element "terms"
-          map_element "term", to: :terms
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
 
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
+          map_element "title",            to: :title
+          map_element "variant-title",    to: :variant_title
+          map_element "fmt-title",        to: :fmt_title
+          map_element "fmt-xref-label",   to: :fmt_xref_label
+          map_element "p",                to: :paragraphs
+          map_element "ul",               to: :unordered_lists
+          map_element "term",             to: :terms
+          map_element "fmt-annotation-start", to: :fmt_annotation_start
+          map_element "fmt-annotation-end",   to: :fmt_annotation_end
         end
       end
     end

data/lib/metanorma/standard_document/sections.rb

@@ -7,18 +7,22 @@ module Metanorma
       autoload :Acknowledgements, "#{__dir__}/sections/acknowledgements"
       autoload :AnnexSection, "#{__dir__}/sections/annex_section"
       autoload :BibliographySection, "#{__dir__}/sections/bibliography_section"
+      autoload :Colophon, "#{__dir__}/sections/colophon"
       autoload :BoilerplateType, "#{__dir__}/sections/boilerplate_type"
       autoload :ClauseHierarchicalSection,
                "#{__dir__}/sections/clause_hierarchical_section"
       autoload :ClauseSection, "#{__dir__}/sections/clause_section"
+      autoload :ContentSection, "#{__dir__}/sections/standard_content_section"
       autoload :DefinitionSection, "#{__dir__}/sections/definition_section"
+      autoload :FloatingSectionTitle,
+               "#{__dir__}/sections/floating_section_title"
       autoload :FloatingTitle, "#{__dir__}/sections/floating_title"
       autoload :Foreword, "#{__dir__}/sections/foreword"
       autoload :Introduction, "#{__dir__}/sections/introduction"
       autoload :MiscContainer, "#{__dir__}/sections/misc_container"
       autoload :NormativeType, "#{__dir__}/sections/normative_type"
-      autoload :StandardContentSection,
-               "#{__dir__}/sections/standard_content_section"
+      autoload :Preface, "#{__dir__}/sections/preface"
+      autoload :Sections, "#{__dir__}/sections/sections"
       autoload :StandardHierarchicalSection,
                "#{__dir__}/sections/standard_hierarchical_section"
       autoload :StandardReferencesSection,

data/lib/metanorma/standard_document/terms/designation.rb

@@ -10,7 +10,7 @@ module Metanorma
                   Metanorma::Document::Components::DataTypes::Iso3166Code, collection: true
         attribute :sources, Metanorma::StandardDocument::Terms::TermSource,
                   collection: true
-        attribute :expression, Metanorma::IsoDocument::Terms::TermExpression
+        attribute :expression, Metanorma::StandardDocument::Terms::TermExpression
 
         attribute :semx_id, :string
         attribute :original_id, :string

data/lib/metanorma/standard_document/terms/term_expression.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      class TermNameElement < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :semx_id, :string
+        attribute :lang, :string
+        attribute :text, :string, collection: true
+        attribute :strike, Metanorma::Document::Components::TextElements::StrikeElement,
+                  collection: true
+        attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
+                  collection: true
+        attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
+                  collection: true
+        attribute :sup, Metanorma::Document::Components::Inline::SupElement,
+                  collection: true
+        attribute :sub, Metanorma::Document::Components::Inline::SubElement,
+                  collection: true
+
+        xml do
+          element "name"
+          map_attribute "id", to: :id
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "lang", to: :lang
+          mixed_content
+          map_content to: :text
+          map_element "strike", to: :strike
+          map_element "em", to: :em
+          map_element "strong", to: :strong
+          map_element "sup", to: :sup
+          map_element "sub", to: :sub
+        end
+      end
+
+      class TermExpression < Lutaml::Model::Serializable
+        attribute :name, TermNameElement, collection: true
+        attribute :usage, :string
+        attribute :abbreviation_type, :string
+
+        xml do
+          element "expression"
+          map_element "name", to: :name
+          map_element "usage", to: :usage
+          map_element "abbreviation-type", to: :abbreviation_type
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms.rb

@@ -22,6 +22,7 @@ module Metanorma
       autoload :Term, "#{__dir__}/terms/term"
       autoload :TermCollection, "#{__dir__}/terms/term_collection"
       autoload :TermDefinition, "#{__dir__}/terms/term_definition"
+      autoload :TermExpression, "#{__dir__}/terms/term_expression"
       autoload :TermSource, "#{__dir__}/terms/term_source"
       autoload :TermSourceStatus, "#{__dir__}/terms/term_source_status"
       autoload :TermSourceType, "#{__dir__}/terms/term_source_type"

data/lib/metanorma/standard_document.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
-require "metanorma/document"
-
 module Metanorma
   module StandardDocument
+    autoload :AnnotationContainer,
+             "metanorma/standard_document/annotation_container"
+    autoload :BlockAttributes, "metanorma/standard_document/block_attributes"
+    autoload :BlockXmlMapping, "metanorma/standard_document/block_attributes"
+    autoload :SectionXmlMapping, "metanorma/standard_document/block_attributes"
+    autoload :PresentationAttributes,
+             "metanorma/standard_document/block_attributes"
+    autoload :OrderedContent, "metanorma/standard_document/block_attributes"
     autoload :Blocks, "metanorma/standard_document/blocks"
+    autoload :Boilerplate, "metanorma/standard_document/boilerplate"
     autoload :Elements, "metanorma/standard_document/elements"
     autoload :Lists, "metanorma/standard_document/lists"
     autoload :Metadata, "metanorma/standard_document/metadata"
     autoload :Namespace, "metanorma/standard_document/namespace"
     autoload :Refs, "metanorma/standard_document/refs"
     autoload :Root, "metanorma/standard_document/root"
+    autoload :RootAttributes, "metanorma/standard_document/root_attributes"
     autoload :Sections, "metanorma/standard_document/sections"
     autoload :StandardDocumentType,
              "metanorma/standard_document/standard_document_type"

data/lib/metanorma/un_document/metadata/un_bib_data_extension_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    module Metadata
+      class UnBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+      end
+    end
+  end
+end

data/lib/metanorma/un_document/metadata/un_bibliographic_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    module Metadata
+      class UnBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, UnBibDataExtensionType
+
+        xml do
+          element "bibdata"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/un_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    module Metadata
+      autoload :UnBibDataExtensionType,
+               "#{__dir__}/metadata/un_bib_data_extension_type"
+      autoload :UnBibliographicItem,
+               "#{__dir__}/metadata/un_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/un_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :un_document
+      end
+
+      attribute :bibdata, Metadata::UnBibliographicItem
+      attribute :preface,
+                UnDocument::Sections::UnPreface
+      attribute :sections,
+                UnDocument::Sections::UnSections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
+                collection: true
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+      end
+    end
+  end
+end

data/lib/metanorma/un_document/sections/un_preface.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    module Sections
+      # UN preface with only abstract, foreword, introduction.
+      # Corresponds to un.rnc:
+      #   preface = element preface { abstract?, foreword?, introduction? }
+      class UnPreface < Metanorma::StandardDocument::Sections::Preface
+        xml do
+          element "preface"
+          ordered
+
+          map_element "abstract",      to: :abstract
+          map_element "foreword",      to: :foreword
+          map_element "introduction",  to: :introduction
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/un_document/sections/un_sections.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    module Sections
+      # UN sections container.
+      # Corresponds to un.rnc:
+      #   sections = element sections { (clause | floating-title)+ }
+      #
+      # UN does not allow terms/definitions at top level of sections.
+      class UnSections < Metanorma::StandardDocument::Sections::Sections
+        xml do
+          element "sections"
+          ordered
+
+          map_element "clause",         to: :clause
+          map_element "floating-title", to: :floating_title
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/un_document/sections.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    module Sections
+      autoload :UnPreface, "#{__dir__}/sections/un_preface"
+      autoload :UnSections, "#{__dir__}/sections/un_sections"
+    end
+  end
+end

data/lib/metanorma/un_document.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    autoload :Metadata, "metanorma/un_document/metadata"
+    autoload :Root, "metanorma/un_document/root"
+    autoload :Sections, "metanorma/un_document/sections"
+  end
+end
+
+Metanorma::Registers::Setup.setup_un_register