asciidoctor 2.0.0.rc.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c6f979786009b69e2cc868e90f1b97a7a62cf7906b6071bba4f7de471230df4
-  data.tar.gz: b117e749de44c5f099b1f40967165cd6c9792e895ca31fa51b654d87c4c7811f
+  metadata.gz: '09c8776c68c1c086a0d17e7597f8e5cd2a4ef27a2b57545a0d82bb7520747c8d'
+  data.tar.gz: 6fa042782d5c3a6e446ce1b3b5a25557055d74248ca618f3bed651d5d6f7535e
 SHA512:
-  metadata.gz: 0a04640a9791301a5007acfcb70c3ed8daaeef605ed1c7e315ee85ba5bca717d7df52dec82870a73aa2d5d84fc6d30d0abe7f9146592b089d2c41bb21e81fe4a
-  data.tar.gz: 7b7ed4a9107ee200c447c69452b371049d6ea12cd36b2c4b29e3bab752ed2e1f1db24ec741971840a2bb4d2463da5802013f073bbd8ebea2a0885d8fe07f4edb
+  metadata.gz: 82e97c50b8ecc3cb09e2aa966e41acc3d714dd8fad4654ab68eadd5e339febdcd680fdb3fba77bb11583eb419120fb6429bcd9d21299ecb4e6f7ff102bda48d3
+  data.tar.gz: 2c96408f4c51935b2b9d413184358d58a55e528675442167a13e879d5a4506ab29fb628c65c63b616333d555f41a54d1da761889afbba64f563a623d3b2b4446

data/CHANGELOG.adoc

@@ -13,7 +13,7 @@ endif::[]
 This document provides a high-level view of the changes introduced in Asciidoctor by release.
 For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
 
-== 2.0.0.rc.3 (2019-03-21) - @mojavelinux
+== 2.0.0 (2019-03-22) - @mojavelinux
 
 Enhancements / Compliance::
 
@@ -44,11 +44,14 @@ Enhancements / Compliance::
   * use value of prettify-theme attribute as is if it starts with http:// or https:// (#3020)
   * allow icontype to be set using icons attribute (#2953)
   * when using a server-side syntax highlighter, highlight content of source block even if source language is not set (#3027)
+  * automatically promote a listing block without an explicit style to a source block if language is set (#1117)
   * remove the 2-character (i.e., `""`) quote block syntax
   * don't allow block role to inherit from document attribute; only look for role in block attributes (#1944)
   * split out functionality of -w CLI flag (script warnings) from -v CLI flag (verbose logging) (#3030)
   * log possible invalid references at info level (#3030)
   * log dropped lines at info level when attribute-missing=drop-line (#2861)
+  * honor attribute-missing setting when processing include directives and block macros (#2855)
+  * log warning when include directive is not resolved due to missing attribute or blank target; always include warning in output document (#2868)
   * use the third argument of AbstractNode#attr / AbstractNode#attr? to set the name of a fallback attribute to look for on the document (#1934)
   * change default value of third argument to Abstractnode#attr / AbstractNode#attr? to nil so attribute doesn't inherit by default (#3059)
   * look for table-frame, table-grid, and table-stripes attributes on document as fallback for frame, grid, and stripes attributes on table (#3059)
@@ -79,12 +82,18 @@ Enhancements / Compliance::
   * rename header_footer option to standalone (while still honoring header_footer for backwards compatibility) (#1444)
   * replace anchors and xrefs before footnotes (replace footnotes last in macros substitution group)
   * apply substitution for custom inline macro before all other macros
-  * drop indexterms table from document catalog (in preparation for solution to #450 in a 2.x release)
+  * only promote index terms automatically (A, B, C becomes A > B > C + B > C + C) if indexterm-promotion option is set on document (#1487)
+  * add support for see and see-also on index terms; parse attributes on indexterm macros if text contains `=` (#2047)
+  * drop :indexterms table from document catalog (in preparation for solution to #450 in a 2.x release)
   * load additional languages for highlight.js as defined in the comma-separated highlightjs-languages attribute (#3036)
   * log warning if conditional expression in ifeval directive is invalid (#3161)
   * drop lines that contain an invalid preprocessor directive (#3161)
   * rename AbstractBlock#find_by directives; use :prune in place of :skip_children and :reject in place of :skip
   * convert example block into details/summary tag set if collapsible option is set; open by default if open option is set (#1699)
+  * substitute replacements in author values used in document header (#2441)
+  * require space after semi-colon that separates multiple authors (#2441)
+  * catalog inline anchors at start of callout list items (#2818) (*@owenh000*)
+  * add parse_attributes helper method to base extension Processor class (#2134)
 
 Improvements::
 
@@ -107,8 +116,6 @@ Improvements::
   * never mutate strings; add a `frozen_string_literal: true` magic comment to top of all Ruby source files (#3054)
   * always use docdate and doctime to compute docyear and docdatetime (#3064)
   * rename PreprocessorReader#exceeded_max_depth? to PreprocessorReader#exceeds_max_depth? and return nil if includes are disabled
-  * log warning when include directive is not resolved due to missing attribute or blank target; always include warning in output (#2868)
-  * honor attribute-missing setting when processing include directives and block macros (#2855)
   * stop populating :ids table in document catalog (#3084)
   * always use :refs table in document catalog to look for registered IDs (#3084)
   * don't compute and store reference text in document catalog (#3084)
@@ -123,6 +130,8 @@ Improvements::
   * truncate with precision (instead of rounding) when computing absolute width for columns in DocBook output (#3131)
   * drop legacy LaTeX math delimiters (e.g, `$..$`) if present (#1339)
   * use proper terminology in warning message about mismatched preprocessor directive (#3165)
+  * rename low-level extension attribute name :pos_attrs to :positional_attrs
+  * mark default_attrs extension DSL method deprecated in favor of default_attributes
   * upgrade MathJax to 2.7.5
 
 Bug Fixes::

data/README-de.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
-v2.0.0.rc.3, 2019-03-21
+v2.0.0, 2019-03-22
 // settings:
 :idprefix:
 :idseparator: -
@@ -17,7 +17,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.0.rc.3
+:release-version: 2.0.0
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor
@@ -136,6 +136,7 @@ Asciidoctor arbeitet unter Linux, MacOS und Windows und benötigt eine der folge
 
 * CRuby (aka MRI) 2.3 - 2.6
 * JRuby 9.1 - 9.2
+* TruffleRuby (GraalVM)
 * Opal (JavaScript)
 
 [CAUTION]

data/README-fr.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
-v2.0.0.rc.3, 2019-03-21
+v2.0.0, 2019-03-22
 // settings:
 :idprefix:
 :idseparator: -
@@ -17,7 +17,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.0.rc.3
+:release-version: 2.0.0
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor
@@ -133,6 +133,7 @@ Asciidoctor fonctionne sur Linux, macOS et Windows et requiert une des implémen
 
 * CRuby (aka MRI) 2.3 - 2.6
 * JRuby 9.1 - 9.2
+* TruffleRuby (GraalVM)
 * Opal (JavaScript)
 
 [CAUTION]

data/README-jp.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
-v2.0.0.rc.3, 2019-03-21
+v2.0.0, 2019-03-22
 // settings:
 :page-layout: base
 :idprefix:
@@ -18,7 +18,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.0.rc.3
+:release-version: 2.0.0
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor
@@ -123,6 +123,7 @@ AsciidoctorはLinux, OS X (Mac)とWindowsで動き, 下記の {uri-ruby}[Ruby]
 
 * CRuby (aka MRI) 2.3 - 2.6
 * JRuby 9.1 - 9.2
+* TruffleRuby (GraalVM)
 * Opal (JavaScript)
 
 [CAUTION]

data/README-zh_CN.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
-v2.0.0.rc.3, 2019-03-21
+v2.0.0, 2019-03-22
 // settings:
 :page-layout: base
 :idprefix:
@@ -18,7 +18,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.0.rc.3
+:release-version: 2.0.0
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor
@@ -125,6 +125,7 @@ Asciidoctor 可以运行在 Linux，OSX (Mac) 和 Windows 系统，但需要安
 
 * CRuby (aka MRI) 2.3 - 2.6
 * JRuby 9.1 - 9.2
+* TruffleRuby (GraalVM)
 * Opal (JavaScript)
 
 我们欢迎你来帮助在这些以及其他平台测试 Asciidoctor。

data/README.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
-v2.0.0.rc.3, 2019-03-21
+v2.0.0, 2019-03-22
 // settings:
 :idprefix:
 :idseparator: -
@@ -17,7 +17,7 @@ ifdef::env-github[]
 :warning-caption: :warning:
 endif::[]
 // Variables:
-:release-version: 2.0.0.rc.3
+:release-version: 2.0.0
 // URIs:
 :uri-org: https://github.com/asciidoctor
 :uri-repo: {uri-org}/asciidoctor
@@ -141,6 +141,7 @@ Asciidoctor works on Linux, macOS and Windows and requires one of the following
 
 * CRuby (aka MRI) 2.3 - 2.6
 * JRuby 9.1 - 9.2
+* TruffleRuby (GraalVM)
 * Opal (JavaScript)
 
 [CAUTION]

data/data/locale/attributes-de.adoc

@@ -8,15 +8,16 @@
 :figure-caption: Abbildung
 :important-caption: Wichtig
 :last-update-label: Zuletzt aktualisiert
-//ifdef::listing-caption[:listing-caption: ???]
+ifdef::listing-caption[:listing-caption: Listing]
 ifdef::manname-title[:manname-title: Bezeichnung]
 :note-caption: Anmerkung
-//:part-refsig: ???
+:part-label: Teil
+:part-refsig: {part-label}
 ifdef::preface-title[:preface-title: Vorwort]
 :section-refsig: Abschnitt
 :table-caption: Tabelle
 :tip-caption: Hinweis
-:toc-title: Inhalt
+:toc-title: Inhaltsverzeichnis
 :untitled-label: Ohne Titel
 :version-label: Version
 :warning-caption: Warnung

data/data/reference/syntax.adoc

@@ -131,7 +131,7 @@ Attach a block or paragraph to a list item using a list continuation (which you
 === Callout
 
 // enable callout bubbles by adding `:icons: font` to the document header
-[source,ruby]
+[,ruby]
 ----
 puts 'Hello, World!' # <1>
 ----
@@ -188,6 +188,12 @@ admonition - a notice for the reader, ranging in severity from a tip to an alert
 example - a demonstration of the concept being documented
 ====
 
+.Toggle Me
+[%collapsible]
+====
+collapsible - these details are revealed by clicking the title
+====
+
 ****
 sidebar - auxiliary content that can be read independently of the main content
 ****
@@ -200,7 +206,7 @@ literal - an exhibit that features program output
 listing - an exhibit that features program input, source code, or the contents of a file
 ----
 
-[source,language]
+[,language]
 ----
 source - a listing that is embellished with (colorized) syntax highlighting
 ----

data/lib/asciidoctor.rb

@@ -142,7 +142,9 @@ module Asciidoctor
     define :unwrap_standalone_preamble, true
 
     # AsciiDoc drops lines that contain references to missing attributes.
-    # This behavior is not intuitive to most writers
+    # This behavior is not intuitive to most writers.
+    # Asciidoctor allows this behavior to be configured.
+    # Possible options are 'skip', 'drop', 'drop-line', and 'warn'.
     # Compliance value: 'drop-line'
     define :attribute_missing, 'skip'
 
@@ -396,6 +398,14 @@ module Asciidoctor
     #
     AuthorInfoLineRx = /^(#{CG_WORD}[#{CC_WORD}\-'.]*)(?: +(#{CG_WORD}[#{CC_WORD}\-'.]*))?(?: +(#{CG_WORD}[#{CC_WORD}\-'.]*))?(?: +<([^>]+)>)?$/
 
+    # Matches the delimiter that separates multiple authors.
+    #
+    # Examples
+    #
+    #   Doc Writer; Junior Writer
+    #
+    AuthorDelimiterRx = /;(?: |$)/
+
     # Matches the revision info line, which appears immediately following
     # the author info line beneath the document title.
     #

data/lib/asciidoctor/abstract_node.rb

@@ -174,12 +174,11 @@ class AbstractNode
   # If an attribute already exists with the same key, it's value will
   # be overwritten.
   #
-  # attributes - A Hash of attributes to assign to this node.
+  # new_attributes - A Hash of additional attributes to assign to this node.
   #
-  # Returns nothing
-  def update_attributes(attributes)
-    @attributes.update(attributes)
-    nil
+  # Returns the updated attributes [Hash] on this node.
+  def update_attributes new_attributes
+    @attributes.update new_attributes
   end
 
   # Public: Retrieves the space-separated String role for this node.

data/lib/asciidoctor/attribute_list.rb

@@ -4,7 +4,7 @@ module Asciidoctor
 # pairs. By default, attributes must each be separated by a comma and quotes
 # may be used around the value. If a key is not detected, the value is assigned
 # to a 1-based positional key, The positional attributes can be "rekeyed" when
-# given a posattrs array either during parsing or after the fact.
+# given a positional_attrs array either during parsing or after the fact.
 #
 # Examples
 #
@@ -56,11 +56,11 @@ class AttributeList
     @attributes = nil
   end
 
-  def parse_into attributes, posattrs = []
-    attributes.update(parse posattrs)
+  def parse_into attributes, positional_attrs = []
+    attributes.update parse positional_attrs
   end
 
-  def parse posattrs = []
+  def parse positional_attrs = []
     # return if already parsed
     return @attributes if @attributes
 
@@ -69,7 +69,7 @@ class AttributeList
     #attributes[0] = @scanner.string
     index = 0
 
-    while parse_attribute index, posattrs
+    while parse_attribute index, positional_attrs
       break if @scanner.eos?
       skip_delimiter
       index += 1
@@ -78,25 +78,25 @@ class AttributeList
     @attributes
   end
 
-  def rekey posattrs
-    AttributeList.rekey @attributes, posattrs
+  def rekey positional_attrs
+    AttributeList.rekey @attributes, positional_attrs
   end
 
-  def self.rekey attributes, pos_attrs
-    pos_attrs.each_with_index do |key, index|
-      next unless key
-      if (val = attributes[index + 1])
+  def self.rekey attributes, positional_attrs
+    index = 0
+    positional_attrs.each do |key|
+      index += 1
+      if (val = attributes[index])
         # QUESTION should we delete the positional key?
         attributes[key] = val
-      end
+      end if key
     end
-
     attributes
   end
 
   private
 
-  def parse_attribute index = 0, pos_attrs = []
+  def parse_attribute index = 0, positional_attrs = []
     single_quoted_value = false
     skip_blank
     # example: "quote"
@@ -174,8 +174,8 @@ class AttributeList
       end
     else
       resolved_name = single_quoted_value && @block ? (@block.apply_subs name) : name
-      if (pos_name = pos_attrs[index])
-        @attributes[pos_name] = resolved_name
+      if (positional_attr_name = positional_attrs[index])
+        @attributes[positional_attr_name] = resolved_name
       end
       # QUESTION should we always assign the positional key?
       @attributes[index + 1] = resolved_name

data/lib/asciidoctor/converter/docbook5.rb

@@ -538,25 +538,40 @@ class Converter::DocBook5Converter < Converter::Base
   end
 
   def convert_inline_indexterm node
+    if (see = node.attr 'see')
+      rel = %(\n<see>#{see}</see>)
+    elsif (see_also_list = node.attr 'see-also')
+      rel = see_also_list.map {|see_also| %(\n<seealso>#{see_also}</seealso>) }.join
+    else
+      rel = ''
+    end
     if node.type == :visible
-      %(<indexterm><primary>#{node.text}</primary></indexterm>#{node.text})
+      %(<indexterm>
+<primary>#{node.text}</primary>#{rel}
+</indexterm>#{node.text})
     else
-      terms = node.attr 'terms'
-      result = []
-      if (numterms = terms.size) > 2
-        result << %(<indexterm>
-<primary>#{terms[0]}</primary><secondary>#{terms[1]}</secondary><tertiary>#{terms[2]}</tertiary>
-</indexterm>)
-      end
-      if numterms > 1
-        result << %(<indexterm>
-<primary>#{terms[-2]}</primary><secondary>#{terms[-1]}</secondary>
+      if (numterms = (terms = node.attr 'terms').size) > 2
+        %(<indexterm>
+<primary>#{terms[0]}</primary><secondary>#{terms[1]}</secondary><tertiary>#{terms[2]}</tertiary>#{rel}
+</indexterm>#{(node.document.option? 'indexterm-promotion') ? %[
+<indexterm>
+<primary>#{terms[1]}</primary><secondary>#{terms[2]}</secondary>
+</indexterm>
+<indexterm>
+<primary>#{terms[2]}</primary>
+</indexterm>] : ''})
+      elsif numterms > 1
+        %(<indexterm>
+<primary>#{terms[0]}</primary><secondary>#{terms[1]}</secondary>#{rel}
+</indexterm>#{(node.document.option?  'indexterm-promotion') ? %[
+<indexterm>
+<primary>#{terms[1]}</primary>
+</indexterm>] : ''})
+      else
+        %(<indexterm>
+<primary>#{terms[0]}</primary>#{rel}
 </indexterm>)
       end
-      result << %(<indexterm>
-<primary>#{terms[-1]}</primary>
-</indexterm>)
-      result.join LF
     end
   end
 
@@ -626,13 +641,13 @@ class Converter::DocBook5Converter < Converter::Base
     end
   end
 
-  def author_tag author
+  def author_tag doc, author
     result = []
     result << '<author>'
     result << '<personname>'
-    result << %(<firstname>#{author.firstname}</firstname>) if author.firstname
-    result << %(<othername>#{author.middlename}</othername>) if author.middlename
-    result << %(<surname>#{author.lastname}</surname>) if author.lastname
+    result << %(<firstname>#{doc.sub_replacements author.firstname}</firstname>) if author.firstname
+    result << %(<othername>#{doc.sub_replacements author.middlename}</othername>) if author.middlename
+    result << %(<surname>#{doc.sub_replacements author.lastname}</surname>) if author.lastname
     result << '</personname>'
     result << %(<email>#{author.email}</email>) if author.email
     result << '</author>'
@@ -663,10 +678,10 @@ class Converter::DocBook5Converter < Converter::Base
       unless (authors = doc.authors).empty?
         if authors.size > 1
           result << '<authorgroup>'
-          authors.each {|author| result << (author_tag author) }
+          authors.each {|author| result << (author_tag doc, author) }
           result << '</authorgroup>'
         else
-          result << author_tag(author = authors[0])
+          result << (author_tag doc, (author = authors[0]))
           result << %(<authorinitials>#{author.initials}</authorinitials>) if author.initials
         end
       end