metanorma-document 0.2.0

data/lib/metanorma/document/components/data_types/iso3166_code.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/data_types/iso639_code.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/data_types/iso8601_date_time.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/data_types/localized_string.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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, collection: true
+          attribute :variant, LocalizedString
+          attribute :br, Metanorma::Document::Components::Inline::BrElement,
+                    collection: true
+
+          xml do
+            element "localized-string"
+            mixed_content
+            map_attribute "language", to: :language
+            map_attribute "script", to: :script
+            map_content to: :value
+            map_element "variant", to: :variant
+            map_element "br", to: :br
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/data_types/string_format.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+
+            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
+  end
+end

data/lib/metanorma/document/components/data_types/uri.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/data_types.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/empty_elements/basic_element.rb

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

data/lib/metanorma/document/components/empty_elements/horizontal_rule_element.rb

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

data/lib/metanorma/document/components/empty_elements/index_element.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module EmptyElements
+        # Index term, defined as applying to the location in the text where the index element appears, as a
+        # milestone.
+        class IndexElement < Metanorma::Document::Components::EmptyElements::BasicElement
+          attribute :primary, :string
+          attribute :secondary, :string
+          attribute :tertiary, :string
+          attribute :to, Metanorma::Document::Components::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
+end

data/lib/metanorma/document/components/empty_elements/line_break_element.rb

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

data/lib/metanorma/document/components/empty_elements/page_break_element.rb

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

data/lib/metanorma/document/components/empty_elements.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/id_elements/alt_source.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/id_elements/audio.rb

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

data/lib/metanorma/document/components/id_elements/bookmark.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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 < IdElement
+          attribute :anchor, :string
+          attribute :semx_id, :string
+
+          xml do
+            element "bookmark"
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/id_elements/id_element.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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::Document::Components::EmptyElements::BasicElement
+          attribute :id, :string
+
+          xml do
+            element "id-element"
+            map_attribute "id", to: :id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/id_elements/image.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module IdElements
+        # Container for image content.
+        class Image < Media
+          attribute :height, :string
+          attribute :width, :string
+          attribute :semx_id, :string
+
+          xml do
+            element "image"
+            map_attribute "height", to: :height, render_empty: true
+            map_attribute "width", to: :width, render_empty: true
+            map_attribute "semx-id", to: :semx_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/id_elements/media.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module IdElements
+        # Container for media content.
+        class Media < 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, render_empty: true
+            map_attribute "title", to: :title
+            map_attribute "longdesc", to: :longdesc
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/id_elements/media_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/id_elements/video.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module IdElements
+        # Container for video content.
+        class Video < Media
+          attribute :altsource, 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
+end

data/lib/metanorma/document/components/id_elements.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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
+end

data/lib/metanorma/document/components/inline/asciimath_element.rb

@@ -0,0 +1,16 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class AsciimathElement < Lutaml::Model::Serializable
+          attribute :text, :string
+
+          xml do
+            element "asciimath"
+            map_content to: :text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/attribution_element.rb

@@ -0,0 +1,17 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class AttributionElement < Lutaml::Model::Serializable
+          attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
+                    collection: true
+
+          xml do
+            element "attribution"
+            map_element "p", to: :p
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/bcp14_element.rb

@@ -0,0 +1,16 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class Bcp14Element < Lutaml::Model::Serializable
+          attribute :text, :string
+
+          xml do
+            element "bcp14"
+            map_content to: :text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/biblio_tag_element.rb

@@ -0,0 +1,23 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class BiblioTagElement < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :span, SpanElement, collection: true
+          attribute :fn, FnElement, collection: true
+          attribute :tab, TabElement, collection: true
+
+          xml do
+            element "biblio-tag"
+            mixed_content
+            map_content to: :text
+            map_element "span", to: :span
+            map_element "fn", to: :fn
+            map_element "tab", to: :tab
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/br_element.rb

@@ -0,0 +1,13 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class BrElement < Lutaml::Model::Serializable
+          xml do
+            element "br"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/comma_element.rb

@@ -0,0 +1,13 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class CommaElement < Lutaml::Model::Serializable
+          xml do
+            element "comma"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/concept_element.rb

@@ -0,0 +1,22 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class ConceptElement < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :refterm, :string, collection: true
+          attribute :renderterm, :string, collection: true
+          attribute :xref, XrefElement, collection: true
+
+          xml do
+            element "concept"
+            map_attribute "id", to: :id
+            map_element "refterm", to: :refterm
+            map_element "renderterm", to: :renderterm
+            map_element "xref", to: :xref
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/display_text_element.rb

@@ -0,0 +1,37 @@
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        class DisplayTextElement < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :em, EmRawElement, collection: true
+          attribute :strong, StrongRawElement, collection: true
+          attribute :sub, SubElement, collection: true
+          attribute :sup, SupElement, collection: true
+          attribute :tt, TtElement, collection: true
+          attribute :underline, "Metanorma::Document::Components::TextElements::UnderlineElement",
+                    collection: true
+          attribute :strike, "Metanorma::Document::Components::TextElements::StrikeElement",
+                    collection: true
+          attribute :smallcap, SmallCapElement, collection: true
+          attribute :br, BrElement, collection: true
+
+          xml do
+            element "display-text"
+            mixed_content
+            map_content to: :text
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "underline", to: :underline
+            map_element "strike", to: :strike
+            map_element "smallcap", to: :smallcap
+            map_element "br", to: :br
+          end
+        end
+      end
+    end
+  end
+end