metanorma-document 0.2.5 → 0.2.7

data/lib/metanorma/basic_document/lists.rb

@@ -6,6 +6,7 @@ module Metanorma
       autoload :Definition, "#{__dir__}/lists/definition"
       autoload :DefinitionList, "#{__dir__}/lists/definition_list"
       autoload :List, "#{__dir__}/lists/list"
+      autoload :ListItem, "#{__dir__}/lists/list_item"
       autoload :OrderedList, "#{__dir__}/lists/ordered_list"
       autoload :OrderedListType, "#{__dir__}/lists/ordered_list_type"
       autoload :UnorderedList, "#{__dir__}/lists/unordered_list"

data/lib/metanorma/basic_document/paragraphs/paragraph_with_footnote.rb

@@ -9,7 +9,9 @@ module Metanorma
       # annotations).
       class ParagraphWithFootnote < Metanorma::BasicDocument::Paragraphs::ParagraphBlock
         # Footnotes contained in the paragraph.
-        attribute :footnotes, BasicObject, collection: true # But actually: ReferenceToldWithParagraphElement
+        attribute :footnotes,
+                  Metanorma::BasicDocument::ReferenceElements::Footnote,
+                  collection: true
 
         xml do
           element "paragraph-with-footnote"

data/lib/metanorma/basic_document/reference_elements/callout.rb

@@ -7,7 +7,7 @@ module Metanorma
       # The target of the callout is understood to be the location of the callout within the source code;
       # the extent of the target is not expressed overtly.
       class Callout < Metanorma::BasicDocument::ReferenceElements::ReferenceToIdElement
-        attribute :type, BasicObject
+        attribute :type, :string
         attribute :text, Metanorma::BasicDocument::TextElements::TextElement
 
         xml do

data/lib/metanorma/basic_document/reference_elements/footnote.rb

@@ -5,7 +5,7 @@ module Metanorma
     module ReferenceElements
       # Inline reference to a paragraph or paragraphs, appearing as a footnote.
       class Footnote < Metanorma::BasicDocument::ReferenceElements::ReferenceToIdWithParagraphElement
-        attribute :type, BasicObject
+        attribute :type, :string
 
         xml do
           element "footnote"

data/lib/metanorma/basic_document/text_elements/mathml.rb

@@ -5,7 +5,7 @@ module Metanorma
     module TextElements
       # Mathematical text formatted in MathML.
       class Mathml < Metanorma::BasicDocument::TextElements::StemValue
-        attribute :value, BasicObject
+        attribute :value, :string
 
         xml do
           element "mathml"

data/lib/metanorma/bipm_document/root.rb

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

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

data/lib/metanorma/bsi_document/metadata/bsi_bib_data_extension_type.rb

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

data/lib/metanorma/bsi_document/metadata/bsi_bibliographic_item.rb

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

data/lib/metanorma/bsi_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Metadata
+      autoload :BsiBibDataExtensionType,
+               "#{__dir__}/metadata/bsi_bib_data_extension_type"
+      autoload :BsiBibliographicItem,
+               "#{__dir__}/metadata/bsi_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/bsi_document/root.rb

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

data/lib/metanorma/bsi_document/sections/bsi_annex_section.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      class BsiAnnexSection < Metanorma::IsoDocument::Sections::IsoAnnexSection
+        attribute :clause, BsiClauseSection, collection: true
+
+        attribute :floating_section_title,
+                  Metanorma::StandardDocument::Sections::FloatingSectionTitle,
+                  collection: true
+
+        xml do
+          element "annex"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
+
+          map_element "section-title", to: :floating_section_title
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bsi_document/sections/bsi_clause_section.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      class BsiClauseSection < Metanorma::IsoDocument::Sections::IsoClauseSection
+        attribute :clause, BsiClauseSection, collection: true
+
+        attribute :floating_section_title,
+                  Metanorma::StandardDocument::Sections::FloatingSectionTitle,
+                  collection: true
+
+        xml do
+          element "clause"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
+
+          map_element "section-title", to: :floating_section_title
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bsi_document/sections/bsi_sections.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      class BsiSections < Metanorma::IsoDocument::Sections::IsoSections
+        attribute :floating_section_title,
+                  Metanorma::StandardDocument::Sections::FloatingSectionTitle,
+                  collection: true
+
+        xml do
+          element "sections"
+          ordered
+
+          map_element "note",           to: :note
+          map_element "admonition",     to: :admonition
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
+          map_element "p",              to: :p
+          map_element "section-title",  to: :floating_section_title
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bsi_document/sections.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      autoload :BsiAnnexSection, "#{__dir__}/sections/bsi_annex_section"
+      autoload :BsiClauseSection, "#{__dir__}/sections/bsi_clause_section"
+      autoload :BsiSections, "#{__dir__}/sections/bsi_sections"
+    end
+  end
+end

data/lib/metanorma/bsi_document.rb

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

data/lib/metanorma/cc_document/root.rb

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

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

data/lib/metanorma/collection.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/iso_document"
-
 module Metanorma
   module Collection
     autoload :Root, "metanorma/collection/root"

data/lib/metanorma/document/components/ancillary_blocks/example_block.rb

@@ -59,11 +59,11 @@ module Metanorma
                     collection: true
 
           # Requirement/recommendation/permission blocks inside examples.
-          attribute :requirement, "Metanorma::StandardDocument::Blocks::RequirementModel",
+          attribute :requirement, "Metanorma::Document::Components::Blocks::RequirementModel",
                     collection: true
-          attribute :recommendation, "Metanorma::StandardDocument::Blocks::RecommendationModel",
+          attribute :recommendation, "Metanorma::Document::Components::Blocks::RecommendationModel",
                     collection: true
-          attribute :permission, "Metanorma::StandardDocument::Blocks::PermissionModel",
+          attribute :permission, "Metanorma::Document::Components::Blocks::PermissionModel",
                     collection: true
 
           # Paragraph blocks contributing to example content.

data/lib/metanorma/document/components/ancillary_blocks/figure_block.rb

@@ -31,6 +31,7 @@ module Metanorma
           attribute :displayorder, :integer
           attribute :height, :string
           attribute :width, :string
+          attribute :align, :string
 
           # The image file to be included in the figure as its main content.
           attribute :image, Metanorma::Document::Components::IdElements::Image
@@ -89,6 +90,7 @@ module Metanorma
             map_attribute "displayorder", to: :displayorder
             map_attribute "height", to: :height
             map_attribute "width", to: :width, render_empty: true
+            map_attribute "align", to: :align
             map_attribute "source", to: :source
             map_attribute "unnumbered", to: :unnumbered
             map_attribute "subsequence", to: :subsequence

data/lib/metanorma/document/components/ancillary_blocks/sourcecode_block.rb

@@ -61,6 +61,7 @@ module Metanorma
 
           # Whether callout markers are displayed
           attribute :markers, :string
+          attribute :alt, :string
 
           # The computer code or other such text presented in the block, as a single unformatted string. (The
           # string should be treated as pre-formatted text, with whitespace treated as significant.)
@@ -109,6 +110,7 @@ module Metanorma
             map_attribute "filename", to: :filename
             map_attribute "lang", to: :lang
             map_attribute "markers", to: :markers
+            map_attribute "alt", to: :alt
             map_content to: :content
             map_element "body", to: :body
             map_element "callout", to: :callouts

data/lib/metanorma/document/components/blocks/passthrough.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class Passthrough < BasicBlockNoNotes
+          attribute :formats, :string
+          attribute :content, :string
+
+          xml do
+            element "passthrough"
+            map_attribute "id", to: :id
+            map_attribute "formats", to: :formats
+            map_content to: :content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/blocks/requirement_model.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class ClassificationValue < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :link, Metanorma::Document::Components::Inline::LinkElement,
+                    collection: true
+
+          xml do
+            mixed_content
+            map_content to: :text
+            map_element "link", to: :link
+          end
+        end
+
+        class RequirementClassification < Lutaml::Model::Serializable
+          attribute :tag, :string
+          attribute :value, ClassificationValue
+
+          xml do
+            element "classification"
+            map_element "tag", to: :tag
+            map_element "value", to: :value
+          end
+        end
+
+        class RequirementDescription < Lutaml::Model::Serializable
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+          attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                    collection: true
+          attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                    collection: true
+          attribute :sourcecode,
+                    Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
+                    collection: true
+          attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                    collection: true
+          attribute :example,
+                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                    collection: true
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+          attribute :figure,
+                    Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
+                    collection: true
+
+          xml do
+            element "description"
+            map_element "p", to: :p
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "sourcecode", to: :sourcecode
+            map_element "table", to: :table
+            map_element "example", to: :example
+            map_element "note", to: :note
+            map_element "figure", to: :figure
+          end
+        end
+
+        class RequirementInherit < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
+                    collection: true
+          attribute :xref, Metanorma::Document::Components::Inline::XrefElement,
+                    collection: true
+
+          xml do
+            mixed_content
+            map_content to: :text
+            map_element "eref", to: :eref
+            map_element "xref", to: :xref
+          end
+        end
+
+        class RequirementBase < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :model, :string
+          attribute :obligation, :string
+          attribute :type, :string
+          attribute :anchor, :string
+          attribute :subject, :string
+          attribute :classification, RequirementClassification, collection: true
+          attribute :description, RequirementDescription, collection: true
+          attribute :inherit, RequirementInherit, collection: true
+          attribute :requirement, "Metanorma::Document::Components::Blocks::RequirementModel",
+                    collection: true
+          attribute :recommendation, "Metanorma::Document::Components::Blocks::RecommendationModel",
+                    collection: true
+          attribute :permission, "Metanorma::Document::Components::Blocks::PermissionModel",
+                    collection: true
+          attribute :example,
+                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                    collection: true
+        end
+
+        class RequirementModel < RequirementBase
+          xml do
+            element "requirement"
+            map_attribute "id", to: :id
+            map_attribute "model", to: :model
+            map_attribute "obligation", to: :obligation
+            map_attribute "type", to: :type
+            map_attribute "anchor", to: :anchor
+            map_element "subject", to: :subject
+            map_element "classification", to: :classification
+            map_element "description", to: :description
+            map_element "inherit", to: :inherit
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "example", to: :example
+          end
+        end
+
+        class RecommendationModel < RequirementBase
+          xml do
+            element "recommendation"
+            map_attribute "id", to: :id
+            map_attribute "model", to: :model
+            map_attribute "obligation", to: :obligation
+            map_attribute "type", to: :type
+            map_attribute "anchor", to: :anchor
+            map_element "subject", to: :subject
+            map_element "classification", to: :classification
+            map_element "description", to: :description
+            map_element "inherit", to: :inherit
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "example", to: :example
+          end
+        end
+
+        class PermissionModel < RequirementBase
+          xml do
+            element "permission"
+            map_attribute "id", to: :id
+            map_attribute "model", to: :model
+            map_attribute "obligation", to: :obligation
+            map_attribute "type", to: :type
+            map_attribute "anchor", to: :anchor
+            map_element "subject", to: :subject
+            map_element "classification", to: :classification
+            map_element "description", to: :description
+            map_element "inherit", to: :inherit
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "example", to: :example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/blocks.rb

@@ -7,6 +7,16 @@ module Metanorma
         autoload :BasicBlock, "#{__dir__}/blocks/basic_block"
         autoload :BasicBlockNoNotes, "#{__dir__}/blocks/basic_block_no_notes"
         autoload :NoteBlock, "#{__dir__}/blocks/note_block"
+        autoload :Passthrough, "#{__dir__}/blocks/passthrough"
+        autoload :ClassificationValue, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementClassification,
+                 "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementDescription, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementInherit, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementBase, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementModel, "#{__dir__}/blocks/requirement_model"
+        autoload :RecommendationModel, "#{__dir__}/blocks/requirement_model"
+        autoload :PermissionModel, "#{__dir__}/blocks/requirement_model"
       end
     end
   end