asciidoctor-epub3 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f47c314fc65663c2bd0a8341ea54d55567aa7919d749b329b8ca71c1a333bd6
-  data.tar.gz: 90af9c361a43fb414ddbbc9307e4f796c1fba65e25b40ae68f8d070ac70f7c80
+  metadata.gz: 0dddf8fe89e08a5735ec8834f22bd922b8385c41d7115e8af62b16ebac212419
+  data.tar.gz: 8db49a9934ce142ffa4bd371abef329d939f4eb8bec928fbc54baa48a267c06d
 SHA512:
-  metadata.gz: 8eb9d489580a19dfbc7a5b0f66850d3d68f1a9e18bb97e1435c54637b2885b131faa14059b9abdb89d825f822fef14948a3e80874510a8829c90750ed50e8003
-  data.tar.gz: 3d1285ae734a37cebb56e4c1a02ada09ec6b7b216cba28b0a312d14f09dcf21704b182b88aaa4162bb2dff8e90bac0369d3fd6b513bc0b857182508346f551a3
+  metadata.gz: e21b62e05193e4b1c208ee8cce4e434f528d543909b0c71e04c7b3fecf43c2724c91d47a01a2f291b2bbbe5718857721412553bdde0db6d09110a59d83169c31
+  data.tar.gz: e9db7e08b20c644db5ad7a06367a668fc77997933bdc0f219121076bbfae902cf8c2ab31d0e7c870b3579d1f8dc6bbd9fc4fa5cb87f1753b40ed0d206c522ced

data/CHANGELOG.adoc

@@ -5,6 +5,14 @@
 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 {uri-repo}/commits/master[commit history] on GitHub.
 
+== 2.3.0 (2025-08-31) - @slonopotamus
+
+* add docinfo support (#502)
+* fix footnote HTML markup (#506)
+* add list styles support #(508)
+* improve CSS styles for example blocks (#516)
+* fix off-by-one `:toclevels:` handling in multi-part books (#492)
+
 == 2.2.0 (2025-05-11) - @slonopotamus
 
 * fix crash when running in environments with non-Unicode locale (#475)
@@ -14,7 +22,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * bump the oldest supported Ruby to 2.7
 * fix Ruby 3.4 compatibility
 * fix captions in example blocks (#497)
-* fix TOC being off-by-one when `:toclevels:` is set (#492)
+* fix off-by-one `:toclevels:` handling (#492)
 * stop using H3 for list headings (#491)
 
 == 2.1.3 (2024-05-12) - @slonopotamus

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}: A _native_ EPUB3 converter for AsciiDoc
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.2.0, 2025-05-11
+v2.2.0, 2025-08-31
 :project-name: Asciidoctor EPUB3
 :project-handle: asciidoctor-epub3
 :uri-project: https://github.com/asciidoctor/{project-handle}

data/asciidoctor-epub3.gemspec

@@ -36,17 +36,19 @@ Gem::Specification.new do |s|
   # TODO: switch to 'sass-embedded' when we drop Ruby 2.5 support
   s.add_dependency 'sass'
 
-  s.add_development_dependency 'asciidoctor-diagram', '~> 2.0'
+  s.add_development_dependency 'asciidoctor-diagram', '~> 3.0'
+  s.add_development_dependency 'asciidoctor-diagram-ditaamini', '~> 1.0'
+  s.add_development_dependency 'asciidoctor-diagram-plantuml', '~> 1.2025'
   s.add_development_dependency 'asciimath', '~> 2.0'
   s.add_development_dependency 'coderay', '~> 1.1.0'
   s.add_development_dependency 'concurrent-ruby', '~> 1.0'
-  s.add_development_dependency 'epubcheck-ruby', '~> 5.2.0.0'
-  s.add_development_dependency 'pygments.rb', '~> 3.0.0'
-  s.add_development_dependency 'rake', '~> 13.2.0'
-  s.add_development_dependency 'rouge', '~> 3.0'
+  s.add_development_dependency 'epubcheck-ruby', '~> 5.2.1.0'
+  s.add_development_dependency 'pygments.rb', '~> 4.0.0'
+  s.add_development_dependency 'rake', '~> 13.3.0'
+  s.add_development_dependency 'rouge', '~> 4.6'
   s.add_development_dependency 'rspec', '~> 3.13.0'
-  s.add_development_dependency 'rubocop', '~> 1.70.0'
-  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'rubocop', '~> 1.80.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.7.1'
   s.add_development_dependency 'rubocop-rspec', '~> 3.3'
   s.add_development_dependency 'slim', '~> 5.0'
   s.add_development_dependency 'tilt', '~> 2.0'

data/data/styles/epub3.scss

@@ -207,7 +207,7 @@ th, td {
 body p,
 ul, ol, li, dl, dt, dd, footer,
 div.verse .attribution, table.table th, table.table td,
-figcaption, caption {
+figcaption, caption, div.example-title {
   /* NOTE iBooks will forcefully override font-family of text inside div, p and span elements when font other than Original is selected */
   /* NOTE iBooks honors Original font for prose text if declared in display-options.xml */
   font-family: "Noto Serif", serif;
@@ -363,6 +363,16 @@ div.callout-list li > i.conum {
   width: 1.25em;
 }
 
+div.example-title {
+  margin-top: 1em;
+}
+
+.example-content > * {
+  margin-top: 0.25em;
+  border: 1px solid $aside-border;
+  padding: 0.25em;
+}
+
 div.itemized-list, div.ordered-list, div.description-list {
   margin-top: 1em;
   padding-bottom: 0.25em; /* REVIEW maybe, maybe not */
@@ -414,11 +424,39 @@ li > span.principal, dd > span.principal {
   text-align: justify;
 }
 
+ol.arabic {
+  list-style-type: decimal
+}
+
 ol.brief > li > span.principal,
 ul.brief > li > span.principal {
   text-align: left;
 }
 
+ol.decimal {
+  list-style-type: decimal-leading-zero
+}
+
+ol.loweralpha {
+  list-style-type: lower-alpha
+}
+
+ol.lowergreek {
+  list-style-type: lower-greek
+}
+
+ol.lowerroman {
+  list-style-type: lower-roman
+}
+
+ol.upperalpha {
+  list-style-type: upper-alpha
+}
+
+ol.upperroman {
+  list-style-type: upper-roman
+}
+
 /* REVIEW still considering keeping this one */
 /* disable justify within a link */
 /*
@@ -469,8 +507,10 @@ h4 {
 
   /* Removed due to multiple definitions, assuming only the last one will be considered by interpreters */
   /* font-size: 1.1em; */
-  /* margin-top: 1em; */ /* 1.1rem */
-  /* margin-bottom: -0.818em; */ /* -0.9rem, 0.1rem to content */
+  /* margin-top: 1em; */
+  /* 1.1rem */
+  /* margin-bottom: -0.818em; */
+  /* -0.9rem, 0.1rem to content */
 
   font-size: 1.2em;
   margin-top: 0.917em; /* 1.1rem */
@@ -783,7 +823,8 @@ figure.coalesce {
 }
 
 figcaption,
-caption {
+caption,
+div.example-title {
   font-size: 0.9em;
   font-style: italic;
   color: $caption-text;

data/lib/asciidoctor-epub3/converter.rb

@@ -245,6 +245,7 @@ module Asciidoctor
 
         nav_item = @book.add_item('nav.xhtml', id: 'nav').nav
 
+        # TODO: Why we default to toclevels=1?
         toclevels = [(node.attr 'toclevels', 1).to_i, 0].max
         outlinelevels = [(node.attr 'outlinelevels', toclevels).to_i, 0].max
 
@@ -388,9 +389,9 @@ module Asciidoctor
         if icon_names.empty?
           icon_css_head = ''
         else
-          icon_defs = icon_names.map { |name|
+          icon_defs = icon_names.map do |name|
             %(.i-#{name}::before { content: "#{FontIconMap.unicode name}"; })
-          } * LF
+          end * LF
           icon_css_head = %(<style>
 #{icon_defs}
 </style>
@@ -435,8 +436,19 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
                                                    self_closing_tag_slash: '/')
         end
 
-        lines << %(</head>
+        unless (docinfo_content = node.document.docinfo :head, '-epub.html').empty?
+          lines << docinfo_content
+        end
+
+        lines << '</head>
 <body>
+'
+
+        unless (docinfo_content = node.document.docinfo :header, '-epub.html').empty?
+          lines << docinfo_content
+        end
+
+        lines << %(
 <section class="chapter" title=#{chapter_title.encode xml: :attr}#{epub_type_attr} id="#{filename}">
 #{header}
         #{content})
@@ -462,6 +474,10 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
                                                               self_closing_tag_slash: '/')
         end
 
+        unless (docinfo_content = node.document.docinfo :footer, '-epub.html').empty?
+          lines << docinfo_content
+        end
+
         lines << '</body>
 </html>'
 
@@ -1257,7 +1273,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
           attrs = []
           attrs << %(id="#{node.id}") if node.id
 
-          %(<sup class="noteref">[<a#{prepend_space attrs * ' '}href="#note-#{index}" epub:type="noteref">#{index}</a>]</sup>)
+          %(<sup class="noteref">[<a#{prepend_space attrs * ' '} href="#note-#{index}" epub:type="noteref">#{index}</a>]</sup>)
         elsif node.type == :xref
           %(<mark class="noteref" title="Unresolved note reference">#{node.text}</mark>)
         end
@@ -1377,7 +1393,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 
       # Prepend a space to the value if it's non-nil, otherwise return empty string.
       def prepend_space(value)
-        value ? %( #{value}) : ''
+        value.nil_or_empty? ? '' : %( #{value})
       end
 
       def add_theme_assets(doc)
@@ -1587,7 +1603,7 @@ body > svg {
         nil
       end
 
-      def nav_doc(doc, items, landmarks, depth)
+      def nav_doc(doc, items, landmarks, levels)
         lines = [%(<?xml version='1.0' encoding='utf-8'?>
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="#{lang = doc.attr 'lang',
@@ -1603,7 +1619,7 @@ body > svg {
 <h1 class="chapter-title"><small class="subtitle">#{doc.attr 'toc-title'}</small></h1>
 </header>
 <nav epub:type="toc" id="toc">)]
-        lines << (nav_level items, [depth, 0].max)
+        lines << (nav_level items, levels)
         lines << '</nav>'
 
         unless landmarks.empty?
@@ -1624,41 +1640,40 @@ body > svg {
         lines * LF
       end
 
-      def nav_level(items, depth, state = {})
+      def nav_level(items, levels, state = {})
         lines = []
 
-        if depth.positive?
-          lines << '<ol>'
-          items.each do |item|
-            # index = (state[:index] = (state.fetch :index, 0) + 1)
-            if (chapter_filename = get_chapter_filename item).nil?
-              item_label = sanitize_xml get_numbered_title(item), :pcdata
-              item_href = %(#{state[:content_doc_href]}##{item.id})
-            else
-              # NOTE: we sanitize the chapter titles because we use formatting to control layout
-              item_label = if item.context == :document
-                             sanitize_doctitle_xml item, :cdata
-                           else
-                             sanitize_xml get_numbered_title(item), :cdata
-                           end
-              item_href = (state[:content_doc_href] = %(#{chapter_filename}.xhtml))
-            end
-            lines << %(<li><a href="#{item_href}">#{item_label}</a>)
-            if (child_sections = item.sections).empty?
-              lines[-1] = %(#{lines[-1]}</li>)
-            else
-              lines << (nav_level child_sections, depth - 1, state)
-              lines << '</li>'
-            end
-            state.delete :content_doc_href unless chapter_filename.nil?
+        items.each do |item|
+          next if item.level > levels
+
+          # index = (state[:index] = (state.fetch :index, 0) + 1)
+          if (chapter_filename = get_chapter_filename item).nil?
+            item_label = sanitize_xml get_numbered_title(item), :pcdata
+            item_href = %(#{state[:content_doc_href]}##{item.id})
+          else
+            # NOTE: we sanitize the chapter titles because we use formatting to control layout
+            item_label = if item.context == :document
+                           sanitize_doctitle_xml item, :cdata
+                         else
+                           sanitize_xml get_numbered_title(item), :cdata
+                         end
+            item_href = (state[:content_doc_href] = %(#{chapter_filename}.xhtml))
+          end
+          lines << %(<li><a href="#{item_href}">#{item_label}</a>)
+          if (child_sections = item.sections).empty?
+            lines[-1] = %(#{lines[-1]}</li>)
+          else
+            lines << (nav_level child_sections, levels, state)
+            lines << '</li>'
           end
-          lines << '</ol>'
+          state.delete :content_doc_href unless chapter_filename.nil?
         end
 
+        lines = ['<ol>', *lines, %(</ol>)] unless lines.empty?
         lines * LF
       end
 
-      def ncx_doc(doc, items, depth)
+      def ncx_doc(doc, items, levels)
         # TODO: populate docAuthor element based on unique authors in work
         lines = [%(<?xml version="1.0" encoding="utf-8"?>
 <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" xml:lang="#{doc.attr 'lang', 'en'}">
@@ -1670,17 +1685,19 @@ body > svg {
 </head>
 <docTitle><text>#{sanitize_doctitle_xml doc, :cdata}</text></docTitle>
 <navMap>)]
-        lines << (ncx_level items, depth, state = {})
+        lines << (ncx_level items, levels, state = {})
         lines[0] = lines[0].sub '%<depth>s', %(<meta name="dtb:depth" content="#{state[:max_depth]}"/>)
         lines << %(</navMap>
 </ncx>)
         lines * LF
       end
 
-      def ncx_level(items, depth, state = {})
+      def ncx_level(items, levels, state = {})
         lines = []
         state[:max_depth] = (state.fetch :max_depth, 0) + 1
         items.each do |item|
+          next if item.level > levels
+
           index = (state[:index] = (state.fetch :index, 0) + 1)
           item_id = %(nav_#{index})
           if (chapter_filename = get_chapter_filename item).nil?
@@ -1697,8 +1714,8 @@ body > svg {
           lines << %(<navPoint id="#{item_id}" playOrder="#{index}">)
           lines << %(<navLabel><text>#{item_label}</text></navLabel>)
           lines << %(<content src="#{item_href}"/>)
-          unless depth.zero? || (child_sections = item.sections).empty?
-            lines << (ncx_level child_sections, depth - 1, state)
+          unless (child_sections = item.sections).empty?
+            lines << (ncx_level child_sections, levels, state)
           end
           lines << %(</navPoint>)
           state.delete :content_doc_href unless chapter_filename.nil?

data/lib/asciidoctor-epub3/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Epub3
-    VERSION = '2.2.0'
+    VERSION = '2.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-epub3
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Dan Allen
@@ -72,14 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-diagram-ditaamini
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-diagram-plantuml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2025'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2025'
 - !ruby/object:Gem::Dependency
   name: asciimath
   requirement: !ruby/object:Gem::Requirement
@@ -128,56 +156,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0.0
+        version: 5.2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0.0
+        version: 5.2.1.0
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.2.0
+        version: 13.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.2.0
+        version: 13.3.0
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -198,28 +226,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.70.0
+        version: 1.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.70.0
+        version: 1.80.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -356,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Converts AsciiDoc documents to EPUB3 e-book format
 test_files: []