metanorma-document 0.5.0 → 0.5.2.pre.alpha.1

data/lib/metanorma/ieee_document/metadata/ieee_bib_data_extension_type.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    module Metadata
-      # Extension point for bibliographical definitions of IEEE documents.
-      # Inherits all ISO extension fields; overrides structuredidentifier for IEEE format.
-      class IeeeBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
-        attribute :structuredidentifier, IeeeStructuredIdentifier
-
-        xml do
-          element "ext"
-          map_element "structuredidentifier", to: :structuredidentifier
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ieee_document/metadata/ieee_bibliographic_item.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    module Metadata
-      # The bibliographical description of an IEEE document.
-      # IEEE adds keyword in bibdata and IEEE-specific structured identifier.
-      class IeeeBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
-        attribute :ext, IeeeBibDataExtensionType
-        attribute :keyword, :string, collection: true
-
-        xml do
-          element "bibdata"
-          map_element "ext", to: :ext
-          map_element "keyword", to: :keyword
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ieee_document/metadata/ieee_structured_identifier.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    module Metadata
-      # Structured identifier for IEEE documents (docnumber, agency, class, version, year).
-      class IeeeStructuredIdentifier < Lutaml::Model::Serializable
-        attribute :docnumber, :string
-        attribute :agency, :string
-        attribute :klass, :string
-        attribute :version, :string
-        attribute :year, :string
-
-        xml do
-          element "structuredidentifier"
-          map_element "docnumber", to: :docnumber
-          map_element "agency", to: :agency
-          map_element "class", to: :klass
-          map_element "version", to: :version
-          map_element "year", to: :year
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ieee_document/metadata.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    module Metadata
-      autoload :IeeeBibDataExtensionType,
-               "#{__dir__}/metadata/ieee_bib_data_extension_type"
-      autoload :IeeeBibliographicItem,
-               "#{__dir__}/metadata/ieee_bibliographic_item"
-      autoload :IeeeStructuredIdentifier,
-               "#{__dir__}/metadata/ieee_structured_identifier"
-    end
-  end
-end

data/lib/metanorma/ieee_document/root.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      def self.lutaml_default_register
-        :ieee_document
-      end
-
-      attribute :bibdata, Metadata::IeeeBibliographicItem
-      attribute :preface,
-                Metanorma::StandardDocument::Sections::Preface
-      attribute :sections,
-                IeeeDocument::Sections::IeeeSections
-      attribute :annex,
-                Metanorma::StandardDocument::Sections::AnnexSection,
-                collection: true
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/ieee_document/sections/ieee_sections.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    module Sections
-      # IEEE sections container.
-      # Corresponds to ieee.rnc:
-      #   sections = element sections {
-      #     note?,
-      #     ( clause | terms | term-clause | definitions | floating-title )+
-      #   }
-      #
-      # Differs from isodoc default by adding an optional leading note.
-      class IeeeSections < Metanorma::StandardDocument::Sections::Sections
-        attribute :note,
-                  Metanorma::Document::Components::Blocks::NoteBlock
-
-        xml do
-          element "sections"
-          ordered
-
-          map_element "note", to: :note
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ieee_document/sections.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    module Sections
-      autoload :IeeeSections, "#{__dir__}/sections/ieee_sections"
-    end
-  end
-end

data/lib/metanorma/ieee_document.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IeeeDocument
-    autoload :Metadata, "metanorma/ieee_document/metadata"
-    autoload :Root, "metanorma/ieee_document/root"
-    autoload :Sections, "metanorma/ieee_document/sections"
-  end
-end
-
-Metanorma::Registers::Setup.setup_ieee_register

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Metadata
-      class IetfBibDataExtensionType < Lutaml::Model::Serializable
-        attribute :doctype, :string
-        attribute :flavor, :string
-        attribute :ipr, :string
-        attribute :consensus, :string
-        attribute :area, :string, collection: true
-        attribute :submission_type, :string
-        attribute :editorial_group, IetfEditorialGroup
-        attribute :pi, PiSettings
-
-        xml do
-          element "ext"
-          map_element "doctype", to: :doctype
-          map_element "flavor", to: :flavor
-          map_element "ipr", to: :ipr
-          map_element "consensus", to: :consensus
-          map_element "area", to: :area
-          map_element "submissionType", to: :submission_type
-          map_element "editorial-group", to: :editorial_group
-          map_element "editorialgroup", to: :editorial_group
-          map_element "pi", to: :pi
-        end
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Metadata
-      class IetfBibliographicItem < Metanorma::Document::Components::BibData::BibliographicItem
-        attribute :ext, Metanorma::IetfDocument::Metadata::IetfBibDataExtensionType
-
-        xml do
-          element "bibdata"
-          map_attribute "type", to: :type_attr
-          map_attribute "schema-version", to: :schema_version
-          map_element "fetched", to: :fetched
-          map_element "title", to: :title
-          map_element "formattedref", to: :formatted_ref
-          map_element "uri", to: :link
-          map_element "docidentifier", to: :docidentifier
-          map_element "docnumber", to: :docnumber
-          map_element "date", to: :date
-          map_element "contributor", to: :contributor
-          map_element "edition", to: :edition
-          map_element "version", to: :version
-          map_element "note", to: :note
-          map_element "language", to: :language
-          map_element "script", to: :script
-          map_element "abstract", to: :abstract
-          map_element "status", to: :status
-          map_element "copyright", to: :copyright
-          map_element "relation", to: :relation
-          map_element "series", to: :series
-          map_element "medium", to: :medium
-          map_element "place", to: :place
-          map_element "price", to: :price
-          map_element "extent", to: :extent
-          map_element "size", to: :size
-          map_element "accessLocation", to: :access_location
-          map_element "license", to: :license
-          map_element "classification", to: :classification
-          map_element "keyword", to: :keyword
-          map_element "validity", to: :validity
-          map_element "ext", to: :ext
-          map_attribute "id", to: :id
-          map_attribute "anchor", to: :anchor
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "schema-version", to: :schema_version
-          map_element "biblio-tag", to: :biblio_tag
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# 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/pi_settings.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Metadata
-      class PiSettings < Lutaml::Model::Serializable
-        attribute :toc, :string
-        attribute :tocdepth, :string
-        attribute :symrefs, :string
-        attribute :sortrefs, :string
-        attribute :compact, :string
-        attribute :subcompact, :string
-        attribute :strict, :string
-        attribute :comments, :string
-        attribute :notedraftinprogress, :string
-
-        xml do
-          element "pi"
-          map_element "toc", to: :toc
-          map_element "tocdepth", to: :tocdepth
-          map_element "symrefs", to: :symrefs
-          map_element "sortrefs", to: :sortrefs
-          map_element "compact", to: :compact
-          map_element "subcompact", to: :subcompact
-          map_element "strict", to: :strict
-          map_element "comments", to: :comments
-          map_element "notedraftinprogress", to: :notedraftinprogress
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ietf_document/metadata.rb

@@ -1,16 +0,0 @@
-# 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"
-      autoload :PiSettings,
-               "metanorma/ietf_document/metadata/pi_settings"
-    end
-  end
-end

data/lib/metanorma/ietf_document/root.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      def self.lutaml_default_register
-        :ietf_document
-      end
-
-      attribute :bibdata,
-                Metanorma::IetfDocument::Metadata::IetfBibliographicItem
-      attribute :preface,
-                Metanorma::StandardDocument::Sections::Preface
-      attribute :sections,
-                Metanorma::IetfDocument::Sections::IetfSections
-      attribute :annex,
-                Metanorma::IetfDocument::Sections::IetfAnnexSection,
-                collection: true
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/ietf_document/sections/ietf_annex_section.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Sections
-      class IetfAnnexSection < Metanorma::StandardDocument::Sections::AnnexSection
-        # IETF-specific attributes
-        attribute :numbered, :string
-        attribute :remove_in_rfc, :boolean
-
-        # Sub-clauses within IETF annex use IetfClauseSection
-        attribute :clause, IetfClauseSection, collection: true
-
-        xml do
-          element "annex"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
-          map_attribute "numbered",    to: :numbered
-          map_attribute "removeInRFC", to: :remove_in_rfc
-          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ietf_document/sections/ietf_clause_section.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Sections
-      class IetfClauseSection < Metanorma::StandardDocument::Sections::ClauseSection
-        # IETF-specific attributes
-        attribute :numbered, :string
-        attribute :remove_in_rfc, :boolean
-
-        # Recursive IETF sub-clauses
-        attribute :clause, IetfClauseSection, collection: true
-
-        xml do
-          element "clause"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
-          map_attribute "numbered",    to: :numbered
-          map_attribute "removeInRFC", to: :remove_in_rfc
-          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ietf_document/sections/ietf_content_section.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Sections
-      class IetfContentSection < Metanorma::StandardDocument::Sections::ContentSection
-        attribute :numbered, :string
-        attribute :remove_in_rfc, :boolean
-
-        # Recursive IETF sub-clauses
-        attribute :subsection, IetfContentSection, collection: true
-
-        xml do
-          element "clause"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
-          map_attribute "numbered",       to: :numbered
-          map_attribute "removeInRFC",    to: :remove_in_rfc
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ietf_document/sections/ietf_sections.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Sections
-      # IETF sections container.
-      # Corresponds to ietf.rnc:
-      #   sections = element sections {
-      #     ( clause | terms | term-clause | definitions | floating-title )+
-      #   }
-      #
-      # Extends StandardDocument sections with loose bibitem references
-      # and paragraph elements directly inside sections.
-      class IetfSections < Metanorma::StandardDocument::Sections::Sections
-        attribute :bibitem,
-                  Metanorma::BasicDocument::BibData::BibliographicItem,
-                  collection: true
-        attribute :p,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-
-        xml do
-          element "sections"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
-          map_element "bibitem",        to: :bibitem
-          map_element "p",              to: :p
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ietf_document/sections.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    module Sections
-      autoload :IetfSections, "#{__dir__}/sections/ietf_sections"
-      autoload :IetfContentSection, "#{__dir__}/sections/ietf_content_section"
-      autoload :IetfClauseSection, "#{__dir__}/sections/ietf_clause_section"
-      autoload :IetfAnnexSection, "#{__dir__}/sections/ietf_annex_section"
-    end
-  end
-end

data/lib/metanorma/ietf_document.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IetfDocument
-    autoload :Metadata, "metanorma/ietf_document/metadata"
-    autoload :Root, "metanorma/ietf_document/root"
-    autoload :Sections, "metanorma/ietf_document/sections"
-  end
-end
-
-Metanorma::Registers::Setup.setup_ietf_register

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,20 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IhoDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      attribute :bibdata, Metadata::IhoBibliographicItem
-      attribute :preface,
-                Metanorma::StandardDocument::Sections::Preface
-      attribute :sections,
-                Metanorma::StandardDocument::Sections::Sections
-      attribute :annex,
-                Metanorma::StandardDocument::Sections::AnnexSection,
-                collection: true
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/iho_document.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    AnnotationContainer = Metanorma::StandardDocument::AnnotationContainer
-  end
-end