metanorma-document 0.2.6 → 0.2.7

data/lib/metanorma/html/theme.rb

@@ -82,7 +82,7 @@ module Metanorma
         @example_bg      = "rgba(232, 248, 245, 0.6)"
         @example_border  = "#0d9488"
         @admonition_color = "#b8860b"
-        @admonition_bg   = "rgba(255, 252, 245, 0.8)"
+        @admonition_bg = "rgba(255, 252, 245, 0.8)"
         @admonition_border = "#e8a820"
         @footer_border_color = nil
         @cover_separator_color = nil
@@ -92,7 +92,7 @@ module Metanorma
         @cover_after_bg    = nil
         @cover_before_bg   = nil
         @progress_bar_color = nil
-        @extra_css         = nil
+        @extra_css = nil
 
         # Dark mode defaults
         @dark_bg          = "#0f1118"

data/lib/metanorma/html.rb

@@ -1,9 +1,56 @@
 # frozen_string_literal: true
 
-require "metanorma/html/whitespace_patch"
+require "liquid"
+require "nokogiri"
 
 module Metanorma
   module Html
+    unless defined?(TEMPLATES_ROOT)
+      TEMPLATES_ROOT = File.join(__dir__, "html", "templates")
+
+      Liquid::Environment.default.file_system = Liquid::LocalFileSystem.new(
+        TEMPLATES_ROOT, "_%s.html.liquid"
+      )
+
+      Moxml::Adapter::Nokogiri.class_eval do
+        class << self
+          alias_method :_original_children_patched, :children
+          remove_method :children
+        end
+
+        def self.children(node)
+          node.children.to_a
+        end
+      end
+
+      Lutaml::Xml::XmlElement.class_eval do
+        remove_method :order
+
+        def order
+          return @order_cache if @order_cache
+
+          @order_cache = children.filter_map do |child|
+            if child.text?
+              Lutaml::Xml::Element.new("Text", "text",
+                                       text_content: child.text,
+                                       node_type: :text)
+            elsif child.cdata?
+              Lutaml::Xml::Element.new("Text", "#cdata-section",
+                                       text_content: child.text,
+                                       node_type: :cdata)
+            elsif child.comment?
+              nil
+            else
+              Lutaml::Xml::Element.new("Element", child.unprefixed_name,
+                                       node_type: :element,
+                                       namespace_uri: child.namespace_uri,
+                                       namespace_prefix: child.namespace_prefix)
+            end
+          end
+        end
+      end
+    end
+
     autoload :BaseRenderer, "metanorma/html/base_renderer"
     autoload :Generator, "metanorma/html/generator"
     autoload :Theme, "metanorma/html/theme"

data/lib/metanorma/iec_document/root.rb

@@ -1,65 +1,26 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module IecDocument
-    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
+
+      def self.lutaml_default_register
+        :iec_document
+      end
 
       attribute :bibdata,
                 Metanorma::IsoDocument::Metadata::IsoBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
-                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/iec_document.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module IecDocument
     autoload :Root, "metanorma/iec_document/root"
   end
 end
+
+Metanorma::Registers::Setup.setup_iec_register

data/lib/metanorma/ieee_document/root.rb

@@ -1,64 +1,28 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module IeeeDocument
-    class Root < Metanorma::StandardDocument::Root
-      attribute :version, :string
-      attribute :type, :string
-      attribute :schema_version, :string
-      attribute :flavor, :string
-
-      attribute :bibdata, Metadata::IeeeBibliographicItem
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
 
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
-                collection: true
+      def self.lutaml_default_register
+        :ieee_document
+      end
 
-      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
-      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
+      attribute :bibdata, Metadata::IeeeBibliographicItem
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                IeeeDocument::Sections::IeeeSections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
                 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/ieee_document/sections/ieee_sections.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IeeeDocument
+    module Sections
+      # IEEE sections container.
+      # Corresponds to ieee.rnc:
+      #   sections = element sections {
+      #     note?,
+      #     ( clause | terms | term-clause | definitions | floating-title )+
+      #   }
+      #
+      # Differs from isodoc default by adding an optional leading note.
+      class IeeeSections < Metanorma::StandardDocument::Sections::Sections
+        attribute :note,
+                  Metanorma::Document::Components::Blocks::NoteBlock
+
+        xml do
+          element "sections"
+          ordered
+
+          map_element "note", to: :note
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ieee_document/sections.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IeeeDocument
+    module Sections
+      autoload :IeeeSections, "#{__dir__}/sections/ieee_sections"
+    end
+  end
+end

data/lib/metanorma/ieee_document.rb

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

data/lib/metanorma/ietf_document/metadata/ietf_bib_data_extension_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
 module Metanorma
   module IetfDocument
     module Metadata

data/lib/metanorma/ietf_document/metadata/ietf_bibliographic_item.rb

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

data/lib/metanorma/ietf_document/root.rb

@@ -1,65 +1,29 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-require_relative "metadata"
-require_relative "sections"
-
 module Metanorma
   module IetfDocument
-    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
+
+      def self.lutaml_default_register
+        :ietf_document
+      end
 
       attribute :bibdata,
                 Metanorma::IetfDocument::Metadata::IetfBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::IetfDocument::Sections::IetfSections
+      attribute :annex,
+                Metanorma::IetfDocument::Sections::IetfAnnexSection,
                 collection: true
 
-      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections, Metanorma::IetfDocument::Sections::IetfSections
-      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 :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/ietf_document/sections/ietf_annex_section.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IetfDocument
+    module Sections
+      class IetfAnnexSection < Metanorma::StandardDocument::Sections::AnnexSection
+        # IETF-specific attributes
+        attribute :numbered, :string
+        attribute :remove_in_rfc, :string
+
+        # Sub-clauses within IETF annex use IetfClauseSection
+        attribute :clause, IetfClauseSection, collection: true
+
+        xml do
+          element "annex"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          map_attribute "numbered",    to: :numbered
+          map_attribute "removeInRFC", to: :remove_in_rfc
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IetfDocument
+    module Sections
+      class IetfClauseSection < Metanorma::StandardDocument::Sections::ClauseSection
+        # IETF-specific attributes
+        attribute :numbered, :string
+        attribute :remove_in_rfc, :string
+
+        # Recursive IETF sub-clauses
+        attribute :clause, IetfClauseSection, collection: true
+
+        xml do
+          element "clause"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
+          map_attribute "numbered",    to: :numbered
+          map_attribute "removeInRFC", to: :remove_in_rfc
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IetfDocument
+    module Sections
+      class IetfContentSection < Metanorma::StandardDocument::Sections::ContentSection
+        attribute :numbered, :string
+        attribute :remove_in_rfc, :string
+
+        # Recursive IETF sub-clauses
+        attribute :subsection, IetfContentSection, collection: true
+
+        xml do
+          element "clause"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
+          map_attribute "numbered",       to: :numbered
+          map_attribute "removeInRFC",    to: :remove_in_rfc
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
+        end
+      end
+    end
+  end
+end

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"