asciidoctor-multipage 0.0.10 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d54d7b18dc06a853c2c12062714158d3a65914b9f7aacda87ac0a939ddcc941
-  data.tar.gz: 9857f979f3dcf2a4dc7faed2271549c4ff473a8fb356b8747673ee828a1a35cb
+  metadata.gz: ab1f550130f59f72549c38e53b85073052489f9447e9dcfd1122e3ffbc418c8e
+  data.tar.gz: 1984fe6907d211571d822451c90725984c14d22c993195508d6e6992d29ce333
 SHA512:
-  metadata.gz: c8cd9b2025eddf8cd9a8c54b6dc0705d60b8757dc3d360cc98247e7df2d0569d1cd464892aed4d468e3320b96e31a4fefef1ca9c135798878d571692b367e476
-  data.tar.gz: 99b46345a15d5e08fabe8a652644b094ef1287d34c2e32333417bbab60c4a63820d9a4f866f66087437cc8e2dae77bafc4662987f52f1083dc405b7201a8b23b
+  metadata.gz: 4566ce596a05c9a60866138d7ef8946121bef05d95648a14a304312a4a632ebcd85dbc077eeff045ef0d94d48b85064d8e15d438e9eb84d19ee4f432177f5b9c
+  data.tar.gz: 9652cb173af11948e16c3ed1d463922f88a233c4118c044ec2b2005095f9b3c9d0478c6f4d5967ff4f3f1b9b4149b709c68932684f21cdf3cc60e12bf68f3d6f

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},#{previous_page.captioned_title}>>)
         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},#{parent_page.captioned_title}>>)
+        links << %(⌂ #{doc.attr('multipage-nav-home-label') || "Home"}: <<#{home_page.id},#{home_page.captioned_title}>>) 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},#{next_page.captioned_title}>> →)
       end
       block = Asciidoctor::Block.new(parent = doc,
                                      context = :paragraph,
@@ -317,9 +356,17 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
       else
         attrs = node.role ? %( class="#{node.role}") : ''
         unless (text = node.text)
-          refid = node.attributes['refid']
-          if AbstractNode === (ref = (@refs ||= node.document.catalog[:refs])[refid])
-            text = (ref.xreftext node.attr('xrefstyle')) || %([#{refid}])
+          if AbstractNode === (ref = (@refs ||= node.document.catalog[:refs])[refid = node.attributes['refid']] || (refid.nil_or_empty? ? (top = get_root_document node) : nil))
+            if (@resolving_xref ||= (outer = true)) && outer
+              if (text = ref.xreftext node.attr 'xrefstyle', nil, true)
+                text = text.gsub DropAnchorRx, '' if text.include? '<a'
+              else
+                text = top ? '[^top]' : %([#{refid}])
+              end
+              @resolving_xref = nil
+            else
+              text = top ? '[^top]' : %([#{refid}])
+            end
           else
             text = %([#{refid}])
           end
@@ -350,14 +397,14 @@ 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
   # applicable for the current page.
   def new_outline_doc(node, new_parent:nil, for_page:nil)
     if node.class == Document
-      new_document = Document.new([])
+      new_document = Document.new([], {:doctype => node.doctype})
       new_document.mplevel = node.mplevel
       new_document.id = node.id
       new_document.update_attributes(node.attributes)
@@ -374,6 +421,7 @@ class MultipageHtml5Converter < Asciidoctor::Converter::Html5Converter
                                 level = node.level,
                                 numbered = node.numbered)
       new_section.id = node.id
+      new_section.sectname = node.sectname
       new_section.caption = node.caption
       new_section.title = node.instance_variable_get(:@title)
       new_section.mplevel = node.mplevel
@@ -392,10 +440,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 +503,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 +587,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 +602,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.10
+  version: 0.0.14
 platform: ruby
 authors:
 - Owen T. Heisler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -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