metanorma-document 0.2.8 → 0.2.12

data/lib/metanorma/standard_document/annotation_container.rb

@@ -3,11 +3,34 @@
 module Metanorma
   module StandardDocument
     class AnnotationContainer < Lutaml::Model::Serializable
-      attribute :content, :string
+      class Annotation < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :reviewer, :string
+        attribute :from, :string
+        attribute :to, :string
+        attribute :type, :string
+        attribute :date, :string
+        attribute :paragraphs,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+
+        xml do
+          element "annotation"
+          map_attribute "id", to: :id
+          map_attribute "reviewer", to: :reviewer
+          map_attribute "from", to: :from
+          map_attribute "to", to: :to
+          map_attribute "type", to: :type
+          map_attribute "date", to: :date
+          map_element "p", to: :paragraphs
+        end
+      end
+
+      attribute :annotations, Annotation, collection: true
 
       xml do
         element "annotation-container"
-        map_all_content to: :content
+        map_element "annotation", to: :annotations
       end
     end
   end

data/lib/metanorma/standard_document/block_attributes.rb

@@ -52,14 +52,27 @@ module Metanorma
     end
 
     # Provides `blocks` method for ordered-content section types.
-    # Returns child nodes in document order via `each_mixed_content`.
+    # Returns child block-level nodes in document order via `each_mixed_content`,
+    # excluding metadata/inline elements like titles and annotations.
     module OrderedContent
+      NON_BLOCK_TYPES = [
+        Metanorma::Document::Components::Inline::TitleWithAnnotationElement,
+        Metanorma::Document::Components::Inline::FmtTitleElement,
+        Metanorma::Document::Components::Inline::VariantTitleElement,
+        Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+        Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
+        Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
+      ].freeze
+
       def blocks
         @blocks ||=
           begin
             result = []
             each_mixed_content do |node|
-              result << node unless node.is_a?(String)
+              next if node.is_a?(String)
+              next if NON_BLOCK_TYPES.any? { |t| node.is_a?(t) }
+
+              result << node
             end
             result
           end

data/lib/metanorma/standard_document/blocks/amend_content_block.rb

@@ -4,12 +4,30 @@ module Metanorma
   module StandardDocument
     module Blocks
       # Content block for amend description and new-content elements.
-      # Uses map_all_content to preserve all children (p, ol, ul, table, etc.)
+      # Contains block-level content: paragraphs, notes, lists, tables, etc.
       class AmendContentBlock < Lutaml::Model::Serializable
-        attribute :content, :string
+        attribute :paragraphs,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+        attribute :note,
+                  Metanorma::Document::Components::Blocks::NoteBlock,
+                  collection: true
+        attribute :ol,
+                  Metanorma::Document::Components::Lists::OrderedList,
+                  collection: true
+        attribute :ul,
+                  Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :dl,
+                  Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
 
         xml do
-          map_all_content to: :content
+          map_element "p", to: :paragraphs
+          map_element "note", to: :note
+          map_element "ol", to: :ol
+          map_element "ul", to: :ul
+          map_element "dl", to: :dl
         end
       end
     end

data/lib/metanorma/standard_document/blocks/block_source.rb

@@ -3,29 +3,6 @@
 module Metanorma
   module StandardDocument
     module Blocks
-      # Reference origin within a block source: <origin bibitemid="..." citeas="...">
-      # Schema: isodoc.rnc — origin = element origin { erefType | termref }
-      class SourceOriginElement < Lutaml::Model::Serializable
-        attribute :bibitemid, :string
-        attribute :type, :string
-        attribute :citeas, :string
-        attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
-                  collection: true
-
-        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
-        end
-      end
-
-      # Bibliographic source for a block: <source status="..." type="...">
-      #   <origin bibitemid="..." citeas="..."/>
-      #   <modification>...</modification>?
-      # </source>
-      # Schema: isodoc.rnc BlockSource = source*
       class BlockSourceElement < Lutaml::Model::Serializable
         attribute :status, :string
         attribute :type, :string

data/lib/metanorma/standard_document/blocks/source_origin_element.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class SourceOriginElement < Lutaml::Model::Serializable
+        attribute :bibitemid, :string
+        attribute :type, :string
+        attribute :citeas, :string
+        attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                  collection: true
+
+        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
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/blocks/standard_block_no_notes.rb

@@ -4,8 +4,8 @@ module Metanorma
   module StandardDocument
     module Blocks
       class StandardBlockNoNotes < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
-        attribute :keep_with_next, :string
-        attribute :keep_lines_together, :string
+        attribute :keep_with_next, :boolean
+        attribute :keep_lines_together, :boolean
         attribute :tag, :string
         attribute :multilingual_rendering, :string
         attribute :columns, :string

data/lib/metanorma/standard_document/blocks.rb

@@ -6,7 +6,7 @@ module Metanorma
       autoload :AmendBlock, "#{__dir__}/blocks/amend_block"
       autoload :AmendContentBlock, "#{__dir__}/blocks/amend_content_block"
       autoload :BlockSourceElement, "#{__dir__}/blocks/block_source"
-      autoload :SourceOriginElement, "#{__dir__}/blocks/block_source"
+      autoload :SourceOriginElement, "#{__dir__}/blocks/source_origin_element"
       autoload :AutoNumber, "#{__dir__}/blocks/auto_number"
       autoload :ChangeType, "#{__dir__}/blocks/change_type"
       autoload :ElementName, "#{__dir__}/blocks/element_name"

data/lib/metanorma/standard_document/boilerplate.rb

@@ -3,11 +3,29 @@
 module Metanorma
   module StandardDocument
     class Boilerplate < Lutaml::Model::Serializable
-      attribute :content, :string
+      attribute :copyright_statement,
+                Metanorma::StandardDocument::Sections::ContentSection,
+                collection: true
+      attribute :license_statement,
+                Metanorma::StandardDocument::Sections::ContentSection,
+                collection: true
+      attribute :legal_statement,
+                Metanorma::StandardDocument::Sections::ContentSection,
+                collection: true
+      attribute :feedback_statement,
+                Metanorma::StandardDocument::Sections::ContentSection,
+                collection: true
+      attribute :clause,
+                Metanorma::StandardDocument::Sections::ContentSection,
+                collection: true
 
       xml do
         element "boilerplate"
-        map_all_content to: :content
+        map_element "copyright-statement", to: :copyright_statement
+        map_element "license-statement", to: :license_statement
+        map_element "legal-statement", to: :legal_statement
+        map_element "feedback-statement", to: :feedback_statement
+        map_element "clause", to: :clause
       end
     end
   end

data/lib/metanorma/standard_document/sections/annex_section.rb

@@ -19,9 +19,9 @@ module Metanorma
         attribute :id, :string
         attribute :number, :string
         attribute :obligation, :string
-        attribute :unnumbered, :string
+        attribute :unnumbered, :boolean
         attribute :toc, :string
-        attribute :inline_header, :string
+        attribute :inline_header, :boolean
         attribute :title,
                   Metanorma::Document::Components::Inline::TitleWithAnnotationElement
 

data/lib/metanorma/standard_document/sections/clause_hierarchical_section.rb

@@ -14,7 +14,7 @@ module Metanorma
         attribute :original_id, :string
         attribute :autonum, :string
         attribute :displayorder, :integer
-        attribute :inline_header, :string
+        attribute :inline_header, :boolean
 
         xml do
           element "clause-hierarchical-section"

data/lib/metanorma/standard_document/sections/clause_section.rb

@@ -20,8 +20,8 @@ module Metanorma
         attribute :type, :string
         attribute :number, :string
         attribute :obligation, :string
-        attribute :inline_header, :string
-        attribute :unnumbered, :string
+        attribute :inline_header, :boolean
+        attribute :unnumbered, :boolean
         attribute :toc, :string
         attribute :class_attr, :string
         attribute :title,

data/lib/metanorma/standard_document/sections/definition_section.rb

@@ -20,8 +20,8 @@ module Metanorma
         attribute :type, :string
         attribute :number, :string
         attribute :obligation, :string
-        attribute :inline_header, :string
-        attribute :unnumbered, :string
+        attribute :inline_header, :boolean
+        attribute :unnumbered, :boolean
         attribute :toc, :string
         attribute :class_attr, :string
         attribute :title,

data/lib/metanorma/standard_document/sections/standard_content_section.rb

@@ -18,8 +18,8 @@ module Metanorma
         attribute :type, :string
         attribute :number, :string
         attribute :obligation, :string
-        attribute :inline_header, :string
-        attribute :unnumbered, :string
+        attribute :inline_header, :boolean
+        attribute :unnumbered, :boolean
         attribute :toc, :string
         attribute :class_attr, :string
         attribute :title,

data/lib/metanorma/standard_document/sections/standard_hierarchical_section.rb

@@ -12,7 +12,7 @@ module Metanorma
         attribute :original_id, :string
         attribute :autonum, :string
         attribute :displayorder, :integer
-        attribute :inline_header, :string
+        attribute :inline_header, :boolean
 
         xml do
           element "standard-hierarchical-section"

data/lib/metanorma/standard_document/sections/standard_references_section.rb

@@ -17,9 +17,9 @@ module Metanorma
       # bibliographical references (as modelled in Relaton), along with
       # any prefatory text.
       class StandardReferencesSection < Metanorma::StandardDocument::Sections::StandardSection
-        attribute :normative, :string
+        attribute :normative, :boolean
         attribute :obligation, :string
-        attribute :hidden, :string
+        attribute :hidden, :boolean
         attribute :references, Metanorma::Document::Components::BibData::BibliographicItem,
                   collection: true
         attribute :passthrough, Metanorma::StandardDocument::Blocks::Passthrough,

data/lib/metanorma/standard_document/sections/standard_section.rb

@@ -10,7 +10,7 @@ module Metanorma
         attribute :amend, Metanorma::StandardDocument::Blocks::AmendBlock
         attribute :number, :string
         attribute :branch_number, :string
-        attribute :unnumbered, :string
+        attribute :unnumbered, :boolean
         attribute :obligation, :string
 
         attribute :semx_id, :string

data/lib/metanorma/standard_document/sections/terms_section.rb

@@ -19,8 +19,8 @@ module Metanorma
         attribute :type, :string
         attribute :number, :string
         attribute :obligation, :string
-        attribute :inline_header, :string
-        attribute :unnumbered, :string
+        attribute :inline_header, :boolean
+        attribute :unnumbered, :boolean
         attribute :toc, :string
         attribute :class_attr, :string
         attribute :title,

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

@@ -3,37 +3,6 @@
 module Metanorma
   module StandardDocument
     module Terms
-      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
-
       class TermExpression < Lutaml::Model::Serializable
         attribute :name, TermNameElement, collection: true
         attribute :usage, :string

data/lib/metanorma/standard_document/terms/term_name_element.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A `<name>` element contains the rendered form of a term's
+      # designation. It accepts arbitrary inline content (formatting,
+      # math symbols, footnotes) — see `Inline::Vocabulary` for the
+      # full set.
+      class TermNameElement < Lutaml::Model::Serializable
+        include Metanorma::Document::Components::Inline::Vocabulary
+
+        attribute :id, :string
+        attribute :semx_id, :string
+        attribute :lang, :string
+
+        xml do
+          element "name"
+          map_attribute "id", to: :id
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "lang", to: :lang
+          mixed_content
+          Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
+            .apply_inline_mappings(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms.rb

@@ -23,6 +23,7 @@ module Metanorma
       autoload :TermCollection, "#{__dir__}/terms/term_collection"
       autoload :TermDefinition, "#{__dir__}/terms/term_definition"
       autoload :TermExpression, "#{__dir__}/terms/term_expression"
+      autoload :TermNameElement, "#{__dir__}/terms/term_name_element"
       autoload :TermSource, "#{__dir__}/terms/term_source"
       autoload :TermSourceStatus, "#{__dir__}/terms/term_source_status"
       autoload :TermSourceType, "#{__dir__}/terms/term_source_type"

data/script/render_both.rb

@@ -0,0 +1,18 @@
+require "metanorma/document"
+require "metanorma/iso_document"
+require "metanorma/ogc_document"
+require "metanorma/html"
+
+# ISO
+iso_xml = File.read("spec/fixtures/iso/is/document-en.presentation.xml")
+iso_doc = Metanorma::IsoDocument::Root.from_xml(iso_xml)
+iso_output = Metanorma::Html::Generator.generate(iso_doc)
+File.write("/tmp/iso_output.html", iso_output)
+puts "ISO: #{iso_output.size} chars written to /tmp/iso_output.html"
+
+# OGC
+ogc_xml = File.read("spec/fixtures/ogc/00-027/document.presentation.xml")
+ogc_doc = Metanorma::OgcDocument::Root.from_xml(ogc_xml)
+ogc_output = Metanorma::Html::Generator.generate(ogc_doc)
+File.write("/tmp/ogc_output.html", ogc_output)
+puts "OGC: #{ogc_output.size} chars written to /tmp/ogc_output.html"