metanorma-document 0.5.0 → 0.5.2.pre.alpha.1

data/lib/metanorma/document/components/lists/fmt_list_element.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # The rendered list forms fmt-ul/fmt-ol: the presentation
+        # rendering of a list that deviates from a sequence of list
+        # items (e.g. rendered as a table). Present to the exclusion
+        # of any other child of the semantic list. Declared as a
+        # module and re-applied per class (lutaml inherits neither the
+        # attribute registry nor xml mappings).
+        module FmtListContract
+          module_function
+
+          def declare_attributes(base)
+            base.attribute :id, :string
+            base.attribute :anchor, :string
+            base.attribute :semx_id, :string
+            base.attribute :name,
+                           Metanorma::Document::Components::Inline::NameWithIdElement
+            base.attribute :table,
+                           "Metanorma::Document::Components::Tables::TableBlock",
+                           collection: true
+            base.attribute :note,
+                           Metanorma::Document::Components::Blocks::NoteBlock,
+                           collection: true
+            base.attribute :text, :string, collection: true
+            base.attribute :semx,
+                           "Metanorma::Document::Components::Inline::SemxElement",
+                           collection: true
+          end
+
+          def apply_mapping(mapping)
+            mapping.mixed_content
+            mapping.map_attribute "id", to: :id
+            mapping.map_attribute "anchor", to: :anchor
+            mapping.map_attribute "semx-id", to: :semx_id
+            mapping.map_element "name", to: :name
+            mapping.map_element "table", to: :table
+            mapping.map_element "note", to: :note
+            mapping.map_content to: :text
+            mapping.map_element "semx", to: :semx
+          end
+        end
+
+        # Rendered counterpart of `<ul>`.
+        class FmtUlElement < Lutaml::Model::Serializable
+          include Metanorma::Document::Components::Inline::RenderedDisplay
+
+          FmtListContract.declare_attributes(self)
+
+          xml do
+            element "fmt-ul"
+            FmtListContract.apply_mapping(self)
+          end
+        end
+
+        # Rendered counterpart of `<ol>`.
+        class FmtOlElement < Lutaml::Model::Serializable
+          include Metanorma::Document::Components::Inline::RenderedDisplay
+
+          FmtListContract.declare_attributes(self)
+
+          xml do
+            element "fmt-ol"
+            FmtListContract.apply_mapping(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/lists/list_item.rb

@@ -70,6 +70,9 @@ module Metanorma
             map_element "dl", to: :dl
             map_element "example", to: :example
             map_element "note", to: :note
+            # Term entries embed <termnote> (a note with an autonum label)
+            # inside list items; capture it through the note model.
+            map_element "termnote", to: :note
             map_element "quote", to: :quote
             map_element "table", to: :table
             map_element "ul", to: :unordered_lists

data/lib/metanorma/document/components/lists/ordered_list.rb

@@ -10,12 +10,13 @@ module Metanorma
           attribute :start, :string
           attribute :semx_id, :string
           attribute :displayorder, :integer
-          attribute :display, :string
+          attribute :display_style, :string
           attribute :display_directives, :string
           attribute :class_attr, :string
           attribute :group, :string
           attribute :spacing, :string
           attribute :indent, :string
+          attribute :fmt_ol, "Metanorma::Document::Components::Lists::FmtOlElement"
 
           def json_type
             "ol"
@@ -33,13 +34,14 @@ module Metanorma
             map_attribute "type", to: :type
             map_attribute "semx-id", to: :semx_id
             map_attribute "displayorder", to: :displayorder
-            map_attribute "display", to: :display
+            map_attribute "display", to: :display_style
             map_attribute "display-directives", to: :display_directives
             map_attribute "class", to: :class_attr, render_empty: true
             map_attribute "start", to: :start
             map_attribute "group", to: :group
             map_attribute "spacing", to: :spacing
             map_attribute "indent", to: :indent
+            map_element "fmt-ol", to: :fmt_ol
           end
         end
       end

data/lib/metanorma/document/components/lists/unordered_list.rb

@@ -14,6 +14,7 @@ module Metanorma
           attribute :indent, :string
           attribute :bare, :boolean
           attribute :json_type, :string
+          attribute :fmt_ul, "Metanorma::Document::Components::Lists::FmtUlElement"
 
           def json_type
             "ul"
@@ -34,6 +35,7 @@ module Metanorma
             map_attribute "spacing", to: :spacing
             map_attribute "indent", to: :indent
             map_attribute "bare", to: :bare
+            map_element "fmt-ul", to: :fmt_ul
           end
         end
       end

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

@@ -8,6 +8,8 @@ module Metanorma
         autoload :Definition, "#{__dir__}/lists/definition"
         autoload :DefinitionList, "#{__dir__}/lists/definition_list"
         autoload :DtElement, "#{__dir__}/lists/dt_element"
+        autoload :FmtUlElement, "#{__dir__}/lists/fmt_list_element"
+        autoload :FmtOlElement, "#{__dir__}/lists/fmt_list_element"
         autoload :List, "#{__dir__}/lists/list"
         autoload :ListItem, "#{__dir__}/lists/list_item"
         autoload :OrderedList, "#{__dir__}/lists/ordered_list"

data/lib/metanorma/document/components/multi_paragraph/quote_block.rb

@@ -14,6 +14,17 @@ module Metanorma
                     collection: true
           attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
                     collection: true
+          attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                    collection: true
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList,
+                    collection: true
+          attribute :formula,
+                    Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
+                    collection: true
+          attribute :bookmark, Metanorma::Document::Components::IdElements::Bookmark,
+                    collection: true
           attribute :attribution, "Metanorma::Document::Components::Inline::AttributionElement"
           attribute :json_type, :string
 
@@ -36,6 +47,11 @@ module Metanorma
             map_element "p", to: :paragraphs
             map_element "ul", to: :ul
             map_element "ol", to: :ol
+            map_element "table", to: :table
+            map_element "note", to: :note
+            map_element "dl", to: :dl
+            map_element "formula", to: :formula
+            map_element "bookmark", to: :bookmark
             map_element "attribution", to: :attribution
           end
         end

data/lib/metanorma/document/components/multi_paragraph/review_block.rb

@@ -20,7 +20,7 @@ module Metanorma
           # Identifier for the end of the text to which the comment applies.
           attribute :applies_to, :string
 
-          attribute :display, :string
+          attribute :display_style, :string
 
           xml do
             element "review"
@@ -28,7 +28,7 @@ module Metanorma
             map_attribute "date", to: :date
             map_attribute "from", to: :applies_from
             map_attribute "to", to: :applies_to
-            map_attribute "display", to: :display
+            map_attribute "display", to: :display_style
           end
         end
       end

data/lib/metanorma/document/components/paragraphs/paragraph_block.rb

@@ -22,6 +22,8 @@ module Metanorma
           # Inline elements
           attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
                     collection: true
+          attribute :ruby, Metanorma::Document::Components::TextElements::RubyElement,
+                    collection: true
           attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
                     collection: true
           attribute :smallcap, Metanorma::Document::Components::Inline::SmallCapElement,
@@ -83,6 +85,14 @@ module Metanorma
                     collection: true
           attribute :input, Metanorma::Document::Elements::Input,
                     collection: true
+          attribute :passthrough, Metanorma::Document::Components::Blocks::Passthrough,
+                    collection: true
+          attribute :date, Metanorma::Document::Components::Inline::DateElement,
+                    collection: true
+          attribute :fmt_date, Metanorma::Document::Components::Inline::FmtDateElement,
+                    collection: true
+          attribute :erefstack, Metanorma::Document::Components::Inline::ErefStack,
+                    collection: true
 
           # JSON serialization attributes
           attribute :json_type, :string
@@ -110,6 +120,7 @@ module Metanorma
             map_attribute "displayorder", to: :displayorder
             map_content to: :text
             map_element "em", to: :em
+            map_element "ruby", to: :ruby
             map_element "strong", to: :strong
             map_element "smallcap", to: :smallcap
             map_element "sub", to: :sub
@@ -141,6 +152,10 @@ module Metanorma
             map_element "add", to: :add
             map_element "del", to: :del
             map_element "input", to: :input
+            map_element "passthrough", to: :passthrough
+            map_element "date", to: :date
+            map_element "fmt-date", to: :fmt_date
+            map_element "erefstack", to: :erefstack
           end
 
           def json_content

data/lib/metanorma/document/components/reference_elements/citation.rb

@@ -16,11 +16,17 @@ module Metanorma
                     collection: true
           attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
                     collection: true
+          attribute :locality, Metanorma::Document::Relaton::BibItemLocality,
+                    collection: true
           attribute :bib_item, Metanorma::Document::Components::BibData::BibliographicItem
           attribute :display_text, "Metanorma::Document::Components::Inline::DisplayTextElement"
+          # The origin's own rendered text (<origin>ISO 19101-1:2014</origin>)
+          attribute :content, :string, collection: true
 
           xml do
             element "citation"
+            mixed_content
+            map_content to: :content
             map_attribute "bibitemid", to: :bibitemid
             map_attribute "date", to: :date
             map_attribute "type", to: :type
@@ -28,6 +34,7 @@ module Metanorma
             map_element "bib-locality", to: :bib_locality
             map_element "bib-locality-stack", to: :bib_locality_stack
             map_element "localityStack", to: :locality_stack
+            map_element "locality", to: :locality
             map_element "bib-item", to: :bib_item
             map_element "display-text", to: :display_text
           end

data/lib/metanorma/document/components/reference_elements/source_element.rb

@@ -10,6 +10,9 @@ module Metanorma
           attribute :type, :string
           attribute :origin, SourceOrigin
           attribute :modification, SourceModification
+          attribute :fmt_source,
+                    "Metanorma::Document::Components::Inline::FmtSourceElement",
+                    collection: true
 
           xml do
             element "source"
@@ -18,6 +21,7 @@ module Metanorma
             map_attribute "type", to: :type
             map_element "origin", to: :origin
             map_element "modification", to: :modification
+            map_element "fmt-source", to: :fmt_source
           end
         end
       end

data/lib/metanorma/document/components/semantic/node.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      # The semantic vocabulary namespace (semantic__* elements under
+      # metanorma-extension/metanorma/source): the machine-readable
+      # layer flavors embed alongside the presentation tree. Element
+      # names are dynamic per flavor and document, so ONE recursive
+      # model with a catch-all element mapping serves the whole
+      # namespace (lutaml-model#903/#905); element_order preserves the
+      # mixed-content sequence and each child's original tag name for
+      # ordered rendering.
+      module Semantic
+        class Node < Lutaml::Model::Serializable
+          attribute :children,
+                    "Metanorma::Document::Components::Semantic::Node",
+                    collection: true
+
+          # Attributes actually consumed by rendering; the rest of the
+          # vocabulary's attribute surface drops at parse. sem_-prefixed
+          # names avoid collisions with the children attribute.
+          XML_ATTRIBUTES = {
+            "id" => :id, "target" => :sem_target, "citeas" => :citeas,
+            "bibitemid" => :bibitemid, "type" => :type_attr,
+            "language" => :sem_language, "script" => :sem_script,
+            "format" => :format, "alt" => :alt, "style" => :sem_style,
+            "display" => :display_style, "scope" => :scope, "role" => :sem_role,
+            "label" => :label, "number" => :sem_number, "value" => :sem_value,
+            "url" => :url, "href" => :href, "from" => :sem_from,
+            "prefix" => :prefix, "hidden" => :hidden, "obligation" => :obligation
+          }.freeze
+
+          XML_ATTRIBUTES.each_value { |attr| attribute attr, :string }
+
+          xml do
+            map_any_element to: :children
+            XML_ATTRIBUTES.each do |xml_name, attr|
+              map_attribute xml_name, to: attr
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Semantic
+        autoload :Node, "metanorma/document/components/semantic/node"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/tables/header_table_cell.rb

@@ -9,6 +9,7 @@ module Metanorma
           xml do
             element "th"
             mixed_content
+            TableCellXmlMapping.apply(self)
           end
         end
       end

data/lib/metanorma/document/components/tables/table_cell.rb

@@ -4,9 +4,68 @@ module Metanorma
   module Document
     module Components
       module Tables
+        # Shared XML mapping for TableCell and its <td>/<th> subclasses.
+        # lutaml-model does not inherit xml mappings into a subclass's
+        # `xml do` block — a bare redeclaration silently drops every
+        # parent map_element (the #51 root cause: stems inside cells
+        # parsed hollow). Each subclass applies this module after
+        # declaring its element name.
+        module TableCellXmlMapping
+          module_function
+
+          def apply(mapping)
+            mapping.map_attribute "id", to: :id
+            mapping.map_attribute "anchor", to: :anchor
+            mapping.map_attribute "colspan", to: :colspan
+            mapping.map_attribute "rowspan", to: :rowspan
+            mapping.map_attribute "align", to: :align
+            mapping.map_attribute "valign", to: :valign
+            mapping.map_attribute "semx-id", to: :semx_id
+            mapping.map_content to: :text
+            mapping.map_element "em", to: :em
+            mapping.map_element "ruby", to: :ruby
+            mapping.map_element "strong", to: :strong
+            mapping.map_element "tt", to: :tt
+            mapping.map_element "sub", to: :sub
+            mapping.map_element "sup", to: :sup
+            mapping.map_element "smallcap", to: :smallcap
+            mapping.map_element "br", to: :br
+            mapping.map_element "xref", to: :xref
+            mapping.map_element "eref", to: :eref
+            mapping.map_element "fmt-eref", to: :fmt_eref
+            mapping.map_element "link", to: :link
+            mapping.map_element "stem", to: :stem
+            mapping.map_element "fn", to: :fn
+            mapping.map_element "strike", to: :strike
+            mapping.map_element "underline", to: :underline
+            mapping.map_element "p", to: :p
+            mapping.map_element "dl", to: :dl
+            mapping.map_element "ul", to: :ul
+            mapping.map_element "ol", to: :ol
+            mapping.map_element "figure", to: :figure
+            mapping.map_element "formula", to: :formula
+            mapping.map_element "note", to: :note
+            mapping.map_element "example", to: :example
+            mapping.map_element "quote", to: :quote
+            mapping.map_element "sourcecode", to: :sourcecode
+            mapping.map_element "source", to: :source
+            mapping.map_element "table", to: :table
+            mapping.map_element "key", to: :key
+            mapping.map_element "fmt-stem", to: :fmt_stem
+            mapping.map_element "fmt-fn-label", to: :fmt_fn_label
+            mapping.map_element "semx", to: :semx
+            mapping.map_element "span", to: :span
+            mapping.map_element "bookmark", to: :bookmark
+            mapping.map_element "input", to: :input
+            mapping.map_element "fmt-annotation-start", to: :fmt_annotation_start
+            mapping.map_element "fmt-annotation-end", to: :fmt_annotation_end
+          end
+        end
+
         # Base class for table cells with common attributes and mixed content.
         class TableCell < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :anchor, :string
           attribute :colspan, :integer
           attribute :rowspan, :integer
           attribute :align, :string
@@ -16,6 +75,8 @@ module Metanorma
           # Inline elements
           attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
                     collection: true
+          attribute :ruby, Metanorma::Document::Components::TextElements::RubyElement,
+                    collection: true
           attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
                     collection: true
           attribute :tt, Metanorma::Document::Components::Inline::TtElement,
@@ -31,6 +92,9 @@ module Metanorma
                     collection: true
           attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
                     collection: true
+          attribute :fmt_eref,
+                    Metanorma::Document::Components::Inline::FmtErefElement,
+                    collection: true
           attribute :link, Metanorma::Document::Components::Inline::LinkElement,
                     collection: true
           attribute :stem,
@@ -65,8 +129,11 @@ module Metanorma
                     Metanorma::Document::Components::ReferenceElements::SourceElement,
                     collection: true
 
-          # Nested tables (table inside td/th)
-          attribute :table, TableBlock,
+          # Nested tables (table inside td/th). String-typed: breaks the
+          # TableCell ⇄ TableBlock autoload cycle (cell → nested table →
+          # rows → cells).
+          attribute :table,
+                    "Metanorma::Document::Components::Tables::TableBlock",
                     collection: true
 
           # Key definitions inside table cells
@@ -93,48 +160,7 @@ module Metanorma
 
           xml do
             mixed_content
-            map_attribute "id", to: :id
-            map_attribute "colspan", to: :colspan
-            map_attribute "rowspan", to: :rowspan
-            map_attribute "align", to: :align
-            map_attribute "valign", to: :valign
-            map_attribute "semx-id", to: :semx_id
-            map_content to: :text
-            map_element "em", to: :em
-            map_element "strong", to: :strong
-            map_element "tt", to: :tt
-            map_element "sub", to: :sub
-            map_element "sup", to: :sup
-            map_element "smallcap", to: :smallcap
-            map_element "br", to: :br
-            map_element "xref", to: :xref
-            map_element "eref", to: :eref
-            map_element "link", to: :link
-            map_element "stem", to: :stem
-            map_element "fn", to: :fn
-            map_element "strike", to: :strike
-            map_element "underline", to: :underline
-            map_element "p", to: :p
-            map_element "dl", to: :dl
-            map_element "ul", to: :ul
-            map_element "ol", to: :ol
-            map_element "figure", to: :figure
-            map_element "formula", to: :formula
-            map_element "note", to: :note
-            map_element "example", to: :example
-            map_element "quote", to: :quote
-            map_element "sourcecode", to: :sourcecode
-            map_element "source", to: :source
-            map_element "table", to: :table
-            map_element "key", to: :key
-            map_element "fmt-stem", to: :fmt_stem
-            map_element "fmt-fn-label", to: :fmt_fn_label
-            map_element "semx", to: :semx
-            map_element "span", to: :span
-            map_element "bookmark", to: :bookmark
-            map_element "input", to: :input
-            map_element "fmt-annotation-start", to: :fmt_annotation_start
-            map_element "fmt-annotation-end", to: :fmt_annotation_end
+            TableCellXmlMapping.apply(self)
           end
         end
       end

data/lib/metanorma/document/components/tables/text_table_cell.rb

@@ -9,6 +9,7 @@ module Metanorma
           xml do
             element "td"
             mixed_content
+            TableCellXmlMapping.apply(self)
           end
         end
       end

data/lib/metanorma/document/components/tables/text_table_row.rb

@@ -7,6 +7,7 @@ module Metanorma
         # Sequence of cells to be displayed as a row in a table.
         class TextTableRow < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :anchor, :string
           attribute :semx_id, :string
           attribute :td, TextTableCell, collection: true
           attribute :th, HeaderTableCell, collection: true
@@ -14,6 +15,7 @@ module Metanorma
           xml do
             element "tr"
             map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
             map_attribute "semx-id", to: :semx_id
             map_element "td", to: :td
             map_element "th", to: :th

data/lib/metanorma/document/components/text_elements/ruby_annotation_element.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Ruby annotation giving information other than pronunciation
+        # of the annotated text (standoc renaming of BasicDoc
+        # `annotation`). The annotation value travels in the `value`
+        # attribute.
+        class RubyAnnotationElement < Lutaml::Model::Serializable
+          attribute :value, :string
+          attribute :language, :string
+          attribute :script, :string
+
+          xml do
+            element "ruby-annotation"
+            map_attribute "value", to: :value
+            map_attribute "language", to: :language
+            map_attribute "script", to: :script
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/ruby_element.rb

@@ -4,17 +4,52 @@ module Metanorma
   module Document
     module Components
       module TextElements
-        # Text with Ruby annotations in East Asian languages. Corresponds to HTML `ruby`.
-        class RubyElement < TextElement
-          attribute :ruby_paren, Metanorma::Document::Components::DataTypes::LocalizedString,
-                    collection: true
-          attribute :ruby_text, Metanorma::Document::Components::DataTypes::LocalizedString,
+        # Text with Ruby annotations in East Asian languages.
+        # Corresponds to HTML `ruby`.
+        #
+        # Semantic form: a leading pronunciation or semantic
+        # annotation, then the annotated text, which may itself nest
+        # further ruby.
+        #
+        # Presentation form: `rb` (the base text) and `rt` (the
+        # rendered annotation).
+        class RubyElement < Lutaml::Model::Serializable
+          attribute :pronunciation,
+                    "Metanorma::Document::Components::TextElements::RubyPronunciationElement"
+          attribute :annotation,
+                    "Metanorma::Document::Components::TextElements::RubyAnnotationElement"
+          attribute :ruby_base,
+                    "Metanorma::Document::Components::TextElements::RbElement"
+          attribute :ruby_text, :string, collection: true
+          attribute :ruby,
+                    "Metanorma::Document::Components::TextElements::RubyElement",
                     collection: true
+          attribute :text, :string, collection: true
 
           xml do
             element "ruby"
-            map_element "rp", to: :ruby_paren
+            mixed_content
+            map_element "ruby-pronunciation", to: :pronunciation
+            map_element "ruby-annotation", to: :annotation
+            map_element "rb", to: :ruby_base
             map_element "rt", to: :ruby_text
+            map_element "ruby", to: :ruby
+            map_content to: :text
+          end
+        end
+
+        # The base text of a presentation-form ruby annotation.
+        class RbElement < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :ruby,
+                    "Metanorma::Document::Components::TextElements::RubyElement",
+                    collection: true
+
+          xml do
+            element "rb"
+            mixed_content
+            map_content to: :text
+            map_element "ruby", to: :ruby
           end
         end
       end

data/lib/metanorma/document/components/text_elements/ruby_pronunciation_element.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Ruby annotation giving the pronunciation of the annotated
+        # text (standoc renaming of BasicDoc `pronunciation`). The
+        # annotation value travels in the `value` attribute.
+        class RubyPronunciationElement < Lutaml::Model::Serializable
+          attribute :value, :string
+          attribute :language, :string
+          attribute :script, :string
+
+          xml do
+            element "ruby-pronunciation"
+            map_attribute "value", to: :value
+            map_attribute "language", to: :language
+            map_attribute "script", to: :script
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/strike_element.rb

@@ -10,6 +10,8 @@ module Metanorma
           attribute :text, :string, collection: true
           attribute :em, "Metanorma::Document::Components::Inline::EmRawElement",
                     collection: true
+          attribute :ruby, "Metanorma::Document::Components::TextElements::RubyElement",
+                    collection: true
           attribute :strong, "Metanorma::Document::Components::Inline::StrongRawElement",
                     collection: true
           attribute :eref, "Metanorma::Document::Components::Inline::ErefElement",
@@ -22,6 +24,7 @@ module Metanorma
             mixed_content
             map_content to: :text
             map_element "em", to: :em
+            map_element "ruby", to: :ruby
             map_element "strong", to: :strong
             map_element "eref", to: :eref
             map_element "link", to: :link