idml 0.8.9 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d58f00746f6afb4233e161dfa9cdeb116d714eed0c238ec543a0f039b4167f0e
-  data.tar.gz: 1a000e34996525fe34cdc441625c9eaa303f121c836ae3f3b07b73c12712abb1
+  metadata.gz: eb1bde51604723b865996a34842c6a5216b3c0ce4f55947902aa9dd92358ed25
+  data.tar.gz: a1e6ed580c3d0fee769287d3619c33fa6e18ed79ee332d1aa0a7976b1352b760
 SHA512:
-  metadata.gz: 15001cbf1427dc278c701cd4980b837ff4b015f6c5657eeb5c88c0c8774933934e606439c40fa3c900368ef2959fc1170cd12841a9caadc0c025a199dd18cd68
-  data.tar.gz: 41f45b1b2db245e1dd2d5ef40aa60990fc3c957930b3d16a633974d1f267149e8b2c5cf638b7b3549b4318bf8ea62f378fbb5d0f98ad32d4d50fbce0e3cb9505
+  metadata.gz: 989af27c2ad974dac8d370e335e923b70727a0c32991fe67011c2231cd5b526fdf59e73d571df8423ae69e9e27a5fa03dd69cf94a732ec76138cb34188af0792
+  data.tar.gz: d3daaccd0d51e4a78b825f5ea2f7baf6a3c23c11df1c33eb793b649c23b18bac2255de8e3fc3e3e7d62addac871b77f20879931dac73d6f14fec6fe54c10caea

data/.github/workflows/release.yml

@@ -1,5 +1,8 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
+# Managed by Cimas; trusted-publishing change is intentional (2026-08-18):
+# publish via RubyGems OIDC Trusted Publishing instead of the API key
+# (the API-key path is blocked by rubygems.org MFA OTP demands).
+# See https://github.com/metanorma/ci — the reusable workflow uses its
+# OIDC path whenever the rubygems-api-key secret is not passed.
 name: release
 
 on:
@@ -20,6 +23,5 @@ jobs:
     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/TODO.pdf/101-paragraph-rules-borders.md

@@ -1,47 +1,44 @@
 # TODO PDF 101: Paragraph borders and rules (RuleAbove, RuleBelow, ParagraphBorder)
 
-## Status: PARTIAL — RuleAbove and RuleBelow implemented via new
-`Render::ParagraphRules` helper; TextFrameRenderer emits them at
-paragraph top/bottom. Rule color comes from PSR#stroke_color (IDML's
-PSR doesn't have a dedicated RuleAboveColor attribute). RuleAboveWidth
-"Text" vs "Column" honored. Tint scaling + line weight + offset honored.
-
-ParagraphBorder and ParagraphShading remain open — they need the
-paragraph's bounding rect, which the renderer doesn't currently
-expose to ParagraphRules. Will add when a real document fixture
-exercises them.
-
-## Problem
-
-`ParagraphStyleRange` carries:
-
-- `RuleAbove`, `RuleAboveLineWeight`, `RuleAboveTint`, `RuleAboveOffset`,
-  `RuleAboveLeftIndent`, `RuleAboveRightIndent`, `RuleAboveWidth`
-- `RuleBelow`, `RuleBelowLineWeight`, `RuleBelowTint`, `RuleBelowOffset`,
-  `RuleBelowLeftIndent`, `RuleBelowRightIndent`, `RuleBelowWidth`
-- `ParagraphBorderOn`, `ParagraphBorderTopLineWeight`,
-  `ParagraphBorderLeftLineWeight`, etc.
-- `ParagraphShadingOn`, `ParagraphShadingTint`, `ParagraphShadingColor`
-
-None of these are rendered today. Real-world documents use RuleAbove
-heavily for headings ("section divider line"), and ParagraphShading
-for callouts.
-
-## What needs to happen
-
-1. After laying out a paragraph, emit RuleAbove as a horizontal line
-   above the first line, with the rule's weight/tint/color/offset/indent.
-2. Emit RuleBelow similarly below the last line.
-3. Optionally emit ParagraphBorder as a rectangle around the paragraph.
-4. Optionally emit ParagraphShading as a fill behind the paragraph.
+## Status: COMPLETE — implemented 2026-08-17
+
+## What was built
+
+- RuleAbove / RuleBelow (earlier milestone): horizontal rules at
+  paragraph top/bottom with weight / tint / offset / indent /
+  TextWidth-ColumnWidth modes, via `Render::ParagraphRules`.
+- Rule colors now resolve from `Properties > RuleAboveColor` /
+  `RuleBelowColor` (typed value elements) with StrokeColor fallback —
+  modeled via `Elements::TypedValue` + Properties mapping, PSR/CSR
+  now carry `properties` collections.
+- ParagraphShading: fill rect behind the paragraph block. Color from
+  `Properties > ParagraphShadingColor`, tint scaling, ParagraphShading
+  width mode (ColumnWidth default / TextWidth), four outward offsets.
+  `TextEngine::Measurement` pre-measures the paragraph's height so
+  the rect is known before the lines are laid out (clamped to the
+  frame's bottom limit when the paragraph splits).
+- ParagraphBorder: per-side strokes around the same block rect, each
+  side with its own line weight and the border offsets/tint/color
+  (Properties > ParagraphBorderColor). Shading and border share one
+  extent so they always agree.
+
+## Known limitations
+
+- Border corner radii and gap colors are parsed on the model but not
+  rendered; MergeConsecutiveParaBorders (merged rects across like-
+  bordered paragraphs) is not modeled.
+- DisplayIfSplits: when a paragraph splits across frames, both
+  shading and border are drawn around the rendered portion only.
 
 ## Acceptance criteria
 
-- [ ] PSR with RuleAbove=true and RuleAboveLineWeight=2 draws a 2pt
-      horizontal line above the paragraph.
-- [ ] PSR with RuleAboveOffset=4 leaves 4pt gap between rule and text.
-- [ ] PSR with ParagraphShadingOn=true and tint fills the paragraph rect.
+- [x] PSR with RuleAbove=true and RuleAboveLineWeight=2 draws the
+      rule above the paragraph.
+- [x] PSR with RuleAboveOffset=4 leaves a 4pt gap.
+- [x] PSR with ParagraphShadingOn=true and tint fills the paragraph
+      rect.
+- [x] ParagraphBorderOn draws per-side strokes.
 
 ## Dependencies
 
-- TODO 94 (VerticalLayout knows the paragraph's rect).
+- TODO 94 (VerticalLayout knows the paragraph's rect) — satisfied.

data/TODO.pdf/104-table-schema-completion.md

@@ -1,11 +1,21 @@
 # TODO PDF 104: Schema-faithful Table model completion
 
-## Status: PARTIAL — added the rendering-relevant subset (column_count,
-single_column_width, header/body/footer row counts, table_direction,
-outer-border strokes). The remaining ~150 schema attributes (alternating
-stroke rows, column rules, table-flavor bits) aren't needed for
-rendering and would be pure model bloat. Add incrementally as use
-cases demand.
+## Status: COMPLETE — implemented 2026-08-18
+
+All 171 Table_Object attributes from
+`reference-docs/schemas/package/Stories/Story.rnc` are declared on
+`Elements::Table` (the prior rendering-relevant subset plus the 155
+remaining: border tints/gaps/overprints, default row/column strokes,
+alternating fills, cell insets, diagonal lines, caption settings,
+…), generated with `scripts/rnc_to_lutaml.rb` in schema order.
+
+Drift defense: `spec/idml/elements/table_spec.rb` reads the RNC at
+spec time and asserts a Table built with every schema attribute
+round-trips every attribute — any attribute dropped from the model
+fails the spec.
+
+The renderer still consults only the rendering-relevant subset; the
+rest are carried for round-trip and downstream-tool fidelity.
 
 ## Problem
 

data/TODO.pdf/116-justification-last-line.md

@@ -0,0 +1,31 @@
+# TODO PDF 116: Justified-text last-line handling
+
+## Status: COMPLETE — implemented 2026-08-18
+
+## Problem
+
+`TextEngine::Justifier` spread slack across inter-word spaces for
+`:justified` paragraphs on EVERY line, including each paragraph's
+final line — InDesign (and standard typography) leaves the last line
+of a justified paragraph ragged. Every fully-justified paragraph
+rendered with its final line stretched across the full column width.
+
+## What was done
+
+- `Justifier.justify` takes `last_line:`; when true, a `:justified`
+  line falls back to left alignment (no space stretching). All other
+  alignments unchanged.
+- `TextFrameRenderer.layout_run` passes `last_line:` true for the
+  final line of the paragraph's FINAL run (`paragraph_last:` flag
+  threaded from `render_runs_for_paragraph`, which knows the run
+  list). Mid-paragraph run breaks still justify — only the true
+  paragraph-final line goes ragged.
+- Footnote layout (`Render::Footnote.layout_paragraph`) applies the
+  same rule for the final line of the final run.
+
+## Known limitations
+
+- Justification adjusts inter-word spaces only; letter spacing and
+  glyph scaling (Minimum/Maximum/DesiredGlyphScaling, tracking) are
+  not applied. ToBinding / RTL binding alignment remains mapped to
+  left.

data/TODO.pdf/117-endnote-support.md

@@ -0,0 +1,45 @@
+# TODO PDF 117: Endnote support
+
+## Status: OPEN (modeling COMPLETE 2026-08-18; rendering OPEN pending
+a real fixture)
+
+## Problem
+
+IDML endnotes use a reference architecture unlike footnotes: the
+main story carries `<Endnote Self="..." EndnoteTextRange="..."/>`
+plus `<EndnoteRange SourceEndnote="..."/>` markers (both at Story
+level, per Story.rnc), while the endnote TEXT lives in a separate
+story flagged `IsEndnoteStory="true"`. Documents with endnotes
+(scholarly publishing) currently drop endnote text entirely.
+
+## What is done (2026-08-18)
+
+- `Elements::Endnote` (Self, EndnoteTextRange) and
+  `Elements::EndnoteRange` (Self, SourceEndnote) — schema-faithful
+  models, wired into `StoryInner` (`endnote`, `endnote_range`
+  collections). Round-trip + parse specs.
+- `StoryInner#is_endnote_story` already parsed, so endnote stories
+  are identifiable.
+
+## Design for rendering (needs a real InDesign fixture to validate)
+
+1. Marker: story-level `Endnote`/`EndnoteRange` pairs delimit the
+   anchor range; marker position requires story text-offset
+   bookkeeping the extraction layer doesn't currently track (unlike
+   footnotes, which sit inside a CSR). A range-aware extraction is
+   the prerequisite.
+2. Endnote text: resolve `EndnoteTextRange` → the endnote story
+   (IsEndnoteStory) → its paragraphs.
+3. Placement: per EndnoteOption Scope — end of story / end of
+   section / end of document; end-of-story is the tractable default
+   (append after the referencing story's last paragraph).
+4. Numbering: endnotes number separately from footnotes
+   (FootnoteOption vs EndnoteOption StartAt/Prefix/Suffix — the
+   Endnote preference object is not yet modeled in Preferences).
+
+## Why rendering is deferred
+
+The marker-position machinery (text-range resolution) cannot be
+validated without a real fixture; blind implementation risks wrong
+anchor placement on production files. Schema modeling + round-trip
+is complete and verified.

data/TODO.pdf/13-cjk-text-layout.md

@@ -1,9 +1,25 @@
 # TODO PDF 13: CJK text layout
 
-## Status: PARTIAL — `Idml::TextEngine::CjkLayout` handles CJK glyph
-measurement and basic horizontal layout. Vertical writing mode,
-kinsoku shori, tate-chu-yoko, and ruby remain stretch goals as
-flagged in the original TODO. See `lib/idml/text_engine/cjk_layout.rb`.
+## Status: PARTIAL — horizontal-mode CJK complete (2026-08-17):
+CJK glyph measurement, kinsoku shori, and ruby annotations render.
+Vertical writing mode, tate-chu-yoko, and mojikumi remain OPEN
+stretch goals — they need a vertical (rotated) layout engine and
+real vertical-mode fixtures to build against. See
+`lib/idml/text_engine/cjk_layout.rb`.
+
+## Progress 2026-08-17
+
+- Kinsoku shori is now LIVE in the pipeline: LineBreaker.break
+  post-processes any run containing CJK glyphs through
+  CjkLayout.apply_kinsoku, so no rendered line starts with
+  、。，」etc. or ends with 「 etc. (previously the logic existed
+  but was never called).
+- Ruby (phonetic annotations) render: CSR RubyString /
+  RubyFontSize / RubyPosition extract onto the run; the renderer
+  emits the annotation centered above the run's first line (half
+  the base size by default; Below* positions place it under).
+  Approximation: IDML attaches ruby to a character range; we
+  annotate the whole first line.
 
 ## Goal
 

data/lib/idml/elements/character_style_range.rb

@@ -298,6 +298,7 @@ module Idml
       attribute :content, Idml::Elements::Content, collection: true
       attribute :hyperlink_text_source, Idml::Elements::HyperlinkTextSource,
                 collection: true
+      attribute :properties, Idml::Elements::Properties, collection: true
       attribute :table, Idml::Elements::Table, collection: true
       attribute :xml_element, Idml::Elements::XmlElement, collection: true
       attribute :footnote, Idml::Elements::Footnote, collection: true
@@ -664,6 +665,7 @@ module Idml
         map_element "CharacterStyleRange", to: :character_style_range
         map_element "Content", to: :content
         map_element "HyperlinkTextSource", to: :hyperlink_text_source
+        map_element "Properties", to: :properties
         map_element "Table", to: :table
         map_element "XMLElement", to: :xml_element
         map_element "Footnote", to: :footnote

data/lib/idml/elements/endnote.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Idml
+  module Elements
+    # `<Endnote>` — a story-level endnote reference. The endnote's
+    # TEXT lives in a separate story flagged `IsEndnoteStory="true"`;
+    # this element points at it via `EndnoteTextRange` (schema:
+    # Endnote_Object in Stories/Story.rnc — Self plus the range
+    # reference; no inline content). Rendering design in
+    # TODO.pdf/117-endnote-support.md.
+    class Endnote < Lutaml::Model::Serializable
+      attribute :self_attr, :string
+      attribute :endnote_text_range, :string
+
+      xml do
+        root "Endnote"
+        map_attribute "Self", to: :self_attr
+        map_attribute "EndnoteTextRange", to: :endnote_text_range
+      end
+    end
+  end
+end

data/lib/idml/elements/endnote_range.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Idml
+  module Elements
+    # `<EndnoteRange>` — marks the text range in the main story that
+    # an endnote references, linking back via `SourceEndnote`
+    # (schema: EndnoteRange_Object in Stories/Story.rnc). Pairs with
+    # Elements::Endnote; rendering design in
+    # TODO.pdf/117-endnote-support.md.
+    class EndnoteRange < Lutaml::Model::Serializable
+      attribute :self_attr, :string
+      attribute :source_endnote, :string
+
+      xml do
+        root "EndnoteRange"
+        map_attribute "Self", to: :self_attr
+        map_attribute "SourceEndnote", to: :source_endnote
+      end
+    end
+  end
+end

data/lib/idml/elements/paragraph_style_range.rb

@@ -298,6 +298,7 @@ module Idml
                 collection: true
       attribute :content, Idml::Elements::Content, collection: true
       attribute :xml_element, Idml::Elements::XmlElement, collection: true
+      attribute :properties, Idml::Elements::Properties, collection: true
 
       xml do
         root "ParagraphStyleRange"
@@ -651,6 +652,7 @@ module Idml
         map_element "ParagraphStyleRange", to: :paragraph_style_range
         map_element "Content", to: :content
         map_element "XMLElement", to: :xml_element
+        map_element "Properties", to: :properties
       end
 
       def text_content

data/lib/idml/elements/properties.rb

@@ -2,18 +2,31 @@
 
 module Idml
   module Elements
-    # `<Properties>` — a common child element on page items. Carries
-    # optional PathBoundingBox, PathGeometry, and Label. Only the
-    # modeled children are populated from XML; others are ignored.
+    # `<Properties>` — a common child element on page items and
+    # story style ranges. Carries optional PathBoundingBox,
+    # PathGeometry, Label, and the paragraph-decoration color value
+    # elements (RuleAboveColor, ParagraphShadingColor, …) used on
+    # PSR/CSR Properties. Only the modeled children are populated
+    # from XML; others are ignored.
     class Properties < Lutaml::Model::Serializable
       attribute :path_bounding_box, :string
       attribute :path_geometry, Idml::Elements::PathGeometry,
                 collection: true
+      attribute :rule_above_color, Idml::Elements::TypedValue
+      attribute :rule_below_color, Idml::Elements::TypedValue
+      attribute :paragraph_shading_color, Idml::Elements::TypedValue
+      attribute :paragraph_border_color, Idml::Elements::TypedValue
+      attribute :paragraph_border_gap_color, Idml::Elements::TypedValue
 
       xml do
         root "Properties"
         map_element "PathBoundingBox", to: :path_bounding_box
         map_element "PathGeometry", to: :path_geometry
+        map_element "RuleAboveColor", to: :rule_above_color
+        map_element "RuleBelowColor", to: :rule_below_color
+        map_element "ParagraphShadingColor", to: :paragraph_shading_color
+        map_element "ParagraphBorderColor", to: :paragraph_border_color
+        map_element "ParagraphBorderGapColor", to: :paragraph_border_gap_color
       end
 
       def first_geometry

data/lib/idml/elements/story_inner.rb

@@ -313,6 +313,9 @@ module Idml
       attribute :content, Idml::Elements::Content, collection: true
       attribute :xml_element, Idml::Elements::XmlElement, collection: true
       attribute :footnote, Idml::Elements::Footnote, collection: true
+      attribute :endnote, Idml::Elements::Endnote, collection: true
+      attribute :endnote_range, Idml::Elements::EndnoteRange,
+                collection: true
 
       xml do
         root "Story"
@@ -678,6 +681,8 @@ module Idml
         map_element "Content", to: :content
         map_element "XMLElement", to: :xml_element
         map_element "Footnote", to: :footnote
+        map_element "Endnote", to: :endnote
+        map_element "EndnoteRange", to: :endnote_range
       end
 
       def text_content