asciidoctor-dot-leader 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a25c3ac68e342ade564fce5f6ae421fb3ba5da8ebec4584682cf6b5c2f0202
-  data.tar.gz: 3883b7986da82e541f1a7dcdf029dc077489906a3ad303e33140ca2f98696d1a
+  metadata.gz: 2382e42c9d8e11c7427f3758ea61f111d4fa390fe99a6daf4c0f4eab46860f64
+  data.tar.gz: 7c518c228291a4be4c236c9848f2e97a0e2d4ea94e617efc7bd79e4667ea14ba
 SHA512:
-  metadata.gz: 671510acec6229d3d54dfb4b9255c307a9141e70d307e3db369ca40773ac4d1f5bc880def7f0d3bc506251a42886956660e5a7535b0743e7e42d98adffaf0e96
-  data.tar.gz: 4a21802b05620af76b340504cd1d9951430a0502c4e1f77769c04a76cafc7ee86b26b1163e91fc4525082e2cc74e9223dd0f8bb30780a74a41d2084c16d4772b
+  metadata.gz: 726405e93b9ed14555643a2ba7d6a490f0f6ab075c54b7dbf16da785c638807f104dd812a0ca94a378316adcae5b8b2ff6df80f770daaee6018916b856f74da7
+  data.tar.gz: 81cbc4675e9ebef09663bdf94460a94ad80b024c2f52e1f800bdde550c616fae9d23f551e2d925711e895d2796728cafee1ab07d56650ea8975c47aa69b70be8

data/CHANGELOG.adoc

@@ -0,0 +1,42 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog],
+and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Versioning].
+
+== [1.2.0] - 2025-10-31
+
+This release adds support for column_boxes in asciidoctor-pdf link:https://asciidoctor.zulipchat.com/#narrow/channel/288690-users.2Fasciidoctor-pdf/topic/Implicit.20page.20break.20after.20column_box/near/503833058[^].
+
+
+== [1.1.0] - 2025-10-31
+
+=== Fixed
+
+This release fixes alignment and width calculation issues for the pdf version:
+
+* All positioning uses a universal grid based on absolute page coordinates which ensures all dot leaders align vertically across all block types
+* Fixed width calculation for roles, such as `.small` and `.big`, by using fragment-specific font sizes
+
+== [1.0.0] - 2025-07-20
+
+=== Added
+
+Initial release of the asciidoctor-dot-leader extension with these features:
+
+* Initial release of the asciidoctor-dot-leader extension
+* Supports the PDF backend via asciidoctor-pdf
+* Supports the HTML5 backend
+* Inline macro syntax: `dot:leader["left", "right"]`
+* Supports formatted text in left and right fragments
+* Handles inline images, superscript, and subscript
+
+=== Features
+
+Key capabilities of the extension:
+
+* Dot leader generation between left and right text
+* Configurable dot leader appearance via theme
+* Support for complex inline formatting
+* Compatible with multiple Asciidoctor backends

data/README.adoc

@@ -1,14 +1,16 @@
-= AsciiDoctor Dot Leader Inline Macro
+= Asciidoctor Dot Leader Inline Macro
 
 This project provides an inline macro which `pass:[dot:leader["left", "right"]]` which inserts leaders between the values.
 
 Dot . . . . . . . . . . . . . . . . . . . . . . . . Leaders
 
+**Current Version:** 1.1.0 | link:CHANGELOG.adoc[View Changelog]
+
 It currently supports three backends:
 
-* AsciiDoctor (Ruby) - `backend-html5`
-* AsciiDoctor-PDF (Ruby) - `backend-pdf`
-* AsciiDoctor.js - `backend-webview-html5` - See <<asciidoctor-js-dot-leader>>
+* Asciidoctor (Ruby) - `backend-html5`
+* Asciidoctor-PDF (Ruby) - `backend-pdf`
+* Asciidoctor.js - `backend-webview-html5` - See <<asciidoctor-js-dot-leader>>
 
 .PDF
 image:resources/images/example-pdf-adoc-formatted.png[]
@@ -16,7 +18,7 @@ image:resources/images/example-pdf-adoc-formatted.png[]
 .HTML5
 image:resources/images/example-html5-roles.png[]
 
-.AsciiDoctor.js
+.Asciidoctor.js
 image:resources/images/example-webview-html5-inline-passthroughs.png[]
 
 == Markup And Usage _Manual_ 
@@ -27,32 +29,58 @@ Markup examples, rendered output examples, and extensive compatibility informati
 * link:dot_leader_example.html[] 
 * Or clone the project and open the link:dot_leader_example.adoc[] file with Visual Studio Code's Asciidoc's preview window.
 
-== Todo
+== Asciidoctor and Asciidoctor-PDF (Ruby) Installation and Usage
 
-There are a few items which need fixing:
+The asciidoctor-dot-leader is available as a Ruby Gem.
 
-* PDF
-** [ ] Upload gem to rubygems.org
-* HTML5
-** [ ] Include .css automatically?
-* webview-html5 (Asciidoctor.js) for Microsoft Visual Studio Code and possibly others
-** [ ] Release on npm
+https://rubygems.org/gems/asciidoctor-dot-leader[^]
+
+Complete these steps to use:
+
+. Install the required Gems:
++
+[source]
+----
+gem install asciidoctor
+gem install asciidoctor-dot-leader
+----
++
+. Render the document:
++
+[source]
+----
+asciidoctor -r asciidoctor-dot-leader dot_leader_example.adoc
+----
++
+. [For PDF] Install Asciidoctor-PDF:
++
+[source]
+----
+gem install asciidoctor-pdf
+----
++
+. [For PDF] Render the PDF:
++
+[source]
+----
+asciidoctor-pdf -r asciidoctor-dot-leader dot_leader_example.adoc
+----
 
-== Ruby GEM Build Instructions (for 白一百 baiyibai)
+=== Ruby GEM Build Instructions (for 白一百 baiyibai)
 
 ```
 gem build asciidoctor-dot-leader.gemspec 
-gem install ./asciidoctor-dot-leader-1.0.0.gem
+gem install ./asciidoctor-dot-leader-1.1.0.gem
 ```
 
 [#asciidoctor-js-dot-leader]
-== AsciiDoctor.js Dot Leader Inline Macro
+== Asciidoctor.js Dot Leader Inline Macro
 
 This project provides an inline macro, `pass:[dot:leader["left", "right"]]`, which inserts dot leaders between the provided values. 
 
 === Target Application
 
-This has only been tested with the  Microsoft Visual Studio Code's AsciiDoc extension's _Preview_ function which uses the `backen-webview-html5`.
+This has only been tested with the  Microsoft Visual Studio Code's AsciiDoc extension's _Preview_ function which uses the `backend-webview-html5`.
 
 === Usage
 
@@ -83,6 +111,14 @@ module.exports = require('../../asciidoctorjs-extension/dot_leader.js')
 .. Enable the Asciidoc > Extensions: *Register Workspace Extensions* option.
 . Open a document containing `pass:[dot:leader[]]` inline macros, and press the _Preview_ button.
 
+== Todo
+
+There are a few items which need fixing:
+
+* HTML5
+** [ ] Include .css automatically?
+* webview-html5 (Asciidoctor.js) for Microsoft Visual Studio Code and possibly others
+** [ ] Release on npm
 
 == Copyright
 

data/lib/asciidoctor/dot_leader/dot_leader_pdf.rb

@@ -1,6 +1,6 @@
 # dot_leader_pdf.rb 2025-07-20 白一百 baiyibai
 # https://gitlab.com/baiyibai/asciidoctor-pdf-dot-leader
-# This inline macro uses AsciiDoctor-PDF's ToC generation code as a jumping off point, but departs from it.
+# This inline macro uses Asciidoctor-PDF's ToC generation code as a jumping off point, but departs from it.
 # Use '':dot-leader-scale: 0.6' to set the document-wide factor
 require 'asciidoctor-pdf' unless defined? ::Asciidoctor::Converter::PdfConverter
 class DotLeader < (Asciidoctor::Converter.for 'pdf')
@@ -9,7 +9,8 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
   def rendered_width_of_fragments(fragments, scale, roles = [])
       fragments.sum do |fragment|
       styles = fragment[:styles] || Set.new
-      size = font_size
+      # Use fragment's size if specified (for roles like .small, .big), otherwise use current font size
+      size = fragment[:size] || font_size
       size *= scale if styles.include?(:subscript) || styles.include?(:superscript)
       font_style = if styles.include?(:bold) && styles.include?(:italic)
         :bold_italic
@@ -43,6 +44,12 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
 
     left_side = node.attr('l_text') || ''
     right_side = node.attr('r_text') || ''    
+    
+    # DEBUG: Initial context information
+    is_column_box = defined?(::Prawn::Document::ColumnBox) && bounds.is_a?(::Prawn::Document::ColumnBox)
+    current_column = is_column_box ? bounds.current_column : 'N/A'
+    # log :info, %(DOT_LEADER_DEBUG: Starting - left="#{left_side}", right="#{right_side}", page=#{page_number}, cursor=#{cursor}, is_column=#{is_column_box}, current_column=#{current_column})
+    
     if left_side.empty? # Allow items only on the right
       left_side = ' '
     end
@@ -75,6 +82,8 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
       }
     end
 
+    # log :info, %(DOT_LEADER_DEBUG: Dot leader config - text="#{dot_leader[:text]}", width=#{dot_leader[:width]}, spacer_width=#{dot_leader[:spacer_width]})
+
     # 2025-07-17 BYB: Set toc_font_info
     toc_font_info = theme_font :toc do
       { font: font, size: @font_size }
@@ -102,14 +111,12 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
     line_metrics = calc_line_metrics @base_line_height
 
     # 2025-07-17 BYB: This needs to be modified
-    right_side_placeholder_width = rendered_width_of_string right_side * @toc_max_pagenum_digits
-    # puts right_side_placeholder_width.inspect # Various widths
-    right_side_placeholder_width = 0 # BYB: Not a problem for now
-    
     right_side_placeholder_width = rendered_width_of_fragments right_side_fragments, scale, node.roles.to_a
 
     left_side_test_width = rendered_width_of_fragments left_side_fragments, scale, node.roles.to_a
     
+    # log :info, %(DOT_LEADER_DEBUG: Text widths - left=#{left_side_test_width}, right=#{right_side_placeholder_width})
+    
     # 2025-07-17 Set hanging_indent to toc; potentially this could be styled
     hanging_indent = @theme.toc_hanging_indent
     start_page_number = page_number
@@ -122,7 +129,7 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
       end
 
       if right_side_placeholder_width > bounds.width
-        warn "WARN: dot-leader: The right side too wide to fit on a line; skipping: #{left_side} #{right_side}"
+        log :warn, %(DOT_LEADER_DEBUG: Right side too wide; skipping: #{left_side} - right_width=#{right_side_placeholder_width}, bounds_width=#{bounds.width})
         return nil
       end
 
@@ -134,6 +141,8 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
       start_cursor = last_fragment_cursor if last_fragment_position.page_number > start_page_number || (start_cursor - last_fragment_cursor) > line_metrics.height
     end
     
+    # log :info, %(DOT_LEADER_DEBUG: After left text - start_dots=#{start_dots}, start_cursor=#{start_cursor})
+    
     # 2025-07-17 No loop
     # NOTE: this will leave behind a gap where this entry would have been
     # break unless start_dots
@@ -152,19 +161,174 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
         # NOTE: the same font is used for dot leaders throughout toc
         set_font toc_font_info[:font], dot_leader[:font_size]
         font_style dot_leader[:font_style]
-        # 2025-07-17 BYB: Add support for Multiple Columns https://asciidoctor.zulipchat.com/#narrow/channel/288690-users.2Fasciidoctor-pdf/topic/Implicit.20page.20break.20after.20column_box
-        if node.parent.parent.attributes['columns']
-          start_dots = start_dots - bounds.left
+        # For true vertical alignment, dots must be at consistent absolute positions across all lines
+        # CONTEXT-AWARE GRID ALIGNMENT:
+        # Use appropriate grid origin for each context to ensure proper alignment
+        # while maintaining correct positioning within bounds
+        
+        # Calculate the absolute position where dots will start
+        # Note: start_dots may already be absolute in some contexts (like right column)
+        # Check if start_dots is already in absolute coordinates
+        if start_dots > bounds.width
+          # start_dots appears to be already absolute (larger than column width)
+          start_dots_absolute = start_dots
+        else
+          # start_dots is relative to bounds, convert to absolute
+          start_dots_absolute = start_dots + bounds.absolute_left
+        end
+        
+        if defined?(::Prawn::Document::ColumnBox) && bounds.is_a?(::Prawn::Document::ColumnBox)
+          # In column context: use UNIVERSAL grid origin (page margin) for alignment across all columns
+          # This ensures dots align consistently across left and right columns
+          
+          # Get column information for debugging
+          current_col = bounds.current_column
+          parent_bounds = bounds.instance_variable_get(:@parent)
+          total_columns = bounds.instance_variable_get(:@columns) || 2
+          
+          # Calculate the actual column dimensions from the parent
+          parent_width = parent_bounds.width
+          column_width = parent_width / total_columns
+          total_spacer_width = parent_width - (column_width * total_columns)
+          spacer_width = total_columns > 1 ? total_spacer_width / (total_columns - 1) : 0
+          column_offset = current_col * (column_width + spacer_width)
+          
+          # UNIVERSAL GRID: Use page margin as grid origin for all columns
+          # This ensures dots align across the entire page
+          grid_origin = page.margins[:left]
+          
+          # log :info, %(DOT_LEADER_DEBUG: Column context - current_column=#{current_col}, total_columns=#{total_columns}, column_width=#{column_width}, spacer_width=#{spacer_width}, column_offset=#{column_offset}, bounds_left=#{bounds.absolute_left}, grid_origin=#{grid_origin})
+        else
+          # In normal context: use the page margin as grid origin to ignore indentation
+          # This ensures consistent alignment across all list levels
+          grid_origin = page.margins[:left]
+          # log :info, %(DOT_LEADER_DEBUG: Normal context - bounds_left=#{bounds.absolute_left}, page_margin=#{page.margins[:left]}, grid_origin=#{grid_origin})
+        end
+        
+        # Calculate the position relative to the grid origin for alignment
+        start_dots_from_grid_origin = start_dots_absolute - grid_origin
+        
+        # log :info, %(DOT_LEADER_DEBUG: Position calculations - start_dots_absolute=#{start_dots_absolute}, start_dots_from_grid_origin=#{start_dots_from_grid_origin})
+        
+        # Find the first grid position after the left text ends
+        # Grid positions are at multiples of dot_leader[:width] from the grid origin
+        first_dot_grid_index = (start_dots_from_grid_origin / dot_leader[:width]).ceil
+        first_dot_position_absolute = grid_origin + (first_dot_grid_index * dot_leader[:width])
+        
+        # Convert back to the local bounds coordinate system for rendering
+        # Use universal grid but fix coordinate conversion for right column
+        first_dot_position = first_dot_position_absolute - bounds.absolute_left
+        
+        # Special handling for columns beyond the first (right column in 2-column layout)
+        # We need to recalculate using the universal grid to ensure proper alignment
+        if defined?(::Prawn::Document::ColumnBox) && bounds.is_a?(::Prawn::Document::ColumnBox)
+          current_col = bounds.current_column
+          if current_col > 0
+            # Right column case: recalculate using universal grid
+            # We need to find the first grid position within the column that comes AFTER the left text
+          
+          # Calculate the left text width to ensure dots start after it
+          left_text_width = rendered_width_of_fragments left_side_fragments, scale, node.roles.to_a
+          
+          # Find the equivalent universal grid position that aligns with other columns
+          # Calculate where text ends (without spacer first)
+          # Use the absolute left position of the current column plus the text width
+          text_end_no_spacer = bounds.absolute_left + left_text_width
+          # Add the spacer to get the absolute position where dots should start
+          text_end_absolute = text_end_no_spacer + dot_leader[:spacer_width]
+          
+          # Find the first universal grid position after the text ends
+          # This ensures alignment with single column and other contexts
+          text_end_from_grid_origin = text_end_absolute - grid_origin
+          universal_grid_index = (text_end_from_grid_origin / dot_leader[:width]).ceil
+          
+          # Check if the previous grid position would still fit (with minimal spacing)
+          # This allows us to fit one more dot if the previous grid position comes after the actual text
+          if universal_grid_index > 0
+            previous_grid_position = grid_origin + ((universal_grid_index - 1) * dot_leader[:width])
+            # Check spacing from actual text end (not including the full spacer)
+            spacing_from_text = previous_grid_position - text_end_no_spacer
+            # Use previous position if it's at least 1pt after the text (minimal spacing)
+            if spacing_from_text >= 1.0
+              universal_grid_index -= 1
+            end
+          end
+          
+          # Calculate the absolute position using the universal grid
+          adjusted_position_absolute = grid_origin + (universal_grid_index * dot_leader[:width])
+          first_dot_position = adjusted_position_absolute - bounds.absolute_left
+          first_dot_position_absolute = adjusted_position_absolute
+          # CRITICAL: Update the grid index to match the adjusted position
+          first_dot_grid_index = universal_grid_index
+          
+            # log :info, %(DOT_LEADER_DEBUG: Right column adjustment - left_text_width=#{left_text_width}, text_end_absolute=#{text_end_absolute}, text_end_from_grid_origin=#{text_end_from_grid_origin}, universal_grid_index=#{universal_grid_index}, adjusted_grid_index=#{first_dot_grid_index}, adjusted_position=#{first_dot_position})
+          else
+            # log :info, %(DOT_LEADER_DEBUG: Left column - no adjustment needed)
+          end
+        else
+          # log :info, %(DOT_LEADER_DEBUG: Standard conversion - first_dot_position_absolute=#{first_dot_position_absolute}, bounds.absolute_left=#{bounds.absolute_left}, first_dot_position=#{first_dot_position})
         end
-        num_dots = [((bounds.width - start_dots - dot_leader[:spacer_width] - right_side_width) / dot_leader[:width]).floor, 0].max
-        # FIXME: dots don't line up in columns if width of page numbers differ # BYB: Original
+        
+        # log :info, %(DOT_LEADER_DEBUG: First dot - grid_index=#{first_dot_grid_index}, position_absolute=#{first_dot_position_absolute}, position_local=#{first_dot_position})
+        
+        # Check if the first dot is too close to the left text
+        # Calculate the actual left text width for precise spacing check
+        left_text_width = rendered_width_of_fragments left_side_fragments, scale, node.roles.to_a
+        space_after_left_text = first_dot_position - left_text_width
+        
+        dot_stripped = dot_leader[:text].rstrip
+        dot_stripped_width = rendered_width_of_string dot_stripped
+        
+        # Calculate where the right text will start (in absolute coordinates)
+        right_text_start_local = bounds.width - right_side_width - dot_leader[:spacer_width]
+        
+        # Convert to absolute coordinates: bounds.absolute_left already accounts for column position
+        right_text_start_absolute = right_text_start_local + bounds.absolute_left
+        
+        # Find the last grid position before the right text starts (using the same grid origin)
+        # Ensure the COMPLETE dot (start + width) fits before right text
+        right_text_from_grid_origin = right_text_start_absolute - grid_origin
+        
+        # Calculate the last grid index where a complete dot would fit
+        # A dot at position N has its right edge at N + dot_leader[:width]
+        # The target: (last_dot_grid_index * dot_leader[:width]) + dot_leader[:width] <= right_text_from_grid_origin
+        # Simplified: last_dot_grid_index <= (right_text_from_grid_origin / dot_leader[:width]) - 1
+        # Add some buffer space to ensure the dot does not touch the right text
+        last_possible_dot_end = right_text_from_grid_origin - (1.0 * dot_stripped_width)
+        last_dot_grid_index = (last_possible_dot_end / dot_leader[:width]).floor
+        
+        # log :info, %(DOT_LEADER_DEBUG: Right text - start_local=#{right_text_start_local}, start_absolute=#{right_text_start_absolute}, from_grid_origin=#{right_text_from_grid_origin})
+        
+        # Calculate the number of dots that fit on the grid between left and right text
+        num_dots = [last_dot_grid_index - first_dot_grid_index + 1, 0].max
+        # log :info, %(DOT_LEADER_DEBUG: Last dot - last_possible_end=#{last_possible_dot_end}, last_grid_index=#{last_dot_grid_index}, num_dots=#{num_dots})
+
+        # Calculate the indent to position the first dot at the correct grid position
+        dot_indent = first_dot_position
+
+        # log :info, %(DOT_LEADER_DEBUG: Final render - dot_indent=#{dot_indent}, num_dots=#{num_dots}, dot_text="#{dot_leader[:text]}")
+
         fragment_positions = []
         right_side_fragments.each do |fragment|
           fragment_positions << (fragment_position = ::Asciidoctor::PDF::FormattedText::FragmentPositionRenderer.new)
           (fragment[:callback] ||= []) << fragment_position
         end
+        
+        # Render the dots with a proper indent to align to the grid
+        if num_dots > 0
+          indent dot_indent, 0 do
+            typeset_formatted_text [
+              { text: dot_leader[:text] * num_dots, color: dot_leader[:font_color] }
+            ], line_metrics, align: :left
+          end
+          # log :info, %(DOT_LEADER_DEBUG: Dots rendered successfully)
+        else
+          log :warn, %(DOT_LEADER_DEBUG: No dots to render - num_dots=#{num_dots})
+        end
+        
+        # Move cursor back to render right text
+        move_cursor_to start_cursor
         typeset_formatted_text [
-        { text: dot_leader[:text] * num_dots, color: dot_leader[:font_color] },
         dot_leader[:spacer],
         *right_side_fragments.map { |fragment|
           fragment.dup.tap do |f|
@@ -179,12 +343,13 @@ class DotLeader < (Asciidoctor::Converter.for 'pdf')
       ], line_metrics, align: :right
       end
     else
+      # log :info, %(DOT_LEADER_DEBUG: Skipping dot rendering - width=#{dot_leader[:width]}, levels_check=#{dot_leader[:levels] ? (dot_leader[:levels].include? entry_level.pred) : true})
       typeset_formatted_text [{ text: right_side, color: @font_color, anchor: entry_anchor }], line_metrics, align: :right
     end
     move_cursor_to end_cursor
 
+    # log :info, %(DOT_LEADER_DEBUG: Completed - final_cursor=#{cursor})
     # Return nil to avoid numbers being printed out
     nil
-
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dot-leader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - 白一百 baiyibai
@@ -30,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.adoc
 - LICENSE
 - README.adoc
 - lib/asciidoctor-dot-leader.rb