metanorma-document 0.3.0 → 0.4.0

data/frontend/tailwind.config.js

@@ -4,6 +4,11 @@ export default {
     './src/**/*.{vue,ts,html}',
   ],
   darkMode: 'class',
+  corePlugins: {
+    // Preflight resets bare elements, which would clobber the classic
+    // renderer's SSR body inlined by InlineFormat (no-JS placeholder).
+    preflight: false,
+  },
   theme: {
     extend: {
       colors: {

data/lib/metanorma/csa_document/root.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module CsaDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :csa_document
+      end
+
+      attribute :bibdata,
+                Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
+      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
+      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
+                collection: true
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+      end
+    end
+  end
+end

data/lib/metanorma/csa_document.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module CsaDocument
+    autoload :Root, "metanorma/csa_document/root"
+  end
+end
+
+Metanorma::Registers::Setup.setup_csa_register

data/lib/metanorma/document/cli.rb

@@ -17,11 +17,20 @@ module Metanorma
         keyword_init: true,
       )
 
+      ToHtmlOptions = Struct.new(
+        :xml_path,
+        :output,
+        :flavor,
+        keyword_init: true,
+      )
+
       def self.run(argv)
         command = argv.shift
         case command
         when "to-mirror"
           to_mirror(argv)
+        when "to-html"
+          to_html(argv)
         when nil, "-h", "--help"
           puts usage
         else
@@ -101,12 +110,55 @@ module Metanorma
         end
       end
 
+      def self.to_html(argv)
+        options = parse_to_html_options(argv)
+        execute_to_html(options)
+      end
+
+      def self.parse_to_html_options(argv)
+        options = ToHtmlOptions.new(output: nil, flavor: nil)
+
+        parser = OptionParser.new do |opts|
+          opts.banner = "Usage: metanorma-document to-html <xml_path> [options]"
+
+          opts.on("-o", "--output PATH",
+                  "Output HTML path (default: stdout)") do |path|
+            options.output = path
+          end
+
+          opts.on("-f", "--flavor FLAVOR",
+                  "Document flavor (default: auto-detect)") do |flavor|
+            options.flavor = flavor
+          end
+        end
+
+        parser.parse!(argv)
+
+        xml_path = argv.shift
+        raise Error, "XML path required" unless xml_path
+        raise Error, "File not found: #{xml_path}" unless File.exist?(xml_path)
+
+        options.xml_path = xml_path
+        options
+      end
+
+      def self.execute_to_html(options)
+        # Metanorma::Html is autoloaded from metanorma/document.
+        # Reuse the mirror pipeline's flavor inference/model dispatch so
+        # to-html and to-mirror parse documents identically.
+        step = Mirror::Output::Pipeline::Steps::ParseXml.new
+        flavor = options.flavor || step.infer_flavor(options.xml_path)
+        doc = step.flavor_class(flavor).from_xml(File.read(options.xml_path))
+        write_output(Html::Generator.generate(doc), options.output)
+      end
+
       def self.usage
         <<~USAGE
           Usage: metanorma-document <command> [options]
 
           Commands:
             to-mirror    Convert presentation XML to mirror JSON
+            to-html      Render presentation XML to standalone HTML
 
           Run `metanorma-document <command> --help` for command-specific options.
         USAGE

data/lib/metanorma/document/components/ancillary_blocks/sourcecode_body.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "cgi"
+
 module Metanorma
   module Document
     module Components
@@ -11,6 +13,18 @@ module Metanorma
             element "body"
             map_all_content to: :content
           end
+
+          # The source text with XML entities DECODED (`&lt;` → `<`).
+          #
+          # `content` is markup-encoded by design: map_all_content keeps
+          # the raw inner markup so to_xml can re-emit it verbatim
+          # (roundtrip fidelity). Consumers that display the code as
+          # text need the decoded form — without it they double-escape
+          # (`&amp;lt;`) or hand-roll fragile gsub chains. Comments in
+          # the listing stay literal ("<!-- ... -->").
+          def decoded_content
+            CGI.unescapeHTML(Array(content).join)
+          end
         end
       end
     end

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

@@ -5,8 +5,11 @@ module Metanorma
     module Components
       module Inline
         class CommaElement < Lutaml::Model::Serializable
+          attribute :text, :string
+
           xml do
             element "comma"
+            map_content to: :text
           end
         end
       end

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

@@ -5,8 +5,11 @@ module Metanorma
     module Components
       module Inline
         class EnumCommaElement < Lutaml::Model::Serializable
+          attribute :text, :string
+
           xml do
             element "enum-comma"
+            map_content to: :text
           end
         end
       end

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

@@ -5,6 +5,8 @@ module Metanorma
     module Components
       module Inline
         class ErefElement < Lutaml::Model::Serializable
+          include Inline::Vocabulary
+
           attribute :id, :string
           attribute :type, :string
           attribute :bibitemid, :string
@@ -15,10 +17,10 @@ module Metanorma
           attribute :relative, :string
           attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
                     collection: true
-          attribute :text, :string
 
           xml do
             element "eref"
+            mixed_content
             map_attribute "id", to: :id
             map_attribute "type", to: :type
             map_attribute "bibitemid", to: :bibitemid
@@ -29,6 +31,7 @@ module Metanorma
             map_attribute "relative", to: :relative
             map_element "localityStack", to: :locality_stack
             map_content to: :text
+            Vocabulary::VocabularyXmlMapping.apply_inline_mappings(self)
           end
         end
       end

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

@@ -6,16 +6,18 @@ module Metanorma
       module Inline
         class FmtTermsourceElement < Lutaml::Model::Serializable
           include RenderedDisplay
+          include Inline::Vocabulary
 
           attribute :status, :string
           attribute :type, :string
-          attribute :semx, SemxElement
 
           xml do
             element "fmt-termsource"
+            mixed_content
             map_attribute "status", to: :status
             map_attribute "type", to: :type
-            map_element "semx", to: :semx
+            map_content to: :text
+            Vocabulary::VocabularyXmlMapping.apply_inline_mappings(self)
           end
         end
       end

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

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
+require "mml"
+
 module Metanorma
   module Document
     module Components
       module Inline
-        class MathElement < Lutaml::Model::Serializable
-          attribute :content, :string
-
-          xml do
-            element "math"
-            map_all_content to: :content
-          end
+        # A MathML `<math>` element. Modeled via the mml gem's
+        # `Mml::V3::Math`, which carries the MathML namespace and a full
+        # MathML content model — no raw markup strings (project rule),
+        # and the `xmlns` survives round-trips (previously the
+        # raw-capture mapping dropped it, silently moving `<math>` into
+        # the standoc namespace on serialize).
+        #
+        # Subclasses SemanticMathElement/RenderedMathElement stay as pure
+        # markers so consumers can distinguish the canonical form from
+        # the locale-rendered form via `is_a?`.
+        class MathElement < Mml::V3::Math
         end
       end
     end

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

@@ -107,6 +107,9 @@ module Metanorma
                              collection: true
               base.attribute :del, "Metanorma::Document::Elements::Del",
                              collection: true
+              base.attribute :input,
+                             Metanorma::Document::Elements::Input,
+                             collection: true
             end
 
             def declare_rendered_display_attributes_on(base)
@@ -164,6 +167,7 @@ module Metanorma
               "index" => :index,
               "add" => :add,
               "del" => :del,
+              "input" => :input,
               "fmt-stem" => :fmt_stem,
               "fmt-concept" => :fmt_concept,
               "fmt-fn-label" => :fmt_fn_label,

data/lib/metanorma/document/components/multi_paragraph/admonition_block.rb

@@ -10,10 +10,15 @@ module Metanorma
           # Subclass of admonition determining how it is to be rendered; e.g.
           # Warning, Note, Tip.
           # Distinct admonition types are often associated with distinct icons or rendering.
+          # Values are the union of AdmonitionType across current flavor grammars:
+          #   basicdoc + isodoc: caution, editorial, important, note, statement,
+          #     tip, warning, box
+          #   isostandard.rng / un.rng: danger, safety precautions
+          #   bsi.rng / jis.rng: commentary
           attribute :type, :string,
                     values: %w[danger caution warning important
                                safety\ precautions editorial tip note
-                               commentary]
+                               commentary statement box]
 
           # Caption of admonition.
           attribute :name, Metanorma::Document::Components::TextElements::TextElement,

data/lib/metanorma/document/components/paragraphs/paragraph_block.rb

@@ -81,6 +81,8 @@ module Metanorma
                     collection: true
           attribute :del, "Metanorma::Document::Elements::Del",
                     collection: true
+          attribute :input, Metanorma::Document::Elements::Input,
+                    collection: true
 
           # JSON serialization attributes
           attribute :json_type, :string
@@ -138,6 +140,7 @@ module Metanorma
             map_element "image", to: :image
             map_element "add", to: :add
             map_element "del", to: :del
+            map_element "input", to: :input
           end
 
           def json_content

data/lib/metanorma/document/components/reference_elements/callout.rb

@@ -10,13 +10,14 @@ module Metanorma
         class Callout < ReferenceToIdElement
           attribute :target_attr, :string
           attribute :type, :string
-          attribute :text, Metanorma::Document::Components::TextElements::TextElement
+          attribute :text, :string, collection: true
 
           xml do
             element "callout"
+            mixed_content
             map_attribute "target", to: :target_attr
             map_element "type", to: :type
-            map_element "text", to: :text
+            map_content to: :text
           end
         end
       end

data/lib/metanorma/document/components/tables/table_cell.rb

@@ -84,6 +84,8 @@ module Metanorma
                     collection: true
           attribute :bookmark, Metanorma::Document::Components::IdElements::Bookmark,
                     collection: true
+          attribute :input, Metanorma::Document::Elements::Input,
+                    collection: true
           attribute :fmt_annotation_start,
                     Metanorma::Document::Components::Inline::FmtAnnotationStartElement, collection: true
           attribute :fmt_annotation_end,
@@ -130,6 +132,7 @@ module Metanorma
             map_element "semx", to: :semx
             map_element "span", to: :span
             map_element "bookmark", to: :bookmark
+            map_element "input", to: :input
             map_element "fmt-annotation-start", to: :fmt_annotation_start
             map_element "fmt-annotation-end", to: :fmt_annotation_end
           end

data/lib/metanorma/document/elements/input.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Elements
+      # An `<input>` form field (text, checkbox, ...) as it appears inline
+      # in form-bearing documents (e.g. OIML application forms). Lives in
+      # the document layer so shared inline containers (ParagraphBlock,
+      # TableCell, Inline::Vocabulary) can map it without referencing
+      # higher model layers.
+      class Input < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :name, :string
+        attribute :value, :string
+        attribute :type, :string
+        attribute :checked, :boolean
+        attribute :disabled, :boolean
+        attribute :readonly, :boolean
+        attribute :maxlength, :integer
+        attribute :minlength, :integer
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "input"
+
+          map_attribute "id", to: :id
+          map_attribute "name", to: :name
+          map_attribute "value", to: :value
+          map_attribute "type", to: :type
+          map_attribute "checked", to: :checked
+          map_attribute "disabled", to: :disabled
+          map_attribute "readonly", to: :readonly
+          map_attribute "maxlength", to: :maxlength
+          map_attribute "minlength", to: :minlength
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/elements.rb

@@ -5,6 +5,7 @@ module Metanorma
     module Elements
       autoload :Add, "#{__dir__}/elements/add"
       autoload :Del, "#{__dir__}/elements/del"
+      autoload :Input, "#{__dir__}/elements/input"
     end
   end
 end

data/lib/metanorma/document/relaton/address.rb

@@ -3,6 +3,11 @@
 module Metanorma
   module Document
     module Relaton
+      # An address of a person or organization.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Address has no
+      # formatted-address attribute and types formattedAddress as a raw
+      # string — fixtures carry structured formattedAddress content with
+      # <br/> line breaks (ietf), kept queryable via FormattedAddress.
       class Address < Lutaml::Model::Serializable
         attribute :formatted_address_attr, :string
         attribute :formatted_address, FormattedAddress

data/lib/metanorma/document/relaton/affiliation.rb

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # The affiliation of a person with an organization.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Affiliation
+      # sanitizes description (LocalizedMarkedUpString strips semx/span/fmt-*)
+      # and types name/organization as relaton's own classes.
       class Affiliation < Lutaml::Model::Serializable
         attribute :name, Metanorma::Document::Components::DataTypes::LocalizedString
         attribute :description,

data/lib/metanorma/document/relaton/bib_item_size.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # The size of a bibliographic item being referred to.
-      class BibItemSize < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :value, Metanorma::Document::Components::DataTypes::LocalizedString
-
-        xml do
-          element "bib-item-size"
-          map_attribute "type", to: :type
-          map_element "value", to: :value
-        end
+      # relaton-bib's <size><value type>text</value></size> grammar matches
+      # metanorma biblio.rng; this gem's previous grammar had +type+ on
+      # +size+ itself and a singular +value+.
+      class BibItemSize < ::Relaton::Bib::Size
+        # Compatibility reader: relaton-bib carries +type+ on each +value+.
+        def type = value&.first&.type
       end
     end
   end

data/lib/metanorma/document/relaton/bib_item_type.rb

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # Type of bibliographic item.
+      # Keep-forever (wave-5 sweep): relaton-bib 2.2.0.pre.alpha.1 carries
+      # the item type as a plain accessor, not a mapped bib-item-type
+      # element class; not a migration candidate.
       class BibItemType < Lutaml::Model::Serializable
         attribute :value, :string
 

data/lib/metanorma/document/relaton/bibliographic_date.rb

@@ -4,6 +4,11 @@ module Metanorma
   module Document
     module Relaton
       # Significant date in the lifecycle of the bibliographic item.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Bib::Date has no
+      # +format+ attribute and no text content, and casts on→at as StringDate
+      # (nil-ing non-ISO values like "–") — fixture dates such as
+      # <date type="published" format="ddMMMyyyy">I.2019</date> would
+      # re-serialize as a bare <date type="published"/>.
       class BibliographicDate < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :format, :string

data/lib/metanorma/document/relaton/contact_method.rb

@@ -4,6 +4,11 @@ module Metanorma
   module Document
     module Relaton
       # Contact information for a person or organization.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 has no Contact
+      # model class — its Contact mixin inlines phone/email/address/uri
+      # directly on Person/Organization (the fixture shape), so there is no
+      # counterpart to inherit. The <contact> wrapper appears in no fixture;
+      # kept because the Person and Organization mappings declare it.
       class ContactMethod < Lutaml::Model::Serializable
         attribute :address, Metanorma::Document::Relaton::Address
         attribute :phone, Metanorma::Document::Relaton::Phone, collection: true

data/lib/metanorma/document/relaton/contribution_info.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # Description of a contributor to the production of the bibliographic item.
-      class ContributionInfo < Lutaml::Model::Serializable
+      # Inherits relaton-bib's Contributor (role + person/organization choice);
+      # the three mappings are re-declared with Metanorma's richer model
+      # classes (mixed-content role, presentation-aware person/organization).
+      class ContributionInfo < ::Relaton::Bib::Contributor
         attribute :role, ContributorRole, collection: true
         attribute :organization, Organization
         attribute :person, Person
 
         xml do
-          element "contributor"
           map_element "role", to: :role
           map_element "organization", to: :organization
           map_element "person", to: :person

data/lib/metanorma/document/relaton/contributor.rb

@@ -5,6 +5,10 @@ module Metanorma
     module Relaton
       # The contributor involved in the production of a bibliographic item; may be either a person or an
       # organization.
+      # Keep-forever (wave-5 sweep): internal base class for Organization and
+      # the contributor-typed attributes — relaton-bib 2.2.0.pre.alpha.1
+      # Contributor is a role+entity model, not this wrapper; not a migration
+      # candidate.
       class Contributor < Lutaml::Model::Serializable
         xml do
           element "contributor"

data/lib/metanorma/document/relaton/contributor_role.rb

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # A description of the role of the contributor in the production of a bibliographic item.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Contributor::Role
+      # has no mixed content (BIPM fixture: <role type="editor">Author for
+      # correspondence</role>) and sanitizes description markup.
       class ContributorRole < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :description,

data/lib/metanorma/document/relaton/copyright_association.rb

@@ -3,6 +3,9 @@
 module Metanorma
   module Document
     module Relaton
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Copyright types
+      # from/to as bare strings (ours preserve the DateTime text attribute) and
+      # maps scope as an element (ours is an attribute).
       class CopyrightAssociation < Lutaml::Model::Serializable
         attribute :from, Metanorma::Document::Relaton::DateTime
         attribute :to, Metanorma::Document::Relaton::DateTime

data/lib/metanorma/document/relaton/copyright_owner.rb

@@ -3,6 +3,9 @@
 module Metanorma
   module Document
     module Relaton
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 has no owner
+      # wrapper (Copyright maps owner directly to ContributionInfo); the
+      # wrapper is kept for consumer compatibility.
       class CopyrightOwner < Lutaml::Model::Serializable
         attribute :organization, Organization
 

data/lib/metanorma/document/relaton/date_time.rb

@@ -5,6 +5,9 @@ module Metanorma
     module Relaton
       # Type which allows date and time to be specified as either a Gregorian
       # date and time, as specified in <<iso8601>>, as text, or as both.
+      # Keep-forever (wave-5 sweep): Metanorma-specific text/content shape
+      # with no relaton-bib 2.2.0.pre.alpha.1 counterpart; not a migration
+      # candidate.
       class DateTime < Lutaml::Model::Serializable
         attribute :text, :string
         attribute :content, :string

data/lib/metanorma/document/relaton/document_identifier.rb

@@ -4,6 +4,10 @@ module Metanorma
   module Document
     module Relaton
       # An identifier of a bibliographic item in an international standard scheme.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Docidentifier
+      # inherits LocalizedMarkedUpString, whose Sanitizer strips
+      # span/semx/link/fmt-* from the content at assignment time, and reads
+      # the identifier string as +content+ (ours is +id+).
       class DocumentIdentifier < Lutaml::Model::Serializable
         attribute :id, :string
         attribute :type, :string

data/lib/metanorma/document/relaton/document_relation.rb

@@ -4,6 +4,14 @@ module Metanorma
   module Document
     module Relaton
       # Relation between a bibliographic item and another bibliographic item.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Relation types
+      # description as a singular sanitized LocalizedMarkedUpString (ours is
+      # a FormattedString collection), bibitem as relaton's own ItemBase tree
+      # (fixtures nest full Metanorma bibitems — fetched, multi-language
+      # titles, typed uris, primary docidentifiers — modeled by our
+      # BibliographicItem), and replaces the localityStack/
+      # sourceLocalityStack-only shape with choice(locality|localityStack)
+      # under different attribute names.
       class DocumentRelation < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :description,

data/lib/metanorma/document/relaton/document_status.rb

@@ -4,6 +4,10 @@ module Metanorma
   module Document
     module Relaton
       # The publication or preparation status of a document.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Status has
+      # singular stage/substage, its Stage lacks +language+, and there is no
+      # stage-abbreviation element — fixtures carry multi-language stage
+      # collections (read as .value/.language by the ISO renderer).
       class DocumentStatus < Lutaml::Model::Serializable
         attribute :stage, Metanorma::Document::Components::DataTypes::FormattedString,
                   collection: true

data/lib/metanorma/document/relaton/formatted_address.rb

@@ -3,6 +3,10 @@
 module Metanorma
   module Document
     module Relaton
+      # A pre-formatted postal address with explicit line breaks.
+      # Keep-forever (wave-5 sweep): structured content + br elements —
+      # relaton-bib 2.2.0.pre.alpha.1 types formattedAddress as a raw string;
+      # not a migration candidate.
       class FormattedAddress < Lutaml::Model::Serializable
         attribute :content, :string, collection: true
         attribute :br, Metanorma::Document::Components::Inline::BrElement,