metanorma-document 0.2.6 → 0.2.7

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

@@ -3,28 +3,93 @@
 module Metanorma
   module StandardDocument
     module Sections
-      # Section of document constituting an annex or appendix.
-      class AnnexSection < Metanorma::StandardDocument::Sections::StandardSection
-        attribute :subsections,
-                  Metanorma::StandardDocument::Sections::ClauseSection, collection: true
+      # An annex section in the document.
+      # Corresponds to isodoc.rnc `Annex-Section-Body`:
+      #   Annex-Section-Attributes, title?,
+      #   ( BasicBlock*,
+      #     (annex-subsection | terms | definitions | references | floating-title)* )
+      #
+      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
+      class AnnexSection < Lutaml::Model::Serializable
+        include Metanorma::StandardDocument::BlockAttributes
 
+        # Section identity and classification
+        attribute :id, :string
+        attribute :number, :string
+        attribute :obligation, :string
+        attribute :unnumbered, :string
+        attribute :toc, :string
+        attribute :inline_header, :string
+        attribute :title,
+                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+
+        # Sub-clauses within annex (recursive)
+        attribute :clause, AnnexSection, collection: true
+
+        # Appendix (sub-sections unique to annex)
+        attribute :appendix, ClauseSection, collection: true
+
+        # Terms, definitions, references within annex
+        attribute :terms,
+                  Metanorma::StandardDocument::Sections::TermsSection,
+                  collection: true
+        attribute :definitions,
+                  Metanorma::StandardDocument::Sections::DefinitionSection,
+                  collection: true
+        attribute :references,
+                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
+                  collection: true
+
+        # Floating titles
+        attribute :floating_title,
+                  Metanorma::StandardDocument::Sections::FloatingTitle,
+                  collection: true
+
+        # Page breaks
+        attribute :pagebreak,
+                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
+                  collection: true
+
+        # Presentation-specific attributes
+        attribute :anchor, :string
         attribute :semx_id, :string
-        attribute :original_id, :string
         attribute :autonum, :string
         attribute :displayorder, :integer
-        attribute :inline_header, :string
-        attribute :type, :string
+        attribute :language, :string
+        attribute :script, :string
+        attribute :fmt_title,
+                  Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label,
+                  Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+                  collection: true
+        attribute :variant_title,
+                  Metanorma::Document::Components::Inline::VariantTitleElement,
+                  collection: true
+        attribute :fmt_annotation_start,
+                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
+                  collection: true
+        attribute :fmt_annotation_end,
+                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
+                  collection: true
 
         xml do
-          element "annex-section"
-          map_element "subsections", to: :subsections
-
-          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_attribute "inline-header", to: :inline_header
-          map_attribute "type", to: :type
+          element "annex"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
+        end
+
+        # Blocks in document order, used by JSON serialization
+        def blocks
+          @blocks ||=
+            begin
+              result = []
+              each_mixed_content do |node|
+                result << node unless node.is_a?(String)
+              end
+              result
+            end
         end
       end
     end

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

@@ -7,8 +7,7 @@ module Metanorma
       # one or more <references> sections (normative and/or informative).
       class BibliographySection < Lutaml::Model::Serializable
         attribute :references, StandardReferencesSection, collection: true
-        attribute :clause, Metanorma::IsoDocument::Sections::IsoClauseSection,
-                  collection: true
+        attribute :clause, ClauseSection, collection: true
 
         xml do
           element "bibliography"

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

@@ -3,25 +3,117 @@
 module Metanorma
   module StandardDocument
     module Sections
-      # A numbered clause constituting part of the main body of a _StandardDocument_.
-      class ClauseSection < Metanorma::StandardDocument::Sections::StandardSection
+      # A numbered clause in the document body.
+      # Corresponds to isodoc.rnc `Clause-Section`:
+      #   Section-Attributes, type?, title?,
+      #   ( (BasicBlock+ | amend) |
+      #     (clause-subsection | terms | definitions | floating-title)+ )
+      #
+      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
+      class ClauseSection < Lutaml::Model::Serializable
+        include Metanorma::StandardDocument::BlockAttributes
+
+        # Section identity and classification
+        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
+
+        # Sub-clauses (recursive)
+        attribute :clause, ClauseSection, collection: true
+
+        # Amend blocks (for amendment documents)
+        attribute :amend,
+                  Metanorma::StandardDocument::Blocks::AmendBlock
+
+        # Terms sections nested inside clauses
+        attribute :terms,
+                  Metanorma::StandardDocument::Sections::TermsSection,
+                  collection: true
+
+        # Definitions sections nested inside clauses
+        attribute :definitions,
+                  Metanorma::StandardDocument::Sections::DefinitionSection,
+                  collection: true
+
+        # References sections nested inside clauses
+        attribute :references,
+                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
+                  collection: true
 
+        # Floating titles
+        attribute :floating_title,
+                  Metanorma::StandardDocument::Sections::FloatingTitle,
+                  collection: true
+
+        # Forms
+        attribute :form,
+                  Metanorma::StandardDocument::Blocks::Form,
+                  collection: true
+
+        # Requirements / recommendations / permissions
+        attribute :requirement,
+                  Metanorma::StandardDocument::Blocks::RequirementModel,
+                  collection: true
+        attribute :recommendation,
+                  Metanorma::StandardDocument::Blocks::RecommendationModel,
+                  collection: true
+        attribute :permission,
+                  Metanorma::StandardDocument::Blocks::PermissionModel,
+                  collection: true
+
+        # Page breaks and bookmarks
+        attribute :pagebreak,
+                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
+                  collection: true
+        attribute :bookmark,
+                  Metanorma::Document::Components::IdElements::Bookmark,
+                  collection: true
+
+        # Presentation-specific attributes
+        attribute :anchor, :string
         attribute :semx_id, :string
-        attribute :original_id, :string
         attribute :autonum, :string
         attribute :displayorder, :integer
-        attribute :inline_header, :string
+        attribute :fmt_title,
+                  Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label,
+                  Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+                  collection: true
+        attribute :variant_title,
+                  Metanorma::Document::Components::Inline::VariantTitleElement,
+                  collection: true
+        attribute :fmt_annotation_start,
+                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
+                  collection: true
+        attribute :fmt_annotation_end,
+                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
+                  collection: true
 
         xml do
           element "clause"
-          map_attribute "type", to: :type
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
+        end
 
-          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_attribute "inline-header", to: :inline_header
+        # Blocks in document order, used by JSON serialization
+        def blocks
+          @blocks ||=
+            begin
+              result = []
+              each_mixed_content do |node|
+                result << node unless node.is_a?(String)
+              end
+              result
+            end
         end
       end
     end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      class Colophon < Lutaml::Model::Serializable
+        attribute :clause, ClauseSection, collection: true
+
+        xml do
+          element "colophon"
+          map_element "clause", to: :clause
+        end
+      end
+    end
+  end
+end

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

@@ -3,71 +3,74 @@
 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
+        attribute :id, :string
+        attribute :anchor, :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 :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
+
+        # Presentation-specific attributes
         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 :fmt_title,
+                  Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label,
+                  Metanorma::Document::Components::Inline::FmtXrefLabelElement,
                   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 "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
         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,56 @@
 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
+
+        # 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
+
+        # Nested content subsections (recursive)
+        attribute :subsection, ContentSection, collection: true
 
+        # Presentation-specific attributes
+        attribute :anchor, :string
         attribute :semx_id, :string
-        attribute :original_id, :string
         attribute :autonum, :string
         attribute :displayorder, :integer
+        attribute :fmt_title,
+                  Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label,
+                  Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+                  collection: true
+        attribute :variant_title,
+                  Metanorma::Document::Components::Inline::VariantTitleElement,
+                  collection: true
+        attribute :fmt_annotation_start,
+                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
+                  collection: true
+        attribute :fmt_annotation_end,
+                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
+                  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