asciidoctor-html 0.1.6 → 0.1.7

data/lib/asciidoctor/html/bi_inline_macro.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "asciidoctor"
-require "pathname"
 
 module Asciidoctor
   module Html

data/lib/asciidoctor/html/book.rb

@@ -8,7 +8,9 @@ require_relative "converter"
 require_relative "ref_tree_processor"
 require_relative "cref_inline_macro"
 require_relative "bi_inline_macro"
+require_relative "sc_inline_macro"
 require_relative "template"
+require_relative "pagination"
 
 module Asciidoctor
   module Html
@@ -21,6 +23,7 @@ module Asciidoctor
       Asciidoctor::Extensions.register do
         tree_processor RefTreeProcessor
         inline_macro CrefInlineMacro
+        inline_macro ScInlineMacro
         inline_macro BiInlineMacro
       end
 
@@ -29,7 +32,9 @@ module Asciidoctor
         "stem" => "latexmath",
         "hide-uri-scheme" => true,
         "source-highlighter" => "highlight.js",
-        "imagesdir" => IMG_PATH
+        "imagesdir" => IMG_PATH,
+        "dollar" => "$",
+        "parskip" => %(<span class="parskip"></span><br>)
       }.freeze
 
       DEFAULT_OPTS = {
@@ -39,7 +44,12 @@ module Asciidoctor
       }.freeze
 
       # Template data to be processed by each document
-      TData = Struct.new("TData", :chapnum, :chaptitle)
+      TData = Struct.new("TData",
+                         :chapprefix,
+                         :chaptitle,
+                         :chapheading,
+                         :chapsubheading,
+                         :index)
 
       # opts:
       # - title
@@ -96,6 +106,8 @@ module Asciidoctor
 
       private
 
+      include Pagination
+
       def search_page(se_id)
         content = <<~HTML
           <script async src="https://cse.google.com/cse.js?cx=#{se_id}"></script>
@@ -108,7 +120,6 @@ module Asciidoctor
           short_title: @short_title,
           author: @author,
           date: @date,
-          chapnum: "",
           chaptitle: "Search",
           langs: []
         )
@@ -128,50 +139,59 @@ module Asciidoctor
       end
 
       def chapter(filename, idx)
-        numeral = idx.to_s
-        doc = parse_file filename, @chapname, numeral
-        chaptitle = doctitle doc
-        chapref = idx.zero? ? chaptitle : chapref_default(@chapname, numeral)
-        chapnum = idx.zero? ? "" : numeral
-        process_doc key(filename), doc, chapnum:, chaptitle:, chapref:
+        key = key filename
+        index = @templates.dig(key, :index) || idx
+        chapnum = index.to_s
+        doc = parse_file filename, @chapname, chapnum
+        chapsubheading = doctitle doc
+        chapref = index.zero? ? chapsubheading : chapref_default(@chapname, chapnum)
+        tdata = TData.new(
+          chapprefix: index.zero? ? "" : chapnum,
+          chaptitle: chapsubheading,
+          chapheading: (chapref unless index.zero?),
+          chapsubheading:,
+          index:
+        )
+        process_doc key, doc, tdata, chapref
       end
 
       def appendix(filename, idx, num_appendices)
+        key = key filename
+        index = @templates.dig(key, :index) || idx
         chapname = "Appendix"
-        numeral = ("a".."z").to_a[idx].upcase
-        doc = parse_file filename, chapname, numeral
-        chapref = num_appendices == 1 ? chapname : chapref_default(chapname, numeral)
-        chapnum = ""
-        chaptitle = Template.appendix_title chapname, numeral, doctitle(doc), num_appendices
-        process_doc key(filename), doc, chapnum:, chaptitle:, chapref:
+        chapnum = ("a".."z").to_a[index].upcase
+        doc = parse_file filename, chapname, chapnum
+        chapsubheading = doctitle doc
+        chapref = num_appendices == 1 ? chapname : chapref_default(chapname, chapnum)
+        tdata = TData.new(
+          chapprefix: "",
+          chaptitle: Template.appendix_title(chapname, chapnum, chapsubheading, num_appendices),
+          chapheading: chapref,
+          chapsubheading:,
+          index:
+        )
+        process_doc key, doc, tdata, chapref
       end
 
       def key(filename)
         Pathname(filename).basename.sub_ext("").to_s
       end
 
-      # opts:
-      # - chapnum
-      # - chaptitle
-      # - chapref
-      def process_doc(key, doc, opts)
+      def process_doc(key, doc, tdata, chapref)
         val = doc.catalog[:refs].transform_values(&method(:reftext)).compact
-        val["chapref"] = opts[:chapref]
+        val["chapref"] = chapref
         @refs[key] = val
-        @templates[key] = TData.new(
-          chapnum: opts[:chapnum],
-          chaptitle: opts[:chaptitle]
-        )
+        @templates[key] = tdata
         doc
       end
 
-      def parse_file(filename, chapname, numeral)
-        attributes = { "chapnum" => numeral, "chapname" => chapname }.merge DOCATTRS
+      def parse_file(filename, chapname, chapnum)
+        attributes = { "chapnum" => chapnum, "chapname" => chapname }.merge DOCATTRS
         Asciidoctor.load_file filename, safe: :unsafe, attributes:
       end
 
-      def chapref_default(chapname, numeral)
-        "#{ERB::Escape.html_escape chapname} #{numeral}"
+      def chapref_default(chapname, chapnum)
+        "#{ERB::Escape.html_escape chapname} #{chapnum}"
       end
 
       def reftext(node)
@@ -200,7 +220,7 @@ module Asciidoctor
         items = @templates.map do |k, td|
           active = (k == active_key)
           subnav = active && doc ? outline(doc) : ""
-          navtext = Template.nav_text td.chapnum, td.chaptitle
+          navtext = Template.nav_text td.chapprefix, td.chaptitle
           Template.nav_item "#{k}.html", navtext, subnav, active:
         end
         return items unless @se_id
@@ -215,7 +235,7 @@ module Asciidoctor
       def build_template(key, doc)
         tdata = @templates[key]
         nav_items = nav_items key, doc
-        content = ERB.new(doc.convert).result(binding)
+        content = "#{ERB.new(doc.convert).result(binding)}\n#{pagination key}"
         Template.html(
           content,
           nav_items,
@@ -224,8 +244,9 @@ module Asciidoctor
           author: @author,
           date: @date,
           description: doc.attr("description"),
-          chapnum: tdata.chapnum,
           chaptitle: tdata.chaptitle,
+          chapheading: tdata.chapheading,
+          chapsubheading: tdata.chapsubheading,
           langs: langs(doc)
         )
       end

data/lib/asciidoctor/html/cli.rb

@@ -37,7 +37,8 @@ module Asciidoctor
         begin
           config = Psych.safe_load_file config_file
         rescue StandardError
-          puts "Error opening configuration file #{config_file}"
+          puts "Error opening configuration file\n  #{config_file}"
+          puts
           exit 1
         end
         config_dir = Pathname(config_file).dirname
@@ -53,22 +54,32 @@ module Asciidoctor
         config
       end
 
-      def self.setup_outdir(outdir)
-        assets_dir = "#{outdir}/#{ASSETS_PATH}"
-        FileUtils.mkdir_p assets_dir unless File.directory?(assets_dir)
+      def self.setup_outdir(srcdir, outdir)
+        assets_out = "#{outdir}/#{ASSETS_PATH}"
+        FileUtils.mkdir_p assets_out unless File.directory?(assets_out)
+        %W[#{IMG_PATH} #{CSS_PATH} #{FAVICON_PATH}].each do |p|
+          dir = "#{srcdir}/#{p}"
+          next unless Dir.exist?(dir)
+
+          puts "Copying\n  #{dir}\nto\n  #{assets_out}"
+          puts
+          FileUtils.cp_r dir, assets_out
+        end
         rootdir = File.absolute_path "#{__dir__}/../../.."
         %W[#{CSS_PATH} #{FAVICON_PATH}].each do |p|
           dir = "#{outdir}/#{p}"
           next if Dir.exist?(dir)
 
-          puts "Generating #{dir}"
-          FileUtils.cp_r "#{rootdir}/#{p}", assets_dir
+          puts "Putting default '#{p}' files in\n  #{dir}"
+          puts
+          FileUtils.cp_r "#{rootdir}/#{p}", assets_out
         end
       end
 
       def self.generate_webmanifest(outdir, name, short_name)
         filename = "#{outdir}/#{FAVICON_PATH}/site.webmanifest"
-        puts "Generating #{filename}"
+        puts "Generating\n  #{filename}"
+        puts
         File.write filename, Webmanifest.generate(name, short_name)
       end
 
@@ -86,25 +97,29 @@ module Asciidoctor
         opts ||= parse_opts
         config = read_config opts[:"config-file"]
         outdir = config["outdir"]
+        srcdir = config["srcdir"]
         book_opts = generate_bookopts config
-        setup_outdir outdir
+        setup_outdir srcdir, outdir
         generate_webmanifest outdir, book_opts[:title], book_opts[:short_title]
         book = Book.new book_opts
-        puts "Writing book to #{outdir}"
-        book.write config["chapters"], config["appendices"], config["outdir"], sitemap: true
+        puts "Writing book to\n  #{outdir}"
+        puts
+        book.write config["chapters"], config["appendices"], outdir, sitemap: true
         return unless opts[:watch]
 
-        Filewatcher.new("#{config["srcdir"]}/*.adoc").watch do |changes|
+        Filewatcher.new("#{srcdir}/*.adoc").watch do |changes|
           chapters = []
           appendices = []
           changes.each_key do |filename|
-            puts "Detected change in #{filename}"
+            puts "Detected change in\n  #{filename}"
+            puts
             chapters.append(filename) if config["chapters"].include?(filename)
             appendices.append(filename) if config["appendices"].include?(filename)
           end
           puts "Regenerating book:"
-          puts "    Chapters: #{chapters.map { |c| Pathname(c).basename }.join ", "}" unless chapters.empty?
-          puts "    Appendices: #{appendices.map { |a| Pathname(a).basename }.join ", "}" unless appendices.empty?
+          puts "  Chapters: #{chapters.map { |c| Pathname(c).basename }.join ", "}" unless chapters.empty?
+          puts "  Appendices: #{appendices.map { |a| Pathname(a).basename }.join ", "}" unless appendices.empty?
+          puts
           book.write chapters, appendices, config["outdir"]
         end
       end

data/lib/asciidoctor/html/converter.rb

@@ -69,7 +69,7 @@ module Asciidoctor
                      end
         icon = %(<div class="icon"><i class="bi bi-#{icon_class}"></i></div>)
         content = node.blocks? ? node.content : "<p>#{node.content}</p>"
-        content = %(#{icon}\n#{Utils.display_title node, needs_prefix: false}#{content})
+        content = %(#{icon}\n#{Utils.display_title node}#{content})
         Utils.wrap_id_classes content, node.id, "admonition admonition-#{name}"
       end
 
@@ -84,7 +84,7 @@ module Asciidoctor
         open, close = BLOCK_MATH_DELIMITERS[node.style.to_sym]
         equation = node.content || ""
         equation = "#{open}#{equation}#{close}" unless (equation.start_with? open) && (equation.end_with? close)
-        classes = ["stem"]
+        classes = ["stem", node.role].compact
         if node.option? "numbered"
           equation = %(<div class="equation">\n#{equation}\n</div> <!-- .equation -->)
           equation = %(#{equation}\n<div class="equation-number">#{node.reftext}</div>)
@@ -126,8 +126,7 @@ module Asciidoctor
           pre_open = %(<pre#{%( class="nowrap") if nowrap}>)
           pre_close = "</pre>"
         end
-        needs_prefix = node.option? "numbered"
-        title = Utils.display_title(node, needs_prefix:)
+        title = Utils.display_title(node)
         content = title + pre_open + node.content + pre_close
         Utils.wrap_node content, node
       end
@@ -135,7 +134,7 @@ module Asciidoctor
       def convert_literal(node)
         nowrap = !(node.document.attr? "prewrap") || (node.option? "nowrap")
         pre = %(<pre#{%( class="nowrap") if nowrap}>#{node.content}</pre>)
-        title = Utils.display_title(node, needs_prefix: false)
+        title = Utils.display_title(node)
         Utils.wrap_node "#{title}#{pre}", node
       end
 
@@ -144,14 +143,14 @@ module Asciidoctor
         title = if collapsible
                   %(<summary>#{node.title || "Details"}</summary>\n)
                 else
-                  Utils.display_title(node, needs_prefix: false)
+                  Utils.display_title(node)
                 end
         tag_name = collapsible ? :details : :div
         Utils.wrap_node(title + node.content, node, tag_name)
       end
 
       def convert_example(node)
-        Utils.wrap_node_with_title node.content, node, needs_prefix: true
+        Utils.wrap_node_with_title node.content, node
       end
 
       def convert_image(node)
@@ -161,6 +160,8 @@ module Asciidoctor
 
       def convert_inline_image(node)
         target = node.target
+        return read_svg_contents(node, target) if node.option?("inline")
+
         mark = node.parent.attr "mark"
         title_attr = node.attr? "title"
         if mark # The image is part of a figlist
@@ -179,7 +180,6 @@ module Asciidoctor
       end
 
       def convert_colist(node)
-        node.style = "arabic-circled"
         List.convert node
       end
 
@@ -206,14 +206,25 @@ module Asciidoctor
       end
 
       def convert_inline_anchor(node)
-        if node.type == :xref && !node.text
+        node_text = node.text
+        if node.type == :xref
           target = node.document.catalog[:refs][node.attr("refid")]
-          if target&.inline?
-            text = target.text
-            return %(<a href="#{node.target}">#{text}</a>) if text&.match?(/\A<i class="bi/)
+          if target&.inline? && target.parent&.parent&.style == "bibliography"
+            reftext = target.reftext
+            if node_text
+              /\A\[(?<numeral>\d+)\]\z/ =~ reftext
+              reftext = if numeral
+                          "[#{numeral}, #{node_text}]"
+                        else
+                          "#{reftext}, #{node_text}"
+                        end
+            end
+            return Utils.popover_button(reftext, target.id, "bibref")
+          end
 
-            list_style = target.parent&.parent&.style
-            return Utils.popover_button(target.reftext, target.id, "bibref") if list_style == "bibliography"
+          if !node_text && (text = target&.inline? ? target&.text : target&.attr("reftext"))
+            subs = %i[specialcharacters quotes replacements macros]
+            return %(<a href="#{node.target}">#{node.apply_subs text, subs}</a>)
           end
         end
         super
@@ -224,6 +235,8 @@ module Asciidoctor
         classes << "table-striped" if node.option? "striped"
         classes << "table-bordered" if node.option? "bordered"
         classes << "table-sm" if node.option? "compact"
+        classes << "table-v#{node.attr "valign"}" if node.attr?("valign")
+        classes << "table-h#{node.attr "halign"}" if node.attr?("halign")
         width_attribute = ""
         if (autowidth = node.option? "autowidth") && !(node.attr? "width")
           classes << "table-fit"
@@ -232,7 +245,7 @@ module Asciidoctor
         end
         result = [%(<table#{Utils.id_class_attr_str node.id, classes.join(" ")}#{width_attribute}>)]
         result << %(<caption class="table-title">#{Utils.display_title_prefix node}#{node.title}</caption>)
-        if node.attr("rowcount").positive?
+        if node.attr("rowcount").positive? && node.attr?("cols")
           result << "<colgroup>"
           if autowidth
             result += (Array.new node.columns.size, %(<col>))

data/lib/asciidoctor/html/figure.rb

@@ -6,6 +6,8 @@ module Asciidoctor
     # Mixed into the Converter class.
     module Figure
       def display_image(node, target, title_attr: false)
+        return read_svg_contents(node, target) if node.option?("inline")
+
         attrs = image_attrs(node, title_attr:)
         %(<img src="#{node.image_uri target}" #{attrs}#{@void_element_slash}>)
       end

data/lib/asciidoctor/html/highlightjs.rb

@@ -46,53 +46,60 @@ module Asciidoctor
       }.freeze
 
       PLUGIN = <<~JS
-        function toggleCopyIcon(copyIcon) {
-          copyIcon.classList.toggle("bi-clipboard");
-          copyIcon.classList.toggle("bi-clipboard-check");
-        }
-        hljs.addPlugin({
-          "after:highlightElement": function({ el, result, text }) {
-            const wrapper = el.parentElement; // pre element
-            if(wrapper == null) { return; }
+        (function() {
+          function canHover() {
+            return matchMedia('(hover: hover)').matches &&
+                   matchMedia('(pointer: fine)').matches;
+          }
+          function toggleCopyIcon(copyIcon) {
+            copyIcon.classList.toggle('bi-clipboard');
+            copyIcon.classList.toggle('bi-clipboard-check');
+          }
+          hljs.addPlugin({
+            'after:highlightElement': function({ el, result, text }) {
+              let cbText = text
+              const wrapper = el.parentElement; // pre element
+              if(wrapper == null) { return; }
 
-            const overlay = document.createElement("div");
-            overlay.classList.add("copy-button");
-            overlay.textContent = result.language.toUpperCase() + ' ';
+              const overlay = document.createElement('div');
+              overlay.classList.add('copy-button');
+              overlay.textContent = result.language.toUpperCase() + ' ';
 
-            const copyButton = document.createElement("button");
-            copyButton.classList.add("btn");
-            copyButton.setAttribute("type", "button");
-            copyButton.setAttribute("data-bs-toggle", "tooltip");
-            copyButton.setAttribute("data-bs-title", "Copy to clipboard");
-            if(!touch) {bootstrap.Tooltip.getOrCreateInstance(copyButton);}
+              const copyButton = document.createElement('button');
+              copyButton.classList.add('btn');
+              copyButton.setAttribute('type', 'button');
+              copyButton.setAttribute('data-bs-toggle', 'tooltip');
+              copyButton.setAttribute('data-bs-title', 'Copy to clipboard');
+              if(canHover()) bootstrap.Tooltip.getOrCreateInstance(copyButton);
 
-            const copyIcon = document.createElement("i");
-            copyIcon.classList.add("bi", "bi-clipboard");
+              const copyIcon = document.createElement('i');
+              copyIcon.classList.add('bi', 'bi-clipboard');
 
-            copyButton.append(copyIcon);
-            overlay.append(copyButton);
+              copyButton.append(copyIcon);
+              overlay.append(copyButton);
 
-            copyButton.onclick = function() {
-              navigator.clipboard.writeText(text);
-              if(!copyIcon.classList.contains("bi-clipboard-check")) {
-                toggleCopyIcon(copyIcon);
-                setTimeout(() => { toggleCopyIcon(copyIcon); }, 1500);
-              }
-            };
+              copyButton.addEventListener('click', function() {
+                navigator.clipboard.writeText(cbText);
+                if(!copyIcon.classList.contains('bi-clipboard-check')) {
+                  toggleCopyIcon(copyIcon);
+                  setTimeout(() => { toggleCopyIcon(copyIcon); }, 1500);
+                }
+              });
 
-            // Append the copy button to the wrapper
-            wrapper.appendChild(overlay);
+              // Append the copy button to the wrapper
+              wrapper.appendChild(overlay);
 
-            // Find and replace inline callouts
-            const rgx = /[\u2460-\u2468]/gu;
-            if(text.match(rgx)) {
-              text = text.replaceAll(rgx, "");
-              el.innerHTML = el.innerHTML.replaceAll(rgx, (match) => {
-                return '<i class="hljs-comment bi bi-' + (match.charCodeAt() - 9311) + '-circle"></i>';
-              });
+              // Find and replace inline callouts
+              const rgx = /[\u2460-\u2468]/gu;
+              if(text.match(rgx)) {
+                cbText = text.replaceAll(rgx, '');
+                el.innerHTML = el.innerHTML.replaceAll(rgx, (match) => {
+                  return '<i class="hljs-comment bi bi-' + (match.charCodeAt() - 9311) + '-circle"></i>';
+                });
+              }
             }
-          }
-        });
+          });
+        })();
       JS
     end
   end

data/lib/asciidoctor/html/list.rb

@@ -2,7 +2,7 @@
 
 module Asciidoctor
   module Html
-    # Helper functions for the list conversion.
+    # Helper functions for the list conversion
     module List
       def self.convert(node, tag_name = :ol)
         depth = node.attr "list-depth"
@@ -11,8 +11,7 @@ module Asciidoctor
         classes = [
           "list",
           "list-#{node.context}",
-          "level-#{level}",
-          flat ? "pseudocode" : node.style,
+          ("level-#{level} pseudocode" if flat),
           node.role
         ].compact
         classes << "checklist" if node.option?("checklist")

data/lib/asciidoctor/html/pagination.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Html
+    # Mixin to add pagination support to Book class
+    module Pagination
+      # Pagination item
+      PagItem = Struct.new("PagItem", :url, :title)
+
+      def display_paginator(prv, nxt)
+        <<~HTML
+          <div class="paginator-wrapper">
+          <div class="d-inline-block">
+          <div class="paginator">
+            #{%(<a href="#{prv.url}">&laquo; #{prv.title}</a>) if prv}
+            #{%(<span class="blank">&nbsp;</span>) unless prv && nxt}
+            #{%(<a href="#{nxt.url}">#{nxt.title} &raquo;</a>) if nxt}
+          </div>
+          </div>
+          </div>
+        HTML
+      end
+
+      def prv_nxt(keys, idx)
+        pagitems = []
+        [idx - 1, idx + 1].each do |i|
+          if i.between?(0, keys.size - 1)
+            key = keys[i]
+            ref = @refs[key]
+            pagitems << PagItem.new(
+              url: "#{key}.html",
+              title: ref["chapref"]
+            )
+          else
+            pagitems << nil
+          end
+        end
+        display_paginator(*pagitems)
+      end
+
+      def pagination(key = -1)
+        keys = @refs.keys
+        idx = keys.find_index key
+        return "" unless idx
+
+        prv_nxt keys, idx
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/popovers.rb

@@ -5,45 +5,42 @@ module Asciidoctor
     # Configure the popovers for footnotes and citations.
     module Popovers
       POPOVERS = <<~JS
-        function initPopovers() {
-          document.querySelectorAll(".btn-po[data-contentid]").forEach(el => {
-            const id = el.dataset.contentid;
-            let content = document.getElementById(id);
-            if(content) {
-              if(content.tagName == "A") {
-                // This is an anchor of a bibitem
-                const listItem = content.parentElement.cloneNode(true)
-                listItem.removeChild(listItem.firstChild)
-                content = listItem
+        (function() {
+          const popovers = []
+          function initPopovers() {
+            document.querySelectorAll('.btn-po[data-contentid]').forEach(el => {
+              const id = el.dataset.contentid;
+              let content = document.getElementById(id);
+              if(content) {
+                if(content.tagName == 'A') {
+                  // This is an anchor of a bibitem
+                  const listItem = content.parentElement.cloneNode(true)
+                  listItem.removeChild(listItem.firstChild)
+                  content = listItem
+                }
+                popovers.push(new bootstrap.Popover(el, {
+                  content: content,
+                  html: true,
+                  sanitize: false
+                }));
               }
-              new bootstrap.Popover(el, {
-                trigger: "focus",
-                content: content,
-                html: true,
-                sanitize: false
-              });
-            }
-          });
-        }
-        MathJax = {
-          startup: {
-            pageReady: function() {
-              return MathJax.startup.defaultPageReady().then(initPopovers);
-            }
+            });
           }
-        };
-      JS
-
-      TOOLTIPS = <<~JS
-        // Only enable tooltips on images if not a touch screen device
-        if(!touch) {
-          document.querySelectorAll('img[data-bs-toggle="tooltip"]').forEach(el => {
-            bootstrap.Tooltip.getOrCreateInstance(el);
+          addEventListener('click', e => {
+            const match = e.target.closest('.btn-po[aria-describedby],.popover');
+            if(!match) {
+              popovers.forEach(po => po.hide());
+            }
+          })
+          MathJax.startup.promise.then(initPopovers);
+          addEventListener('load', function() {
+            // Enable tooltips on images
+            document.querySelectorAll('img[data-bs-toggle="tooltip"]').forEach(el => {
+              bootstrap.Tooltip.getOrCreateInstance(el);
+            });
           });
-        }
+        })();
       JS
-
-      INIT = "#{TOOLTIPS}\n#{POPOVERS}".freeze
     end
   end
 end