metanorma-document 0.2.5 → 0.2.7

data/lib/metanorma/ietf_document/sections/ietf_sections.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IetfDocument
+    module Sections
+      # IETF sections container.
+      # Corresponds to ietf.rnc:
+      #   sections = element sections {
+      #     ( clause | terms | term-clause | definitions | floating-title )+
+      #   }
+      #
+      # Extends StandardDocument sections with loose bibitem references
+      # and paragraph elements directly inside sections.
+      class IetfSections < Metanorma::StandardDocument::Sections::Sections
+        attribute :bibitem,
+                  Metanorma::BasicDocument::BibData::BibliographicItem,
+                  collection: true
+        attribute :p,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+
+        xml do
+          element "sections"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
+          map_element "bibitem",        to: :bibitem
+          map_element "p",              to: :p
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ietf_document/sections.rb

@@ -1,31 +1,12 @@
 # frozen_string_literal: true
 
-require "metanorma/iso_document"
-
 module Metanorma
   module IetfDocument
     module Sections
-      class IetfSections < Metanorma::IsoDocument::Sections::IsoSections
-        # Loose bibliographic items appearing directly inside sections.
-        attribute :bibitem,
-                  Metanorma::BasicDocument::BibData::BibliographicItem,
-                  collection: true
-
-        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 "bibitem", to: :bibitem
-          map_element "p", to: :p
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "displayorder", to: :displayorder
-        end
-      end
+      autoload :IetfSections, "#{__dir__}/sections/ietf_sections"
+      autoload :IetfContentSection, "#{__dir__}/sections/ietf_content_section"
+      autoload :IetfClauseSection, "#{__dir__}/sections/ietf_clause_section"
+      autoload :IetfAnnexSection, "#{__dir__}/sections/ietf_annex_section"
     end
   end
 end

data/lib/metanorma/ietf_document.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module IetfDocument
+    autoload :Metadata, "metanorma/ietf_document/metadata"
     autoload :Root, "metanorma/ietf_document/root"
+    autoload :Sections, "metanorma/ietf_document/sections"
   end
 end
+
+Metanorma::Registers::Setup.setup_ietf_register

data/lib/metanorma/iho_document/metadata/iho_bib_data_extension_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/iso_document"
-
 module Metanorma
   module IhoDocument
     module Metadata

data/lib/metanorma/iho_document/root.rb

@@ -1,64 +1,24 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module IhoDocument
-    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::IhoBibliographicItem
-
-      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/iho_document.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module IhoDocument
     autoload :Metadata, "metanorma/iho_document/metadata"

data/lib/metanorma/iso_document/annotation_container.rb

@@ -2,15 +2,6 @@
 
 module Metanorma
   module IsoDocument
-    # Container for review annotations. Uses map_all_content to preserve
-    # mixed content including annotation elements with their p children.
-    class AnnotationContainer < Lutaml::Model::Serializable
-      attribute :content, :string
-
-      xml do
-        element "annotation-container"
-        map_all_content to: :content
-      end
-    end
+    AnnotationContainer = Metanorma::StandardDocument::AnnotationContainer
   end
 end

data/lib/metanorma/iso_document/boilerplate.rb

@@ -2,16 +2,6 @@
 
 module Metanorma
   module IsoDocument
-    # Boilerplate section containing copyright statements and license text.
-    # Uses map_all_content to preserve all child XML including inline
-    # elements (span, link, br) inside paragraphs.
-    class Boilerplate < Lutaml::Model::Serializable
-      attribute :content, :string
-
-      xml do
-        element "boilerplate"
-        map_all_content to: :content
-      end
-    end
+    Boilerplate = Metanorma::StandardDocument::Boilerplate
   end
 end

data/lib/metanorma/iso_document/metadata/iso_bibliographic_item.rb

@@ -158,10 +158,10 @@ module Metanorma
           if titles.is_a?(TitleCollection)
             titles.for_language(language)
           elsif titles.is_a?(Array)
-            titles.find { |t|
+            titles.find do |t|
               lang = safe_attr(t, :language) || safe_attr(t, :lang)
               lang == language
-            }
+            end
           end
         end
 

data/lib/metanorma/iso_document/metadata/iso_localized_title.rb

@@ -41,14 +41,15 @@ module Metanorma
           if title_part
             prefix = title_part_prefix&.value.to_s.strip
             part_val = title_part.value
-            if !prefix.empty?
+            if prefix.empty?
+              parts << part_val
+            else
               sep = prefix.end_with?(":") ? " " : ": "
               parts << "#{prefix}#{sep}#{part_val}"
-            else
-              parts << part_val
             end
           end
           return parts.join(" — ") unless parts.empty?
+
           ""
         end
       end

data/lib/metanorma/iso_document/metadata/metanorma_extension.rb

@@ -3,18 +3,7 @@
 module Metanorma
   module IsoDocument
     module Metadata
-      # Container for metanorma-specific extensions (semantic-metadata,
-      # presentation-metadata, UnitsML). Uses map_all_content to preserve
-      # all child XML as raw string since these elements have complex
-      # namespace-qualified structures.
-      class MetanormaExtension < Lutaml::Model::Serializable
-        attribute :content, :string
-
-        xml do
-          element "metanorma-extension"
-          map_all_content to: :content
-        end
-      end
+      MetanormaExtension = Metanorma::StandardDocument::Metadata::MetanormaExtension
     end
   end
 end

data/lib/metanorma/iso_document/root.rb

@@ -2,90 +2,24 @@
 
 module Metanorma
   module IsoDocument
-    class Root < Metanorma::StandardDocument::Root
-      # Version number of the schema used for this standards document.
-      attribute :version, :string
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
 
-      # Type of the document (semantic, presentation).
-      attribute :type, :string
-
-      # Schema version.
-      attribute :schema_version, :string
-
-      # Document flavor (iso, standoc, etc).
-      attribute :flavor, :string
+      def self.lutaml_default_register
+        :iso_document
+      end
 
-      # Bibliographic description of the document itself, expressed in the Relaton
-      # model.
       attribute :bibdata, Metanorma::IsoDocument::Metadata::IsoBibliographicItem
-
-      # Citations for sources of term definitions.
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
-                collection: true
-
-      # Zero or more optional _preface_ sections.
       attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-
-      # One or more _sections_.
       attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
-
-      # Zero or more _annexes_.
       attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
                 collection: true
 
-      # Zero to two _bibliographies_.
-      attribute :bibliography,
-                Metanorma::StandardDocument::Sections::BibliographySection
-
-      # Boilerplate section (copyright statements, license text).
-      attribute :boilerplate, Boilerplate
-
-      # Metanorma-specific extensions (semantic-metadata, presentation-metadata, UnitsML).
-      attribute :metanorma_extension, Metadata::MetanormaExtension
-
-      # Container for review annotations.
-      attribute :annotation_container, AnnotationContainer
-
-      # Index of a standards document.
-      attribute :indexsect,
-                Metanorma::Document::Components::Sections::BasicSection
-
-      # Presentation-specific attributes
-      attribute :autonum, :string
-      attribute :fmt_xref_label, :string
-
-      # Localized strings container (presentation XML)
-      attribute :localized_strings, Metanorma::Document::Components::Inline::LocalizedStringsElement
-
-      # Formatted footnote container (presentation XML)
-      attribute :fmt_footnote_container, Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
-
-      # Colophon section (presentation XML)
-      attribute :colophon, 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/iso_document/sections/colophon.rb

@@ -1,18 +1,3 @@
 # frozen_string_literal: true
 
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Colophon section in presentation XML.
-      # Contains document control information.
-      class Colophon < Lutaml::Model::Serializable
-        attribute :clause, IsoClauseSection, collection: true
-
-        xml do
-          element "colophon"
-          map_element "clause", to: :clause
-        end
-      end
-    end
-  end
-end
+Metanorma::IsoDocument::Sections::Colophon = Metanorma::StandardDocument::Sections::Colophon

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

@@ -4,146 +4,24 @@ module Metanorma
   module IsoDocument
     module Sections
       # Annex appearing in ISO/IEC document.
-      class IsoAnnexSection < Lutaml::Model::Serializable
-        attribute :id, :string
-        attribute :number, :string
-        attribute :obligation, :string
-        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+      # Inherits structure from StandardDocument::AnnexSection and overrides
+      # clause/appendix/terms to use ISO-specific types.
+      class IsoAnnexSection < Metanorma::StandardDocument::Sections::AnnexSection
+        # Override: ISO sub-clauses are IsoClauseSection
+        attribute :clause, IsoClauseSection, collection: true
 
-        # Sub-clauses within annex.
-        attribute :clause, IsoClauseSection,
-                  collection: true
+        # Override: ISO appendixes are IsoClauseSection
+        attribute :appendix, IsoClauseSection, collection: true
 
-        # Appendixes to annex.
-        attribute :appendix, 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
-
-        # Terms sections within annex
-        attribute :terms,
-                  IsoTermsSection, collection: true
-
-        # Definitions sections within annex
-        attribute :definitions,
-                  Metanorma::StandardDocument::Sections::DefinitionSection,
-                  collection: true
-
-        # References sections within annex
-        attribute :references,
-                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
-                  collection: true
-
-        # Page breaks
-        attribute :pagebreak,
-                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
-                  collection: true
-
-        # Presentation-specific attributes
-        attribute :semx_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
-        attribute :inline_header, :string
-        attribute :anchor, :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
+        # Override: ISO terms sections use IsoTermsSection
+        attribute :terms, IsoTermsSection, collection: true
 
         xml do
           element "annex"
           ordered
-          map_attribute "id", to: :id
-          map_attribute "number", to: :number
-          map_attribute "obligation", to: :obligation, render_empty: true
-          map_attribute "anchor", to: :anchor
-          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 "appendix", to: :appendix
-          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 "terms", to: :terms
-          map_element "definitions", to: :definitions
-          map_element "references", to: :references
-          map_element "pagebreak", to: :pagebreak
-          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
-          map_attribute "inline-header", to: :inline_header
-          map_attribute "language", to: :language, render_empty: true
-          map_attribute "script", to: :script, render_empty: true
-        end
 
-        # Blocks in document order
-        def blocks
-          @blocks ||=
-            begin
-              result = []
-              each_mixed_content do |node|
-                result << node unless node.is_a?(String)
-              end
-              result
-            end
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
         end
 
         json do