metanorma-document 0.2.6 → 0.2.8

data/lib/metanorma/iso_document/sections/iso_clause_section.rb

@@ -4,179 +4,22 @@ module Metanorma
   module IsoDocument
     module Sections
       # A numbered clause in an ISO/IEC document body.
-      # Supports recursive nesting via `clause` collection.
-      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
-      class IsoClauseSection < Lutaml::Model::Serializable
-        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)
+      # Extends StandardDocument::ClauseSection with ISO-specific overrides:
+      #   - Recursive clauses are IsoClauseSection (not ClauseSection)
+      #   - Terms sections are IsoTermsSection (not TermsSection)
+      class IsoClauseSection < Metanorma::StandardDocument::Sections::ClauseSection
+        # Override: ISO sub-clauses are IsoClauseSection
         attribute :clause, IsoClauseSection, collection: true
 
-        # Block collections
-        attribute :paragraphs,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :unordered_lists,
-                  Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-        attribute :ordered_lists,
-                  Metanorma::Document::Components::Lists::OrderedList,
-                  collection: true
-        attribute :tables,
-                  Metanorma::Document::Components::Tables::TableBlock,
-                  collection: true
-        attribute :figures,
-                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
-                  collection: true
-        attribute :formulas,
-                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
-                  collection: true
-        attribute :examples,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-        attribute :notes,
-                  Metanorma::Document::Components::Blocks::NoteBlock,
-                  collection: true
-        attribute :admonitions,
-                  Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
-                  collection: true
-        attribute :sourcecode_blocks,
-                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
-                  collection: true
-        attribute :quote_blocks,
-                  Metanorma::Document::Components::MultiParagraph::QuoteBlock,
-                  collection: true
-        attribute :definition_lists,
-                  Metanorma::Document::Components::Lists::DefinitionList,
-                  collection: true
-
-        # Amend blocks (for amendment documents)
-        attribute :amend,
-                  Metanorma::StandardDocument::Blocks::AmendBlock
-
-        # Terms sections nested inside clauses
-        attribute :terms,
-                  IsoTermsSection, 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
-
-        # Forms (HTML input forms with tables)
-        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
-        attribute :pagebreak,
-                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
-                  collection: true
-
-        # Bookmarks (inline anchors)
-        attribute :bookmark,
-                  Metanorma::Document::Components::IdElements::Bookmark,
-                  collection: true
-
-        # Presentation annotation markers
-        attribute :fmt_annotation_start,
-                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
-                  collection: true
-        attribute :fmt_annotation_end,
-                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
-                  collection: true
-
-        # Presentation-specific attributes
-        attribute :anchor, :string
-        attribute :semx_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
+        # Override: ISO terms sections use IsoTermsSection
+        attribute :terms, IsoTermsSection, collection: true
 
         xml do
           element "clause"
           ordered
-          map_attribute "id", to: :id
-          map_attribute "anchor", to: :anchor
-          map_attribute "type", to: :type
-          map_attribute "number", to: :number
-          map_attribute "obligation", to: :obligation
-          map_attribute "inline-header", to: :inline_header
-          map_attribute "unnumbered", to: :unnumbered
-          map_attribute "toc", to: :toc
-          map_attribute "class", to: :class_attr
-          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 "clause", to: :clause
-          map_element "p", to: :paragraphs
-          map_element "ul", to: :unordered_lists
-          map_element "ol", to: :ordered_lists
-          map_element "table", to: :tables
-          map_element "figure", to: :figures
-          map_element "formula", to: :formulas
-          map_element "example", to: :examples
-          map_element "note", to: :notes
-          map_element "admonition", to: :admonitions
-          map_element "sourcecode", to: :sourcecode_blocks
-          map_element "quote", to: :quote_blocks
-          map_element "dl", to: :definition_lists
-          map_element "amend", to: :amend
-          map_element "terms", to: :terms
-          map_element "definitions", to: :definitions
-          map_element "references", to: :references
-          map_element "form", to: :form
-          map_element "requirement", to: :requirement
-          map_element "recommendation", to: :recommendation
-          map_element "permission", to: :permission
-          map_element "pagebreak", to: :pagebreak
-          map_element "bookmark", to: :bookmark
-          map_element "fmt-annotation-start", to: :fmt_annotation_start
-          map_element "fmt-annotation-end", to: :fmt_annotation_end
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
-        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
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
         end
 
         json do

data/lib/metanorma/iso_document/sections/iso_foreword_section.rb

@@ -4,100 +4,15 @@ module Metanorma
   module IsoDocument
     module Sections
       # Foreword section of an ISO/IEC document.
-      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
-      # Maps direct block children (no <blocks> wrapper).
-      class IsoForewordSection < Lutaml::Model::Serializable
-        # Element identifier
-        attribute :id, :string
-
-        # Title text (may contain fmt-annotation-end in presentation XML)
-        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
-
-        # Block collections — using base classes with correct ISO XML element names
-        attribute :paragraphs,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :unordered_lists,
-                  Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-        attribute :ordered_lists,
-                  Metanorma::Document::Components::Lists::OrderedList,
-                  collection: true
-        attribute :tables,
-                  Metanorma::Document::Components::Tables::TableBlock,
-                  collection: true
-        attribute :figures,
-                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
-                  collection: true
-        attribute :formulas,
-                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
-                  collection: true
-        attribute :examples,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-        attribute :notes,
-                  Metanorma::Document::Components::Blocks::NoteBlock,
-                  collection: true
-        attribute :admonitions,
-                  Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
-                  collection: true
-        attribute :sourcecode_blocks,
-                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
-                  collection: true
-        attribute :definition_lists,
-                  Metanorma::Document::Components::Lists::DefinitionList,
-                  collection: true
-        attribute :quote_blocks,
-                  Metanorma::Document::Components::MultiParagraph::QuoteBlock,
-                  collection: true
-
-        # Presentation-specific attributes
-        attribute :anchor, :string
-        attribute :obligation, :string
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-        attribute :fmt_title, Metanorma::Document::Components::Inline::FmtTitleElement
-        attribute :fmt_annotation_start,
-                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement, collection: true
-        attribute :fmt_annotation_end,
-                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement, collection: true
-
+      # Extends ContentSection (blocks + optional subsections) but maps to
+      # the "foreword" element. ISO foreword typically has no subsections.
+      class IsoForewordSection < Metanorma::StandardDocument::Sections::ContentSection
         xml do
           element "foreword"
           ordered
-          map_attribute "id", to: :id
-          map_attribute "anchor", to: :anchor
-          map_attribute "obligation", to: :obligation
-          map_element "title", to: :title
-          map_element "fmt-title", to: :fmt_title
-          map_element "p", to: :paragraphs
-          map_element "ul", to: :unordered_lists
-          map_element "ol", to: :ordered_lists
-          map_element "table", to: :tables
-          map_element "figure", to: :figures
-          map_element "formula", to: :formulas
-          map_element "example", to: :examples
-          map_element "note", to: :notes
-          map_element "admonition", to: :admonitions
-          map_element "sourcecode", to: :sourcecode_blocks
-          map_element "dl", to: :definition_lists
-          map_element "quote", to: :quote_blocks
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "displayorder", to: :displayorder
-          map_element "fmt-annotation-start", to: :fmt_annotation_start
-          map_element "fmt-annotation-end", to: :fmt_annotation_end
-        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
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
         end
 
         json do

data/lib/metanorma/iso_document/sections/iso_preface.rb

@@ -3,39 +3,33 @@
 module Metanorma
   module IsoDocument
     module Sections
-      # Prefatory clauses appearing in an ISO/IEC document.
-      class IsoPreface < Lutaml::Model::Serializable
-        # Abstract.
+      # Prefatory clauses in an ISO/IEC document.
+      # Extends StandardDocument::Preface with ISO-specific section types:
+      #   abstract → IsoAbstractSection
+      #   foreword → IsoForewordSection
+      #   introduction → IsoClauseSection
+      # ISO preface mandates foreword; isodoc preface is permissive.
+      class IsoPreface < Metanorma::StandardDocument::Sections::Preface
+        # Override: ISO uses specific section types
         attribute :abstract, IsoAbstractSection
-
-        # Foreword.
         attribute :foreword, IsoForewordSection
-
-        # Introduction.
         attribute :introduction, IsoClauseSection
 
-        # TOC and other special clauses in preface.
+        # Generic clauses in preface use IsoClauseSection
         attribute :clause, IsoClauseSection, collection: true
 
-        # Acknowledgements section.
+        # Acknowledgements and executivesummary use IsoClauseSection
         attribute :acknowledgements, IsoClauseSection
-
-        # Executive summary section.
         attribute :executivesummary, IsoClauseSection
 
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
         xml do
           element "preface"
-          map_element "abstract", to: :abstract
-          map_element "foreword", to: :foreword
-          map_element "introduction", to: :introduction
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_elements(self)
           map_element "clause", to: :clause
-          map_element "acknowledgements", to: :acknowledgements
-          map_element "executivesummary", to: :executivesummary
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "displayorder", to: :displayorder
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
         end
       end
     end

data/lib/metanorma/iso_document/sections/iso_sections.rb

@@ -4,56 +4,46 @@ module Metanorma
   module IsoDocument
     module Sections
       # Main body of ISO/IEC document.
-      class IsoSections < Lutaml::Model::Serializable
-        # Notes applicable to the entire document (e.g. footnotes on title).
+      # Extends StandardDocument::Sections with ISO strict ordering:
+      #   (note | admonition)*, clause, (term-clause | terms)?, definitions?,
+      #   (clause | term-clause | terms)+
+      class IsoSections < Metanorma::StandardDocument::Sections::Sections
+        # Notes applicable to the entire document (appearing before clauses)
         attribute :note,
                   Metanorma::Document::Components::Blocks::NoteBlock,
                   collection: true
 
-        # Admonitions applicable to the entire document (appearing before the initial clause).
+        # Admonitions applicable to the entire document
         attribute :admonition,
                   Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
                   collection: true
 
-        # Terms & Definitions clause.
-        attribute :terms,
-                  IsoTermsSection
+        # Override: ISO terms is singular (zero or one), uses IsoTermsSection
+        attribute :terms, IsoTermsSection
 
-        # Symbols & Abbreviated Terms clause.
+        # Override: ISO definitions is singular (zero or one)
         attribute :definitions,
                   Metanorma::StandardDocument::Sections::DefinitionSection
 
-        # Normal Clauses.
-        attribute :clause,
-                  IsoClauseSection,
-                  collection: true
-
-        # References section (can appear inside <sections> in presentation XML).
-        attribute :references,
-                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
-                  collection: true
+        # Override: ISO clauses use IsoClauseSection
+        attribute :clause, IsoClauseSection, collection: true
 
-        # Initial paragraphs (document title repeated at start of sections in some flavours).
+        # Initial paragraphs (document title repeated at start of sections)
         attribute :p,
                   Metanorma::Document::Components::Paragraphs::ParagraphBlock,
                   collection: true
 
-        # Presentation-specific attributes
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
         xml do
           element "sections"
           ordered
-          map_element "note", to: :note
-          map_element "admonition", to: :admonition
-          map_element "terms", to: :terms
-          map_element "definitions", to: :definitions
-          map_element "clause", to: :clause
-          map_element "references", to: :references
+
+          map_element "note",         to: :note
+          map_element "admonition",   to: :admonition
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
           map_element "p", to: :p
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "displayorder", to: :displayorder
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
         end
       end
     end

data/lib/metanorma/iso_document/sections/iso_terms_section.rb

@@ -6,12 +6,16 @@ module Metanorma
       # Terms section specific to ISO/IEC documents.
       # Maps <terms> element with <title>, <p>, <ul>, <term> children.
       class IsoTermsSection < Lutaml::Model::Serializable
+        include Metanorma::StandardDocument::PresentationAttributes
+
         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
         attribute :p, RawParagraph, collection: true
         attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
@@ -43,28 +47,14 @@ module Metanorma
 
         # Nested clause sections inside terms
         attribute :clause, IsoClauseSection, collection: true
-        attribute :semx_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 :fmt_annotation_start,
-                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
-                  collection: true
-        attribute :fmt_annotation_end,
-                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
-                  collection: true
 
         xml do
           element "terms"
-          map_attribute "id", to: :id
-          map_attribute "anchor", to: :anchor
-          map_attribute "type", to: :type
-          map_attribute "number", to: :number
-          map_attribute "obligation", to: :obligation
-          map_attribute "inline-header", to: :inline_header
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
+
           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: :p
@@ -78,9 +68,6 @@ module Metanorma
           map_element "clause", to: :clause
           map_element "fmt-annotation-start", to: :fmt_annotation_start
           map_element "fmt-annotation-end", to: :fmt_annotation_end
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
         end
       end
     end

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

@@ -3,53 +3,8 @@
 module Metanorma
   module IsoDocument
     module Terms
-      # Name element inside a term expression.
-      # Has id and semx-id attributes in presentation XML.
-      # Contains mixed content with inline elements like strike, em, etc.
-      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
-
-      # Expression of a term designation.
-      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
+      TermNameElement = Metanorma::StandardDocument::Terms::TermNameElement
+      TermExpression = Metanorma::StandardDocument::Terms::TermExpression
     end
   end
 end

data/lib/metanorma/iso_document/terms/term_origin.rb

@@ -1,26 +1,4 @@
 # frozen_string_literal: true
 
-module Metanorma
-  module IsoDocument
-    module Terms
-      # Origin reference in a term source.
-      class TermOrigin < Lutaml::Model::Serializable
-        attribute :bibitemid, :string
-        attribute :type, :string
-        attribute :citeas, :string
-        attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
-                  collection: true
-        attribute :display_text, Metanorma::Document::Components::Inline::DisplayTextElement
-
-        xml do
-          element "origin"
-          map_attribute "bibitemid", to: :bibitemid
-          map_attribute "type", to: :type
-          map_attribute "citeas", to: :citeas
-          map_element "localityStack", to: :locality_stack
-          map_element "display-text", to: :display_text
-        end
-      end
-    end
-  end
-end
+Metanorma::IsoDocument::Terms::TermOrigin =
+  Metanorma::Document::Components::ReferenceElements::SourceOrigin

data/lib/metanorma/iso_document/terms/term_source.rb

@@ -1,40 +1,12 @@
 # frozen_string_literal: true
 
+Metanorma::IsoDocument::Terms::TermSource =
+  Metanorma::Document::Components::ReferenceElements::SourceElement
+
 module Metanorma
   module IsoDocument
     module Terms
-      # Modification element in term source, containing paragraphs.
-      class TermModification < Lutaml::Model::Serializable
-        attribute :id, :string
-        attribute :p, RawParagraph, collection: true
-
-        xml do
-          element "modification"
-          map_attribute "id", to: :id
-          map_element "p", to: :p
-        end
-      end
-
-      # Source of a term definition, with optional modification info.
-      class TermSource < Lutaml::Model::Serializable
-        attribute :id, :string
-        attribute :status, :string
-        attribute :type, :string
-        attribute :origin, TermOrigin
-        attribute :modification, TermModification
-
-        xml do
-          element "source"
-          map_attribute "id", to: :id
-          map_attribute "status", to: :status
-          map_attribute "type", to: :type
-          map_element "origin", to: :origin
-          map_element "modification", to: :modification
-        end
-      end
-
-      # Same structure as TermSource but mapped to the <termsource> element.
-      class TermsourceElement < TermSource
+      class TermsourceElement < Metanorma::Document::Components::ReferenceElements::SourceElement
         xml do
           element "termsource"
           map_attribute "id", to: :id

data/lib/metanorma/iso_document.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-
 module Metanorma
   module IsoDocument
     autoload :AnnotationContainer, "metanorma/iso_document/annotation_container"
@@ -14,3 +12,5 @@ module Metanorma
     autoload :Terms, "metanorma/iso_document/terms"
   end
 end
+
+Metanorma::Registers::Setup.setup_iso_register