metanorma-document 0.2.0

data/lib/metanorma/ribose_document/root.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+require "metanorma/iso_document"
+
+module Metanorma
+  module RiboseDocument
+    # Most basic document flavor — uses StandardDocument metadata
+    # but ISO document structure for sections/blocks.
+    class Root < Metanorma::StandardDocument::Root
+      attribute :version, :string
+      attribute :type, :string
+      attribute :schema_version, :string
+      attribute :flavor, :string
+
+      attribute :bibdata,
+                Metanorma::RiboseDocument::Metadata::RiboseBibliographicItem
+
+      attribute :term_sources,
+                Metanorma::Document::Components::ReferenceElements::Citation,
+                collection: true
+
+      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
+      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
+      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
+                collection: true
+      attribute :bibliography,
+                Metanorma::StandardDocument::Sections::BibliographySection
+      attribute :boilerplate, Metanorma::IsoDocument::Boilerplate
+      attribute :metanorma_extension,
+                Metanorma::IsoDocument::Metadata::MetanormaExtension
+      attribute :annotation_container, Metanorma::IsoDocument::AnnotationContainer
+      attribute :indexsect,
+                Metanorma::Document::Components::Sections::BasicSection
+      attribute :autonum, :string
+      attribute :fmt_xref_label, :string
+      attribute :localized_strings,
+                Metanorma::Document::Components::Inline::LocalizedStringsElement
+      attribute :fmt_footnote_container,
+                Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
+      attribute :colophon, Metanorma::IsoDocument::Sections::Colophon
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+        map_attribute "type", to: :type
+        map_attribute "version", to: :version
+        map_attribute "schema-version", to: :schema_version
+        map_attribute "flavor", to: :flavor
+        map_element "bibdata", to: :bibdata
+        map_element "termdocsource", to: :term_sources
+        map_element "metanorma-extension", to: :metanorma_extension
+        map_element "boilerplate", to: :boilerplate
+        map_element "preface", to: :preface
+        map_element "sections", to: :sections
+        map_element "annex", to: :annex
+        map_element "bibliography", to: :bibliography
+        map_element "annotation-container", to: :annotation_container
+        map_element "indexsect", to: :indexsect
+        map_element "localized-strings", to: :localized_strings
+        map_element "fmt-footnote-container", to: :fmt_footnote_container
+        map_element "colophon", to: :colophon
+        map_attribute "autonum", to: :autonum
+        map_attribute "fmt-xref-label", to: :fmt_xref_label
+      end
+    end
+  end
+end

data/lib/metanorma/ribose_document.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+
+module Metanorma
+  module RiboseDocument
+    autoload :Metadata, "metanorma/ribose_document/metadata"
+    autoload :Root, "metanorma/ribose_document/root"
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Block expressing a machine-readable change in a document.
+      class AmendBlock < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :change, :string
+        attribute :bib_locality, Metanorma::Document::Relaton::BibItemLocality,
+                  collection: true
+        attribute :path, :string
+        attribute :path_end, :string
+        attribute :position, :string
+        attribute :name, :string
+        attribute :description,
+                  AmendContentBlock, collection: true
+        attribute :auto_number, Metanorma::StandardDocument::Blocks::AutoNumber,
+                  collection: true
+        attribute :new_content,
+                  AmendContentBlock, collection: true
+
+        # Presentation-specific attributes
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "amend"
+          mixed_content
+          map_attribute "change", to: :change
+          map_element "bib-locality", to: :bib_locality
+          map_attribute "path", to: :path
+          map_attribute "position", to: :position
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_attribute "path-end", to: :path_end
+          map_attribute "name", to: :name
+          map_element "autonumber", to: :auto_number
+          map_element "description", to: :description
+          map_element "newcontent", to: :new_content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Content block for amend description and new-content elements.
+      # Uses map_all_content to preserve all children (p, ol, ul, table, etc.)
+      class AmendContentBlock < Lutaml::Model::Serializable
+        attribute :content, :string
+
+        xml do
+          map_all_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Specification of how blocks of a given class should be autonumbered
+      # within an AmendBlock newContent element.
+      class AutoNumber < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :value, :string
+
+        xml do
+          element "autonumber"
+          map_attribute "type", to: :type
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Reference origin within a block source: <origin bibitemid="..." citeas="...">
+      # Schema: isodoc.rnc — origin = element origin { erefType | termref }
+      class SourceOriginElement < Lutaml::Model::Serializable
+        attribute :bibitemid, :string
+        attribute :type, :string
+        attribute :citeas, :string
+        attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                  collection: true
+
+        xml do
+          element "origin"
+          map_attribute "bibitemid", to: :bibitemid
+          map_attribute "type", to: :type
+          map_attribute "citeas", to: :citeas
+          map_element "localityStack", to: :locality_stack
+        end
+      end
+
+      # Bibliographic source for a block: <source status="..." type="...">
+      #   <origin bibitemid="..." citeas="..."/>
+      #   <modification>...</modification>?
+      # </source>
+      # Schema: isodoc.rnc BlockSource = source*
+      class BlockSourceElement < Lutaml::Model::Serializable
+        attribute :status, :string
+        attribute :type, :string
+        attribute :origin, SourceOriginElement
+        attribute :modification, Metanorma::Document::Components::Paragraphs::ParagraphBlock
+
+        xml do
+          element "source"
+          map_attribute "status", to: :status
+          map_attribute "type", to: :type
+          map_element "origin", to: :origin
+          map_element "modification", to: :modification
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # The type of change described in AmendBlock.
+      class ChangeType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "change-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[add modify delete]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # The classes of block subject to autonumbering within an `AmendBlock` `newContent` element.
+      class ElementName < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "element-name"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[requirement recommendation permission table figure admonition formula
+             sourcecode example note]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Input form, for use under HTML.
+      class Form < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :id, :string
+        attribute :name, :string
+        attribute :action, :string
+        attribute :class_attr, :string
+        attribute :text,
+                  Metanorma::Document::Components::TextElements::TextElement, collection: true
+        attribute :input, Metanorma::StandardDocument::Elements::FormInput,
+                  collection: true
+        attribute :label, Metanorma::StandardDocument::Elements::Label,
+                  collection: true
+        attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+        attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                  collection: true
+
+        xml do
+          element "form"
+          map_attribute "id", to: :id
+          map_attribute "name", to: :name
+          map_attribute "action", to: :action
+          map_attribute "class", to: :class_attr
+          map_element "text", to: :text
+          map_element "input", to: :input
+          map_element "label", to: :label
+          map_element "p", to: :p
+          map_element "table", to: :table
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Specification of an area of an image to be hyperlinked, as part of an image map.
+      class ImageMapAreaType < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :element, Metanorma::Document::Components::ReferenceElements::ReferenceElement
+        attribute :coords, Metanorma::StandardDocument::Blocks::ImageMapCoords,
+                  collection: true
+        attribute :radius, Metanorma::StandardDocument::Blocks::ImageMapRadius
+
+        xml do
+          element "image-map-area-type"
+          map_attribute "type", to: :type
+          map_element "element", to: :element
+          map_element "coords", to: :coords
+          map_element "radius", to: :radius
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # The type of area in an image map to be hyperlinked.
+      class ImageMapAreaTypeType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "image-map-area-type-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[rect circle ellipse poly]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Wrapper around an image file, to specify an image map, with areas of an image being hyperlinked.
+      class ImageMapBlock < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :source, :string
+        attribute :alt, :string
+        attribute :area, Metanorma::StandardDocument::Blocks::ImageMapAreaType,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "image-map-block"
+          map_attribute "source", to: :source
+          map_attribute "alt", to: :alt
+          map_element "area", to: :area
+
+          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/image_map_coords.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Coordinate point to be used within an image map.
+      class ImageMapCoords < Lutaml::Model::Serializable
+        attribute :x, :float
+        attribute :y, :float
+
+        xml do
+          element "image-map-coords"
+          map_attribute "x", to: :x
+          map_attribute "y", to: :y
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Radius of a circle area within an image map.
+      class ImageMapRadius < Lutaml::Model::Serializable
+        attribute :x, :float
+        attribute :y, :float
+
+        xml do
+          element "image-map-radius"
+          map_attribute "x", to: :x
+          map_attribute "y", to: :y
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # How a block element may be rendered in a multilingual document.
+      class MultilingualRenderingType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "multilingual-rendering-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[common all-columns parallel tag]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Wrapper around raw markup to be transferred into one or more nominated output formats
+      # during processing.
+      class Passthrough < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :formats, :string
+        attribute :content, :string
+
+        xml do
+          element "passthrough"
+          map_attribute "formats", to: :formats
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      # Value element inside classification — mixed content with link.
+      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
+
+      # Classification element inside requirement with tag/value children.
+      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
+
+      # Description wrapper inside requirements containing paragraphs and other 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
+
+      # Inherit element — mixed content, can contain text, eref, or xref.
+      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
+
+      # Base class for requirement/recommendation/permission with shared structure.
+      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::StandardDocument::Blocks::RequirementModel",
+                  collection: true
+        attribute :recommendation, "Metanorma::StandardDocument::Blocks::RecommendationModel",
+                  collection: true
+        attribute :permission, "Metanorma::StandardDocument::Blocks::PermissionModel",
+                  collection: true
+        attribute :example,
+                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                  collection: true
+      end
+
+      # Requirement element — prescriptive statement using "shall".
+      class RequirementModel < RequirementBase
+        xml do
+          element "requirement"
+          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
+
+      # Recommendation element — prescriptive statement using "should".
+      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
+
+      # Permission element — prescriptive statement using "may".
+      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/standard_document/blocks/standard_admonition_block.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Blocks
+      class StandardAdmonitionBlock < Metanorma::Document::Components::MultiParagraph::AdmonitionBlock
+        attribute :cover_page, :boolean
+        attribute :notag, :boolean
+
+        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-admonition-block"
+          map_attribute "cover-page", to: :cover_page
+          map_attribute "notag", to: :notag
+
+          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