asciidoctor-lists-extended 1.1.10 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16dda3a711337611c76e4fc8c4b6eda22fc66419e81ef557ff679578c292c986
-  data.tar.gz: 208a25e0ec8d8854970c8ab027d6a02c06f0f94517aa1086310d07588a729fe0
+  metadata.gz: eea56f2723162b60d59bbb2d93db827851391f3e6ad27868e79e3cd48260087e
+  data.tar.gz: 0c8f0a1cea5a7afd52c934b43e41557f7e41869e9ffe4fc159a7cfc70fd0ee8d
 SHA512:
-  metadata.gz: c470295d328df8f293a372a66c72463c9d7393eb27e71ff9d768ba0a9932bfda9123ae34523298f4340a4b614a43a8ff7f3fab55f5d4fd71448f94b117d93233
-  data.tar.gz: 07e2c7a94bd841ba46c4ff168ec21f51e1209a495e0d522db60b4d2dbf390226a26e4e5434952bc1105705684b7b54b2dbf78e3d378053d8cac884539defca20
+  metadata.gz: 2e901929fc60afc373360eaa07f0822a05a12270c2fc9c6757741d8e52db864702f663b03921d35f497b5583daa884ed63da9eea99ebb88434f0461675ed1c98
+  data.tar.gz: 92059b3b00548fd752791b1bda2abef6d7288d1dc9b0726b23fe499e0a4e00db9b25e3e64b7a72f3bbc400a698596285af6934175e8f00f22d51f5ecdfc4d03f

data/lib/asciidoctor-lists-extended/pdf_converter.rb

@@ -38,6 +38,7 @@ module Asciidoctor
         @list_entry_indent             = nil
         @list_first_entry_margin       = nil
         @list_toc_insert_idx           = 0
+        @virtual_list_sections         = []   # list-of:: virtual sections, kept for running content
       end
 
       # -----------------------------------------------------------------------
@@ -82,15 +83,20 @@ module Asciidoctor
       def ink_toc(doc, num_levels, toc_page_number, start_cursor, num_front_matter_pages = 0)
         @inline_num_front_matter_pages = num_front_matter_pages
         @list_toc_insert_idx = 0
+        @virtual_list_sections = []
 
         # toc-in-toc: insert the Table of Contents itself as the first entry in
         # the PDF ToC, before any list-of:: sections.  Excluded from the bookmark
         # outline because asciidoctor-pdf's add_outline already adds a ToC bookmark.
-        if (doc.attr? 'toc-in-toc') && @toc_extent
+        # IMPORTANT: do this in both scratch and final passes. During scratch,
+        # @toc_extent may not yet be set; fall back to toc_page_number so the
+        # dry-run ToC entry count/height matches the final pass.
+        if doc.attr? 'toc-in-toc'
           toc_entry_title = doc.attr('toc-title') || 'Table of Contents'
-          insert_list_into_toc_section doc, toc_entry_title, @toc_extent.page_range,
+          toc_entry_range = @toc_extent&.page_range || (toc_page_number..toc_page_number)
+          insert_list_into_toc_section doc, toc_entry_title, toc_entry_range,
             '_toc_in_toc', @list_toc_insert_idx,
-            pdf_dest: dest_top(@toc_extent.page_range.first),
+            pdf_dest: (@toc_extent ? dest_top(@toc_extent.page_range.first) : nil),
             exclude_from_outline: true
           @list_toc_insert_idx += 1
         end
@@ -107,10 +113,13 @@ module Asciidoctor
           # Bare macros (no parent section and no title= attribute) have no
           # meaningful label for the ToC or outline — skip the virtual section.
           unless list_title.nil_or_empty?
-            insert_list_into_toc_section doc, list_title, list_page_nums, list_id, @list_toc_insert_idx,
+            virtual_section = insert_list_into_toc_section doc, list_title, list_page_nums, list_id, @list_toc_insert_idx,
               pdf_dest:             @last_list_dest || dest_top(list_page_nums.first),
               exclude_from_toc:     resolve_exclude_from_toc(config),
               exclude_from_outline: resolve_exclude_from_outline(config)
+            # Retain a reference so running content can show the list title on its
+            # own pages; the section itself is purged from the tree below.
+            @virtual_list_sections << virtual_section
             @list_toc_insert_idx += 1
           end
         end
@@ -118,6 +127,7 @@ module Asciidoctor
         result = super
 
         # Phase 2: render deferred inline section-scoped lists.
+
         # traverse doc has completed before ink_toc is called, so all
         # pdf-page-start attributes are now set and page numbers are real.
         unless @inline_render_positions.empty?
@@ -150,6 +160,35 @@ module Asciidoctor
         end
 
         result
+      ensure
+        purge_virtual_sections doc
+      end
+
+      # -----------------------------------------------------------------------
+      # ink_running_content override
+      # -----------------------------------------------------------------------
+      # asciidoctor-pdf builds its per-page running-content title map from
+      # doc.find_by(context: :section), keyed by each section's pdf-page-start.
+      # Our list-of:: virtual sections carry both a title and a pdf-page-start,
+      # but they were purged in ink_toc's ensure (which runs before this), so the
+      # list-of pages fall back to the preface/chapter title.  Re-insert them for
+      # the duration of the indexing pass, then purge again so they cannot leak
+      # into the scratch/final document tree.
+      def ink_running_content(periphery, doc, *args)
+        reinsert_virtual_list_sections doc
+        super
+      ensure
+        purge_virtual_sections doc
+      end
+
+      # Restore the retained list-of:: virtual sections into their original
+      # parent so doc.find_by(context: :section) can see them again.
+      def reinsert_virtual_list_sections(doc)
+        @virtual_list_sections.each do |sect|
+          parent = sect.parent || doc
+          parent.blocks << sect   if parent.respond_to?(:blocks)   && !(parent.blocks.include? sect)
+          parent.sections << sect if parent.respond_to?(:sections) && !(parent.sections.include? sect)
+        end
       end
 
       # -----------------------------------------------------------------------
@@ -175,6 +214,16 @@ module Asciidoctor
         super outline, filtered, num_levels, expand_levels
       end
 
+      # -----------------------------------------------------------------------
+      # convert_section override
+      # -----------------------------------------------------------------------
+      # Virtual sections inserted only to drive ToC/outline entries should not
+      # be rendered as normal body headings during document traversal.
+      def convert_section(node, *args)
+        return if node.attr? 'list-virtual-section'
+        super node, *args
+      end
+
       # -----------------------------------------------------------------------
       # convert_paragraph override
       # -----------------------------------------------------------------------
@@ -276,6 +325,22 @@ module Asciidoctor
 
       private
 
+      # -----------------------------------------------------------------------
+      # purge_virtual_sections
+      # -----------------------------------------------------------------------
+      # Remove synthetic sections inserted only for ToC/outline generation so
+      # they cannot leak into subsequent passes or downstream section processing.
+      def purge_virtual_sections(doc)
+        return unless doc
+        doc.find_by(context: :section).each do |sect|
+          next unless sect.attr? 'list-virtual-section'
+          parent = sect.parent
+          next unless parent
+          parent.blocks.delete sect if parent.respond_to? :blocks
+          parent.sections.delete sect if parent.respond_to? :sections
+        end
+      end
+
       # -----------------------------------------------------------------------
       # mark_empty_list_sections
       # -----------------------------------------------------------------------

data/lib/asciidoctor-lists-extended/pdf_renderer.rb

@@ -115,11 +115,25 @@ module Asciidoctor
           base_idx            = 0
         end
 
+        # If a virtual section with this id was already inserted during an earlier
+        # pass (e.g. scratch before final), refresh it in place rather than
+        # inserting a duplicate that would skew ToC height and entry count.
+        if (existing = grandparent_section.blocks.find { |b| b.context == :section && b.id == list_id })
+          existing.title = list_title
+          existing.set_attr 'pdf-destination', pdf_dest if pdf_dest
+          existing.set_attr 'pdf-page-start', list_page_nums.first
+          existing.set_attr 'list-virtual-section', ''
+          exclude_from_toc     ? existing.set_attr('list-exclude-from-toc', '')     : existing.remove_attr('list-exclude-from-toc')
+          exclude_from_outline ? existing.set_attr('list-exclude-from-outline', '') : existing.remove_attr('list-exclude-from-outline')
+          return existing
+        end
+
         list_section       = Asciidoctor::Section.new grandparent_section, toc_level, false
         list_section.set_attr 'pdf-destination', pdf_dest if pdf_dest
         list_section.title = list_title
         list_section.id    = list_id
         list_section.set_attr 'pdf-page-start', list_page_nums.first
+        list_section.set_attr 'list-virtual-section', ''
         list_section.set_attr 'list-exclude-from-toc',     '' if exclude_from_toc
         list_section.set_attr 'list-exclude-from-outline', '' if exclude_from_outline
         grandparent_section.blocks.insert base_idx + insert_idx, list_section

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-lists-extended
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.2.2
 platform: ruby
 authors:
 - 白一百 baiyibai