asciidoctor 2.0.12 → 2.0.13

data/asciidoctor.gemspec

@@ -34,21 +34,21 @@ Gem::Specification.new do |s|
   #s.test_files = files.grep %r/^(?:features|test)\/.+$/
 
   # asciimath is needed for testing AsciiMath in DocBook backend
-  s.add_development_dependency 'asciimath', '~> 1.0.0'
+  s.add_development_dependency 'asciimath', '~> 2.0.0'
   # coderay is needed for testing syntax highlighting
   s.add_development_dependency 'coderay', '~> 1.1.0'
   # concurrent-ruby, haml, slim, and tilt are needed for testing custom templates
   s.add_development_dependency 'concurrent-ruby', '~> 1.1.0'
   s.add_development_dependency 'cucumber', '~> 3.1.0'
   # erubi is needed for testing alternate eRuby impls
-  s.add_development_dependency 'erubi', '~> 1.9.0'
-  s.add_development_dependency 'haml', '~> 5.0.0'
+  s.add_development_dependency 'erubi', '~> 1.10.0'
+  s.add_development_dependency 'haml', '~> 5.2.0'
   s.add_development_dependency 'minitest', '~> 5.11.0'
   s.add_development_dependency 'nokogiri', '~> 1.10.0'
   s.add_development_dependency 'rake', '~> 12.3.0'
   # Asciidoctor supports Rouge >= 2
-  s.add_development_dependency 'rouge', '~> 3.15.0'
+  s.add_development_dependency 'rouge', '~> 3.26.0'
   s.add_development_dependency 'rspec-expectations', '~> 3.8.0'
-  s.add_development_dependency 'slim', '~> 4.0.0'
+  s.add_development_dependency 'slim', '~> 4.1.0'
   s.add_development_dependency 'tilt', '~> 2.0.0'
 end

data/data/locale/attributes-be.adoc

@@ -0,0 +1,23 @@
+// Belarusian translation, courtesy of Dexter Morganov <dexter.morganov@gmail.com>
+:appendix-caption: Дадатак
+:appendix-refsig: {appendix-caption}
+:caution-caption: Увага
+:chapter-signifier: Глава
+:chapter-refsig: {chapter-signifier}
+:example-caption: Прыклад
+:figure-caption: Малюнак
+:important-caption: Важна
+:last-update-label: Апошняе абнаўленне
+ifdef::listing-caption[:listing-caption: Лістынг]
+ifdef::manname-title[:manname-title: Назва]
+:note-caption: Заўвага
+:part-signifier: Частка
+:part-refsig: {part-signifier}
+ifdef::preface-title[:preface-title: Прадмова]
+:section-refsig: Раздзел
+:table-caption: Табліца
+:tip-caption: Падказка
+:toc-title: Змест
+:untitled-label: Без назвы
+:version-label: Версія
+:warning-caption: Папярэджанне

data/data/locale/attributes-it.adoc

@@ -1,4 +1,4 @@
-// Italian translation, courtesy of Marco Ciampa <ciampix@libero.it>
+// Italian translation, courtesy of Marco Ciampa <ciampix@posteo.net>
 :appendix-caption: Appendice
 :appendix-refsig: {appendix-caption}
 :caution-caption: Attenzione
@@ -11,10 +11,10 @@
 ifdef::listing-caption[:listing-caption: Elenco]
 ifdef::manname-title[:manname-title: Nome]
 :note-caption: Nota
-//:part-signifier: ???
-//:part-refsig: {part-signifier}
+:part-signifier: Parte
+:part-refsig: {part-signifier}
 ifdef::preface-title[:preface-title: Prefazione]
-//:section-refsig: ???
+:section-refsig: Sezione
 :table-caption: Tabella
 :tip-caption: Suggerimento
 :toc-title: Indice

data/data/locale/attributes-nl.adoc

@@ -2,8 +2,8 @@
 :appendix-caption: Bijlage
 :appendix-refsig: {appendix-caption}
 :caution-caption: Opgelet
-//:chapter-signifier: Hoofdstuk
-//:chapter-refsig: {chapter-signifier}
+:chapter-signifier: Hoofdstuk
+:chapter-refsig: {chapter-signifier}
 :example-caption: Voorbeeld
 :figure-caption: Figuur
 :important-caption: Belangrijk
@@ -11,13 +11,13 @@
 ifdef::listing-caption[:listing-caption: Lijst]
 ifdef::manname-title[:manname-title: Naam]
 :note-caption: Noot
-//:part-signifier: ???
-//:part-refsig: {part-signifier}
+:part-signifier: Deel
+:part-refsig: {part-signifier}
 ifdef::preface-title[:preface-title: Inleiding]
-//:section-refsig: ???
+:section-refsig: Paragraaf
 :table-caption: Tabel
 :tip-caption: Tip
-:toc-title: Ínhoudsopgave
+:toc-title: Inhoudsopgave
 :untitled-label: Naamloos
 :version-label: Versie
 :warning-caption: Waarschuwing

data/data/reference/syntax.adoc

@@ -17,7 +17,7 @@ Line breaks are not preserved.
 A blank line separates paragraphs.
 
 [%hardbreaks]
-This paragraph carries the `hardbreaks` option.
+This paragraph is marked with the `hardbreaks` option.
 Notice how line breaks are now preserved.
 
  An indented (literal) paragraph disables text formatting,
@@ -25,14 +25,14 @@ Notice how line breaks are now preserved.
  monospaced font.
 
 [sidebar#id.role]
-A style, ID, and/or role gives a paragraph (or block) special meaning, like this sidebar.
+Adding a style, ID, and/or role gives a paragraph (or block) special meaning, like this sidebar.
 
 NOTE: An admonition paragraph, like this note, grabs the reader's attention.
 
 TIP: Convert this document using the `asciidoctor` command to see the output produced from it.
 
 == Text Formatting
-:hardbreaks:
+:hardbreaks-option:
 
 .Constrained (applied at word boundaries)
 *strong importance* (aka bold)
@@ -41,17 +41,24 @@ _stress emphasis_ (aka italic)
 "`double`" and '`single`' typographic quotes
 +passthrough text+ (substitutions disabled)
 `+literal text+` (monospaced with substitutions disabled)
+a #mark# to remember (highlighted for notation)
 
 .Unconstrained (applied anywhere)
-**C**reate+**R**ead+**U**pdate+**D**elete
+**C**reate, **R**ead, **U**pdate, and **D**elete (CRUD)
 fan__freakin__tastic
 ``mono``culture
+##mark##up your text
 
 .Replacements
 A long time ago in a galaxy far, far away...
 (C) 1976 Arty Artisan
 I believe I shall--no, actually I won't.
 
+.ID and roles for phrases
+[.line-through]#delete me#
+the [.path]_images_ directory
+a [#wibble.term]*wibble* does wobble
+
 .Macros
 // where c=specialchars, q=quotes, a=attributes, r=replacements, m=macros, p=post_replacements, etc.
 The European icon:flag[role=blue] is blue & contains pass:[************] arranged in a icon:circle-o[role=yellow].
@@ -60,7 +67,7 @@ Since `pass:[++]` has strong priority in AsciiDoc, you can rewrite pass:c,a,r[C+
 // activate stem support by adding `:stem:` to the document header
 stem:[sqrt(4) = 2]
 
-:!hardbreaks:
+:!hardbreaks-option:
 == Attributes
 
  // define attributes in the document header; must be flush with left margin
@@ -242,7 +249,7 @@ comment - content which is not included in the output document
 == Tables
 
 .Table Attributes
-[cols=>1h;2d,width=50%,frame=topbot]
+[cols=>1h;2d,width=50%,frame=ends]
 |===
 | Attribute Name | Values
 
@@ -256,7 +263,7 @@ comment - content which is not included in the output document
 | all \| cols \| rows \| none
 
 | frame
-| all \| sides \| topbot \| none
+| all \| sides \| ends \| none
 
 | stripes
 | all \| even \| odd \| none

data/data/stylesheets/asciidoctor-default.css

@@ -84,9 +84,6 @@ dl dd{margin-bottom:1.25em}
 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
 abbr{text-transform:none}
 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
-blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
-blockquote cite::before{content:"\2014 \0020"}
-blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 h1{font-size:2.75em}
@@ -251,7 +248,7 @@ pre.pygments .lineno::before{content:"";margin-right:-.125em}
 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
-.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0}
+.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
 p.tableblock:last-child{margin-bottom:0}
 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
 td.tableblock>.content>:last-child{margin-bottom:-1.25em}

data/lib/asciidoctor.rb

@@ -136,8 +136,8 @@ module Asciidoctor
     # Compliance value: true
     define :underline_style_section_titles, true
 
-    # Asciidoctor will unwrap the content in a preamble
-    # if the document has a title and no sections.
+    # Asciidoctor will unwrap the content in a preamble if the document has a
+    # title and no sections, then discard the empty preamble.
     # Compliance value: false
     define :unwrap_standalone_preamble, true
 

data/lib/asciidoctor/abstract_node.rb

@@ -216,7 +216,7 @@ class AbstractNode
     (val = @attributes['role']) ? (%( #{val} ).include? %( #{name} )) : false
   end
 
-  # Public: Sets the value of the role attribute on this ndoe.
+  # Public: Sets the value of the role attribute on this node.
   #
   # names - A single role name, a space-separated String of role names, or an Array of role names
   #

data/lib/asciidoctor/attribute_list.rb

@@ -27,7 +27,7 @@ class AttributeList
   QUOT = '"'
 
   # Public: Regular expressions for detecting the boundary of a value
-  BoundaryRxs = {
+  BoundaryRx = {
     QUOT => /.*?[^\\](?=")/,
     APOS => /.*?[^\\](?=')/,
     ',' => /.*?(?=[ \t]*(,|$))/
@@ -46,7 +46,7 @@ class AttributeList
   BlankRx = /[ \t]+/
 
   # Public: Regular expressions for skipping delimiters
-  SkipRxs = {
+  SkipRx = {
     ',' => /[ \t]*(,|$)/
   }
 
@@ -54,8 +54,8 @@ class AttributeList
     @scanner = ::StringScanner.new source
     @block = block
     @delimiter = delimiter
-    @delimiter_skip_pattern = SkipRxs[delimiter]
-    @delimiter_boundary_pattern = BoundaryRxs[delimiter]
+    @delimiter_skip_pattern = SkipRx[delimiter]
+    @delimiter_boundary_pattern = BoundaryRx[delimiter]
     @attributes = nil
   end
 
@@ -214,7 +214,7 @@ class AttributeList
   end
 
   def scan_to_quote quote
-    @scanner.scan BoundaryRxs[quote]
+    @scanner.scan BoundaryRx[quote]
   end
 end
 end

data/lib/asciidoctor/cli/options.rb

@@ -39,14 +39,15 @@ module Asciidoctor
           # NOTE don't use squiggly heredoc to maintain compatibility with Ruby < 2.3
           opts.banner = <<-'EOS'.gsub '          ', ''
           Usage: asciidoctor [OPTION]... FILE...
-          Translate the AsciiDoc source FILE or FILE(s) into the backend output format (e.g., HTML 5, DocBook 5, etc.)
-          By default, the output is written to a file with the basename of the source file and the appropriate extension.
-          Example: asciidoctor -b html5 source.asciidoc
+          Convert the AsciiDoc input FILE(s) to the backend output format (e.g., HTML 5, DocBook 5, etc.)
+          Unless specified otherwise, the output is written to a file whose name is derived from the input file.
+          Application log messages are printed to STDERR.
+          Example: asciidoctor input.adoc
 
           EOS
 
-          opts.on('-b', '--backend BACKEND', 'set output format backend: [html5, xhtml5, docbook5, manpage] (default: html5)',
-                  'additional backends are supported via extensions (e.g., pdf, latex)') do |backend|
+          opts.on('-b', '--backend BACKEND', 'set backend output format: [html5, xhtml5, docbook5, manpage] (default: html5)',
+                  'additional backends are supported via extended converters (e.g., pdf, epub3)') do |backend|
             self[:attributes]['backend'] = backend
           end
           opts.on('-d', '--doctype DOCTYPE', ['article', 'book', 'manpage', 'inline'],
@@ -128,7 +129,7 @@ module Asciidoctor
           opts.on('--trace', 'include backtrace information when reporting errors (default: false)') do |trace|
             self[:trace] = true
           end
-          opts.on('-v', '--verbose', 'enable verbose mode (default: false)') do |verbose|
+          opts.on('-v', '--verbose', 'directs application messages logged at DEBUG or INFO level to STDERR (default: false)') do |verbose|
             self[:verbose] = 2
           end
           opts.on('-w', '--warnings', 'turn on script warnings (default: false)') do |warnings|

data/lib/asciidoctor/converter/html5.rb

@@ -1310,7 +1310,7 @@ Your browser does not support the video tag.
     manname_id_attr = (manname_id = node.attr 'manname-id') ? %( id="#{manname_id}") : ''
     %(<h2#{manname_id_attr}>#{manname_title}</h2>
 <div class="sectionbody">
-<p>#{node.attr 'manname'} - #{node.attr 'manpurpose'}</p>
+<p>#{(node.attr 'mannames').join ', '} - #{node.attr 'manpurpose'}</p>
 </div>)
   end
 

data/lib/asciidoctor/converter/manpage.rb

@@ -2,8 +2,12 @@
 module Asciidoctor
 # A built-in {Converter} implementation that generates the man page (troff) format.
 #
-# The output follows the groff man page definition while also trying to be
-# consistent with the output produced by the a2x tool from AsciiDoc Python.
+# 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.
+# That means if you've previously been generating man pages using the a2x tool
+# from AsciiDoc Python, you should be able to achieve a very similar result
+# using this converter. Though you'll also get to enjoy some notable
+# enhancements that have been added since, such as the customizable linkstyle.
 #
 # See http://www.gnu.org/software/groff/manual/html_node/Man-usage.html#Man-usage
 class Converter::ManPageConverter < Converter::Base
@@ -18,10 +22,13 @@ class Converter::ManPageConverter < Converter::Base
   LiteralBackslashRx = /\A\\|(#{ESC})?\\/
   LeadingPeriodRx = /^\./
   EscapedMacroRx = /^(?:#{ESC}\\c\n)?#{ESC}\.((?:URL|MTO) "#{CC_ANY}*?" "#{CC_ANY}*?" )( |[^\s]*)(#{CC_ANY}*?)(?: *#{ESC}\\c)?$/
-  MockBoundaryRx = /<\/?BOUNDARY>/
+  MalformedEscapedMacroRx = /(#{ESC}\\c) (#{ESC}\.(?:URL|MTO) )/
+  MockMacroRx = /<\/?(#{ESC}\\[^>]+)>/
   EmDashCharRefRx = /&#8212;(?:&#8203;)?/
   EllipsisCharRefRx = /&#8230;(?:&#8203;)?/
   WrappedIndentRx = /#{CG_BLANK}*#{LF}#{CG_BLANK}*/
+  XMLMarkupRx = /&#?[a-z\d]+;|</
+  PCDATAFilterRx = /(&#?[a-z\d]+;|<[^>]+>)|([^&<]+)/
 
   def initialize backend, opts = {}
     @backend = backend
@@ -91,17 +98,14 @@ class Converter::ManPageConverter < Converter::Base
       if node.attr? 'manpurpose'
         mannames = node.attr 'mannames', [manname]
         result << %(.SH "#{(node.attr 'manname-title', 'NAME').upcase}"
-#{mannames.map {|n| manify n }.join ', '} \\- #{manify node.attr('manpurpose'), whitespace: :normalize})
+#{mannames.map {|n| (manify n).gsub '\-', '-' }.join ', '} \\- #{manify node.attr('manpurpose'), whitespace: :normalize})
       end
     end
 
     result << node.content
 
     # QUESTION should NOTES come after AUTHOR(S)?
-    if node.footnotes? && !(node.attr? 'nofootnotes')
-      result << '.SH "NOTES"'
-      result.concat(node.footnotes.map {|fn| %(#{fn.index}. #{fn.text}) })
-    end
+    append_footnotes result, node
 
     unless (authors = node.authors).empty?
       if authors.size > 1
@@ -124,10 +128,7 @@ class Converter::ManPageConverter < Converter::Base
   def convert_embedded node
     result = [node.content]
 
-    if node.footnotes? && !(node.attr? 'nofootnotes')
-      result << '.SH "NOTES"'
-      result.concat(node.footnotes.map {|fn| %(#{fn.index}. #{fn.text}) })
-    end
+    append_footnotes result, node
 
     # QUESTION should we add an AUTHOR(S) section?
 
@@ -142,7 +143,7 @@ class Converter::ManPageConverter < Converter::Base
       stitle = node.captioned_title
     else
       macro = 'SH'
-      stitle = node.title.upcase
+      stitle = uppercase_pcdata node.title
     end
     result << %(.#{macro} "#{manify stitle}"
 #{node.content})
@@ -315,8 +316,9 @@ r lw(\n(.lu*75u/100u).'
     end
   end
 
-  # TODO use Page Control https://www.gnu.org/software/groff/manual/html_node/Page-Control.html#Page-Control
-  alias convert_page_break skip
+  def convert_page_break node
+    '.bp'
+  end
 
   def convert_paragraph node
     if node.title?
@@ -531,12 +533,13 @@ allbox tab(:);'
     result.join LF
   end
 
-  # FIXME git uses [verse] for the synopsis; detect this special case
   def convert_verse node
     result = []
-    result << (node.title? ? %(.sp
+    if node.title?
+      result << %(.sp
 .B #{manify node.title}
-.br) : '.sp')
+.br)
+    end
     attribution_line = (node.attr? 'citetitle') ? %(#{node.attr 'citetitle'} ) : nil
     attribution_line = (node.attr? 'attribution') ? %[#{attribution_line}\\(em #{node.attr 'attribution'}] : nil
     result << %(.sp
@@ -609,7 +612,6 @@ allbox tab(:);'
     %(#{ESC_BS}fB(#{node.text})#{ESC_BS}fP)
   end
 
-  # TODO supposedly groff has footnotes, but we're in search of an example
   def convert_inline_footnote node
     if (index = node.attr 'index')
       %([#{index}])
@@ -647,19 +649,19 @@ allbox tab(:);'
     end
   end
 
-  # NOTE use fake <BOUNDARY> element to prevent creating artificial word boundaries
+  # NOTE use fake XML elements to prevent creating artificial word boundaries
   def convert_inline_quoted node
     case node.type
     when :emphasis
-      %(#{ESC_BS}fI<BOUNDARY>#{node.text}</BOUNDARY>#{ESC_BS}fP)
+      %(<#{ESC_BS}fI>#{node.text}</#{ESC_BS}fP>)
     when :strong
-      %(#{ESC_BS}fB<BOUNDARY>#{node.text}</BOUNDARY>#{ESC_BS}fP)
+      %(<#{ESC_BS}fB>#{node.text}</#{ESC_BS}fP>)
     when :monospaced
-      %[#{ESC_BS}f(CR<BOUNDARY>#{node.text}</BOUNDARY>#{ESC_BS}fP]
+      %[<#{ESC_BS}f(CR>#{node.text}</#{ESC_BS}fP>]
     when :single
-      %[#{ESC_BS}(oq<BOUNDARY>#{node.text}</BOUNDARY>#{ESC_BS}(cq]
+      %[<#{ESC_BS}(oq>#{node.text}</#{ESC_BS}(cq>]
     when :double
-      %[#{ESC_BS}(lq<BOUNDARY>#{node.text}</BOUNDARY>#{ESC_BS}(rq]
+      %[<#{ESC_BS}(lq>#{node.text}</#{ESC_BS}(rq>]
     else
       node.text
     end
@@ -678,6 +680,22 @@ allbox tab(:);'
 
   private
 
+  def append_footnotes result, node
+    if node.footnotes? && !(node.attr? 'nofootnotes')
+      result << '.SH "NOTES"'
+      node.footnotes.each_with_index do |fn, idx|
+        result << %(.IP [#{fn.index}])
+        # NOTE restore newline in escaped macro that gets removed by normalize_text in substitutor
+        if (text = fn.text).include? %(#{ESC}\\c #{ESC}.)
+          text = (manify %(#{text.gsub MalformedEscapedMacroRx, %(\\1#{LF}\\2)} ), whitespace: :normalize).chomp ' '
+        else
+          text = manify text, whitespace: :normalize
+        end
+        result << text
+      end
+    end
+  end
+
   # Converts HTML entity references back to their original form, escapes
   # special man characters and strips trailing whitespace.
   #
@@ -704,7 +722,7 @@ allbox tab(:);'
       gsub(EllipsisCharRefRx, '...'). # horizontal ellipsis
       gsub(LeadingPeriodRx, '\\\&.'). # leading . is used in troff for macro call or other formatting; replace with \&.
       # drop orphaned \c escape lines, unescape troff macro, quote adjacent character, isolate macro line
-      gsub(EscapedMacroRx) { (rest = $3.lstrip).empty? ? %(.#$1"#$2") : %(.#$1"#$2"#{LF}#{rest}) }.
+      gsub(EscapedMacroRx) { (rest = $3.lstrip).empty? ? %(.#$1"#$2") : %(.#$1"#{$2.rstrip}"#{LF}#{rest}) }.
       gsub('-', '\-').
       gsub('&lt;', '<').
       gsub('&gt;', '>').
@@ -726,13 +744,17 @@ allbox tab(:);'
       gsub('&#8203;', '\:').    # zero width space
       gsub('&amp;', '&').       # literal ampersand (NOTE must take place after any other replacement that includes &)
       gsub('\'', '\(aq').       # apostrophe-quote
-      gsub(MockBoundaryRx, ''). # mock boundary
+      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
 
+  def uppercase_pcdata string
+    (XMLMarkupRx.match? string) ? string.gsub(PCDATAFilterRx) { $2 ? $2.upcase : $1 } : string.upcase
+  end
+
   def enclose_content node
     node.content_model == :compound ? node.content : %(.sp#{LF}#{manify node.content, whitespace: :normalize})
   end