asciidoctor-pdf 2.3.20 → 2.3.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c14c6b1955b9d36bc085d127fef49bf8f90f3a035e8b6e3d196bf6fe4ee22323
-  data.tar.gz: a0755e6cfb29974f58b94f6785fb871ca99bf7101b18e1a60b6e7c7cada9f3e9
+  metadata.gz: 4250f6c0a0f203fe5e164656467da521bf4741771dd2627030c02a5401c24970
+  data.tar.gz: ef2cdb91e970f26ec2cbbb680d94db21d613aaf3c339492f63bbdb5c30a19337
 SHA512:
-  metadata.gz: bdd80f2e12b579772e5f0d433f2e002e56ff864f71400baaafa178a6a139817e875651b5feb494fc7b5a25907ef3f4ba331b622fda563befe65e0a3c38687d60
-  data.tar.gz: 7922d5ac110d170fe242070ef65d324bd8ff9fd5bd7820111324d9cfb878070238f2b9057808beb5c1aee33aad94062590ef21f388a3efef45a6d98b84fec71f
+  metadata.gz: a53a41fffe731219da61c25eea7f443dd7cb3b64594e116637f28f2f43173a8d4f43c1b7040cacee56566a3e0bb6be474a6d488275d02094646ea1d48b1fb9a2
+  data.tar.gz: 717af76d4f0f4d958301f099e68ccd3395bc54b5740b2fa47d741fee2bd13aec2d2f48e5443c5d43f64535f23f6b12dc1a00d1c0dd74216a0f95f7ac15845e89

data/CHANGELOG.adoc

@@ -5,6 +5,19 @@
 This document provides a high-level view of the changes to the {project-name} by release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 2.3.21 (2025-10-08) - @mojavelinux
+
+Improvements::
+
+* remove shy hyphens from text in log message when formatted text cannot be parsed (#2599)
+* clear float box if next block falls outside of flaot group (#2596)
+* resolve fonts relative to theme dir before GEM_FONTS_DIR if `pdf-fontsdir` not specified (#2349)
+* add see and see-also associations on index terms to index (#2527)
+
+=== Details
+
+{url-repo}/releases/tag/v2.3.21[git tag] | {url-repo}/compare/v2.3.20\...v2.3.21[full diff]
+
 == 2.3.20 (2025-09-17) - @mojavelinux
 
 Improvements::

data/README.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor PDF: A native PDF converter for AsciiDoc
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.3.20, 2025-09-17
+v2.3.21, 2025-10-08
 // Settings:
 :experimental:
 :idprefix:

data/lib/asciidoctor/pdf/converter.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'formatted_string'
 require_relative 'formatted_text'
 require_relative 'index_catalog'
 require_relative 'pdfmark'
@@ -403,7 +402,7 @@ module Asciidoctor
         @page_bg_image = {}
         @page_bg_color = resolve_theme_color :page_background_color, 'FFFFFF'
         # QUESTION: should ThemeLoader handle registering fonts instead?
-        register_fonts theme.font_catalog, ((doc.attr 'pdf-fontsdir')&.sub '{docdir}', (doc.attr 'docdir')) || 'GEM_FONTS_DIR'
+        register_fonts theme.font_catalog, ((doc.attr 'pdf-fontsdir')&.sub '{docdir}', (doc.attr 'docdir')) || (theme.__dir__ == ThemeLoader::ThemesDir ? 'GEM_FONTS_DIR' : %(#{theme.__dir__};GEM_FONTS_DIR))
         default_kerning theme.base_font_kerning != 'none'
         @fallback_fonts = Array theme.font_fallbacks
         @root_font_size = theme.base_font_size
@@ -710,6 +709,7 @@ module Asciidoctor
       end
 
       def convert_index_section node
+        @index.link_associations
         if ColumnBox === bounds || (columns = @theme.index_columns || 1) < 2
           convert_index_categories @index.categories, (node.document.attr 'index-pagenum-sequence-style')
         else
@@ -739,41 +739,73 @@ module Asciidoctor
       end
 
       def convert_index_term term, pagenum_sequence_style = nil
-        term_fragments = term.name.fragments
+        # NOTE: dup fragment list and all fragments to avoid any modification
+        term_fragments = term.name.fragments.map(&:dup)
         unless term.container?
-          pagenum_fragment = (parse_text %(<a>#{DummyText}</a>), inline_format: true)[0]
           if @media == 'screen'
-            case pagenum_sequence_style
-            when 'page'
-              pagenums = term.dests.uniq {|dest| dest[:page] }.map {|dest| pagenum_fragment.merge anchor: dest[:anchor], text: dest[:page] }
-            when 'range'
-              first_anchor_per_page = {}.tap {|accum| term.dests.each {|dest| accum[dest[:page]] ||= dest[:anchor] } }
-              pagenums = (consolidate_ranges first_anchor_per_page.keys).map do |range|
-                anchor = first_anchor_per_page[(range.include? '-') ? (range.partition '-')[0] : range]
-                pagenum_fragment.merge text: range, anchor: anchor
-              end
-            else # term
-              pagenums = term.dests.map {|dest| pagenum_fragment.merge text: dest[:page], anchor: dest[:anchor] }
+            link_fragment = (parse_text %(<a>#{DummyText}</a>), inline_format: true)[0]
+            term_fragments.unshift name: term.anchor, callback: [FormattedText::InlineDestinationMarker], text: DummyText
+          end
+          if (see = term.see)
+            term_fragments << { text: ' (see ' }
+            if link_fragment && IndexTerm === see
+              link_fragment_ = link_fragment.merge anchor: see.anchor
+              see.name.fragments.each {|it| term_fragments << (link_fragment_.merge it) }
+            else
+              term_fragments.concat see.name.fragments
             end
+            term_fragments << { text: ')' }
           else
-            pagenums = consolidate_ranges term.dests.map {|dest| dest[:page] }.uniq
-          end
-          pagenums.each do |pagenum|
-            if ::String === pagenum
-              term_fragments << ({ text: %(, #{pagenum}) })
+            if @media == 'screen'
+              case pagenum_sequence_style
+              when 'page'
+                pagenums = term.dests.uniq {|dest| dest[:page] }.map {|dest| link_fragment.merge anchor: dest[:anchor], text: dest[:page] }
+              when 'range'
+                first_anchor_per_page = {}.tap {|accum| term.dests.each {|dest| accum[dest[:page]] ||= dest[:anchor] } }
+                pagenums = (consolidate_ranges first_anchor_per_page.keys).map do |range|
+                  anchor = first_anchor_per_page[(range.include? '-') ? (range.partition '-')[0] : range]
+                  link_fragment.merge text: range, anchor: anchor
+                end
+              else # term
+                pagenums = term.dests.map {|dest| link_fragment.merge text: dest[:page], anchor: dest[:anchor] }
+              end
             else
-              term_fragments << { text: ', ' }
-              term_fragments << pagenum
+              pagenums = consolidate_ranges term.dests.map {|dest| dest[:page] }.uniq
+            end
+            pagenums.each do |pagenum|
+              if ::String === pagenum
+                term_fragments << ({ text: %(, #{pagenum}) })
+              else
+                term_fragments << { text: ', ' }
+                term_fragments << pagenum
+              end
+            end
+            if (see_also = term.see_also)
+              see_also_items = []
+              see_also.each do |also_term|
+                see_also_fragments = [{ text: '(see also ' }]
+                if link_fragment && IndexTerm === also_term
+                  link_fragment_ = link_fragment.merge anchor: also_term.anchor
+                  also_term.name.fragments.map {|it| see_also_fragments << (link_fragment_.merge it) }
+                else
+                  see_also_fragments.concat also_term.name.fragments
+                end
+                see_also_fragments << { text: ')' }
+                see_also_items << see_also_fragments
+              end
             end
           end
         end
         subterm_indent = @theme.description_list_description_indent
         typeset_formatted_text term_fragments, (calc_line_metrics @base_line_height), align: :left, color: @font_color, hanging_indent: subterm_indent * 2, consolidate: true
         indent subterm_indent do
+          see_also_items&.each do |see_also_fragments|
+            typeset_formatted_text see_also_fragments, (calc_line_metrics @base_line_height), align: :left, color: @font_color, hanging_indent: subterm_indent * 2, consolidate: true
+          end
           term.subterms.each do |subterm|
             convert_index_term subterm, pagenum_sequence_style
-          end
-        end unless term.leaf?
+          end unless term.leaf?
+        end if see_also_items || !term.leaf?
       end
 
       def convert_preamble node
@@ -871,14 +903,19 @@ module Asciidoctor
         end
 
         if (float_box = (@float_box ||= nil))
-          ink_paragraph_in_float_box node, float_box, prose_opts, role_keys, block_next, insert_margin_bottom
-        else
-          # TODO: check if we're within one line of the bottom of the page
-          # and advance to the next page if so (similar to logic for section titles)
-          ink_caption node, labeled: false if node.title?
-          role_keys ? theme_font_cascade(role_keys) { ink_prose node.content, prose_opts } : (ink_prose node.content, prose_opts)
-          insert_margin_bottom.call
+          if (prev_sibling = node.previous_sibling)&.context == :open && (prev_sibling.role? 'float-group')
+            move_cursor_to float_box[:bottom]
+            @float_box = nil
+          else
+            ink_paragraph_in_float_box node, float_box, prose_opts, role_keys, block_next, insert_margin_bottom
+            return
+          end
         end
+        # TODO: check if we're within one line of the bottom of the page
+        # and advance to the next page if so (similar to logic for section titles)
+        ink_caption node, labeled: false if node.title?
+        role_keys ? theme_font_cascade(role_keys) { ink_prose node.content, prose_opts } : (ink_prose node.content, prose_opts)
+        insert_margin_bottom.call
       end
 
       def convert_admonition node
@@ -2667,12 +2704,19 @@ module Asciidoctor
           # NOTE: page number (:page key) is added by InlineDestinationMarker
           dest = { anchor: (anchor_name = @index.next_anchor_name) }
           anchor = %(<a id="#{anchor_name}" type="indexterm"#{visible ? ' visible="true"' : ''}>#{DummyText}</a>)
+          assoc = {}
+          if (see = node.attr 'see')
+            assoc[:see] = parse_text see, inline_format: [normalize: true]
+          end
+          if (see_also = node.attr 'see-also')
+            assoc[:see_also] = see_also.map {|term| parse_text term, inline_format: [normalize: true] }
+          end
           if visible
             visible_term = node.text
-            @index.store_primary_term (FormattedString.new parse_text visible_term, inline_format: [normalize: true]), dest
+            @index.store_term [(parse_text visible_term, inline_format: [normalize: true])], dest, assoc
             %(#{anchor}#{visible_term})
           else
-            @index.store_term (node.attr 'terms').map {|term| FormattedString.new parse_text term, inline_format: [normalize: true] }, dest
+            @index.store_term (node.attr 'terms').map {|term| parse_text term, inline_format: [normalize: true] }, dest, assoc
             anchor
           end
         end

data/lib/asciidoctor/pdf/formatted_text/formatter.rb

@@ -10,6 +10,7 @@ module Asciidoctor
 
         FormattingSnifferPattern = /[<&]/
         WHITESPACE = %( \t\n)
+        SHY = ::Prawn::Text::SHY
 
         def initialize options = {}
           @parser = MarkupParser.new
@@ -26,7 +27,7 @@ module Asciidoctor
               return @transform.apply parsed.content, [], inherited
             end
             reason = @parser.failure_reason.sub %r/ at line \d+, column \d+ \(byte (\d+)\)(.*)/, '\2 at byte \1'
-            logger.error %(failed to parse formatted text: #{string} (reason: #{reason})) unless @scratch
+            logger.error %(failed to parse formatted text: #{string.tr SHY, ''} (reason: #{reason.tr SHY, ''})) unless @scratch
           end
           [inherited ? (inherited.merge text: string) : { text: string }]
         end

data/lib/asciidoctor/pdf/index_catalog.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'digest'
+require_relative 'formatted_string'
+
 module Asciidoctor
   module PDF
     class IndexCatalog
@@ -20,29 +23,29 @@ module Asciidoctor
         %(__indexterm-#{@sequence += 1})
       end
 
-      def store_term names, dest
-        if (num_terms = names.size) > 2
-          store_tertiary_term names[0], names[1], names[2], dest
+      def store_term names, dest, assoc = {}
+        if (num_terms = (names = names.map {|name| FormattedString.new name }).size) == 1
+          store_primary_term names[0], dest, assoc
         elsif num_terms == 2
-          store_secondary_term names[0], names[1], dest
-        elsif num_terms == 1
-          store_primary_term names[0], dest
+          store_secondary_term names[0], names[1], dest, assoc
+        elsif num_terms > 2
+          store_tertiary_term names[0], names[1], names[2], dest, assoc
         end
       end
 
-      def store_primary_term name, dest = nil
+      def store_primary_term name, dest = nil, assoc = {}
         store_dest dest if dest
-        (init_category name.chr.upcase).store_term name, dest
+        (init_category name.chr.upcase).store_term name, dest, assoc
       end
 
-      def store_secondary_term primary_name, secondary_name, dest = nil
+      def store_secondary_term primary_name, secondary_name, dest = nil, assoc = {}
         store_dest dest if dest
-        (store_primary_term primary_name).store_term secondary_name, dest
+        (store_primary_term primary_name).store_term secondary_name, dest, assoc
       end
 
-      def store_tertiary_term primary_name, secondary_name, tertiary_name, dest
+      def store_tertiary_term primary_name, secondary_name, tertiary_name, dest, assoc = {}
         store_dest dest
-        (store_secondary_term primary_name, secondary_name).store_term tertiary_name, dest
+        (store_secondary_term primary_name, secondary_name).store_term tertiary_name, dest, assoc
       end
 
       def init_category name
@@ -54,6 +57,34 @@ module Asciidoctor
         @categories[name]
       end
 
+      def find_primary_term name
+        @categories.each_value do |category|
+          term = category.terms.find {|candidate| candidate.name == name }
+          return term if term
+        end
+        nil
+      end
+
+      def link_associations group = nil
+        if group
+          group.terms.each do |term|
+            associations = term.associations
+            if (see_name = associations[:see])
+              see_name = FormattedString.new see_name
+              term.see = (find_primary_term see_name) || (UnresolvedIndexTerm.new see_name)
+            elsif (see_also_names = associations[:see_also])
+              term.see_also = see_also_names.map do |see_also_name|
+                see_also_name = FormattedString.new see_also_name
+                (find_primary_term see_also_name) || (UnresolvedIndexTerm.new see_also_name)
+              end
+            end
+            link_associations term unless term.leaf?
+          end
+        else
+          @categories.each_value {|category| link_associations category }
+        end
+      end
+
       def store_dest dest
         @dests[dest[:anchor]] = dest
       end
@@ -83,9 +114,18 @@ module Asciidoctor
         @terms = {}
       end
 
-      def store_term name, dest
+      def store_term name, dest, assoc = {}
         term = (@terms[name] ||= (IndexTerm.new name))
         term.add_dest dest if dest
+        term.associations ||= {}
+        unless assoc.empty?
+          if !term.associations[:see] && (see = assoc[:see])
+            term.associations[:see] = see
+          end
+          if (see_also = assoc[:see_also])
+            (term.associations[:see_also] ||= []).concat see_also
+          end
+        end
         term
       end
 
@@ -100,10 +140,22 @@ module Asciidoctor
 
     class IndexTermCategory < IndexTermGroup; end
 
+    class UnresolvedIndexTerm < IndexTermGroup; end
+
     class IndexTerm < IndexTermGroup
+      attr_reader :anchor
+
+      attr_accessor :associations
+
+      attr_accessor :see
+
+      attr_writer :see_also
+
       def initialize name
         super
         @dests = ::Set.new
+        @anchor = %(__indextermdef-#{(::Digest::MD5.new << name.to_s).hexdigest})
+        @associations = @see = @see_also = nil
       end
 
       alias subterms terms
@@ -124,6 +176,10 @@ module Asciidoctor
       def leaf?
         @terms.empty?
       end
+
+      def see_also
+        @see_also&.sort
+      end
     end
   end
 end

data/lib/asciidoctor/pdf/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module PDF
-    VERSION = '2.3.20'
+    VERSION = '2.3.21'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf
 version: !ruby/object:Gem::Version
-  version: 2.3.20
+  version: 2.3.21
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-09-17 00:00:00.000000000 Z
+date: 2025-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor