asciidoctor 2.0.20 → 2.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95bddd5f820dc0441d3accb7dd49864b1fb9f1807823887d0075e595a2d55094
-  data.tar.gz: 1dd21111bda88dde555fe981b30e89684bd0ac0bbe8e329721bbdc7b18ab806d
+  metadata.gz: eb33ff3290649511b70addaa88b8b1ef9429641bc0cf04113b8fe8613ac6ad63
+  data.tar.gz: 6c26157b4e3a366c43b2ef6a2fffcad558b3a3363fc3985ca7a1b2412292d192
 SHA512:
-  metadata.gz: a03b03f8a1bda4d71235f975603353c9653c1ad98ff26a42b5d2d844dab6954c41d75c45d598a8b976bba3b4b35aa05f7e2791c1dc6c1da75714bced767f6f8f
-  data.tar.gz: c463c0c23a75ddadf2c1eff1cc3afdf574b07a2551693b7330a1cebcef8a9e789ffa5f9bec005843a327837d33f42298f30684f6d16a8c0271d1379ac080485e
+  metadata.gz: 72aca517f60e682e3038e8f790669de5e00f86f6b3d20be023b090bff7e837f866e2211e67657ba5139ca9758f9b260ffff70edf597b060d371e2e1ffc09e1e7
+  data.tar.gz: efcc562d749e9fafc3462598490a9b03a0f556919a55c1fb0c5f04635006ac006800dd6607388bacef5d837aeb7f3d2951ed11069675dae5555b84ce8945bcf3

data/CHANGELOG.adoc

@@ -16,6 +16,38 @@ For an even more detailed look at what has changed, refer to the {url-repo}/comm
 This project utilizes semantic versioning.
 
 // tag::compact[]
+== 2.0.21 (2024-02-20) - @mojavelinux
+
+Compliance::
+
+  * Turn off system-dependent newline conversion when writing files; don't convert line feeds to system-dependent newline (#4550)
+  * Support logger in Ruby 3.3 by instantiating super class (#4493) (*@mtasaka*)
+  * Add support for `scaledwidth` and `scale` attributes on inline image macro in DocBook output (#4552)
+  * Update latest Ruby to 3.3 in CI workflows
+
+Improvements::
+
+  * Change title to doctitle in warning message about use of abstract to make subject more clear
+  * Modify default stylesheet to add text decoration to active footnote number link in footnotes list (#4530) (@Larhzu)
+
+Bug Fixes::
+
+  * Nested dlist attached using list continuation should not consume detached paragraph (#3535)
+  * Don't break nested dlist with attached block if offset from parent list by empty line (#3693)
+  * Preserve paragraph breaks in normal table cell in manpage output (#4481)
+  * Style cells in head row as bold in manpage output (#4490)
+  * Escape spaces in include target (using inline passthrough) when generating link from include directive (#4461)
+  * Move abstract inside info tag in DocBook output (#3602)
+  * Honor secondary and tertiary terms on `indexterm` macro when primary term is quoted and contains an equals sign (#3652)
+  * Remove extra border below doctitle when sidebar toc is collapsed into main content area (#4523)
+  * Treat bare URL enclosed in angle brackets as unconstrained syntax; only match until closing angled bracket (#4468)
+  * Allow URL enclosed in angled brackets syntax to be escaped using backslash (#4468)
+
+=== Details
+
+{url-repo}/releases/tag/v2.0.21[git tag] | {url-repo}/compare/v2.0.20\...v2.0.21[full diff]
+// end::compact[]
+
 == 2.0.20 (2023-05-18) - @mojavelinux
 
 Bug Fixes::
@@ -26,7 +58,6 @@ Bug Fixes::
 === Details
 
 {url-repo}/releases/tag/v2.0.20[git tag] | {url-repo}/compare/v2.0.19\...v2.0.20[full diff]
-// end::compact[]
 
 == 2.0.19 (2023-05-17) - @mojavelinux
 

data/README-de.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.20, 2023-05-18
+v2.0.21, 2024-02-20
 // settings:
 :idprefix:
 :idseparator: -
@@ -16,7 +16,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.20
+:release-version: 2.0.21
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor

data/README-fr.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.20, 2023-05-18
+v2.0.21, 2024-02-20
 // settings:
 :idprefix:
 :idseparator: -
@@ -16,7 +16,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.20
+:release-version: 2.0.21
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor

data/README-jp.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.20, 2023-05-18
+v2.0.21, 2024-02-20
 // settings:
 :idprefix:
 :idseparator: -
@@ -16,7 +16,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.20
+:release-version: 2.0.21
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor

data/README-zh_CN.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.20, 2023-05-18
+v2.0.21, 2024-02-20
 // settings:
 :page-layout: base
 :idprefix:
@@ -17,7 +17,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.20
+:release-version: 2.0.21
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor

data/README.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.20, 2023-05-18
+v2.0.21, 2024-02-20
 // settings:
 :idprefix:
 :idseparator: -
@@ -16,7 +16,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.20
+:release-version: 2.0.21
 // URLs:
 :url-org: https://github.com/asciidoctor
 :url-repo: {url-org}/asciidoctor

data/data/reference/syntax.adoc

@@ -112,7 +112,7 @@ Attach a block or paragraph to a list item using a list continuation (which you
 
 .Some Authors
 [circle]
-- Edgar Allen Poe
+- Edgar Allan Poe
 - Sheri S. Tepper
 - Bill Bryson
 

data/data/stylesheets/asciidoctor-default.css

@@ -130,7 +130,7 @@ p a>code:hover{color:rgba(0,0,0,.9)}
 #content::before{content:none}
 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
-#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
+#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
 #header .details span:first-child{margin-left:-.125em}
 #header .details span.email a{color:rgba(0,0,0,.85)}
@@ -152,6 +152,7 @@ p a>code:hover{color:rgba(0,0,0,.9)}
 #toctitle{color:#7a2518;font-size:1.2em}
 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
 body.toc2{padding-left:15em;padding-right:0}
+body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
@@ -317,7 +318,7 @@ a.image{text-decoration:none;display:inline-block}
 a.image object{pointer-events:none}
 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 sup.footnote a,sup.footnoteref a{text-decoration:none}
-sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
+sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}

data/lib/asciidoctor/converter/docbook5.rb

@@ -44,7 +44,8 @@ class Converter::DocBook5Converter < Converter::Base
     end
     root_tag_idx = result.size
     id = node.id
-    result << (document_info_tag node) unless node.noheader
+    abstract = find_root_abstract node
+    result << (document_info_tag node, abstract) unless node.noheader
     if manpage
       result << '<refentry>'
       result << '<refmeta>'
@@ -61,7 +62,9 @@ class Converter::DocBook5Converter < Converter::Base
     unless (docinfo_content = node.docinfo :header).empty?
       result << docinfo_content
     end
-    result << node.content if node.blocks?
+    abstract = extract_abstract node, abstract if abstract
+    result << (node.blocks.map {|block| block.convert }.compact.join LF) if node.blocks?
+    restore_abstract abstract if abstract
     unless (docinfo_content = node.docinfo :footer).empty?
       result << docinfo_content
     end
@@ -73,7 +76,15 @@ class Converter::DocBook5Converter < Converter::Base
     result.join LF
   end
 
-  alias convert_embedded content_only
+  def convert_embedded node
+    # NOTE in DocBook 5, the root abstract must be in the info tag and is thus not part of the body
+    if @backend == 'docbook5' && (abstract = find_root_abstract node)
+      abstract = extract_abstract node, abstract
+    end
+    result = node.blocks.map {|block| block.convert }.compact.join LF
+    restore_abstract abstract if abstract
+    result
+  end
 
   def convert_section node
     if node.document.doctype == 'manpage'
@@ -183,27 +194,11 @@ class Converter::DocBook5Converter < Converter::Base
   end
 
   def convert_image node
-    # NOTE according to the DocBook spec, content area, scaling, and scaling to fit are mutually exclusive
-    # See http://tdg.docbook.org/tdg/4.5/imagedata-x.html#d0e79635
-    if node.attr? 'scaledwidth'
-      width_attribute = %( width="#{node.attr 'scaledwidth'}")
-      depth_attribute = ''
-      scale_attribute = ''
-    elsif node.attr? 'scale'
-      # QUESTION should we set the viewport using width and depth? (the scaled image would be contained within this box)
-      #width_attribute = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : ''
-      #depth_attribute = (node.attr? 'height') ? %( depth="#{node.attr 'height'}") : ''
-      scale_attribute = %( scale="#{node.attr 'scale'}")
-    else
-      width_attribute = (node.attr? 'width') ? %( contentwidth="#{node.attr 'width'}") : ''
-      depth_attribute = (node.attr? 'height') ? %( contentdepth="#{node.attr 'height'}") : ''
-      scale_attribute = ''
-    end
     align_attribute = (node.attr? 'align') ? %( align="#{node.attr 'align'}") : ''
 
     mediaobject = %(<mediaobject>
 <imageobject>
-<imagedata fileref="#{node.image_uri(node.attr 'target')}"#{width_attribute}#{depth_attribute}#{scale_attribute}#{align_attribute}/>
+<imagedata fileref="#{node.image_uri node.attr 'target'}"#{image_size_attributes node.attributes}#{align_attribute}/>
 </imageobject>
 <textobject><phrase>#{node.alt}</phrase></textobject>
 </mediaobject>)
@@ -308,13 +303,17 @@ class Converter::DocBook5Converter < Converter::Base
   def convert_open node
     case node.style
     when 'abstract'
-      if node.parent == node.document && node.document.doctype == 'book'
-        logger.warn 'abstract block cannot be used in a document without a title when doctype is book. Excluding block content.'
+      if (parent = node.parent) == node.document && node.document.doctype == 'book'
+        logger.warn 'abstract block cannot be used in a document without a doctitle when doctype is book. Excluding block content.'
         ''
       else
-        %(<abstract>
+        result = %(<abstract>
 #{title_tag node}#{enclose_content node}
 </abstract>)
+        if @backend == 'docbook5' && !(node.option? 'root') && (parent.context == :open ? parent.style == 'partintro' : parent.context == :section && parent.sectname == 'partintro') && node == parent.blocks[0]
+          result = %(<info>\n#{result}\n</info>)
+        end
+        result
       end
     when 'partintro'
       if node.level == 0 && node.parent.context == :section && node.document.doctype == 'book'
@@ -536,11 +535,9 @@ class Converter::DocBook5Converter < Converter::Base
   end
 
   def convert_inline_image node
-    width_attribute = (node.attr? 'width') ? %( contentwidth="#{node.attr 'width'}") : ''
-    depth_attribute = (node.attr? 'height') ? %( contentdepth="#{node.attr 'height'}") : ''
     %(<inlinemediaobject#{common_attributes nil, node.role}>
 <imageobject>
-<imagedata fileref="#{node.type == 'icon' ? (node.icon_uri node.target) : (node.image_uri node.target)}"#{width_attribute}#{depth_attribute}/>
+<imagedata fileref="#{node.type == 'icon' ? (node.icon_uri node.target) : (node.image_uri node.target)}"#{image_size_attributes node.attributes}/>
 </imageobject>
 <textobject><phrase>#{node.alt}</phrase></textobject>
 </inlinemediaobject>)
@@ -648,6 +645,23 @@ class Converter::DocBook5Converter < Converter::Base
     end
   end
 
+  def image_size_attributes attributes
+    # NOTE according to the DocBook spec, content area, scaling, and scaling to fit are mutually exclusive
+    # See http://tdg.docbook.org/tdg/4.5/imagedata-x.html#d0e79635
+    if attributes.key? 'scaledwidth'
+      %( width="#{attributes['scaledwidth']}")
+    elsif attributes.key? 'scale'
+      # QUESTION should we set the viewport using width and depth? (the scaled image would be contained within this box)
+      #width_attribute = (attributes.key? 'width') ? %( width="#{attributes['width']}") : ''
+      #depth_attribute = (attributes.key? 'height') ? %( depth="#{attributes['height']}") : ''
+      %( scale="#{attributes['scale']}")
+    else
+      width_attribute = (attributes.key? 'width') ? %( contentwidth="#{attributes['width']}") : ''
+      depth_attribute = (attributes.key? 'height') ? %( contentdepth="#{attributes['height']}") : ''
+      %(#{width_attribute}#{depth_attribute})
+    end
+  end
+
   def author_tag doc, author
     result = []
     result << '<author>'
@@ -661,7 +675,7 @@ class Converter::DocBook5Converter < Converter::Base
     result.join LF
   end
 
-  def document_info_tag doc
+  def document_info_tag doc, abstract
     result = ['<info>']
     unless doc.notitle
       if (title = doc.doctitle partition: true, use_fallback: true).subtitle?
@@ -715,11 +729,37 @@ class Converter::DocBook5Converter < Converter::Base
         result << docinfo_content
       end
     end
+    if abstract
+      abstract.set_option 'root'
+      result << (convert abstract, abstract.node_name)
+      abstract.remove_attr 'root-option'
+    end
     result << '</info>'
 
     result.join LF
   end
 
+  def find_root_abstract doc
+    return unless doc.blocks?
+    if (first_block = doc.blocks[0]).context == :preamble
+      return unless (first_block = first_block.blocks[0])
+    elsif first_block.context == :section
+      return first_block if first_block.sectname == 'abstract'
+      return unless first_block.sectname == 'preface' && (first_block = first_block.blocks[0])
+    end
+    return first_block if first_block.style == 'abstract' && first_block.context == :open
+  end
+
+  def extract_abstract document, abstract
+    parent = abstract.parent
+    parent = parent.parent while parent != document && parent.blocks.length == 1
+    parent.blocks.delete_at 0
+  end
+
+  def restore_abstract abstract
+    abstract.parent.blocks.insert 0, abstract
+  end
+
   def get_root_document node
     while (node = node.document).nested?
       node = node.parent_document
@@ -742,26 +782,18 @@ class Converter::DocBook5Converter < Converter::Base
 
   def cover_tag doc, face, use_placeholder = false
     if (cover_image = doc.attr %(#{face}-cover-image))
-      width_attr = ''
-      depth_attr = ''
       if (cover_image.include? ':') && ImageMacroRx =~ cover_image
-        attrlist = $2
-        cover_image = doc.image_uri $1
-        if attrlist
-          attrs = (AttributeList.new attrlist).parse ['alt', 'width', 'height']
-          if attrs.key? 'scaledwidth'
-            # NOTE scalefit="1" is the default in this case
-            width_attr = %( width="#{attrs['scaledwidth']}")
-          else
-            width_attr = %( contentwidth="#{attrs['width']}") if attrs.key? 'width'
-            depth_attr = %( contentdepth="#{attrs['height']}") if attrs.key? 'height'
-          end
-        end
+        target, attrlist = $1, $2
+        cover_image = doc.image_uri target
+        # NOTE scalefit="1" is the default for a cover image
+        size_attrs = image_size_attributes (AttributeList.new attrlist).parse %w(alt width height) if attrlist
+      else
+        size_attrs = ''
       end
       %(<cover role="#{face}">
 <mediaobject>
 <imageobject>
-<imagedata fileref="#{cover_image}"#{width_attr}#{depth_attr}/>
+<imagedata fileref="#{cover_image}"#{size_attrs}/>
 </imageobject>
 </mediaobject>
 </cover>)

data/lib/asciidoctor/converter/html5.rb

@@ -748,7 +748,7 @@ Your browser does not support the audio tag.
   def convert_open node
     if (style = node.style) == 'abstract'
       if node.parent == node.document && node.document.doctype == 'book'
-        logger.warn 'abstract block cannot be used in a document without a title when doctype is book. Excluding block content.'
+        logger.warn 'abstract block cannot be used in a document without a doctitle when doctype is book. Excluding block content.'
         ''
       else
         id_attr = node.id ? %( id="#{node.id}") : ''

data/lib/asciidoctor/converter/manpage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Asciidoctor
-# A built-in {Converter} implementation that generates the man page (troff) format.
+# A built-in {Converter} implementation that generates the man page (groff) format.
 #
 # The output of this converter adheres to the man definition as defined by
 # groff and uses the manpage output of the DocBook toolchain as a foundation.
@@ -432,7 +432,7 @@ allbox tab(:);'
             when :literal
               cell_content = %(.nf#{LF}#{manify cell.text, whitespace: :preserve}#{LF}.fi)
             else
-              cell_content = manify cell.content.join, whitespace: :normalize
+              cell_content = cell.content.map {|p| manify p, whitespace: :normalize }.join %(#{LF}.sp#{LF})
             end
             row_text[row_index] << %(#{cell_content}#{LF})
           else # tsec == :head || tsec == :foot
@@ -476,21 +476,14 @@ allbox tab(:);'
       end unless rows.empty?
     end
 
-    #row_header.each do |row|
-    #  result << LF
-    #  row.each_with_index do |cell, i|
-    #    result << (cell.join ' ')
-    #    result << ' ' if row.size > i + 1
-    #  end
-    #end
-    # FIXME temporary fix to get basic table to display
-    result << LF
-    result << ('lt ' * row_header[0].size).chop
-
-    result << %(.#{LF})
-    row_text.each do |row|
-      result << row.join
+    if node.has_header_option && (header_row_text = row_text[0])
+      result << %(#{LF}#{row_header[0].join ' '}.)
+      result << %(#{LF}#{header_row_text.join})
+      result << '.T&'
+      row_text = row_text.slice 1, row_text.length
     end
+    result << %(#{LF}#{row_header[0].map { 'lt' }.join ' '}.#{LF})
+    row_text.each {|row| result << row.join }
     result << %(.TE#{LF}.sp)
     result.join
   end
@@ -712,40 +705,38 @@ allbox tab(:);'
     else
       str = str.tr_s WHITESPACE, ' '
     end
-    str = str
-      .gsub(LiteralBackslashRx) { $1 ? $& : '\\(rs' } # literal backslash (not a troff escape sequence)
-      .gsub(EllipsisCharRefRx, '...') # horizontal ellipsis
-      .gsub(LeadingPeriodRx, '\\\&.') # leading . is used in troff for macro call or other formatting; replace with \&.
-      .gsub(EscapedMacroRx) do # drop orphaned \c escape lines, unescape troff macro, quote adjacent character, isolate macro line
-        (rest = $3.lstrip).empty? ? %(.#{$1}"#{$2}") : %(.#{$1}"#{$2.rstrip}"#{LF}#{rest})
-      end
-      .gsub('-', '\-')
-      .gsub('&lt;', '<')
-      .gsub('&gt;', '>')
-      .gsub('&#43;', '+')       # plus sign; alternately could use \c(pl
-      .gsub('&#160;', '\~')     # non-breaking space
-      .gsub('&#169;', '\(co')   # copyright sign
-      .gsub('&#174;', '\(rg')   # registered sign
-      .gsub('&#8482;', '\(tm')  # trademark sign
-      .gsub('&#176;', '\(de')   # degree sign
-      .gsub('&#8201;', ' ')     # thin space
-      .gsub('&#8211;', '\(en')  # en dash
-      .gsub(EmDashCharRefRx, '\(em') # em dash
-      .gsub('&#8216;', '\(oq')  # left single quotation mark
-      .gsub('&#8217;', '\(cq')  # right single quotation mark
-      .gsub('&#8220;', '\(lq')  # left double quotation mark
-      .gsub('&#8221;', '\(rq')  # right double quotation mark
-      .gsub('&#8592;', '\(<-')  # leftwards arrow
-      .gsub('&#8594;', '\(->')  # rightwards arrow
-      .gsub('&#8656;', '\(lA')  # leftwards double arrow
-      .gsub('&#8658;', '\(rA')  # rightwards double arrow
-      .gsub('&#8203;', '\:')    # zero width space
-      .gsub('&amp;', '&')       # literal ampersand (NOTE must take place after any other replacement that includes &)
-      .gsub('\'', '\*(Aq')      # apostrophe / neutral single quote
-      .gsub(MockMacroRx, '\1')  # mock boundary
-      .gsub(ESC_BS, '\\')       # unescape troff backslash (NOTE update if more escapes are added)
-      .gsub(ESC_FS, '.')        # unescape full stop in troff commands (NOTE must take place after gsub(LeadingPeriodRx))
-      .rstrip                   # strip trailing space
+    str = str.
+      gsub(LiteralBackslashRx) { $1 ? $& : '\\(rs' }. # literal backslash (not a troff escape sequence)
+      gsub(EllipsisCharRefRx, '...'). # horizontal ellipsis
+      gsub(LeadingPeriodRx, '\\\&.'). # leading . is used in troff for macro call or other formatting; replace with \&.
+      gsub(EscapedMacroRx) { (rest = $3.lstrip).empty? ? %(.#{$1}"#{$2}") : %(.#{$1}"#{$2.rstrip}"#{LF}#{rest}) }. # drop orphaned \c escape lines, unescape troff macro, quote adjacent character, isolate macro line
+      gsub('-', '\-').
+      gsub('&lt;', '<').
+      gsub('&gt;', '>').
+      gsub('&#43;', '+').      # plus sign; alternately could use \c(pl
+      gsub('&#160;', '\~').    # non-breaking space
+      gsub('&#169;', '\(co').  # copyright sign
+      gsub('&#174;', '\(rg').  # registered sign
+      gsub('&#8482;', '\(tm'). # trademark sign
+      gsub('&#176;', '\(de').  # degree sign
+      gsub('&#8201;', ' ').    # thin space
+      gsub('&#8211;', '\(en'). # en dash
+      gsub(EmDashCharRefRx, '\(em'). # em dash
+      gsub('&#8216;', '\(oq'). # left single quotation mark
+      gsub('&#8217;', '\(cq'). # right single quotation mark
+      gsub('&#8220;', '\(lq'). # left double quotation mark
+      gsub('&#8221;', '\(rq'). # right double quotation mark
+      gsub('&#8592;', '\(<-'). # leftwards arrow
+      gsub('&#8594;', '\(->'). # rightwards arrow
+      gsub('&#8656;', '\(lA'). # leftwards double arrow
+      gsub('&#8658;', '\(rA'). # rightwards double arrow
+      gsub('&#8203;', '\:').   # zero width space
+      gsub('&amp;', '&').      # literal ampersand (NOTE must take place after any other replacement that includes &)
+      gsub('\'', '\*(Aq').     # apostrophe / neutral single quote
+      gsub(MockMacroRx, '\1'). # mock boundary
+      gsub(ESC_BS, '\\').      # unescape troff backslash (NOTE update if more escapes are added)
+      gsub(ESC_FS, '.').       # unescape full stop in troff commands (NOTE must take place after gsub(LeadingPeriodRx))
+      rstrip                   # strip trailing space
     opts[:append_newline] ? %(#{str}#{LF}) : str
   end
 

data/lib/asciidoctor/logging.rb

@@ -40,6 +40,7 @@ class MemoryLogger < ::Logger
   attr_reader :messages
 
   def initialize
+    super nil
     self.level = WARN
     @messages = []
   end
@@ -67,6 +68,7 @@ class NullLogger < ::Logger
   attr_reader :max_severity
 
   def initialize
+    super nil
     self.level = WARN
   end
 

data/lib/asciidoctor/parser.rb

@@ -43,6 +43,12 @@ class Parser
 
   AuthorKeys = ['author', 'authorinitials', 'firstname', 'middlename', 'lastname', 'email']
 
+  ListContinuationMarker = ::Module.new
+
+  ListContinuationPlaceholder = ::String.new.extend ListContinuationMarker
+
+  ListContinuationString = (::String.new LIST_CONTINUATION).extend ListContinuationMarker
+
   # Internal: A Hash mapping horizontal alignment abbreviations to alignments
   # that can be applied to a table cell (or to all cells in a column)
   TableCellHorzAlignments = {
@@ -1420,17 +1426,18 @@ class Parser
       # the termination of the list
       break if is_sibling_list_item?(this_line, list_type, sibling_trait)
 
+      this_line = ListContinuationString if this_line == LIST_CONTINUATION
       prev_line = buffer.empty? ? nil : buffer[-1]
 
-      if prev_line == LIST_CONTINUATION
+      if ListContinuationMarker === prev_line
         if continuation == :inactive
           continuation = :active
           has_text = true
-          buffer[-1] = '' unless within_nested_list
+          buffer[-1] = ListContinuationPlaceholder unless within_nested_list
         end
 
         # dealing with adjacent list continuations (which is really a syntax error)
-        if this_line == LIST_CONTINUATION
+        if ListContinuationMarker === this_line
           if continuation != :frozen
             continuation = :frozen
             buffer << this_line
@@ -1489,7 +1496,7 @@ class Parser
             (ch0 == '[' && (BlockAttributeLineRx.match? this_line)) || (ch0 == ':' && (AttributeEntryRx.match? this_line))
           buffer << this_line
         else
-          if (nested_list_type = (within_nested_list ? [:dlist] : NESTABLE_LIST_CONTEXTS).find {|ctx| ListRxMap[ctx].match? this_line })
+          if (nested_list_type = (within_nested_list ? [:dlist] : NESTABLE_LIST_CONTEXTS).find {|ctx| ListRxMap[ctx] =~ this_line })
             within_nested_list = true
             if nested_list_type == :dlist && $3.nil_or_empty?
               # get greedy again
@@ -1510,7 +1517,7 @@ class Parser
 
         if this_line == LIST_CONTINUATION
           detached_continuation = buffer.size
-          buffer << this_line
+          buffer << ListContinuationString
         elsif has_text # has_text only relevant for dlist, which is more greedy until it has text for an item; has_text is always true for all other lists
           # in this block, we have to see whether we stay in the list
           # TODO any way to combine this with the check after skipping blank lines?
@@ -1543,6 +1550,9 @@ class Parser
           buffer << this_line
           has_text = true
         end
+      elsif ListContinuationMarker === this_line
+        has_text = true
+        buffer << this_line
       else
         has_text = true unless this_line.empty?
         if (nested_list_type = (within_nested_list ? [:dlist] : NESTABLE_LIST_CONTEXTS).find {|ctx| ListRxMap[ctx] =~ this_line })
@@ -1559,16 +1569,17 @@ class Parser
 
     reader.unshift_line this_line if this_line
 
-    buffer[detached_continuation] = '' if detached_continuation
+    buffer[detached_continuation] = ListContinuationPlaceholder if detached_continuation
 
     until buffer.empty?
+      # drop optional trailing continuation
+      if ListContinuationMarker === (last_line = buffer[-1])
+        buffer.pop
+        break
       # strip trailing blank lines to prevent empty blocks
-      if (last_line = buffer[-1]).empty?
+      elsif last_line.empty?
         buffer.pop
       else
-        # drop optional trailing continuation
-        # (a blank line would have served the same purpose in the document)
-        buffer.pop if last_line == LIST_CONTINUATION
         break
       end
     end

data/lib/asciidoctor/reader.rb

@@ -1039,6 +1039,7 @@ class PreprocessorReader < Reader
     # if running in SafeMode::SECURE or greater, don't process this directive
     # however, be friendly and at least make it a link to the source document
     elsif doc.safe >= SafeMode::SECURE
+      expanded_target = %(pass:c[#{expanded_target}]) if expanded_target.include? ' '
       # FIXME we don't want to use a link macro if we are in a verbatim context
       replace_next_line %(link:#{expanded_target}[role=include])
     elsif @maxdepth
@@ -1238,7 +1239,10 @@ class PreprocessorReader < Reader
   def resolve_include_path target, attrlist, attributes
     doc = @document
     if (Helpers.uriish? target) || (::String === @dir ? nil : (target = %(#{@dir}/#{target})))
-      return replace_next_line %(link:#{target}[role=include]) unless doc.attr? 'allow-uri-read'
+      unless doc.attr? 'allow-uri-read'
+        target = %(pass:c[#{target}]) if target.include? ' '
+        return replace_next_line %(link:#{target}[role=include])
+      end
       if doc.attr? 'cache-uri'
         # caching requires the open-uri-cached gem to be installed
         # processing will be automatically aborted if these libraries can't be opened

data/lib/asciidoctor/rx.rb

@@ -513,12 +513,12 @@ module Asciidoctor
   #
   #   https://github.com
   #   https://github.com[GitHub]
-  #   <https://github.com>
+  #   <https://github.com> <= angle brackets not included in autolink
   #   link:https://github.com[]
   #   "https://github.com[]"
   #   (https://github.com) <= parenthesis not included in autolink
   #
-  InlineLinkRx = %r((^|link:|#{CG_BLANK}|&lt;|[>\(\)\[\];"'])(\\?(?:https?|file|ftp|irc)://)(?:([^\s\[\]]+)\[(|#{CC_ALL}*?[^\\])\]|([^\s\[\]<]*([^\s,.?!\[\]<\)]))))m
+  InlineLinkRx = %r((^|link:|#{CG_BLANK}|\\?&lt;()|[>\(\)\[\];"'])(\\?(?:https?|file|ftp|irc)://)(?:([^\s\[\]]+)\[(|#{CC_ALL}*?[^\\])\]|\2([^\s]*?)&gt;|([^\s\[\]<]*([^\s,.?!\[\]<\)]))))m
 
   # Match a link or e-mail inline macro.
   #

data/lib/asciidoctor/substitutors.rb

@@ -445,7 +445,14 @@ module Substitutors
           # indexterm:[Tigers,Big cats]
           if (attrlist = normalize_text $2, true, true).include? '='
             if (primary = (attrs = (AttributeList.new attrlist, self).parse)[1])
-              attrs['terms'] = [primary]
+              terms = [primary]
+              if (secondary = attrs[2])
+                terms << secondary
+                if (tertiary = attrs[3])
+                  terms << tertiary
+                end
+              end
+              attrs['terms'] = terms
               if (see_also = attrs['see-also'])
                 attrs['see-also'] = (see_also.include? ',') ? (see_also.split ',').map {|it| it.lstrip } : [see_also]
               end
@@ -524,97 +531,101 @@ module Substitutors
     end
 
     if found_colon && (text.include? '://')
-      # inline urls, target[text] (optionally prefixed with link: and optionally surrounded by <>)
+      # inline urls, target[text] (optionally prefixed with link: or enclosed in <>)
       text = text.gsub InlineLinkRx do
-        if (target = $2 + ($3 || $5)).start_with? RS
-          # honor the escape
-          next ($&.slice 0, (rs_idx = $1.length)) + ($&.slice rs_idx + 1, $&.length)
-        end
-
-        prefix, suffix = $1, ''
-        # NOTE if $4 is set, we're looking at a formal macro (e.g., https://example.org[])
-        if $4
-          prefix = '' if prefix == 'link:'
-          link_text = nil if (link_text = $4).empty?
+        if $2 && !$5
+          # honor the escapes
+          next $&.slice 1, $&.length if $1.start_with? RS
+          next %(#{$1}#{$&.slice $1.length + 1, $&.length}) if $3.start_with? RS
+          target = $3 + $6
+          next $& if target == $3
+          doc.register :links, target
+          link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
+          (Inline.new self, :anchor, link_text, type: :link, target: target, attributes: { 'role' => 'bare' }).convert
         else
-          # invalid macro syntax (link: prefix w/o trailing square brackets or enclosed in double quotes)
-          # FIXME we probably shouldn't even get here when the link: prefix is present; the regex is doing too much
-          case prefix
-          when 'link:', ?", ?'
-            next $&
-          end
-          case $6
-          when ';'
-            if (prefix.start_with? '&lt;') && (target.end_with? '&gt;')
-              # move surrounding <> out of URL
-              prefix = prefix.slice 4, prefix.length
-              target = target.slice 0, target.length - 4
-            elsif (target = target.chop).end_with? ')'
-              # move trailing ); out of URL
-              target = target.chop
-              suffix = ');'
-            else
-              # move trailing ; out of URL
-              suffix = ';'
+          # honor the escape
+          next %(#{$1}#{$&.slice $1.length + 1, $&.length}) if $3.start_with? RS
+          prefix, target, suffix = $1, $3 + ($4 || $7), ''
+          # NOTE if $5 is set (the attrlist), we're looking at a formal macro (e.g., https://example.org[])
+          if $5
+            prefix = '' if prefix == 'link:'
+            link_text = nil if (link_text = $5).empty?
+          else
+            case prefix
+            # invalid macro syntax (link: prefix w/o trailing square brackets or URL enclosed in quotes)
+            # FIXME we probably shouldn't even get here when the link: prefix is present; the regex is doing too much
+            when 'link:', ?", ?'
+              next $&
             end
-            # NOTE handle case when modified target is a URI scheme (e.g., http://)
-            next $& if target.end_with? '://'
-          when ':'
-            if (target = target.chop).end_with? ')'
-              # move trailing ): out of URL
-              target = target.chop
-              suffix = '):'
-            else
-              # move trailing : out of URL
-              suffix = ':'
+            case $8
+            when ';'
+              if (target = target.chop).end_with? ')'
+                # move trailing ); out of URL
+                target = target.chop
+                suffix = ');'
+              else
+                # move trailing ; out of URL
+                suffix = ';'
+              end
+              # NOTE handle case when modified target is a bare URI scheme (e.g., http://)
+              next $& if target == $3
+            when ':'
+              if (target = target.chop).end_with? ')'
+                # move trailing ): out of URL
+                target = target.chop
+                suffix = '):'
+              else
+                # move trailing : out of URL
+                suffix = ':'
+              end
+              # NOTE handle case when modified target is a bare URI scheme (e.g., http://)
+              next $& if target == $3
             end
-            # NOTE handle case when modified target is a URI scheme (e.g., http://)
-            next $& if target.end_with? '://'
           end
-        end
 
-        attrs, link_opts = nil, { type: :link }
+          link_opts = { type: :link }
 
-        if link_text
-          new_link_text = link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
-          if !doc.compat_mode && (link_text.include? '=')
-            # NOTE if an equals sign (=) is present, extract attributes from link text
-            link_text, attrs = extract_attributes_from_text link_text, ''
-            new_link_text = link_text
-            link_opts[:id] = attrs['id']
-          end
+          if link_text
+            new_link_text = link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
+            if !doc.compat_mode && (link_text.include? '=')
+              # NOTE if an equals sign (=) is present, extract attributes from link text
+              link_text, attrs = extract_attributes_from_text link_text, ''
+              new_link_text = link_text
+              link_opts[:id] = attrs['id']
+            end
 
-          if link_text.end_with? '^'
-            new_link_text = link_text = link_text.chop
-            if attrs
-              attrs['window'] ||= '_blank'
-            else
-              attrs = { 'window' => '_blank' }
+            if link_text.end_with? '^'
+              new_link_text = link_text = link_text.chop
+              if attrs
+                attrs['window'] ||= '_blank'
+              else
+                attrs = { 'window' => '_blank' }
+              end
             end
-          end
 
-          if new_link_text && new_link_text.empty?
-            # NOTE it's not possible for the URI scheme to be bare in this case
+            if new_link_text && new_link_text.empty?
+              # NOTE the modified target will not be a bare URI scheme (e.g., http://) in this case
+              link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
+              bare = true
+            end
+          else
+            # NOTE the modified target will not be a bare URI scheme (e.g., http://) in this case
             link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
             bare = true
           end
-        else
-          # NOTE it's not possible for the URI scheme to be bare in this case
-          link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
-          bare = true
-        end
 
-        if bare
-          if attrs
-            attrs['role'] = (attrs.key? 'role') ? %(bare #{attrs['role']}) : 'bare'
-          else
-            attrs = { 'role' => 'bare' }
+          if bare
+            if attrs
+              attrs['role'] = (attrs.key? 'role') ? %(bare #{attrs['role']}) : 'bare'
+            else
+              attrs = { 'role' => 'bare' }
+            end
           end
-        end
 
-        doc.register :links, (link_opts[:target] = target)
-        link_opts[:attributes] = attrs if attrs
-        %(#{prefix}#{(Inline.new self, :anchor, link_text, link_opts).convert}#{suffix})
+          doc.register :links, (link_opts[:target] = target)
+          link_opts[:attributes] = attrs if attrs
+          %(#{prefix}#{(Inline.new self, :anchor, link_text, link_opts).convert}#{suffix})
+        end
       end
     end
 

data/lib/asciidoctor/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Asciidoctor
-  VERSION = '2.0.20'
+  VERSION = '2.0.21'
 end

data/lib/asciidoctor.rb

@@ -215,7 +215,7 @@ module Asciidoctor
   URI_READ_MODE = FILE_READ_MODE
 
   # The mode to use when opening a file for writing
-  FILE_WRITE_MODE = RUBY_ENGINE_OPAL ? 'w' : 'w:utf-8'
+  FILE_WRITE_MODE = RUBY_ENGINE_OPAL ? 'w' : 'wb:utf-8'
 
   # The default document type
   # Can influence markup generated by the converters

data/man/asciidoctor.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: asciidoctor
 .\"    Author: Dan Allen, Sarah White
-.\" Generator: Asciidoctor 2.0.19
+.\" Generator: Asciidoctor 2.0.20
 .\"      Date: 2018-03-20
 .\"    Manual: Asciidoctor Manual
-.\"    Source: Asciidoctor 2.0.20
+.\"    Source: Asciidoctor 2.0.21
 .\"  Language: English
 .\"
-.TH "ASCIIDOCTOR" "1" "2018-03-20" "Asciidoctor 2.0.20" "Asciidoctor Manual"
+.TH "ASCIIDOCTOR" "1" "2018-03-20" "Asciidoctor 2.0.21" "Asciidoctor Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0

data/man/asciidoctor.adoc

@@ -1,7 +1,7 @@
 = asciidoctor(1)
 Dan Allen; Sarah White
 :doctype: manpage
-:release-version: 2.0.20
+:release-version: 2.0.21
 :man manual: Asciidoctor Manual
 :man source: Asciidoctor {release-version}
 ifdef::backend-manpage[:!author:]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor
 version: !ruby/object:Gem::Version
-  version: 2.0.20
+  version: 2.0.21
 platform: ruby
 authors:
 - Dan Allen
@@ -272,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: An implementation of the AsciiDoc text processor and publishing toolchain