metanorma-document 0.2.0

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardBlock < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :keep_lines_together, :boolean
+        attribute :keep_with_next, :boolean
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-block"
+          map_attribute "keep-lines-together", to: :keep_lines_together
+          map_attribute "keep-with-next", to: :keep_with_next
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardBlockNoNotes < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
+        attribute :keep_with_next, :string
+        attribute :keep_lines_together, :string
+        attribute :tag, :string
+        attribute :multilingual_rendering, :string
+        attribute :columns, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-block-no-notes"
+          map_attribute "keep-with-next", to: :keep_with_next
+          map_attribute "keep-lines-together", to: :keep_lines_together
+          map_attribute "tag", to: :tag
+          map_attribute "multilingual-rendering", to: :multilingual_rendering
+          map_attribute "columns", to: :columns
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardExampleBlock < Metanorma::Document::Components::AncillaryBlocks::ExampleBlock
+        attribute :number, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-example-block"
+          map_attribute "number", to: :number
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardFigureBlock < Metanorma::Document::Components::AncillaryBlocks::FigureBlock
+        attribute :width, :string
+        attribute :number, :string
+        attribute :source, BlockSourceElement, collection: true
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-figure-block"
+          map_attribute "width", to: :width
+          map_attribute "number", to: :number
+          map_element "source", to: :source
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardFormulaBlock < Metanorma::Document::Components::AncillaryBlocks::FormulaBlock
+        attribute :number, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-formula-block"
+          map_attribute "number", to: :number
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardNoteBlock < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :keep_lines_together, :boolean
+        attribute :keep_with_next, :boolean
+        attribute :number, :string
+        attribute :subsequence, :string
+        attribute :unnumbered, :boolean
+        attribute :cover_page, :boolean
+        attribute :notag, :boolean
+        attribute :type, :string
+        attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                  collection: true
+        attribute :dl, Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
+        attribute :formula,
+                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock, collection: true
+        attribute :sourcecode,
+                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock, collection: true
+        attribute :quotes,
+                  Metanorma::Document::Components::MultiParagraph::QuoteBlock, collection: true
+
+        # Presentation-specific attributes
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-note-block"
+          map_attribute "keep-lines-together", to: :keep_lines_together
+          map_attribute "keep-with-next", to: :keep_with_next
+          map_attribute "number", to: :number
+          map_attribute "subsequence", to: :subsequence
+          map_attribute "unnumbered", to: :unnumbered
+          map_attribute "cover-page", to: :cover_page
+          map_attribute "notag", to: :notag
+          map_attribute "type", to: :type
+          map_element "ul", to: :ul
+          map_element "ol", to: :ol
+          map_element "dl", to: :dl
+          map_element "formula", to: :formula
+          map_element "sourcecode", to: :sourcecode
+          map_element "quote", to: :quotes
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardParagraphBlock < Metanorma::Document::Components::Paragraphs::ParagraphBlock
+        attribute :type, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        xml do
+          element "standard-paragraph-block"
+          map_attribute "type", to: :type
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardQuoteBlock < Metanorma::Document::Components::MultiParagraph::QuoteBlock
+        attribute :type, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+        xml do
+          element "standard-quote-block"
+          map_attribute "type", to: :type
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardSourcecodeBlock < Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock
+        attribute :linenums, :string
+        attribute :number, :string
+        attribute :source, BlockSourceElement, collection: true
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-sourcecode-block"
+          map_attribute "linenums", to: :linenums
+          map_attribute "number", to: :number
+          map_element "source", to: :source
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardTableBlock < Metanorma::Document::Components::Tables::TableBlock
+        attribute :width, :string
+        attribute :plain, :string
+        attribute :style, :string
+        attribute :number, :string
+        attribute :colgroup, Metanorma::StandardDocument::Blocks::TableCol,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-table-block"
+          map_attribute "width", to: :width
+          map_attribute "plain", to: :plain
+          map_attribute "style", to: :style
+          map_attribute "number", to: :number
+          map_element "colgroup", to: :colgroup
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_element "fmt-name", to: :fmt_name
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Wrapper around an SVG file, to update its hyperlinks with potentially document-specific
+      # links, so that the SVG file can hyperlink to anchors within the document.
+      class SvgMapBlock < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :source, :string
+        attribute :alt, :string
+        attribute :target, Metanorma::StandardDocument::Blocks::SvgTargetType,
+                  collection: true
+
+        xml do
+          element "svg-map-block"
+          map_attribute "source", to: :source
+          map_attribute "alt", to: :alt
+          map_element "target", to: :target
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Specification of (potentially document-specific) cross-references, to overwrite the
+      # links within an SVG file, so that the SVG file can hyperlink to anchors within the document.
+      class SvgTargetType < Lutaml::Model::Serializable
+        attribute :href, :string
+        attribute :reference_element, Metanorma::Document::Components::ReferenceElements::ReferenceElement
+
+        xml do
+          element "svg-target-type"
+          map_attribute "href", to: :href
+          map_element "reference-element", to: :reference_element
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class TableCol < Lutaml::Model::Serializable
+        attribute :width, :string
+
+        xml do
+          element "table-col"
+          map_attribute "width", to: :width
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Table of contents, represented as a list of crossreferences, each with textual content.
+      class ToC < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :list, Metanorma::StandardDocument::Lists::StandardUnorderedList
+
+        xml do
+          element "toc"
+          map_element "list", to: :list
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/blocks.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      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 :AutoNumber, "#{__dir__}/blocks/auto_number"
+      autoload :ChangeType, "#{__dir__}/blocks/change_type"
+      autoload :ElementName, "#{__dir__}/blocks/element_name"
+      autoload :Form, "#{__dir__}/blocks/form"
+      autoload :ImageMapAreaType, "#{__dir__}/blocks/image_map_area_type"
+      autoload :ImageMapAreaTypeType,
+               "#{__dir__}/blocks/image_map_area_type_type"
+      autoload :ImageMapBlock, "#{__dir__}/blocks/image_map_block"
+      autoload :ImageMapCoords, "#{__dir__}/blocks/image_map_coords"
+      autoload :ImageMapRadius, "#{__dir__}/blocks/image_map_radius"
+      autoload :MultilingualRenderingType,
+               "#{__dir__}/blocks/multilingual_rendering_type"
+      autoload :Passthrough, "#{__dir__}/blocks/passthrough"
+      autoload :StandardAdmonitionBlock,
+               "#{__dir__}/blocks/standard_admonition_block"
+      autoload :StandardBlock, "#{__dir__}/blocks/standard_block"
+      autoload :StandardBlockNoNotes,
+               "#{__dir__}/blocks/standard_block_no_notes"
+      autoload :StandardExampleBlock, "#{__dir__}/blocks/standard_example_block"
+      autoload :StandardFigureBlock, "#{__dir__}/blocks/standard_figure_block"
+      autoload :StandardFormulaBlock, "#{__dir__}/blocks/standard_formula_block"
+      autoload :StandardNoteBlock, "#{__dir__}/blocks/standard_note_block"
+      autoload :StandardParagraphBlock,
+               "#{__dir__}/blocks/standard_paragraph_block"
+      autoload :StandardQuoteBlock, "#{__dir__}/blocks/standard_quote_block"
+      autoload :StandardSourcecodeBlock,
+               "#{__dir__}/blocks/standard_sourcecode_block"
+      autoload :StandardTableBlock, "#{__dir__}/blocks/standard_table_block"
+      autoload :ClassificationValue,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :RequirementClassification,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :RequirementDescription,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :RequirementInherit,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :RequirementBase,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :RequirementModel,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :RecommendationModel,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :PermissionModel,
+               "#{__dir__}/blocks/requirement_model"
+      autoload :SvgMapBlock, "#{__dir__}/blocks/svg_map_block"
+      autoload :SvgTargetType, "#{__dir__}/blocks/svg_target_type"
+      autoload :TableCol, "#{__dir__}/blocks/table_col"
+      autoload :ToC, "#{__dir__}/blocks/to_c"
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/add.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Indication of text added through editorial intervention.
+      class Add < Metanorma::Document::Components::TextElements::TextElement
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        xml do
+          element "add"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/del.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Indication of text deleted through editorial intervention.
+      class Del < Metanorma::Document::Components::TextElements::TextElement
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        xml do
+          element "del"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/form_input.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Input element for forms, associated with name/value pair to be submitted
+      class FormInput < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :name, :string
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "form-input"
+          map_attribute "id", to: :id
+          map_attribute "name", to: :name
+          map_attribute "value", to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/input.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Indication of text added through editorial intervention.
+      class Input < Metanorma::StandardDocument::Elements::FormInput
+        attribute :type, :string
+        attribute :checked, :boolean
+        attribute :disabled, :boolean
+        attribute :readonly, :boolean
+        attribute :maxlength, :integer
+        attribute :minlength, :integer
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "input"
+          map_attribute "type", to: :type
+          map_attribute "checked", to: :checked
+          map_attribute "disabled", to: :disabled
+          map_attribute "readonly", to: :readonly
+          map_attribute "maxlength", to: :maxlength
+          map_attribute "minlength", to: :minlength
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/input_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Type of simple Input element
+      class InputType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "input-type"
+          map_content to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+
+        def self.values
+          %w[button checkbox date file password radio submit text]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/label.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Label associated with form input element
+      class Label < Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        xml do
+          element "label"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/option.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Option of a Select input
+      class Option < Lutaml::Model::Serializable
+        attribute :disabled, :boolean
+        attribute :value, :string
+        attribute :content, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "option"
+          map_attribute "disabled", to: :disabled
+          map_attribute "value", to: :value
+          map_content to: :content
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end