metanorma-document 0.2.9 → 0.2.12

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

@@ -4,88 +4,23 @@ module Metanorma
   module Document
     module Components
       module AncillaryBlocks
-        # Body of sourcecode block, containing code text with embedded callout elements.
-        # Uses map_all_content to preserve mixed content.
-        class SourcecodeBody < Lutaml::Model::Serializable
-          attribute :content, :string
-
-          xml do
-            element "body"
-            map_all_content to: :content
-          end
-        end
-
-        # Callout annotation in sourcecode, containing id, anchor, and paragraphs.
-        class CalloutAnnotation < Lutaml::Model::Serializable
-          attribute :id, :string
-          attribute :anchor, :string
-          attribute :semx_id, :string
-          attribute :original_id, :string
-          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                    collection: true
-
-          xml do
-            element "callout-annotation"
-            map_attribute "id", to: :id
-            map_attribute "anchor", to: :anchor
-            map_attribute "semx-id", to: :semx_id
-            map_attribute "original-id", to: :original_id
-            map_element "p", to: :p
-          end
-        end
-
-        # Block containing computer code or comparable text.
         class SourcecodeBlock < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
-          # The caption of the block.
           attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
-
-          # The block should be excluded from any automatic numbering of blocks of this class in the document.
           attribute :unnumbered, :boolean
-
-          # Anchor attribute for cross-references
           attribute :anchor, :string
-
-          # Define a subsequence for numbering of this block; e.g. if this block would be numbered
-          # as 7, but it has a subsequence value of XYZ, this block, and all consecutive blocks
-          # of the same class and with the same subsequence value, will be numbered consecutively
-          # with the same number and in a subsequence: 7a, 7b, 7c etc.
           attribute :subsequence, :string
-
-          # A file name associated with the source code (and which could be used to extract the source code
-          # fragment to from the document, or to populate the source code fragment with from the external file,
-          # in automated processing of the document).
           attribute :filename, :string
-
-          # The computer language or other notational convention that the source code is expressed in.
           attribute :lang, :string
-
-          # 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.)
           attribute :content, :string
-
-          # The source code body, containing code text with embedded callout references.
           attribute :body, SourcecodeBody
-
-          # Zero or more cross-references; these are intended to be embedded within the `content` string, and
-          # link to annotations.
           attribute :callouts,
                     Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement, collection: true
-
-          # Annotations to the source code; each annotation consists of zero or more paragraphs, and is intended
-          # to be referenced by a callout within the source code.
           attribute :callout_annotations,
                     CalloutAnnotation, collection: true
-
-          # Presentation-specific elements
           attribute :fmt_sourcecode, Metanorma::Document::Components::Inline::FmtSourcecodeElement
-
-          # Presentation-specific: semx-id for round-trip fidelity
           attribute :semx_id, :string
-
           attribute :json_type, :string
 
           def json_type

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        class SourcecodeBody < Lutaml::Model::Serializable
+          attribute :content, :string
+
+          xml do
+            element "body"
+            map_all_content to: :content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,8 @@ module Metanorma
   module Document
     module Components
       module AncillaryBlocks
+        autoload :CalloutAnnotation,
+                 "#{__dir__}/ancillary_blocks/callout_annotation"
         autoload :ExampleBlock, "#{__dir__}/ancillary_blocks/example_block"
         autoload :FigureBlock, "#{__dir__}/ancillary_blocks/figure_block"
         autoload :FormulaBlock, "#{__dir__}/ancillary_blocks/formula_block"
@@ -11,6 +13,8 @@ module Metanorma
         autoload :LiteralBlock, "#{__dir__}/ancillary_blocks/literal_block"
         autoload :SourcecodeBlock,
                  "#{__dir__}/ancillary_blocks/sourcecode_block"
+        autoload :SourcecodeBody,
+                 "#{__dir__}/ancillary_blocks/sourcecode_body"
         autoload :Subfigure, "#{__dir__}/ancillary_blocks/subfigure"
       end
     end

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

@@ -60,6 +60,13 @@ module Metanorma
             map_element "keyword", to: :keyword
             map_element "classification", to: :classification
           end
+
+          def title_for(language = "en")
+            return nil unless title && !title.empty?
+
+            found = title.find { |t| t.language == language }
+            found || title.first
+          end
         end
       end
     end

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

@@ -0,0 +1,21 @@
+# 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        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/recommendation_model.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        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
+      end
+    end
+  end
+end

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

@@ -4,99 +4,6 @@ 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"
@@ -115,44 +22,6 @@ module Metanorma
             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

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

@@ -6,17 +6,18 @@ module Metanorma
       module Blocks
         autoload :BasicBlock, "#{__dir__}/blocks/basic_block"
         autoload :BasicBlockNoNotes, "#{__dir__}/blocks/basic_block_no_notes"
+        autoload :ClassificationValue, "#{__dir__}/blocks/classification_value"
         autoload :NoteBlock, "#{__dir__}/blocks/note_block"
         autoload :Passthrough, "#{__dir__}/blocks/passthrough"
-        autoload :ClassificationValue, "#{__dir__}/blocks/requirement_model"
+        autoload :PermissionModel, "#{__dir__}/blocks/permission_model"
+        autoload :RecommendationModel, "#{__dir__}/blocks/recommendation_model"
+        autoload :RequirementBase, "#{__dir__}/blocks/requirement_base"
         autoload :RequirementClassification,
-                 "#{__dir__}/blocks/requirement_model"
-        autoload :RequirementDescription, "#{__dir__}/blocks/requirement_model"
-        autoload :RequirementInherit, "#{__dir__}/blocks/requirement_model"
-        autoload :RequirementBase, "#{__dir__}/blocks/requirement_model"
+                 "#{__dir__}/blocks/requirement_classification"
+        autoload :RequirementDescription,
+                 "#{__dir__}/blocks/requirement_description"
+        autoload :RequirementInherit, "#{__dir__}/blocks/requirement_inherit"
         autoload :RequirementModel, "#{__dir__}/blocks/requirement_model"
-        autoload :RecommendationModel, "#{__dir__}/blocks/requirement_model"
-        autoload :PermissionModel, "#{__dir__}/blocks/requirement_model"
       end
     end
   end

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

@@ -10,6 +10,7 @@ module Metanorma
           attribute :width, :string
           attribute :align, :string
           attribute :semx_id, :string
+          attribute :inline_svg, :string
 
           xml do
             element "image"
@@ -17,6 +18,7 @@ module Metanorma
             map_attribute "width", to: :width, render_empty: true
             map_attribute "align", to: :align
             map_attribute "semx-id", to: :semx_id
+            map_element "svg", to: :inline_svg, raw: :element
           end
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtAdmittedElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
                     collection: true
 

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtAnnotationBodyElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :id, :string
           attribute :date, :string
           attribute :from, :string

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtAnnotationEndElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :id, :string
           attribute :date, :string
           attribute :source, :string

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtAnnotationStartElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :id, :string
           attribute :date, :string
           attribute :source, :string