metanorma-document 0.2.0

data/lib/metanorma/bipm_document/metadata/bipm_bibliographic_item.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BipmDocument
+    module Metadata
+      # Depiction element containing image/SVG content.
+      class DepictionElement < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :content, :string
+
+        xml do
+          element "depiction"
+          map_attribute "type", to: :type
+          map_all_content to: :content
+        end
+      end
+
+      # The bibliographical description of a BIPM document.
+      # Inherits all ISO bibdata fields; BIPM adds depiction.
+      class BipmBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, BipmBibDataExtensionType
+        attribute :depiction, DepictionElement
+
+        xml do
+          element "bibdata"
+          map_element "depiction", to: :depiction
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bipm_document/metadata/bipm_structured_identifier.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BipmDocument
+    module Metadata
+      # Structured identifier for BIPM documents (docnumber only).
+      class BipmStructuredIdentifier < Lutaml::Model::Serializable
+        attribute :docnumber, :string
+        attribute :part, :string
+        attribute :appendix, :string
+
+        xml do
+          element "structuredidentifier"
+          map_element "docnumber", to: :docnumber
+          map_element "part", to: :part
+          map_element "appendix", to: :appendix
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bipm_document/metadata.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BipmDocument
+    module Metadata
+      autoload :BipmBibDataExtensionType,
+               "#{__dir__}/metadata/bipm_bib_data_extension_type"
+      autoload :BipmBibliographicItem,
+               "#{__dir__}/metadata/bipm_bibliographic_item"
+      autoload :BipmStructuredIdentifier,
+               "#{__dir__}/metadata/bipm_structured_identifier"
+      autoload :DepictionElement, "#{__dir__}/metadata/bipm_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/bipm_document/root.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+require "metanorma/iso_document"
+
+module Metanorma
+  module BipmDocument
+    class Root < Metanorma::StandardDocument::Root
+      attribute :version, :string
+      attribute :type, :string
+      attribute :schema_version, :string
+      attribute :flavor, :string
+
+      attribute :bibdata, Metadata::BipmBibliographicItem
+
+      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/bipm_document.rb

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

data/lib/metanorma/cc_document/metadata/cc_bib_data_extension_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module CcDocument
+    module Metadata
+      # Extension point for bibliographical definitions of CC documents.
+      # Inherits all ISO extension fields; CC adds nothing extra.
+      class CcBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+      end
+    end
+  end
+end

data/lib/metanorma/cc_document/metadata/cc_bibliographic_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module CcDocument
+    module Metadata
+      # The bibliographical description of a CC document.
+      # Inherits all ISO bibdata fields; CC adds nothing extra.
+      class CcBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, CcBibDataExtensionType
+
+        xml do
+          element "bibdata"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/cc_document/metadata.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module CcDocument
+    module Metadata
+      autoload :CcBibDataExtensionType,
+               "#{__dir__}/metadata/cc_bib_data_extension_type"
+      autoload :CcBibliographicItem, "#{__dir__}/metadata/cc_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/cc_document/root.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+require "metanorma/iso_document"
+
+module Metanorma
+  module CcDocument
+    class Root < Metanorma::StandardDocument::Root
+      attribute :version, :string
+      attribute :type, :string
+      attribute :schema_version, :string
+      attribute :flavor, :string
+
+      attribute :bibdata, Metadata::CcBibliographicItem
+
+      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/cc_document.rb

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

data/lib/metanorma/collection/directive.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Collection
+    # A key-value directive in a metanorma-collection.
+    # Directives control collection behavior (e.g., documents-inline, flavor).
+    class Directive < Lutaml::Model::Serializable
+      attribute :key, :string
+      attribute :value, :string
+
+      xml do
+        element "directive"
+        map_element "key", to: :key
+        map_element "value", to: :value
+      end
+    end
+  end
+end

data/lib/metanorma/collection/doc_container.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Collection
+    # A container for an embedded document within a metanorma-collection.
+    # Each doc-container holds one <metanorma> document identified by its id attribute.
+    class DocContainer < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :document, Metanorma::IsoDocument::Root
+
+      xml do
+        element "doc-container"
+        map_attribute "id", to: :id
+        map_element "metanorma", to: :document
+      end
+    end
+  end
+end

data/lib/metanorma/collection/entry.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Collection
+    # An entry in a metanorma-collection manifest.
+    # Entries are recursive — a top-level entry can contain nested entries,
+    # each representing a document in the collection.
+    class Entry < Lutaml::Model::Serializable
+      attribute :index, :string
+      attribute :target, :string
+      attribute :fileref, :string
+      attribute :identifier, :string
+      attribute :type, :string
+      attribute :title, :string
+      attribute :format, :string, collection: true
+      attribute :bibdata, Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+      attribute :entry, Entry, collection: true
+
+      xml do
+        element "entry"
+        map_attribute "index", to: :index
+        map_attribute "target", to: :target
+        map_attribute "fileref", to: :fileref
+        map_element "identifier", to: :identifier
+        map_element "type", to: :type
+        map_element "title", to: :title
+        map_element "format", to: :format
+        map_element "bibdata", to: :bibdata
+        map_element "entry", to: :entry
+      end
+    end
+  end
+end

data/lib/metanorma/collection/root.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Collection
+    # Root model for <metanorma-collection> XML.
+    # Represents a collection of Metanorma documents bundled together,
+    # with shared metadata, directives, and a manifest of entries.
+    #
+    # The collection root has no namespace (semantic) or xmlns="http://metanorma.org"
+    # (presentation). Embedded <metanorma> documents inside doc-containers use
+    # the standoc namespace (https://www.metanorma.org/ns/standoc).
+    class Root < Lutaml::Model::Serializable
+      attribute :bibdata, Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+      attribute :directive, Directive, collection: true
+      attribute :entry, Entry
+      attribute :format, :string, collection: true
+      attribute :coverpage, :string
+      attribute :doc_container, DocContainer, collection: true
+
+      xml do
+        element "metanorma-collection"
+        map_element "bibdata", to: :bibdata
+        map_element "directive", to: :directive
+        map_element "entry", to: :entry
+        map_element "format", to: :format
+        map_element "coverpage", to: :coverpage
+        map_element "doc-container", to: :doc_container
+      end
+    end
+  end
+end

data/lib/metanorma/collection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "metanorma/iso_document"
+
+module Metanorma
+  module Collection
+    autoload :Root, "metanorma/collection/root"
+    autoload :Directive, "metanorma/collection/directive"
+    autoload :Entry, "metanorma/collection/entry"
+    autoload :DocContainer, "metanorma/collection/doc_container"
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # Block containing an example illustrating a claim made in the main flow of text.
+        class ExampleBlock < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
+          # The caption of the block.
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement,
+                    collection: true
+
+          # The block should be excluded from any automatic numbering of blocks of this class in the document.
+          attribute :unnumbered, :boolean
+
+          # Define a subsequence for numbering of this example block.
+          #
+          # [example]
+          # If this block is numbered as 7, and 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
+
+          # Formula blocks contributing to example content.
+          attribute :formula, Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
+                    collection: true
+
+          # Unordered list blocks contributing to example content.
+          attribute :list, Metanorma::Document::Components::Lists::UnorderedList,
+                    collection: true
+
+          # Ordered list blocks contributing to example content.
+          attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                    collection: true
+
+          # Unordered list blocks (ul element).
+          attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                    collection: true
+
+          # Quotation blocks contributing to example content.
+          attribute :quote, Metanorma::Document::Components::MultiParagraph::QuoteBlock,
+                    collection: true
+
+          # Sourcecode blocks contributing to example content.
+          attribute :sourcecode,
+                    Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock, collection: true
+
+          # Table blocks contributing to example content.
+          attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                    collection: true
+
+          # Figure blocks contributing to example content.
+          attribute :figure,
+                    Metanorma::Document::Components::AncillaryBlocks::FigureBlock, collection: true
+
+          # Definition list blocks contributing to example content.
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList,
+                    collection: true
+
+          # Requirement/recommendation/permission blocks inside examples.
+          attribute :requirement, "Metanorma::StandardDocument::Blocks::RequirementModel",
+                    collection: true
+          attribute :recommendation, "Metanorma::StandardDocument::Blocks::RecommendationModel",
+                    collection: true
+          attribute :permission, "Metanorma::StandardDocument::Blocks::PermissionModel",
+                    collection: true
+
+          # Paragraph blocks contributing to example content.
+          attribute :paragraphs,
+                    Metanorma::Document::Components::Paragraphs::ParagraphWithFootnote, collection: true
+
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :autonum, :string
+
+          # Presentation-specific elements
+          attribute :fmt_xref_label,
+                    Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+
+          attribute :json_type, :string
+
+          def json_type
+            "example"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "name", to: :name
+            map "paragraphs", to: :paragraphs
+          end
+
+          xml do
+            element "example"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "autonum", to: :autonum, render_empty: true
+            map_element "name", to: :name
+            map_attribute "unnumbered", to: :unnumbered
+            map_attribute "subsequence", to: :subsequence
+            map_element "formula", to: :formula
+            map_element "list", to: :list
+            map_element "ol", to: :ol
+            map_element "ul", to: :ul
+            map_element "quote", to: :quote
+            map_element "sourcecode", to: :sourcecode
+            map_element "table", to: :table
+            map_element "figure", to: :figure
+            map_element "dl", to: :dl
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "p", to: :paragraphs
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "fmt-name", to: :fmt_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # Block containing a figure: a visual rather than textual asset, possibly with accompanying text.
+        class FigureBlock < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
+          # A URI or other reference intended to link to an externally hosted image (or equivalent).
+          attribute :source, :string
+
+          # The block should be excluded from any automatic numbering of blocks of this class in the document.
+          attribute :unnumbered, :boolean
+
+          # 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
+
+          # The caption of the block.
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
+
+          # The semantic category of the figure. This is to allow different classes of figure (e.g. _Plate_,
+          # _Chart_, _Diagram_) to be auto-numbered and captioned differently.
+          attribute :figure_class, :string
+
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :autonum, :string
+          attribute :displayorder, :integer
+          attribute :height, :string
+          attribute :width, :string
+
+          # The image file to be included in the figure as its main content.
+          attribute :image, Metanorma::Document::Components::IdElements::Image
+
+          # The video file to be included in the figure as its main content.
+          attribute :video, Metanorma::Document::Components::IdElements::Video
+
+          # The audio file to be included in the figure as its main content.
+          attribute :audio, Metanorma::Document::Components::IdElements::Audio
+
+          # Figures embedded within the main figure.
+          attribute :figure,
+                    Metanorma::Document::Components::AncillaryBlocks::Subfigure, collection: true
+
+          # An optional definitions list defining any symbols used in the figure.
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+
+          # Pre-formatted text content within the figure (e.g., ASCII art).
+          attribute :pre, Metanorma::Document::Components::AncillaryBlocks::LiteralBlock
+
+          # Key definitions for figure
+          attribute :key, KeyElement
+
+          # Optional footnotes specific to the figure.
+          attribute :footnotes, Metanorma::Document::Components::Inline::FnElement,
+                    collection: true
+
+          # Notes attached to the figure.
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+
+          # Presentation-specific elements
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+          attribute :fmt_xref_label,
+                    Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true
+
+          attribute :json_type, :string
+
+          def json_type
+            "figure"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "image", to: :image
+            map "name", to: :name
+          end
+
+          xml do
+            element "figure"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "autonum", to: :autonum
+            map_attribute "displayorder", to: :displayorder
+            map_attribute "height", to: :height
+            map_attribute "width", to: :width, render_empty: true
+            map_attribute "source", to: :source
+            map_attribute "unnumbered", to: :unnumbered
+            map_attribute "subsequence", to: :subsequence
+            map_element "name", to: :name
+            map_attribute "class", to: :figure_class
+            map_element "image", to: :image
+            map_element "video", to: :video
+            map_element "audio", to: :audio
+            map_element "figure", to: :figure
+            map_element "dl", to: :dl
+            map_element "pre", to: :pre
+            map_element "key", to: :key
+            map_element "fn", to: :footnotes
+            map_element "note", to: :note
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+          end
+        end
+      end
+    end
+  end
+end