metanorma-document 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc7125fd4984bbedebb8d471fc29d0d34d5b56b7de1ec518570bc27f8e0671d5
+  data.tar.gz: bc63e4f58ba6053d66df6a2671737c0ce051057ef4e0b14fc51154d050ca0c67
+SHA512:
+  metadata.gz: 45e13915f1b88579d06b94968c5a7f469fdbf77b6980cf3cb68d6747bb9fd1a87d111c8388d2f0f337ba5ccde71aa96c7f755ca6d0080f8ccafa154a15ed7075
+  data.tar.gz: 1a6ab72e96afe880682ffb9646273e794dec60ce1a2e208d794054fe99ea38c6adf09672678a8234ebf805b800ab491bfa01332efcd663b65c403e8cd617712c

data/.github/workflows/rake.yml

@@ -0,0 +1,21 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+permissions:
+  contents: write
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    with:
+      setup-tools: libreoffice
+      submodules: false
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+

data/.github/workflows/roundtrip-samples.yml

@@ -0,0 +1,132 @@
+name: Roundtrip Samples
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'  # Monday 6am UTC
+
+jobs:
+  # --- Discover which mn-samples-* GitHub Pages sites exist ---
+  discover:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - name: Discover mn-samples GitHub Pages sites
+        id: set-matrix
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -e
+          # List all public metanorma/mn-samples-* repos
+          REPOS=$(gh repo list metanorma --limit 1000 --json name \
+            --jq '.[].name | select(startswith("mn-samples-")) | sub("^mn-samples-"; "")' \
+            2>/dev/null | sort || true)
+
+          if [ -z "$REPOS" ]; then
+            echo "::warning::Failed to discover repos via API, using fallback list"
+            REPOS="bipm
+          cc
+          csa
+          iec
+          ieee
+          ietf
+          iho
+          iso
+          itu
+          m3aawg
+          ogc
+          oiml
+          ribose
+          standoc
+          un"
+          fi
+
+          # Exclude deprecated flavors
+          EXCLUDED="mpfa"
+
+          # Verify each site is reachable (GitHub Pages)
+          VALID=""
+          for repo in $REPOS; do
+            if echo "$EXCLUDED" | grep -qw "$repo"; then
+              echo "  EXCLUDED: $repo (deprecated)"
+              continue
+            fi
+            url="https://metanorma.github.io/mn-samples-${repo}/"
+            code=$(curl -sL -o /dev/null -w '%{http_code}' "$url" --max-time 15)
+            if [ "$code" = "200" ]; then
+              VALID="${VALID}${repo}
+          "
+              echo "  OK: $repo ($code)"
+            else
+              echo "  SKIP: $repo ($code)"
+            fi
+          done
+
+          MATRIX=$(echo "$VALID" | jq -R -s -c \
+            'split("\n") | map(select(length > 0)) | map({repo: .})')
+          echo "matrix={\"include\":$MATRIX}" >> "$GITHUB_OUTPUT"
+          echo "Valid sites: $MATRIX"
+
+  # --- Round-trip each site in parallel ---
+  roundtrip:
+    needs: discover
+    runs-on: ubuntu-latest
+    strategy:
+      matrix: ${{ fromJson(needs.discover.outputs.matrix) }}
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Run roundtrip for ${{ matrix.repo }}
+        run: |
+          mkdir -p tmp/roundtrip_reports
+          bundle exec rake "roundtrip:site[https://metanorma.github.io/mn-samples-${{ matrix.repo }},${{ matrix.repo }}]"
+        continue-on-error: true
+
+      - name: Upload report
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: report-${{ matrix.repo }}
+          path: tmp/roundtrip_reports/${{ matrix.repo }}.yml
+          retention-days: 14
+
+  # --- Consolidate all reports ---
+  consolidate:
+    needs: roundtrip
+    runs-on: ubuntu-latest
+    if: always()
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download all reports
+        uses: actions/download-artifact@v4
+        with:
+          path: tmp/roundtrip_reports
+          pattern: report-*
+          merge-multiple: true
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Consolidate reports
+        run: bundle exec rake "roundtrip:consolidate[tmp/roundtrip_reports]"
+        continue-on-error: true
+
+      - name: Upload consolidated report
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: roundtrip-consolidated-report
+          path: tmp/roundtrip_consolidated.yml
+          retention-days: 30

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock
+TODO*
+/data/dist/
+**/output/
+output.html
+output-*.html
+/private-do-not-commit/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# local repo-specific modifications
+# ...
+
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'data/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,166 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2026-04-22 12:28:09 UTC using RuboCop version 1.86.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'metanorma-document.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/ClosingParenthesisIndentation:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: consistent, consistent_relative_to_receiver, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Layout/FirstArgumentIndentation:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 580
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: symmetrical, new_line, same_line
+Layout/MultilineMethodCallBraceLayout:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/metanorma/html/index_generator.rb'
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/metanorma/iso_document/metadata/title_roundtrip_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: (?-mix:(exactly|at_least|at_most)\(\d+\)\.times)
+Lint/UnreachableLoop:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 1
+Lint/UselessConstantScoping:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 26
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/metanorma/document/components/lists/list_item.rb'
+    - 'lib/metanorma/html/index_generator.rb'
+    - 'lib/metanorma/html/renderer.rb'
+    - 'lib/metanorma/html/transformer.rb'
+
+# Offense count: 11
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 139
+
+# Offense count: 2
+# Configuration parameters: CountBlocks, CountModifierForms.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 31
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/metanorma/document/components/lists/list_item.rb'
+    - 'lib/metanorma/html/index_generator.rb'
+    - 'lib/metanorma/html/renderer.rb'
+    - 'lib/metanorma/html/transformer.rb'
+    - 'lib/metanorma/iso_document/metadata/iso_localized_title.rb'
+
+# Offense count: 33
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 141
+
+# Offense count: 24
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/metanorma/document/components/lists/list_item.rb'
+    - 'lib/metanorma/html/index_generator.rb'
+    - 'lib/metanorma/html/renderer.rb'
+    - 'lib/metanorma/html/transformer.rb'
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'
+
+# Offense count: 10
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/metanorma/document_spec.rb'
+    - 'spec/metanorma/iso_document/metadata/title_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/bipm_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/cc_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/iso_amd_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/iso_is_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/itu_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/ogc_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/oiml_collection_roundtrip_spec.rb'
+    - 'spec/metanorma/iso_document/roundtrip/oiml_roundtrip_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 6
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/metanorma/document_spec.rb'
+
+# Offense count: 279
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: ^expect_, ^assert_
+RSpec/NoExpectationExample:
+  Enabled: false
+
+# Offense count: 16
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
+# SupportedInflectors: default, active_support
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/IdenticalConditionalBranches:
+  Exclude:
+    - 'lib/metanorma/html/index_generator.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Style/SafeNavigationChainLength:
+  Exclude:
+    - 'lib/metanorma/html/renderer.rb'

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [Unreleased]
+
+### Added
+
+- Full document model for all Metanorma XML flavors: ISO, IEC, IEEE, IETF, IHO, OIML, BIPM, ITU, OGC, CC, Ribose, and Standoc
+- Autoload-based lazy loading across all modules — replaces eager `require_relative` chains
+- Roundtrip test suite verifying XML parse → serialize fidelity for ISO, BIPM, CC, ITU, OGC, OIML, and collections
+- GHA workflow (`roundtrip-samples.yml`) for automated roundtrip testing against live mn-samples sites
+- `tasks/roundtrip_samples.rake` with flavor-to-model mapping and consolidated reporting
+- Inline element models: LaTeX math, strike, underline, localized strings, formatted footnotes
+- Missing XML attribute mappings: `ol@start`, `subdivision name@language`, `docidentifier@language`
+- Mixed content and nested link support in inline elements
+
+### Fixed
+
+- Roundtrip fidelity: missing attributes, model corrections, and Canon config alignment
+- Stale `Semantic::Root` reference in rake task
+
+## [0.1.0] - 2022-03-11
+
+- Initial release

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in metanorma-standoc-document.gemspec
+gemspec
+
+if ENV["CI"]
+  gem "canon", github: "lutaml/canon", branch: "main"
+  gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
+  gem "mml", github: "plurimath/mml", branch: "main"
+  gem "moxml", github: "lutaml/moxml", branch: "main"
+else
+  gem "canon", path: "../../lutaml/canon"
+  gem "lutaml-model", path: "../../lutaml/lutaml-model"
+  gem "mml", path: "../../plurimath/mml"
+end
+
+gem "nokogiri"
+gem "rake", "~> 13.0"
+gem "rdoc"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, Ribose Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,176 @@
+= metanorma-document
+
+Ruby library for working with Metanorma document XML.
+
+== Installation
+
+ gem install metanorma-document
+
+== Usage
+
+ require 'metanorma/document'
+
+ doc = IO.read('spec/fixtures/rice-amd-en.final.xml')
+ standard = Metanorma::IsoDocument::Root.from_xml(doc)
+ puts standard.to_xml(pretty: true)
+
+=== HTML Generation
+
+The `Metanorma::Html::Generator` produces a complete, self-contained HTML document from a presentation XML document model. It handles body content rendering, table of contents, CSS theming, JavaScript interactivity, and responsive layout.
+
+==== Quick Start
+
+[source,ruby]
+require "metanorma/document"
+require "metanorma/html/generator"
+
+# Parse presentation XML into a document model
+xml = File.read("spec/fixtures/iso/is/document-en.presentation.xml")
+doc = Metanorma::IsoDocument::Root.from_xml(xml)
+
+# Generate a complete HTML document
+html = Metanorma::Html::Generator.generate(doc)
+File.write("output.html", html)
+
+==== Renderer Selection
+
+The `Generator` automatically selects the correct renderer based on the document model class:
+
+[horizontal]
+`Metanorma::Document::Root` :: `BaseRenderer` (generic documents)
+`Metanorma::StandardDocument::Root` :: `StandardRenderer` (standards with terms, annexes)
+`Metanorma::IsoDocument::Root` :: `IsoRenderer` (ISO-specific formatting)
+
+For publisher-based dispatch within the same model (e.g., ICC documents published through ISO), use _taste_ registration:
+
+[source,ruby]
+# ICC documents are IsoDocument::Root but use IccRenderer
+Metanorma::Html::Generator.register_taste(
+  Metanorma::IsoDocument::Root,
+  "ICC",
+  Metanorma::Html::IccRenderer
+)
+
+The lookup order is: taste match (publisher) → model class (most specific last) → `BaseRenderer`.
+
+==== Renderer Architecture
+
+The renderer hierarchy follows the open/closed principle:
+
+....
+BaseRenderer                  # Core HTML rendering, document assembly, CSS/JS pipeline
+└── StandardRenderer          # Terms, definitions, annexes, bibliography
+    ├── IsoRenderer           # ISO cover page, copyright, title formatting
+    │   ├── IccRenderer       # ICC publisher styling
+    │   └── PdfaRenderer      # PDF Association publisher styling
+    ├── IecRenderer           # IEC-specific formatting
+    ├── IeeeRenderer          # IEEE-specific formatting
+    ├── IetfRenderer          # IETF-specific formatting
+    ├── IhoRenderer           # IHO-specific formatting
+    ├── ItuRenderer           # ITU-specific formatting
+    ├── OgcRenderer           # OGC-specific formatting
+    ├── OimlRenderer          # OIML-specific formatting
+    ├── BipmRenderer          # BIPM-specific formatting
+    ├── CcRenderer            # CC-specific formatting
+    └── RiboseRenderer        # Ribose-specific formatting
+....
+
+==== Presentation XML
+
+The HTML renderer expects **presentation XML** (not source XML). Presentation XML contains `fmt-*` display elements (`fmt-title`, `fmt-xref`, `fmt-link`, `fmt-concept`, `fmt-definition`, `fmt-preferred`, etc.) alongside semantic elements. The renderer prioritizes `fmt-*` elements for rendering, falling back to semantic elements when display elements are absent.
+
+==== Theming
+
+Each renderer has a `Theme` object controlling colors, typography, and layout. Override theme properties in subclasses:
+
+[source,ruby]
+class MyRenderer < Metanorma::Html::StandardRenderer
+  def theme
+    @theme ||= begin
+      t = Theme.new
+      t.primary = "#1a5276"
+      t.accent = "#2e86c1"
+      t.font_body = '"Charter", serif'
+      t
+    end
+  end
+end
+
+Theme properties are emitted as CSS custom properties (`--mn-primary`, `--font-body`, etc.) for runtime customization.
+
+==== Liquid Templates
+
+HTML structure is defined in `.liquid` templates under `lib/metanorma/html/templates/`:
+
+[horizontal]
+`document.html.liquid` :: Full document shell (`<html>`, `<head>`, `<body>`)
+`_header.html.liquid` :: Sticky header with publisher logos
+`_footer.html.liquid` :: Footer with copyright
+`_cover.html.liquid` :: Cover page layout
+`_footnotes.html.liquid` :: Footnotes section
+`_doc_title.html.liquid` :: Document title rendering
+
+Templates use `Liquid::LocalFileSystem` for partials (prefixed with `_`). The `render_liquid` method handles template caching via `TEMPLATE_CACHE`.
+
+==== Asset Pipeline
+
+The `AssetPipeline` compiles CSS and JavaScript from modular source files:
+
+[horizontal]
+CSS :: `data/stylesheets/base/` (reset, typography, layout, dark mode, print) + `data/stylesheets/components/` (21 component stylesheets)
+JS  :: `data/javascripts/core/` (reader, theme, scroll, navigation, reveal) + `data/javascripts/components/` (ToC, search, lightbox, code copy, glossary, etc.)
+
+All assets are compiled into inline `<style>` and `<script>` blocks for self-contained output.
+
+==== CLI Usage
+
+From the command line:
+
+[source,bash]
+# Generate HTML from presentation XML
+bundle exec ruby -e '
+  require "metanorma/document"
+  require "metanorma/html/generator"
+  doc = Metanorma::IsoDocument::Root.from_xml(ARGF.read)
+  puts Metanorma::Html::Generator.generate(doc)
+' < document.presentation.xml > output.html
+
+==== API Reference
+
+[horizontal]
+`Generator.generate(document, **options)` :: Returns a complete HTML string. Auto-selects the renderer.
+`Generator.register(model_class, renderer_class)` :: Register a model-to-renderer mapping.
+`Generator.register_taste(model_class, publisher_abbrev, renderer_class)` :: Register a publisher-based override.
+`Generator.renderer_for(document)` :: Returns the renderer class that would be used.
+
+Renderer instance methods:
+
+[horizontal]
+`generate_full_document(document)` :: Full HTML document (body + assembly).
+`to_html` :: Returns the rendered body content after `generate_full_document`.
+`theme` :: Returns the `Theme` instance (override in subclasses).
+`render_liquid(template_name, assigns)` :: Renders a Liquid template with caching.
+
+ == Document Flavors
+
+ The gem provides a hierarchy of document flavors:
+
+ * BasicDocument - Basic document model
+ * StandardDocument - Standard document model (extends BasicDocument)
+ * IsoDocument - ISO standard document model (extends StandardDocument)
+ * IecDocument - IEC standard document model
+ * IeeeDocument - IEEE standard document model
+ * IetfDocument - IETF standard document model
+ * IhoDocument - IHO standard document model
+ * OimlDocument - OIML standard document model
+ * BipmDocument - BIPM standard document model
+ * ItuDocument - ITU standard document model
+ * OgcDocument - OGC standard document model
+ * CcDocument - CC standard document model
+ * RiboseDocument - Ribose standard document model
+
+ == Supported XML Formats
+
+ This library targets the modern Metanorma XML format which uses `<metanorma>` as the root element.
+
+ Legacy XML formats that use flavor-specific root elements (e.g. `<iso-standard>`, `<m3d-standard>`, `<csa-standard>`, `<un-standard>`) are *not supported*.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+Dir[File.join(__dir__, "tasks", "*.rake")].each { |f| import f }

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/metanorma/document"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)