metanorma-document 0.2.0

data/lib/metanorma/iso_document/terms/term_source.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Terms
+      # Modification element in term source, containing paragraphs.
+      class TermModification < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :p, RawParagraph, collection: true
+
+        xml do
+          element "modification"
+          map_attribute "id", to: :id
+          map_element "p", to: :p
+        end
+      end
+
+      # Source of a term definition, with optional modification info.
+      class TermSource < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :status, :string
+        attribute :type, :string
+        attribute :origin, TermOrigin
+        attribute :modification, TermModification
+
+        xml do
+          element "source"
+          map_attribute "id", to: :id
+          map_attribute "status", to: :status
+          map_attribute "type", to: :type
+          map_element "origin", to: :origin
+          map_element "modification", to: :modification
+        end
+      end
+
+      # Same structure as TermSource but mapped to the <termsource> element.
+      class TermsourceElement < TermSource
+        xml do
+          element "termsource"
+          map_attribute "id", to: :id
+          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/iso_document/terms/verbal_definition.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Terms
+      # Verbal definition of a term, containing paragraphs.
+      class VerbalDefinition < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :semx_id, :string
+        attribute :p, RawParagraph, collection: true
+        attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                  collection: true
+        attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+        attribute :formula,
+                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
+                  collection: true
+        attribute :figure,
+                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
+                  collection: true
+        attribute :table,
+                  Metanorma::Document::Components::Tables::TableBlock,
+                  collection: true
+
+        xml do
+          element "verbal-definition"
+          map_attribute "id", to: :id
+          map_attribute "semx-id", to: :semx_id
+          map_element "p", to: :p
+          map_element "ol", to: :ol
+          map_element "ul", to: :ul
+          map_element "dl", to: :dl
+          map_element "formula", to: :formula
+          map_element "figure", to: :figure
+          map_element "table", to: :table
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/terms.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Terms
+      autoload :IsoTermCollection,
+               "#{__dir__}/terms/iso_term_collection"
+      autoload :IsoTerm, "#{__dir__}/terms/iso_term"
+      autoload :TermDesignation, "#{__dir__}/terms/term_designation"
+      autoload :TermExpression, "#{__dir__}/terms/term_expression"
+      autoload :TermDefinition, "#{__dir__}/terms/term_definition"
+      autoload :VerbalDefinition, "#{__dir__}/terms/verbal_definition"
+      autoload :TermSource, "#{__dir__}/terms/term_source"
+      autoload :TermsourceElement, "#{__dir__}/terms/term_source"
+      autoload :TermOrigin, "#{__dir__}/terms/term_origin"
+      autoload :TermNote, "#{__dir__}/terms/term_note"
+      autoload :TermExample, "#{__dir__}/terms/term_example"
+    end
+  end
+end

data/lib/metanorma/iso_document.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+
+module Metanorma
+  module IsoDocument
+    autoload :AnnotationContainer, "metanorma/iso_document/annotation_container"
+    autoload :Blocks, "metanorma/iso_document/blocks"
+    autoload :Boilerplate, "metanorma/iso_document/boilerplate"
+    autoload :Metadata, "metanorma/iso_document/metadata"
+    autoload :RawParagraph, "metanorma/iso_document/raw_paragraph"
+    autoload :Root, "metanorma/iso_document/root"
+    autoload :Sections, "metanorma/iso_document/sections"
+    autoload :Terms, "metanorma/iso_document/terms"
+  end
+end

data/lib/metanorma/itu_document/metadata/itu_bib_data_extension_type.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module ItuDocument
+    module Metadata
+      # Study period element with start/end years.
+      class StudyPeriod < Lutaml::Model::Serializable
+        attribute :start, :string
+        attribute :end_year, :string
+
+        xml do
+          element "studyperiod"
+          map_element "start", to: :start
+          map_element "end", to: :end_year
+        end
+      end
+
+      # Meeting date with from/to children.
+      class MeetingDate < Lutaml::Model::Serializable
+        attribute :from, :string
+        attribute :to, :string
+
+        xml do
+          element "meeting-date"
+          map_element "from", to: :from
+          map_element "to", to: :to
+        end
+      end
+
+      # Meeting element with acronym attribute.
+      class MeetingElement < Lutaml::Model::Serializable
+        attribute :acronym, :string
+        attribute :text, :string
+
+        xml do
+          element "meeting"
+          map_attribute "acronym", to: :acronym
+          map_content to: :text
+        end
+      end
+
+      # Extension point for bibliographical definitions of ITU documents.
+      class ItuBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+        attribute :structuredidentifier, ItuStructuredIdentifier
+        attribute :ip_notice_received, :string
+        attribute :studyperiod, StudyPeriod
+        attribute :meeting, MeetingElement
+        attribute :meeting_date, MeetingDate
+        attribute :meeting_place, :string
+
+        xml do
+          element "ext"
+          map_element "structuredidentifier", to: :structuredidentifier
+          map_element "ip-notice-received", to: :ip_notice_received
+          map_element "studyperiod", to: :studyperiod
+          map_element "meeting", to: :meeting
+          map_element "meeting-date", to: :meeting_date
+          map_element "meeting-place", to: :meeting_place
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/itu_document/metadata/itu_bibliographic_item.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module ItuDocument
+    module Metadata
+      # The bibliographical description of an ITU document.
+      # Adds keyword, series, and ITU-specific extension elements.
+      class ItuBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :keyword, :string, collection: true
+        attribute :series, ItuSeries, collection: true
+        attribute :ext, ItuBibDataExtensionType
+
+        xml do
+          element "bibdata"
+          map_element "keyword", to: :keyword
+          map_element "series", to: :series
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/itu_document/metadata/itu_series.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module ItuDocument
+    module Metadata
+      # Series classification for ITU documents.
+      class ItuSeries < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :title, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+        attribute :number, :string
+
+        xml do
+          element "series"
+          map_attribute "type", to: :type
+          map_element "title", to: :title
+          map_element "number", to: :number
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/itu_document/metadata/itu_structured_identifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module ItuDocument
+    module Metadata
+      # Structured identifier for ITU documents (bureau + docnumber).
+      class ItuStructuredIdentifier < Lutaml::Model::Serializable
+        attribute :project_number, Metanorma::IsoDocument::Metadata::ProjectNumber
+        attribute :bureau, :string
+        attribute :docnumber, :string
+        attribute :annexid, :string
+
+        xml do
+          element "structuredidentifier"
+          map_element "project-number", to: :project_number
+          map_element "bureau", to: :bureau
+          map_element "docnumber", to: :docnumber
+          map_element "annexid", to: :annexid
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/itu_document/metadata.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module ItuDocument
+    module Metadata
+      autoload :ItuBibDataExtensionType,
+               "#{__dir__}/metadata/itu_bib_data_extension_type"
+      autoload :ItuBibliographicItem,
+               "#{__dir__}/metadata/itu_bibliographic_item"
+      autoload :ItuSeries, "#{__dir__}/metadata/itu_series"
+      autoload :ItuStructuredIdentifier,
+               "#{__dir__}/metadata/itu_structured_identifier"
+      autoload :StudyPeriod, "#{__dir__}/metadata/itu_bib_data_extension_type"
+      autoload :MeetingDate, "#{__dir__}/metadata/itu_bib_data_extension_type"
+      autoload :MeetingElement,
+               "#{__dir__}/metadata/itu_bib_data_extension_type"
+    end
+  end
+end

data/lib/metanorma/itu_document/root.rb

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

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

data/lib/metanorma/ogc_document/metadata/ogc_bib_data_extension_type.rb

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

data/lib/metanorma/ogc_document/metadata/ogc_bibliographic_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module OgcDocument
+    module Metadata
+      # The bibliographical description of an OGC document.
+      # Adds keyword element; OGC uses the same ext as ISO.
+      class OgcBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :keyword, :string, collection: true
+        attribute :ext, OgcBibDataExtensionType
+
+        xml do
+          element "bibdata"
+          map_element "keyword", to: :keyword
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ogc_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module OgcDocument
+    module Metadata
+      autoload :OgcBibDataExtensionType,
+               "#{__dir__}/metadata/ogc_bib_data_extension_type"
+      autoload :OgcBibliographicItem,
+               "#{__dir__}/metadata/ogc_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/ogc_document/root.rb

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

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

data/lib/metanorma/oiml_document/root.rb

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+require "metanorma/iso_document"
+
+module Metanorma
+  module OimlDocument
+    autoload :Root, "metanorma/oiml_document/root"
+  end
+end

data/lib/metanorma/ribose_document/metadata/ribose_bib_data_extension_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module RiboseDocument
+    module Metadata
+      # Extension point for bibliographical definitions of Ribose documents.
+      # Inherits all ISO extension fields; adds security and recipient.
+      class RiboseBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+        attribute :security, :string
+        attribute :recipient, :string
+
+        xml do
+          element "ext"
+          map_element "security", to: :security
+          map_element "recipient", to: :recipient
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ribose_document/metadata/ribose_bibliographic_item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module RiboseDocument
+    module Metadata
+      # Bibliographical description of a Ribose document.
+      # Inherits all ISO bibliographic fields; overrides ext for Ribose format.
+      class RiboseBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, RiboseBibDataExtensionType
+
+        xml do
+          element "bibdata"
+          map_element "ext", to: :ext
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ribose_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module RiboseDocument
+    module Metadata
+      autoload :RiboseBibDataExtensionType,
+               "#{__dir__}/metadata/ribose_bib_data_extension_type"
+      autoload :RiboseBibliographicItem,
+               "#{__dir__}/metadata/ribose_bibliographic_item"
+    end
+  end
+end