metanorma-document 0.2.6 → 0.2.7

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

@@ -12,6 +12,9 @@ module Metanorma
         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,
@@ -58,12 +61,9 @@ module Metanorma
 
         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 "fmt-title", to: :fmt_title
           map_element "fmt-xref-label", to: :fmt_xref_label
@@ -78,9 +78,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

data/lib/metanorma/itu_document/root.rb

@@ -1,64 +1,24 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module ItuDocument
-    class Root < Metanorma::StandardDocument::Root
-      attribute :version, :string
-      attribute :type, :string
-      attribute :schema_version, :string
-      attribute :flavor, :string
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
 
       attribute :bibdata, Metadata::ItuBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
                 collection: true
 
-      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
-      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
-                collection: true
-      attribute :bibliography,
-                Metanorma::StandardDocument::Sections::BibliographySection
-      attribute :boilerplate, Metanorma::IsoDocument::Boilerplate
-      attribute :metanorma_extension,
-                Metanorma::IsoDocument::Metadata::MetanormaExtension
-      attribute :annotation_container, Metanorma::IsoDocument::AnnotationContainer
-      attribute :indexsect,
-                Metanorma::Document::Components::Sections::BasicSection
-      attribute :autonum, :string
-      attribute :fmt_xref_label, :string
-      attribute :localized_strings,
-                Metanorma::Document::Components::Inline::LocalizedStringsElement
-      attribute :fmt_footnote_container,
-                Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
-      attribute :colophon, Metanorma::IsoDocument::Sections::Colophon
-
       xml do
         element "metanorma"
         namespace Metanorma::StandardDocument::Namespace
-        map_attribute "type", to: :type
-        map_attribute "version", to: :version
-        map_attribute "schema-version", to: :schema_version
-        map_attribute "flavor", to: :flavor
-        map_element "bibdata", to: :bibdata
-        map_element "termdocsource", to: :term_sources
-        map_element "metanorma-extension", to: :metanorma_extension
-        map_element "boilerplate", to: :boilerplate
-        map_element "preface", to: :preface
-        map_element "sections", to: :sections
-        map_element "annex", to: :annex
-        map_element "bibliography", to: :bibliography
-        map_element "annotation-container", to: :annotation_container
-        map_element "indexsect", to: :indexsect
-        map_element "localized-strings", to: :localized_strings
-        map_element "fmt-footnote-container", to: :fmt_footnote_container
-        map_element "colophon", to: :colophon
-        map_attribute "autonum", to: :autonum
-        map_attribute "fmt-xref-label", to: :fmt_xref_label
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
       end
     end
   end

data/lib/metanorma/itu_document.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-
 module Metanorma
   module ItuDocument
     autoload :Metadata, "metanorma/itu_document/metadata"

data/lib/metanorma/jis_document/metadata/jis_bib_data_extension_type.rb

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

data/lib/metanorma/jis_document/metadata/jis_bibliographic_item.rb

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

data/lib/metanorma/jis_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Metadata
+      autoload :JisBibDataExtensionType,
+               "#{__dir__}/metadata/jis_bib_data_extension_type"
+      autoload :JisBibliographicItem,
+               "#{__dir__}/metadata/jis_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/jis_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :jis_document
+      end
+
+      attribute :bibdata, Metadata::JisBibliographicItem
+      attribute :preface,
+                Metanorma::IsoDocument::Sections::IsoPreface
+      attribute :sections,
+                Metanorma::IsoDocument::Sections::IsoSections
+      attribute :annex,
+                JisDocument::Sections::JisAnnexSection,
+                collection: true
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+      end
+    end
+  end
+end

data/lib/metanorma/jis_document/sections/jis_annex_section.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Sections
+      class JisAnnexSection < Metanorma::IsoDocument::Sections::IsoAnnexSection
+        attribute :commentary, :string
+
+        xml do
+          element "annex"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          map_attribute "commentary", to: :commentary
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/jis_document/sections.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Sections
+      autoload :JisAnnexSection, "#{__dir__}/sections/jis_annex_section"
+    end
+  end
+end

data/lib/metanorma/jis_document.rb

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

data/lib/metanorma/m3d_document/metadata/m3d_bib_data_extension_type.rb

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

data/lib/metanorma/m3d_document/metadata/m3d_bibliographic_item.rb

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

data/lib/metanorma/m3d_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    module Metadata
+      autoload :M3dBibDataExtensionType,
+               "#{__dir__}/metadata/m3d_bib_data_extension_type"
+      autoload :M3dBibliographicItem,
+               "#{__dir__}/metadata/m3d_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/m3d_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :m3d_document
+      end
+
+      attribute :bibdata, Metadata::M3dBibliographicItem
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      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/m3d_document.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    autoload :Metadata, "metanorma/m3d_document/metadata"
+    autoload :Root, "metanorma/m3d_document/root"
+  end
+end
+
+Metanorma::Registers::Setup.setup_m3d_register

data/lib/metanorma/nist_document/metadata/nist_bib_data_extension_type.rb

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

data/lib/metanorma/nist_document/metadata/nist_bibliographic_item.rb

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

data/lib/metanorma/nist_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Metadata
+      autoload :NistBibDataExtensionType,
+               "#{__dir__}/metadata/nist_bib_data_extension_type"
+      autoload :NistBibliographicItem,
+               "#{__dir__}/metadata/nist_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/nist_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :nist_document
+      end
+
+      attribute :bibdata, Metadata::NistBibliographicItem
+      attribute :preface,
+                NistDocument::Sections::NistPreface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      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