metanorma-document 0.2.0

data/lib/metanorma/basic_document/change/unique_identifier.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Identifier used to uniquely identify a BasicDocument.
+      class UniqueIdentifier < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "unique-identifier"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      autoload :AttributeChangeAction,
+               "#{__dir__}/change/attribute_change_action"
+      autoload :AttributeModify, "#{__dir__}/change/attribute_modify"
+      autoload :Change, "#{__dir__}/change/change"
+      autoload :ChangeSet, "#{__dir__}/change/change_set"
+      autoload :ContentAction, "#{__dir__}/change/content_action"
+      autoload :ContentChange, "#{__dir__}/change/content_change"
+      autoload :ContentChangeAction,
+               "#{__dir__}/change/content_change_action"
+      autoload :ContentModify, "#{__dir__}/change/content_modify"
+      autoload :NodeChange, "#{__dir__}/change/node_change"
+      autoload :NodeDelete, "#{__dir__}/change/node_delete"
+      autoload :NodeInsert, "#{__dir__}/change/node_insert"
+      autoload :NodeMove, "#{__dir__}/change/node_move"
+      autoload :UniqueIdentifier, "#{__dir__}/change/unique_identifier"
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata/contribution_element_metadata.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      # Container encoding the contribution made by a party towards a particular element in the document
+      class ContributionElementMetadata < Lutaml::Model::Serializable
+        attribute :date_time,
+                  :string
+        attribute :contributor, Metanorma::Document::Relaton::Contributor
+        attribute :integrity_value, :string, collection: true
+
+        xml do
+          element "contribution-element-metadata"
+          map_attribute "date-time", to: :date_time
+          map_element "contributor", to: :contributor
+          map_element "integrity-value", to: :integrity_value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata/hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      # Hash value for a digital signature.
+      class Hash < Metanorma::BasicDocument::ContribMetadata::IntegrityValue
+        attribute :algorithm, :string
+        attribute :value, :string
+
+        xml do
+          element "hash"
+          map_attribute "algorithm", to: :algorithm
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata/integrity_value.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      # A digital signature of the contribution, consisting of a `hash` value and a `signature`, with an
+      # associated `publicKey`.
+      class IntegrityValue < Lutaml::Model::Serializable
+        xml do
+          element "integrity-value"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata/iso10118_oid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      # Identifier of hash algorithm defined in ISO 10118.
+      class Iso10118Oid < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso10118-oid"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata/iso14888_oid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      # Identifier of digital signature algorithm defined in ISO 14888.
+      class Iso14888Oid < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso14888-oid"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata/signature.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      # Digital signature.
+      class Signature < Metanorma::BasicDocument::ContribMetadata::IntegrityValue
+        attribute :algorithm, :string
+        attribute :public_key, :string
+        attribute :signature, :string
+
+        xml do
+          element "signature"
+          map_attribute "algorithm", to: :algorithm
+          map_attribute "public-key", to: :public_key
+          map_content to: :signature
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/contrib_metadata.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ContribMetadata
+      autoload :ContributionElementMetadata,
+               "#{__dir__}/contrib_metadata/contribution_element_metadata"
+      autoload :Hash, "#{__dir__}/contrib_metadata/hash"
+      autoload :IntegrityValue,
+               "#{__dir__}/contrib_metadata/integrity_value"
+      autoload :Iso10118Oid, "#{__dir__}/contrib_metadata/iso10118_oid"
+      autoload :Iso14888Oid, "#{__dir__}/contrib_metadata/iso14888_oid"
+      autoload :Signature, "#{__dir__}/contrib_metadata/signature"
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/formatted_string.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # String which is formatted according to conventions specified
+      # in a named MIME type (<<rfc2046>>).
+      class FormattedString < Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :type, :string
+
+        xml do
+          map_attribute "type", to: :type
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/iso15924_code.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # Script identifier, as defined in ISO 15924.
+      class Iso15924Code < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso15924-code"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/iso3166_code.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # Country and country subdivisions identifier, as defined in ISO 3166.
+      class Iso3166Code < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso3166-code"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/iso639_code.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # Language identifier, as defined in ISO 639.
+      class Iso639Code < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso639-code"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/iso8601_date_time.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # Gregorian date and time, as specified in <<iso8601>>.
+      class Iso8601DateTime < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso8601-date-time"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/localized_string.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # FormattedString which optionally specifies its language and/or script.
+      class LocalizedString < Lutaml::Model::Serializable
+        attribute :language, :string
+        attribute :script, :string
+        attribute :value, :string
+        attribute :variant, LocalizedString
+
+        xml do
+          element "localized-string"
+          map_attribute "language", to: :language
+          map_attribute "script", to: :script
+          map_content to: :value
+          map_element "variant", to: :variant
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/string_format.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # The MIME type for a formatted string.
+      class StringFormat < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "string-format"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[text/plain text/html application/docbook+xml application/tei+xml
+             text/x-asciidoc text/markdown application/x-metanorma+xml]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types/uri.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      # Container for URIs, as defined by <<rfc3986>>.
+      class Uri < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "uri"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/data_types.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module DataTypes
+      autoload :FormattedString, "#{__dir__}/data_types/formatted_string"
+      autoload :Iso15924Code, "#{__dir__}/data_types/iso15924_code"
+      autoload :Iso3166Code, "#{__dir__}/data_types/iso3166_code"
+      autoload :Iso639Code, "#{__dir__}/data_types/iso639_code"
+      autoload :Iso8601DateTime, "#{__dir__}/data_types/iso8601_date_time"
+      autoload :LocalizedString, "#{__dir__}/data_types/localized_string"
+      autoload :StringFormat, "#{__dir__}/data_types/string_format"
+      autoload :Uri, "#{__dir__}/data_types/uri"
+    end
+  end
+end

data/lib/metanorma/basic_document/empty_elements/basic_element.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module EmptyElements
+      # Container of inline content in BasicDocument.
+      class BasicElement < Lutaml::Model::Serializable
+        attribute :contrib_metadata, Metanorma::BasicDocument::ContribMetadata::ContributionElementMetadata,
+                  collection: true
+
+        xml do
+          element "basic-element"
+          map_element "contrib-metadata", to: :contrib_metadata
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/empty_elements/horizontal_rule_element.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module EmptyElements
+      # Horizontal rule.
+      class HorizontalRuleElement < Metanorma::BasicDocument::EmptyElements::BasicElement
+        xml do
+          element "hr"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/empty_elements/index_element.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module EmptyElements
+      # Index term, defined as applying to the location in the text where the index element appears, as a
+      # milestone.
+      class IndexElement < Metanorma::BasicDocument::EmptyElements::BasicElement
+        attribute :primary, :string
+        attribute :secondary, :string
+        attribute :tertiary, :string
+        attribute :to, Metanorma::BasicDocument::IdElements::IdElement
+
+        xml do
+          element "index-xref"
+          map_element "primary", to: :primary
+          map_element "secondary", to: :secondary
+          map_element "tertiary", to: :tertiary
+          map_element "to", to: :to
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/empty_elements/line_break_element.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module EmptyElements
+      # Line break.
+      class LineBreakElement < Metanorma::BasicDocument::EmptyElements::BasicElement
+        xml do
+          element "br"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/empty_elements/page_break_element.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module EmptyElements
+      # Page break. Only applicable in paged layouts (e.g. PDF, Word), and not
+      # flow layouts (e.g. HTML).
+      class PageBreakElement < Metanorma::BasicDocument::EmptyElements::BasicElement
+        xml do
+          element "pagebreak"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/empty_elements.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module EmptyElements
+      autoload :BasicElement, "#{__dir__}/empty_elements/basic_element"
+      autoload :HorizontalRuleElement,
+               "#{__dir__}/empty_elements/horizontal_rule_element"
+      autoload :IndexElement, "#{__dir__}/empty_elements/index_element"
+      autoload :LineBreakElement,
+               "#{__dir__}/empty_elements/line_break_element"
+      autoload :PageBreakElement,
+               "#{__dir__}/empty_elements/page_break_element"
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/alt_source.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Alternative file to use as media.
+      class AltSource < Lutaml::Model::Serializable
+        attribute :filename, :string
+        attribute :source, :string
+        attribute :type, :string
+
+        xml do
+          element "alt-source"
+          map_attribute "filename", to: :filename
+          map_attribute "source", to: :source
+          map_attribute "mimetype", to: :type
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/audio.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Container for audio content.
+      class Audio < Metanorma::BasicDocument::IdElements::Media
+        attribute :altsource, Metanorma::BasicDocument::IdElements::AltSource,
+                  collection: true
+
+        xml do
+          element "audio"
+          map_element "alt-source", to: :altsource
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/bookmark.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Anchor for cross-references which do not have scope over blocks or sections. Anchors within a block
+      # under the BasicDocument model cannot span across a number of inline elements; bookmarks are intended
+      # as point anchors. For that reason, the Review block has a starting reference and an optional ending
+      # reference, which can be bookmarks as well as block or section references.
+      class Bookmark < Metanorma::BasicDocument::IdElements::IdElement
+        xml do
+          element "bookmark"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/id_element.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # `BasicElement` with an identifier, to be used in crossreferencing by Reference Elements. The
+      # `IdElement` itself acts as a reference point, such as in a `SourcecodeBlock` for callout references
+      # (the `IdElement` is the location), and for delimiting `ReviewComment` start/end places.
+      class IdElement < Metanorma::BasicDocument::EmptyElements::BasicElement
+        attribute :id, :string
+
+        xml do
+          element "id-element"
+          map_attribute "id", to: :id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/image.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Container for image content.
+      class Image < Metanorma::BasicDocument::IdElements::Media
+        attribute :height, :string
+        attribute :width, :string
+
+        xml do
+          element "image"
+          map_attribute "height", to: :height
+          map_attribute "width", to: :width
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/media.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Container for media content.
+      class Media < Metanorma::BasicDocument::IdElements::IdElement
+        # File name corresponding to the media, to which the media can be extracted if it is represented
+        # inline (e.g. in Base64 encoding in the URI).
+        attribute :filename, :string
+
+        # URI of the media file.
+        attribute :source, :string
+
+        # Type of the media file.
+        attribute :type, :string
+
+        # Alternate text, supplied for accessibility.
+        attribute :alt, :string
+
+        # Title, supplied for accessibility.
+        attribute :title, :string
+
+        # URI pointing to more extensive alternate text description, supplied for accessibility.
+        attribute :longdesc, :string
+
+        xml do
+          element "media"
+          map_attribute "filename", to: :filename
+          map_attribute "src", to: :source
+          map_attribute "mimetype", to: :type
+          map_attribute "alt", to: :alt
+          map_attribute "title", to: :title
+          map_attribute "longdesc", to: :longdesc
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/media_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Type of a media file.
+      class MediaType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "media-type"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements/video.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      # Container for video content.
+      class Video < Metanorma::BasicDocument::IdElements::Media
+        attribute :altsource, Metanorma::BasicDocument::IdElements::AltSource,
+                  collection: true
+        attribute :height, :string
+        attribute :width, :string
+
+        xml do
+          element "video"
+          map_element "alt-source", to: :altsource
+          map_attribute "height", to: :height
+          map_attribute "width", to: :width
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/id_elements.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module IdElements
+      autoload :AltSource, "#{__dir__}/id_elements/alt_source"
+      autoload :Audio, "#{__dir__}/id_elements/audio"
+      autoload :Bookmark, "#{__dir__}/id_elements/bookmark"
+      autoload :IdElement, "#{__dir__}/id_elements/id_element"
+      autoload :Image, "#{__dir__}/id_elements/image"
+      autoload :Media, "#{__dir__}/id_elements/media"
+      autoload :MediaType, "#{__dir__}/id_elements/media_type"
+      autoload :Video, "#{__dir__}/id_elements/video"
+    end
+  end
+end