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

data/lib/metanorma/document/components/bib_data/bibliographic_item.rb

@@ -7,6 +7,8 @@ module Metanorma
         # Description of a bibliographic resource.
         class BibliographicItem < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :hidden, :boolean
+          attribute :suppress_identifier, :boolean
           attribute :type, Metanorma::Document::Relaton::BibItemType
           attribute :fetched, Metanorma::Document::Relaton::DateTime
           attribute :title, Metanorma::Document::Relaton::TypedTitleString,
@@ -65,6 +67,8 @@ module Metanorma
           xml do
             element "bibitem"
             map_attribute "id", to: :id
+            map_attribute "hidden", to: :hidden
+            map_attribute "suppress_identifier", to: :suppress_identifier
             map_attribute "type", to: :type_attr
             map_attribute "anchor", to: :anchor
             map_attribute "semx-id", to: :semx_id

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        # Presentation-layer rendering of a requirement: the fully
+        # formatted block content emitted alongside the semantic requirement.
+        class FmtProvision < RequirementDescription
+          xml do
+            element "fmt-provision"
+            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
+      end
+    end
+  end
+end

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

@@ -27,11 +27,17 @@ module Metanorma
                     "Metanorma::Document::Components::MultiParagraph::QuoteBlock",
                     collection: true
 
+          # Presentation XML wraps the note body in a semx slice
+          # (<note><semx element="note"><p>…</p></semx></note>).
+          attribute :semx, "Metanorma::Document::Components::Inline::SemxElement",
+                    collection: true
+
           attribute :json_type, :string
           attribute :type_attr, :string
           attribute :format, :string
           attribute :semx_id, :string
           attribute :autonum, :string
+          attribute :number, :string
 
           def json_type
             "note"
@@ -60,6 +66,7 @@ module Metanorma
             map_attribute "format", to: :format
             map_attribute "semx-id", to: :semx_id
             map_attribute "autonum", to: :autonum, render_empty: true
+            map_attribute "number", to: :number
             map_attribute "anchor", to: :anchor
             map_attribute "removeInRFC", to: :remove_in_rfc
             map_element "name", to: :name
@@ -69,6 +76,7 @@ module Metanorma
             map_element "ul", to: :ul
             map_element "ol", to: :ol
             map_element "quote", to: :quote
+            map_element "semx", to: :semx
             map_element "fmt-xref-label", to: :fmt_xref_label
             map_element "fmt-name", to: :fmt_name
           end

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

@@ -15,7 +15,16 @@ module Metanorma
             map_element "subject", to: :subject
             map_element "classification", to: :classification
             map_element "description", to: :description
+            map_element "identifier", to: :identifier
+            map_element "title", to: :title
+            map_element "specification", to: :specification
+            map_element "measurement-target", to: :measurement_target
+            map_element "verification", to: :verification
+            map_element "import", to: :import
             map_element "inherit", to: :inherit
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "fmt-provision", to: :fmt_provision
             map_element "requirement", to: :requirement
             map_element "recommendation", to: :recommendation
             map_element "permission", to: :permission

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

@@ -15,7 +15,16 @@ module Metanorma
             map_element "subject", to: :subject
             map_element "classification", to: :classification
             map_element "description", to: :description
+            map_element "identifier", to: :identifier
+            map_element "title", to: :title
+            map_element "specification", to: :specification
+            map_element "measurement-target", to: :measurement_target
+            map_element "verification", to: :verification
+            map_element "import", to: :import
             map_element "inherit", to: :inherit
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "fmt-provision", to: :fmt_provision
             map_element "requirement", to: :requirement
             map_element "recommendation", to: :recommendation
             map_element "permission", to: :permission

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

@@ -10,10 +10,22 @@ module Metanorma
           attribute :obligation, :string
           attribute :type, :string
           attribute :anchor, :string
+          attribute :identifier, :string
+          attribute :title, Metanorma::Document::Components::DataTypes::FormattedString
           attribute :subject, :string
           attribute :classification, RequirementClassification, collection: true
           attribute :description, RequirementDescription, collection: true
+          attribute :specification, RequirementSpecification, collection: true
+          attribute :measurement_target, RequirementMeasurementTarget,
+                    collection: true
+          attribute :verification, RequirementVerification, collection: true
+          attribute :import, RequirementImport, collection: true
           attribute :inherit, RequirementInherit, collection: true
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+          attribute :fmt_xref_label,
+                    Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+                    collection: true
+          attribute :fmt_provision, FmtProvision
           attribute :requirement, "Metanorma::Document::Components::Blocks::RequirementModel",
                     collection: true
           attribute :recommendation, "Metanorma::Document::Components::Blocks::RecommendationModel",

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class RequirementImport < RequirementDescription
+          xml do
+            element "import"
+            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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class RequirementMeasurementTarget < RequirementDescription
+          xml do
+            element "measurement-target"
+            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
+      end
+    end
+  end
+end

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

@@ -15,7 +15,16 @@ module Metanorma
             map_element "subject", to: :subject
             map_element "classification", to: :classification
             map_element "description", to: :description
+            map_element "identifier", to: :identifier
+            map_element "title", to: :title
+            map_element "specification", to: :specification
+            map_element "measurement-target", to: :measurement_target
+            map_element "verification", to: :verification
+            map_element "import", to: :import
             map_element "inherit", to: :inherit
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "fmt-provision", to: :fmt_provision
             map_element "requirement", to: :requirement
             map_element "recommendation", to: :recommendation
             map_element "permission", to: :permission

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class RequirementSpecification < RequirementDescription
+          xml do
+            element "specification"
+            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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class RequirementVerification < RequirementDescription
+          xml do
+            element "verification"
+            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
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ module Metanorma
         autoload :BasicBlock, "#{__dir__}/blocks/basic_block"
         autoload :BasicBlockNoNotes, "#{__dir__}/blocks/basic_block_no_notes"
         autoload :ClassificationValue, "#{__dir__}/blocks/classification_value"
+        autoload :FmtProvision, "#{__dir__}/blocks/fmt_provision"
         autoload :NoteBlock, "#{__dir__}/blocks/note_block"
         autoload :Passthrough, "#{__dir__}/blocks/passthrough"
         autoload :PermissionModel, "#{__dir__}/blocks/permission_model"
@@ -17,7 +18,14 @@ module Metanorma
         autoload :RequirementDescription,
                  "#{__dir__}/blocks/requirement_description"
         autoload :RequirementInherit, "#{__dir__}/blocks/requirement_inherit"
+        autoload :RequirementImport, "#{__dir__}/blocks/requirement_import"
+        autoload :RequirementMeasurementTarget,
+                 "#{__dir__}/blocks/requirement_measurement_target"
         autoload :RequirementModel, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementSpecification,
+                 "#{__dir__}/blocks/requirement_specification"
+        autoload :RequirementVerification,
+                 "#{__dir__}/blocks/requirement_verification"
       end
     end
   end

data/lib/metanorma/document/components/data_types/formatted_string.rb

@@ -19,12 +19,16 @@ module Metanorma
                     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 :smallcap, Metanorma::Document::Components::Inline::SmallCapElement,
                     collection: true
           attribute :link, Metanorma::Document::Components::Inline::LinkElement,
                     collection: true
+          attribute :fmt_link, Metanorma::Document::Components::Inline::LinkElement,
+                    collection: true
           attribute :br, Metanorma::Document::Components::Inline::BrElement,
                     collection: true
           attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
@@ -56,6 +60,8 @@ module Metanorma
                     collection: true
           attribute :underline, Metanorma::Document::Components::TextElements::UnderlineElement,
                     collection: true
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
 
           xml do
             mixed_content
@@ -68,9 +74,11 @@ module Metanorma
             map_element "semx", to: :semx
             map_element "span", to: :span
             map_element "em", to: :em
+            map_element "ruby", to: :ruby
             map_element "strong", to: :strong
             map_element "smallcap", to: :smallcap
             map_element "link", to: :link
+            map_element "fmt-link", to: :fmt_link
             map_element "br", to: :br
             map_element "p", to: :p
             map_element "sup", to: :sup
@@ -87,6 +95,7 @@ module Metanorma
             map_element "table", to: :table
             map_element "tt", to: :tt
             map_element "underline", to: :underline
+            map_element "note", to: :note
           end
         end
       end

data/lib/metanorma/document/components/id_elements/image.rb

@@ -9,16 +9,20 @@ module Metanorma
           attribute :height, :string
           attribute :width, :string
           attribute :align, :string
+          attribute :anchor, :string
           attribute :semx_id, :string
           attribute :inline_svg, :string
+          attribute :inline_emf, :string
 
           xml do
             element "image"
             map_attribute "height", to: :height, render_empty: true
             map_attribute "width", to: :width, render_empty: true
             map_attribute "align", to: :align
+            map_attribute "anchor", to: :anchor
             map_attribute "semx-id", to: :semx_id
             map_element "svg", to: :inline_svg, raw: :element
+            map_element "emf", to: :inline_emf, raw: :element
           end
         end
       end

data/lib/metanorma/document/components/inline/columnbreak_element.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Indication of a break in text rendered as columns (e.g. in
+        # multilingual side-by-side rendering).
+        class ColumnbreakElement < Lutaml::Model::Serializable
+          xml do
+            element "columnbreak"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/concept_element.rb

@@ -6,16 +6,34 @@ module Metanorma
       module Inline
         class ConceptElement < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :bold, :boolean
+          attribute :ital, :boolean
+          attribute :ref, :boolean
+          attribute :linkmention, :boolean
+          attribute :linkref, :boolean
           attribute :refterm, :string, collection: true
           attribute :renderterm, :string, collection: true
           attribute :xref, XrefElement, collection: true
+          attribute :eref, Metanorma::Document::Components::Inline::ErefElement
+          attribute :erefstack, Metanorma::Document::Components::Inline::ErefStack
+          attribute :termref, Metanorma::Document::Components::Inline::TermrefElement
+          attribute :errormsg, Metanorma::Document::Components::Inline::ErrorMessage
 
           xml do
             element "concept"
             map_attribute "id", to: :id
+            map_attribute "bold", to: :bold
+            map_attribute "ital", to: :ital
+            map_attribute "ref", to: :ref
+            map_attribute "linkmention", to: :linkmention
+            map_attribute "linkref", to: :linkref
             map_element "refterm", to: :refterm
             map_element "renderterm", to: :renderterm
             map_element "xref", to: :xref
+            map_element "eref", to: :eref
+            map_element "erefstack", to: :erefstack
+            map_element "termref", to: :termref
+            map_element "errormsg", to: :errormsg
           end
         end
       end

data/lib/metanorma/document/components/inline/date_element.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Localisable rendering of a date in body content.
+        class DateElement < Lutaml::Model::Serializable
+          attribute :language, :string
+          attribute :script, :string
+          attribute :value, :string
+          attribute :format, :string
+          attribute :fmt_date_inline,
+                    "Metanorma::Document::Components::Inline::FmtDateInlineElement",
+                    collection: true
+
+          xml do
+            element "date"
+            map_attribute "language", to: :language
+            map_attribute "script", to: :script
+            map_attribute "value", to: :value
+            map_attribute "format", to: :format
+            map_element "fmt-date-inline", to: :fmt_date_inline
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/display_text_element.rb

@@ -7,6 +7,7 @@ module Metanorma
         class DisplayTextElement < Lutaml::Model::Serializable
           attribute :text, :string, collection: true
           attribute :em, EmRawElement, collection: true
+          attribute :ruby, "Metanorma::Document::Components::TextElements::RubyElement", collection: true
           attribute :strong, StrongRawElement, collection: true
           attribute :sub, SubElement, collection: true
           attribute :sup, SupElement, collection: true
@@ -23,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 "sub", to: :sub
             map_element "sup", to: :sup

data/lib/metanorma/document/components/inline/em_raw_element.rb

@@ -4,19 +4,18 @@ module Metanorma
   module Document
     module Components
       module Inline
+        # Emphasised raw text: accepts the full inline vocabulary as
+        # children (footnotes, links, nested formatting, math) so no
+        # inline payload inside <em> is dropped at parse time.
         class EmRawElement < Lutaml::Model::Serializable
-          attribute :text, :string, collection: true
-          attribute :semx, "Metanorma::Document::Components::Inline::SemxElement",
-                    collection: true
-          attribute :span, "Metanorma::Document::Components::Inline::SpanElement",
-                    collection: true
+          include Metanorma::Document::Components::Inline::Vocabulary
 
           xml do
             element "em"
             mixed_content
             map_content to: :text
-            map_element "semx", to: :semx
-            map_element "span", to: :span
+            Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
+              .apply_inline_mappings(self)
           end
         end
       end

data/lib/metanorma/document/components/inline/eref_element.rb

@@ -4,34 +4,60 @@ module Metanorma
   module Document
     module Components
       module Inline
+        # The eref content contract (erefAttributes, CitationType,
+        # ErefBody) shared by the semantic element and its rendered
+        # twins fmt-eref/fmt-origin (identical grammar shapes).
+        # Declared as a module and re-applied per class: lutaml-model
+        # neither inherits xml mappings into a redeclared `xml do`
+        # block nor inherits the attribute registry, so every
+        # shape-sharing class applies both halves in full.
+        module ErefContract
+          module_function
+
+          def declare_attributes(base)
+            base.attribute :id, :string
+            base.attribute :type, :string
+            base.attribute :bibitemid, :string
+            base.attribute :citeas, :string
+            base.attribute :normative, :boolean
+            base.attribute :alt, :string
+            base.attribute :display_format, :string
+            base.attribute :relative, :string
+            base.attribute :connective, :string
+            base.attribute :custom_connective, :string
+            base.attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                           collection: true
+            base.attribute :locality, Metanorma::Document::Relaton::BibItemLocality,
+                           collection: true
+          end
+
+          def apply_mapping(mapping)
+            mapping.mixed_content
+            mapping.map_attribute "id", to: :id
+            mapping.map_attribute "type", to: :type
+            mapping.map_attribute "bibitemid", to: :bibitemid
+            mapping.map_attribute "citeas", to: :citeas
+            mapping.map_attribute "normative", to: :normative
+            mapping.map_attribute "alt", to: :alt
+            mapping.map_attribute "displayFormat", to: :display_format
+            mapping.map_attribute "relative", to: :relative
+            mapping.map_attribute "connective", to: :connective
+            mapping.map_attribute "custom-connective", to: :custom_connective
+            mapping.map_element "localityStack", to: :locality_stack
+            mapping.map_element "locality", to: :locality
+            mapping.map_content to: :text
+            Vocabulary::VocabularyXmlMapping.apply_inline_mappings(mapping)
+          end
+        end
+
         class ErefElement < Lutaml::Model::Serializable
           include Inline::Vocabulary
 
-          attribute :id, :string
-          attribute :type, :string
-          attribute :bibitemid, :string
-          attribute :citeas, :string
-          attribute :normative, :boolean
-          attribute :alt, :string
-          attribute :display_format, :string
-          attribute :relative, :string
-          attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
-                    collection: true
+          ErefContract.declare_attributes(self)
 
           xml do
             element "eref"
-            mixed_content
-            map_attribute "id", to: :id
-            map_attribute "type", to: :type
-            map_attribute "bibitemid", to: :bibitemid
-            map_attribute "citeas", to: :citeas
-            map_attribute "normative", to: :normative
-            map_attribute "alt", to: :alt
-            map_attribute "displayFormat", to: :display_format
-            map_attribute "relative", to: :relative
-            map_element "localityStack", to: :locality_stack
-            map_content to: :text
-            Vocabulary::VocabularyXmlMapping.apply_inline_mappings(self)
+            ErefContract.apply_mapping(self)
           end
         end
       end

data/lib/metanorma/document/components/inline/eref_stack.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Set of cross-references to bibliographic references,
+        # joined with connectives.
+        class ErefStack < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
+                    collection: true
+
+          xml do
+            element "erefstack"
+            map_attribute "id", to: :id
+            map_element "eref", to: :eref
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/error_message.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Generator-only error message carried in place of an unresolved
+        # concept or related-term cross-reference.
+        class ErrorMessage < Lutaml::Model::Serializable
+          include Metanorma::Document::Components::Inline::Vocabulary
+
+          attribute :index_xref,
+                    Metanorma::Document::Components::EmptyElements::IndexElement,
+                    collection: true
+
+          xml do
+            element "errormsg"
+            mixed_content
+            map_content to: :text
+            map_element "index-xref", to: :index_xref
+            Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
+              .apply_inline_mappings(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/fmt_date_element.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Presentation-layer rendering of an inline date.
+        class FmtDateElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
+          attribute :id, :string
+          attribute :text, :string, collection: true
+          attribute :span, SpanElement, collection: true
+          attribute :semx, SemxElement, collection: true
+
+          xml do
+            element "fmt-date"
+            mixed_content
+            map_attribute "id", to: :id
+            map_content to: :text
+            map_element "span", to: :span
+            map_element "semx", to: :semx
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/fmt_date_inline_element.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Rendered counterpart of an inline `<date>`: the i18n'd
+        # rendering of a value/format-marked date, appearing inside the
+        # semantic date element.
+        class FmtDateInlineElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
+          attribute :text, :string, collection: true
+          attribute :semx, SemxElement, collection: true
+
+          xml do
+            element "fmt-date-inline"
+            mixed_content
+            map_content to: :text
+            map_element "semx", to: :semx
+          end
+        end
+      end
+    end
+  end
+end