asciidoctor-multipage 0.0.9 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61bac9f5757d7dd1864896ce026ba9459f05a4b2860b8fcc04087b02f6d99e4
-  data.tar.gz: 80e39a0c29b8a125f4001cd290e3d2b8494b51b67f0a4e96f3a3951ffccde583
+  metadata.gz: f3969d1ba0eb1078d827fb24791759e87a66f646c0de7bbe2a88d8937d4cda5a
+  data.tar.gz: b7bce56dee751a9e13b16cd6eeba2939aad51e98bf8f2090d7e5780b0c381251
 SHA512:
-  metadata.gz: 921880fa69d16485028b378017b680ea7cab5f30376361da442cdf3f7c53d144e67d7a8af76dc0134bb0cff41a66b00242e82519878bf2a91c748ba98931adc3
-  data.tar.gz: 2430e67e5d8992737a9b77f7d0512853b4ae7a8771b44e57347cf9547930f91860acb70acb3acbd0161ff0dc3c1b69fb968f5c1d96b2785db699aca2129f0f9f
+  metadata.gz: 5966efde3e3d4728a5ff2f65d381d89d7f0e2d81c18ec7bc647b2f02bf2d9fee5aef190f321e1573ac61b33a629f4204de3f40fabd234fd0a77c85eec8528ec0
+  data.tar.gz: ccf9339527d9cf6c9876e5317349e7ce6ea4ba3fed445becee5c1bcbc62efd5a20304095de59e4c467057952222906baf105b332053c20c1de88ee558d7de4aa

data/lib/asciidoctor-multipage.rb

@@ -52,6 +52,14 @@ class Asciidoctor::Document
   # nodes are no longer accessible.
   attr_writer :sectnum
 
+  # A pointer to the original converter (first converter instantiated to
+  # convert the original document). As we create additional documents
+  # ourselves, AsciiDoctor will instantiate additional instances of
+  # MultipageHtml5Converter for each created document. These instances need
+  # to share state, so they can use the original converter instance
+  # for that purpose.
+  attr_accessor :mp_root
+
   # Override the AbstractBlock sections?() check to enable the Table Of
   # Contents. This extension may generate short pages that would normally have
   # no need for a TOC. However, we override the Html5Converter outline() in
@@ -77,17 +85,11 @@ class Asciidoctor::Section
   # Sections. The sectnum is saved in section() below.
   def sectnum(delimiter = '.', append = nil)
     append ||= (append == false ? '' : delimiter)
-    if @level == 1
-      %(#{@numeral}#{append})
-    elsif @level > 1
-      if @parent.class == Asciidoctor::Section ||
-         (@mplevel && @parent.class == Asciidoctor::Document)
+    if @level > 1 and @parent.class == Asciidoctor::Section ||
+                      (@mplevel && @parent.class == Asciidoctor::Document)
         %(#{@parent.sectnum(delimiter)}#{@numeral}#{append})
-      else
-        %(#{@numeral}#{append})
-      end
-    else # @level == 0
-      %(#{Asciidoctor::Helpers.int_to_roman @numeral}#{append})
+    else
+      %(#{@numeral}#{append})
     end
   end
 end
@@ -101,6 +103,12 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
 
   attr_accessor :pages
 
+  # contains the entire outline of the top-level document, used
+  # as a guide-rail for creating TOC elements for documents we
+  # split off. Only expected to be set in the top-level converter
+  # (see AsciiDoctor::Document::mp_root)
+  attr_accessor :full_outline
+
   def initialize(backend, opts = {})
     @xml_mode = false
     @void_element_slash = nil
@@ -118,8 +126,29 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
     page << block
   end
 
+  # ensures that the AsciiDoctor::Document::mp_root is correctly
+  # set on the document object. The variable could have already been
+  # set if we created the document ourselves
+  # (see ::MultipageHtml5Converter::convert_section), in which case it's
+  # not changed. If the documented is "nested", then we expect the parent
+  # document to already have it set. Otherwise, this is expected to be
+  # a top-level document, and we assign ourselves as its original converter.
+  def check_root(doc)
+    unless doc.mp_root
+      if doc.nested?
+        doc.mp_root = doc.parent_document.mp_root
+      else
+        doc.mp_root = self
+      end
+    end
+  end
+
   # Process Document (either the original full document or a processed page)
   def convert_document(node)
+
+    # make sure document has original converter reference
+    check_root(node)
+
     if node.processed
       # This node (an individual page) can now be handled by
       # Html5Converter.
@@ -166,8 +195,16 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
       # Generate navigation links for all pages
       generate_nav_links(node)
 
-      # Create and save a skeleton document for generating the TOC lists.
-      @@full_outline = new_outline_doc(node)
+      # Create and save a skeleton document for generating the TOC lists,
+      # but don't attempt to create outline for nested documents.
+      unless node.nested?
+        # if the original converter has the @full_outline set already, we are about
+        # to replace it. That's not supposed to happen, and probably means we encountered
+        # a document structure we aren't prepared for. Log an error and move on.
+        logger.error "Regenerating document outline, something wrong?" if node.mp_root.full_outline
+        node.mp_root.full_outline = new_outline_doc(node)
+      end
+
       # Save the document catalog to use for each part/chapter page.
       @catalog = node.catalog
 
@@ -179,7 +216,7 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
           part = block
           part.convert
           text = %(<<#{part.id},#{part.captioned_title}>>)
-          if desc = block.attr('desc') then text << %( – #{desc}) end
+          if (desc = block.attr('desc')) then text << %( – #{desc}) end
           parts_list << Asciidoctor::ListItem.new(parts_list, text)
         end
       end
@@ -197,6 +234,8 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
   # Process Document in embeddable mode (either the original full document or a
   # processed page)
   def convert_embedded(node)
+    # make sure document has original converter reference
+    check_root(node)
     if node.processed
       # This node (an individual page) can now be handled by
       # Html5Converter.
@@ -223,14 +262,14 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
         # NOTE: There are some non-breaking spaces (U+00A0) below, in
         # the "links <<" lines and "links.join" line.
         if previous_page != parent_page
-          links << %(← Previous: <<#{previous_page.id}>>)
+          links << %(← #{doc.attr('multipage-nav-previous-label') || "Previous"}: <<#{previous_page.id}>>)
         end
-        links << %(↑ Up: <<#{parent_page.id}>>)
-        links << %(⌂ Home: <<#{home_page.id}>>) if home_page != parent_page
+        links << %(↑ #{doc.attr('multipage-nav-up-label') || "Up"}: <<#{parent_page.id}>>)
+        links << %(⌂ #{doc.attr('multipage-nav-home-label') || "Home"}: <<#{home_page.id}>>) if home_page != parent_page
       end
       if page_index != pages.length-1
         next_page = pages[page_index+1]
-        links << %(Next: <<#{next_page.id}>> →)
+        links << %(#{doc.attr('multipage-nav-next-label') || "Next"}: <<#{next_page.id}>> →)
       end
       block = Asciidoctor::Block.new(parent = doc,
                                      context = :paragraph,
@@ -245,7 +284,7 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
   # Html5Converter convert_outline().
   def generate_outline(node, opts = {})
     # Do the same as Html5Converter convert_outline() here
-    return unless node.sections?
+    return unless node.sections? && node.sections.length > 0
     sectnumlevels = opts[:sectnumlevels] || (node.document.attributes['sectnumlevels'] || 3).to_i
     toclevels = opts[:toclevels] || (node.document.attributes['toclevels'] || 2).to_i
     sections = node.sections
@@ -350,7 +389,7 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
   end
 
   # From node, create a skeleton document that will be used to generate the
-  # TOC. This is first used to create a full skeleton (@@full_outline) from the
+  # TOC. This is first used to create a full skeleton (@full_outline) from the
   # original document (for_page=nil). Then it is used for each individual page
   # to create a second skeleton from the first. In this way, TOC entries are
   # included that are not part of the current page, or excluded if not
@@ -392,10 +431,10 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
   # outline.
   def convert_outline(node, opts = {})
     doc = node.document
-    # Find this node in the @@full_outline skeleton document
-    page_node = @@full_outline.find_by(id: node.id).first
+    # Find this node in the @full_outline skeleton document
+    page_node = doc.mp_root.full_outline.find_by(id: node.id).first
     # Create a skeleton document for this particular page
-    custom_outline_doc = new_outline_doc(@@full_outline, for_page: page_node)
+    custom_outline_doc = new_outline_doc(doc.mp_root.full_outline, for_page: page_node)
     opts[:page_id] = node.id
     # Generate an extra TOC entry for the root page. Add additional styling if
     # the current page is the root page.
@@ -455,6 +494,8 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
         page.sectnum = node.parent.sectnum
       end
 
+      page.mp_root = doc.mp_root
+
       # Process node according to mplevel
       if node.mplevel == :branch
         # Retain any part intro blocks, delete others, and add a list
@@ -537,7 +578,6 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
     # Write remaining part/chapter pages
     outdir = ::File.dirname(target)
     ext = ::File.extname(target)
-    target_name = ::File.basename(target, ext)
     @pages.each do |doc|
       chapter_target = doc.id + ext
       outfile = ::File.join(outdir, chapter_target)
@@ -553,6 +593,10 @@ class MultipageHtml5CSS < Asciidoctor::Extensions::DocinfoProcessor
   at_location :head
 
   def process doc
+    # Disable this entirely if the multipage-disable-css attribute is set
+    if doc.attr('multipage-disable-css')
+      return
+    end
     css = []
     # Style Table Of Contents entry for current page
     css << %(.toc-current{font-weight: bold;})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-multipage
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.13
 platform: ruby
 authors:
 - Owen T. Heisler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 2.2.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 2.2.18
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Asciidoctor multipage HTML output extension