metanorma-document 0.2.0

data/lib/metanorma/ietf_document/metadata/ietf_editorial_group.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IetfDocument
+    module Metadata
+      # IETF editorial group containing workgroup names.
+      class IetfEditorialGroup < Lutaml::Model::Serializable
+        attribute :workgroup, :string, collection: true
+
+        xml do
+          element "editorialgroup"
+          map_element "workgroup", to: :workgroup
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ietf_document/metadata.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IetfDocument
+    module Metadata
+      autoload :IetfBibDataExtensionType,
+               "metanorma/ietf_document/metadata/ietf_bib_data_extension_type"
+      autoload :IetfBibliographicItem,
+               "metanorma/ietf_document/metadata/ietf_bibliographic_item"
+      autoload :IetfEditorialGroup,
+               "metanorma/ietf_document/metadata/ietf_editorial_group"
+    end
+  end
+end

data/lib/metanorma/ietf_document/root.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+require "metanorma/iso_document"
+require_relative "metadata"
+require_relative "sections"
+
+module Metanorma
+  module IetfDocument
+    class Root < Metanorma::StandardDocument::Root
+      attribute :version, :string
+      attribute :type, :string
+      attribute :schema_version, :string
+      attribute :flavor, :string
+
+      attribute :bibdata,
+                Metanorma::IetfDocument::Metadata::IetfBibliographicItem
+
+      attribute :term_sources,
+                Metanorma::Document::Components::ReferenceElements::Citation,
+                collection: true
+
+      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
+      attribute :sections, Metanorma::IetfDocument::Sections::IetfSections
+      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 :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/ietf_document/sections.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "metanorma/iso_document"
+
+module Metanorma
+  module IetfDocument
+    module Sections
+      class IetfSections < Metanorma::IsoDocument::Sections::IsoSections
+        # Loose bibliographic items appearing directly inside sections.
+        attribute :bibitem,
+                  Metanorma::BasicDocument::BibData::BibliographicItem,
+                  collection: true
+
+        xml do
+          element "sections"
+          ordered
+          map_element "note", to: :note
+          map_element "admonition", to: :admonition
+          map_element "terms", to: :terms
+          map_element "definitions", to: :definitions
+          map_element "clause", to: :clause
+          map_element "references", to: :references
+          map_element "bibitem", to: :bibitem
+          map_element "p", to: :p
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ietf_document.rb

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

data/lib/metanorma/iho_document/metadata/iho_bib_data_extension_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "metanorma/iso_document"
+
+module Metanorma
+  module IhoDocument
+    module Metadata
+      # Extension point for bibliographical definitions of IHO documents.
+      class IhoBibDataExtensionType < Lutaml::Model::Serializable
+        attribute :doctype,
+                  Metanorma::IsoDocument::Metadata::DoctypeElement,
+                  collection: true
+        attribute :flavor, :string
+        attribute :editorial_group, IhoEditorialGroup
+
+        xml do
+          element "ext"
+          map_element "doctype", to: :doctype
+          map_element "flavor", to: :flavor
+          map_element "editorialgroup", to: :editorial_group
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iho_document/metadata/iho_bibliographic_item.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IhoDocument
+    module Metadata
+      # The bibliographical description of an IHO document.
+      # IHO-specific: series in bibdata, IHO editorial group in ext.
+      class IhoBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, IhoBibDataExtensionType
+        attribute :series, IhoSeries, collection: true
+
+        xml do
+          element "bibdata"
+          map_element "ext", to: :ext
+          map_element "series", to: :series
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iho_document/metadata/iho_editorial_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IhoDocument
+    module Metadata
+      # Editorial group for IHO documents with committee and workgroup.
+      class IhoEditorialGroup < Lutaml::Model::Serializable
+        attribute :committee, IhoSubGroup, collection: true
+        attribute :workgroup, IhoSubGroup, collection: true
+
+        xml do
+          element "editorialgroup"
+          map_element "committee", to: :committee
+          map_element "workgroup", to: :workgroup
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iho_document/metadata/iho_series.rb

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

data/lib/metanorma/iho_document/metadata/iho_sub_group.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IhoDocument
+    module Metadata
+      # An editorial group sub-unit (committee, workgroup, etc.)
+      # with an abbreviation child element.
+      class IhoSubGroup < Lutaml::Model::Serializable
+        attribute :abbreviation, :string
+
+        xml do
+          element "subgroup"
+          map_element "abbreviation", to: :abbreviation
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iho_document/metadata.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IhoDocument
+    module Metadata
+      autoload :IhoBibDataExtensionType,
+               "#{__dir__}/metadata/iho_bib_data_extension_type"
+      autoload :IhoBibliographicItem,
+               "#{__dir__}/metadata/iho_bibliographic_item"
+      autoload :IhoEditorialGroup, "#{__dir__}/metadata/iho_editorial_group"
+      autoload :IhoSeries, "#{__dir__}/metadata/iho_series"
+      autoload :IhoSubGroup, "#{__dir__}/metadata/iho_sub_group"
+    end
+  end
+end

data/lib/metanorma/iho_document/root.rb

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "metanorma/standard_document"
+require "metanorma/iso_document"
+
+module Metanorma
+  module IhoDocument
+    autoload :Metadata, "metanorma/iho_document/metadata"
+    autoload :Root, "metanorma/iho_document/root"
+  end
+end

data/lib/metanorma/iso_document/annotation_container.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    # Container for review annotations. Uses map_all_content to preserve
+    # mixed content including annotation elements with their p children.
+    class AnnotationContainer < Lutaml::Model::Serializable
+      attribute :content, :string
+
+      xml do
+        element "annotation-container"
+        map_all_content to: :content
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/blocks/iso_admonition_block.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Blocks
+      class IsoAdmonitionBlock < Lutaml::Model::Serializable
+        # Types of admonition specific to ISO/IEC.
+        attribute :type, :string
+        attribute :semx_id, :string
+        attribute :autonum, :string
+        attribute :fmt_name, :string
+        attribute :fmt_xref_label, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "admonition"
+          map_attribute "type", to: :type
+          map_attribute "semx-id", to: :semx_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/iso_document/blocks/iso_admonition_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Blocks
+      # Types of admonition specific to ISO/IEC.
+      class IsoAdmonitionType < Lutaml::Model::Serializable
+        attribute :value, :string
+        attribute :semx_id, :string
+        attribute :displayorder, :integer
+
+        def self.values
+          %w[danger caution warning important safetyPrecautions]
+        end
+
+        xml do
+          element "iso-admonition-type"
+          map_content to: :value
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/blocks.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Blocks
+      autoload :IsoAdmonitionBlock,
+               "#{__dir__}/blocks/iso_admonition_block"
+      autoload :IsoAdmonitionType,
+               "#{__dir__}/blocks/iso_admonition_type"
+    end
+  end
+end

data/lib/metanorma/iso_document/boilerplate.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    # Boilerplate section containing copyright statements and license text.
+    # Uses map_all_content to preserve all child XML including inline
+    # elements (span, link, br) inside paragraphs.
+    class Boilerplate < Lutaml::Model::Serializable
+      attribute :content, :string
+
+      xml do
+        element "boilerplate"
+        map_all_content to: :content
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/metadata/abstract_title.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Metadata
+      # Abstract base class for typed title elements.
+      # Subclasses correspond to different title types in ISO XML:
+      # - TitleFull: type="main"
+      # - TitleIntro: type="title-intro"
+      # - TitleMain: type="title-main"
+      # - TitlePart: type="title-part"
+      # - TitlePartPrefix: type="title-part-prefix"
+      class AbstractTitle < Lutaml::Model::Serializable
+        attribute :_type, :string
+        attribute :language, :string
+        attribute :format, :string
+        attribute :value, :string
+        attribute :semx_id, :string
+
+        xml do
+          map_attribute "language", to: :language
+          map_attribute "type", to: :_type
+          map_attribute "format", to: :format
+          map_content to: :value
+          map_attribute "semx-id", to: :semx_id
+        end
+
+        json do
+          map "_type", to: :_type
+          map "language", to: :language
+          map "value", to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/metadata/doc_identifier.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Metadata
+      # Simple document identifier with type attribute and text content.
+      # Used for the multiple <docidentifier> elements in bibdata/bibitem.
+      class DocIdentifier < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :primary, :string
+        attribute :scope, :string
+        attribute :language, :string
+        attribute :value, :string
+
+        xml do
+          element "docidentifier"
+          map_attribute "type", to: :type
+          map_attribute "primary", to: :primary
+          map_attribute "scope", to: :scope
+          map_attribute "language", to: :language
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/metadata/ics.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Metadata
+      # ICS (International Classification for Standards) code entry.
+      class Ics < Lutaml::Model::Serializable
+        attribute :code, :string
+        attribute :text, :string
+
+        xml do
+          element "ics"
+          map_element "code", to: :code
+          map_element "text", to: :text
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/metadata/iec_document_category.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Metadata
+      # Categories of IEC standards document.
+      class IecDocumentCategory < Lutaml::Model::Serializable
+        attribute :value, :string
+        attribute :semx_id, :string
+
+        def self.values
+          %w[emc safety environment quality-assurance]
+        end
+
+        xml do
+          element "iec-document-category"
+          map_content to: :value
+          map_attribute "semx-id", to: :semx_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/metadata/iso_bib_data_extension_type.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Metadata
+      # Extension point for bibliographical definitions of ISO/IEC documents.
+      # Document type element with language attribute.
+      class DoctypeElement < Lutaml::Model::Serializable
+        attribute :language, :string
+        attribute :abbreviation, :string
+        attribute :value, :string
+
+        xml do
+          element "doctype"
+          map_attribute "language", to: :language, render_empty: true
+          map_attribute "abbreviation", to: :abbreviation
+          map_content to: :value
+        end
+      end
+
+      # Stage name element with abbreviation attribute.
+      class StagenameElement < Lutaml::Model::Serializable
+        attribute :abbreviation, :string
+        attribute :value, :string
+
+        xml do
+          element "stagename"
+          map_attribute "abbreviation", to: :abbreviation
+          map_content to: :value
+        end
+      end
+
+      class IsoBibDataExtensionType < Lutaml::Model::Serializable
+        # The document is a horizontal standard.
+        attribute :horizontal, :boolean
+
+        # Editorial groups associated with the production of the document.
+        attribute :editorial_group, IsoProjectGroup
+
+        # Name of the publication stage of the document.
+        attribute :stage_name, :string
+
+        # Category of IEC Standard applicable.
+        attribute :category, :string
+
+        # Type of document being updated by this document, if it is an amendment or technical corrigendum.
+        attribute :updates_document_type, :string
+        attribute :semx_id, :string
+
+        # Document type (e.g. "international-standard").
+        attribute :doctype, DoctypeElement, collection: true
+
+        # Document flavor (e.g. "iso").
+        attribute :flavor, :string
+
+        # ICS classification codes.
+        attribute :ics, Ics, collection: true
+
+        # Structured identifier (project number, part).
+        attribute :structuredidentifier, StructuredIdentifier
+
+        # Name of the publication stage.
+        attribute :stagename, StagenameElement
+
+        # Sub-document type.
+        attribute :subdoctype, :string
+
+        xml do
+          element "ext"
+          map_attribute "horizontal", to: :horizontal
+          map_element "editorial-group", to: :editorial_group
+          map_attribute "stage-name", to: :stage_name
+          map_attribute "category", to: :category
+          map_attribute "semx-id", to: :semx_id
+          map_element "doctype", to: :doctype
+          map_element "flavor", to: :flavor
+          map_element "ics", to: :ics
+          map_element "structuredidentifier", to: :structuredidentifier
+          map_element "stagename", to: :stagename
+          map_element "updates-document-type", to: :updates_document_type
+          map_element "subdoctype", to: :subdoctype
+        end
+      end
+    end
+  end
+end