asciidoctor 1.5.1 → 1.5.2

data/lib/asciidoctor/section.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods for managing sections of AsciiDoc content in a document.
 # The section responds as an Array of content blocks by delegating
@@ -41,14 +42,10 @@ class Section < AbstractBlock
   # parent - The parent Asciidoc Object.
   def initialize parent = nil, level = nil, numbered = true, opts = {}
     super parent, :section, opts
-    if level.nil?
-      if parent
-        @level = parent.level + 1
-      elsif @level.nil?
-        @level = 1
-      end
-    else
+    if level
       @level = level
+    else
+      @level = parent ? (parent.level + 1) : 1
     end
     @numbered = numbered && @level > 0
     @special = parent && parent.context == :section && parent.special
@@ -96,7 +93,7 @@ class Section < AbstractBlock
         base_id = base_id[1..-1] while base_id.start_with?(sep)
       end
       gen_id = base_id
-      cnt = 2
+      cnt = Compliance.unique_id_start_index
       while @document.references[:ids].has_key? gen_id
         gen_id = "#{base_id}#{sep}#{cnt}"
         cnt += 1

data/lib/asciidoctor/stylesheets.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # A utility class for working with the built-in stylesheets.
 #--

data/lib/asciidoctor/substitutors.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods to perform substitutions on lines of AsciiDoc text. This module
 # is intented to be mixed-in to Section and Block to provide operations for performing
@@ -1031,14 +1032,6 @@ module Substitutors
         #else
         #  reftext = "[#{id}]"
         #end
-        if @document.references[:ids].has_key? id
-          # reftext may not match since inline substitutions have been applied
-          #if reftext != @document.references[:ids][id]
-          #  Debug.debug { "Mismatched reference for anchor #{id}" }
-          #end
-        else
-          Debug.debug { "Missing reference for anchor #{id}" }
-        end
         Inline.new(self, :anchor, reftext, :type => :ref, :target => id).convert
       }
     end
@@ -1112,13 +1105,15 @@ module Substitutors
     text
   end
 
-  # Public: Substitute callout references
+  # Public: Substitute callout source references
   #
   # text - The String text to process
   #
   # Returns the converted String text
   def sub_callouts(text)
-    text.gsub(CalloutConvertRx) {
+    # FIXME cache this dynamic regex
+    callout_rx = (attr? 'line-comment') ? /(?:#{::Regexp.escape(attr 'line-comment')} )?#{CalloutSourceRxt}/ : CalloutSourceRx
+    text.gsub(callout_rx) {
       # alias match for Ruby 1.8.7 compat
       m = $~
       # honor the escape
@@ -1396,22 +1391,24 @@ module Substitutors
   # incorrectly processed by the source highlighter.
   #
   # source - the source code String to highlight
-  # sub_callouts - a Boolean flag indicating whether callout marks should be substituted
+  # process_callouts - a Boolean flag indicating whether callout marks should be substituted
   #
   # returns the highlighted source code, if a source highlighter is defined
   # on the document, otherwise the unprocessed text
-  def highlight_source(source, sub_callouts, highlighter = nil)
+  def highlight_source(source, process_callouts, highlighter = nil)
     highlighter ||= @document.attributes['source-highlighter']
     Helpers.require_library highlighter, (highlighter == 'pygments' ? 'pygments.rb' : highlighter)
-    callout_marks = {}
     lineno = 0
     callout_on_last = false
-    if sub_callouts
+    if process_callouts
+      callout_marks = {}
       last = -1
+      # FIXME cache this dynamic regex
+      callout_rx = (attr? 'line-comment') ? /(?:#{::Regexp.escape(attr 'line-comment')} )?#{CalloutExtractRxt}/ : CalloutExtractRx
       # extract callout marks, indexed by line number
       source = source.split(EOL).map {|line|
         lineno = lineno + 1
-        line.gsub(CalloutScanRx) {
+        line.gsub(callout_rx) {
           # alias match for Ruby 1.8.7 compat
           m = $~
           # honor the escape
@@ -1425,6 +1422,9 @@ module Substitutors
         }
       } * EOL
       callout_on_last = (last == lineno)
+      callout_marks = nil if callout_marks.empty?
+    else
+      callout_marks = nil
     end
 
     linenums_mode = nil
@@ -1467,9 +1467,7 @@ module Substitutors
       result = result.gsub PASS_MATCH_HI, %(#{PASS_START}\\1#{PASS_END})
     end
 
-    if !sub_callouts || callout_marks.empty?
-      result
-    else
+    if process_callouts && callout_marks
       lineno = 0
       reached_code = linenums_mode != :table
       result.split(EOL).map {|line|
@@ -1502,6 +1500,8 @@ module Substitutors
           line
         end
       } * EOL
+    else
+      result
     end
   end
 

data/lib/asciidoctor/table.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods and constants for managing AsciiDoc table content in a document.
 # It supports all three of AsciiDoc's table formats: psv, dsv and csv.
@@ -486,7 +487,7 @@ class Table::ParserContext
       # TODO perhaps the col_count/linenum logic should be in end_of_row? (or a should_end_row? method)
       close_row if end_of_row? && (@col_count != -1 || @linenum > 0 || (eol && i == repeat))
     end
-    @open_cell = false
+    @cell_open = false
     nil
   end
 

data/lib/asciidoctor/timings.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
   class Timings
     def initialize

data/lib/asciidoctor/version.rb

@@ -1,3 +1,3 @@
 module Asciidoctor
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

data/man/asciidoctor.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: asciidoctor
 .\"    Author: Dan Allen
-.\" Generator: Asciidoctor 1.5.0
-.\"      Date: 2014-05-19
+.\" Generator: Asciidoctor 1.5.2
+.\"      Date: 2014-11-27
 .\"    Manual: Asciidoctor Manual
-.\"    Source: Asciidoctor 1.5.0
+.\"    Source: Asciidoctor 1.5.2
 .\"  Language: English
 .\"
-.TH "ASCIIDOCTOR" "1" "2014-08-12" "Asciidoctor 1\&.5\&.0" "Asciidoctor Manual"
+.TH "ASCIIDOCTOR" "1" "2014-11-27" "Asciidoctor 1\&.5\&.2" "Asciidoctor Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
@@ -50,7 +50,7 @@ This option may be specified more than once\&.
 .PP
 \fB\-b, \-\-backend\fR=\fIBACKEND\fR
 .RS 4
-Backend output file format: \fIhtml5\fR, \fIdocbook45\fR and \fIdocbook5\fR supported out of the box\&. You can also use the backend alias names \fIhtml\fR (aliased to \fIhtml5\fR) or \fIdocbook\fR (aliased to \fIdocbook5\fR)\&. Defaults to \fIhtml5\fR\&. Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during rendering\&.
+Backend output file format: \fIhtml5\fR, \fIdocbook45\fR and \fIdocbook5\fR supported out of the box\&. You can also use the backend alias names \fIhtml\fR (aliased to \fIhtml5\fR) or \fIdocbook\fR (aliased to \fIdocbook5\fR)\&. Defaults to \fIhtml5\fR\&. Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during conversion\&.
 .RE
 .PP
 \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR
@@ -71,12 +71,12 @@ Destination output directory\&. Defaults to the directory containing the source
 .PP
 \fB\-E, \-\-template\-engine\fR=\fINAME\fR
 .RS 4
-Template engine to use for the custom render templates\&. The gem with the same name as the engine will be loaded automatically\&. This name is also used to build the full path to the custom templates\&. If a template engine is not specified, it will be auto\-detected based on the file extension of the custom templates found\&.
+Template engine to use for the custom converter templates\&. The gem with the same name as the engine will be loaded automatically\&. This name is also used to build the full path to the custom converter templates\&. If a template engine is not specified, it will be auto\-detected based on the file extension of the custom converter templates found\&.
 .RE
 .PP
 \fB\-e, \-\-eruby\fR
 .RS 4
-Specifies the eRuby implementation to use for rendering the custom ERB templates\&. Supported values are \fIerb\fR and \fIerubis\fR\&. Defaults to \fIerb\fR\&.
+Specifies the eRuby implementation to use for executing the custom converter templates written in ERB\&. Supported values are \fIerb\fR and \fIerubis\fR\&. Defaults to \fIerb\fR\&.
 .RE
 .PP
 \fB\-n, \-\-section\-numbers\fR
@@ -96,7 +96,7 @@ Suppress the document header and footer in the output\&.
 .PP
 \fB\-T, \-\-template\-dir\fR=\fIDIR\fR
 .RS 4
-A directory containing custom render templates that override one or more templates from the built\-in set\&. (requires \fItilt\fR gem)
+A directory containing custom converter templates that override one or more templates from the built\-in set\&. (requires \fItilt\fR gem)
 .sp
 If there is a subfolder that matches the engine name (if specified), that folder is appended to the template directory path\&. Similarly, if there is a subfolder in the resulting template directory that matches the name of the backend, that folder is appended to the template directory path\&.
 .sp
@@ -121,7 +121,7 @@ Verbosely print processing information and configuration file checks to stderr\&
 .PP
 \fB\-t, \-\-timings\fR
 .RS 4
-Display timings information (time to read, parse and convert)
+Display timings information (time to read, parse and convert)\&.
 .RE
 .SS "Program Information"
 .PP
@@ -129,7 +129,6 @@ Display timings information (time to read, parse and convert)
 .RS 4
 Show the help message\&.
 .RE
-.PP
 \fB\-V, \-\-version\fR
 .RS 4
 Print program version number\&.
@@ -138,7 +137,7 @@ Print program version number\&.
 .PP
 \fB0\fR
 .RS 4
-Success
+Success\&.
 .RE
 .PP
 \fB1\fR

data/man/asciidoctor.adoc

@@ -2,173 +2,155 @@
 Dan Allen; Sarah White; Ryan Waldron
 :doctype: manpage
 :man manual: Asciidoctor Manual
-:man source: Asciidoctor 1.5.0
+:man source: Asciidoctor 1.5.2
 :page-layout: base
 
 == NAME
 
 asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
 
-
 == SYNOPSIS
 
-*asciidoctor* ['OPTION']... 'FILE'...
-
+*asciidoctor* [_OPTION_]... _FILE_...
 
 == DESCRIPTION
 
-The asciidoctor(1) command converts the AsciiDoc source file(s) 'FILE' to HTML5,
-DocBook 4.5, DocBook 5.0 and other custom output formats.
-
-If 'FILE' is '-' then the AsciiDoc source is read from standard input.
+The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 4.5, DocBook 5.0 and other custom output formats.
 
+If _FILE_ is _-_ then the AsciiDoc source is read from standard input.
 
 == OPTIONS
 
 === Security Settings
 
-*-B, --base-dir*='DIR'::
-    Base directory containing the document and resources. Defaults to the
-    directory containing the source file, or the working directory if the
-    source is read from a stream. Can be used as a way to chroot the execution
-    of the program.
+*-B, --base-dir*=_DIR_::
+  Base directory containing the document and resources.
+  Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
+  Can be used as a way to chroot the execution of the program.
 
-*-S, --safe-mode*='SAFE_MODE'::
-    Set safe mode level: 'unsafe', 'safe', 'server' or 'secure'. Disables
-    potentially dangerous macros in source files, such as include::[]. If not
-    set, the safe mode level defaults to 'unsafe' when Asciidoctor is invoked
-    using this script.
+*-S, --safe-mode*=_SAFE_MODE_::
+  Set safe mode level: _unsafe_, _safe_, _server_ or _secure_.
+  Disables potentially dangerous macros in source files, such as `include::[]`.
+  If not set, the safe mode level defaults to _unsafe_ when Asciidoctor is invoked using this script.
 
 *--safe*::
-    Set safe mode level to 'safe'. Enables include macros, but restricts access
-    to ancestor paths of source file. Provided for compatibility with the
-    asciidoc command. If not set, the safe mode level defaults to 'unsafe' when
-    Asciidoctor is invoked using this script.
+  Set safe mode level to _safe_.
+  Enables include macros, but restricts access to ancestor paths of source file.
+  Provided for compatibility with the asciidoc command.
+  If not set, the safe mode level defaults to _unsafe_ when Asciidoctor is invoked using this script.
 
 === Document Settings
 
-*-a, --attribute*='ATTRIBUTE'::
-    Define, override or delete a document attribute. Command-line attributes
-    take precedence over attributes defined in the source file.
+*-a, --attribute*=_ATTRIBUTE_::
+  Define, override or delete a document attribute.
+  Command-line attributes take precedence over attributes defined in the source file.
 +
-'ATTRIBUTE' is normally formatted as a key-value pair, in the form 'NAME=VALUE'.
-Alternate acceptable forms are 'NAME' (where the 'VALUE' defaults to an empty
-string), 'NAME!' (unassigns the 'NAME' attribute) and 'NAME=VALUE@' (where
-'VALUE' does not override value of 'NAME' attribute if it's already defined in
-the source document). Values containing spaces should be enclosed in quotes.
+_ATTRIBUTE_ is normally formatted as a key-value pair, in the form _NAME=VALUE_.
+Alternate acceptable forms are _NAME_ (where the _VALUE_ defaults to an empty string), _NAME!_ (unassigns the _NAME_ attribute) and _NAME=VALUE@_ (where _VALUE_ does not override value of _NAME_ attribute if it's already defined in the source document).
+Values containing spaces should be enclosed in quotes.
 +
-This option may be specified more than once. 
-
-*-b, --backend*='BACKEND'::
-    Backend output file format: 'html5', 'docbook45' and 'docbook5' supported
-    out of the box. You can also use the backend alias names 'html' (aliased to
-    'html5') or 'docbook' (aliased to 'docbook5'). Defaults to 'html5'. Other
-    options can be passed, but if Asciidoctor cannot find the backend, it will
-    fail during rendering.
-
-*-d, --doctype*='DOCTYPE'::
-    Document type: 'article', 'book', 'manpage' or 'inline'. Sets the root
-    element when using the 'docbook' backend and the style class on the HTML
-    body element when using the 'html' backend. The 'book' document type allows
-    multiple level-0 section titles in a single document. The 'manpage' document
-    type enables parsing of metadata necessary to produce a manpage. The
-    'inline' document type allows the content of a single paragraph to be
-    formatted and returned without wrapping it in a containing element. Defaults
-    to 'article'.
+This option may be specified more than once.
+
+*-b, --backend*=_BACKEND_::
+  Backend output file format: _html5_, _docbook45_ and _docbook5_ supported out of the box.
+  You can also use the backend alias names _html_ (aliased to _html5_) or _docbook_ (aliased to _docbook5_).
+  Defaults to _html5_.
+  Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during conversion.
+
+*-d, --doctype*=_DOCTYPE_::
+  Document type: _article_, _book_, _manpage_ or _inline_.
+  Sets the root element when using the _docbook_ backend and the style class on the HTML body element when using the _html_ backend.
+  The _book_ document type allows multiple level-0 section titles in a single document.
+  The _manpage_ document type enables parsing of metadata necessary to produce a manpage.
+  The _inline_ document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element.
+  Defaults to _article_.
 
 === Rendering Control
 
 *-C, --compact*::
-    Compact the output by removing blank lines. (No longer in use).
+  Compact the output by removing blank lines.
+  (No longer in use).
 
-*-D, --destination-dir*='DIR'::
-    Destination output directory. Defaults to the directory containing the
-    source file, or the working directory if the source is read from a stream.
-    If specified, the directory is resolved relative to the working directory.
+*-D, --destination-dir*=_DIR_::
+  Destination output directory.
+  Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
+  If specified, the directory is resolved relative to the working directory.
 
-*-E, --template-engine*='NAME'::
-    Template engine to use for the custom render templates. The gem with the
-    same name as the engine will be loaded automatically. This name is also
-    used to build the full path to the custom templates. If a template engine
-    is not specified, it will be auto-detected based on the file extension
-    of the custom templates found.
+*-E, --template-engine*=_NAME_::
+  Template engine to use for the custom converter templates.
+  The gem with the same name as the engine will be loaded automatically.
+  This name is also used to build the full path to the custom converter templates.
+  If a template engine is not specified, it will be auto-detected based on the file extension of the custom converter templates found.
 
 *-e, --eruby*::
-    Specifies the eRuby implementation to use for rendering the custom ERB
-    templates. Supported values are 'erb' and 'erubis'. Defaults to 'erb'.
+  Specifies the eRuby implementation to use for executing the custom converter templates written in ERB.
+  Supported values are _erb_ and _erubis_.
+  Defaults to _erb_.
 
 *-n, --section-numbers*::
-    Auto-number section titles. Synonym for *--attribute numbered*.
+  Auto-number section titles.
+  Synonym for *--attribute numbered*.
 
-*-o, --out-file*='OUT_FILE'::
-    Write output to file 'OUT_FILE'. Defaults to the base name of the input
-    file suffixed with 'backend' extension. If the input is read from standard
-    input, then the output file defaults to stdout. If 'OUT_FILE' is '-' then
-    the standard output is also used. If specified, the file is resolved
-    relative to the working directory.
+*-o, --out-file*=_OUT_FILE_::
+  Write output to file _OUT_FILE_.
+  Defaults to the base name of the input file suffixed with _backend_ extension.
+  If the input is read from standard input, then the output file defaults to stdout.
+  If _OUT_FILE_ is _-_ then the standard output is also used.
+  If specified, the file is resolved relative to the working directory.
 
 *-s, --no-header-footer*::
-    Suppress the document header and footer in the output.
+  Suppress the document header and footer in the output.
 
-*-T, --template-dir*='DIR'::
-    A directory containing custom render templates that override one or more
-    templates from the built-in set. (requires 'tilt' gem)
+*-T, --template-dir*=_DIR_::
+  A directory containing custom converter templates that override one or more templates from the built-in set.
+  (requires _tilt_ gem)
 +
-If there is a subfolder that matches the engine name (if specified), that folder
-is appended to the template directory path. Similarly, if there is a subfolder
-in the resulting template directory that matches the name of the backend, that
-folder is appended to the template directory path.
+If there is a subfolder that matches the engine name (if specified), that folder is appended to the template directory path.
+Similarly, if there is a subfolder in the resulting template directory that matches the name of the backend, that folder is appended to the template directory path.
 +
-This option may be specified more than once. Matching templates found in
-subsequent directories override ones previously discovered.
+This option may be specified more than once.
+Matching templates found in subsequent directories override ones previously discovered.
 
 === Processing Information
 
 *-q, --quiet*::
-    Silence warnings.
+  Silence warnings.
 
 *--trace*::
-    Include backtrace information on errors. Not enabled by default.
+  Include backtrace information on errors.
+  Not enabled by default.
 
 *-v, --verbose*::
-    Verbosely print processing information and configuration file checks to
-    stderr.
+  Verbosely print processing information and configuration file checks to stderr.
 
 *-t, --timings*::
-    Display timings information (time to read, parse and convert)
+  Display timings information (time to read, parse and convert).
 
 === Program Information
 
 *-h, --help*::
-    Show the help message.
+  Show the help message.
 
 *-V, --version*::
-    Print program version number.
-
+  Print program version number.
 
 == EXIT STATUS
 
 *0*::
-    Success
+  Success.
 
 *1*::
-    Failure (syntax or usage error; configuration error; document processing
-    failure; unexpected error).
-
+  Failure (syntax or usage error; configuration error; document processing failure; unexpected error).
 
 == BUGS
 
 See the *Asciidoctor* issue tracker: <**https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen**>
 
-
 == AUTHORS
 
-*Asciidoctor* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick
-Hengeveld and other contributors.
-
-*AsciiDoc* was written by Stuart Rackham and has received contributions from
-many other individuals.
+*Asciidoctor* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld and other contributors.
 
+*AsciiDoc* was written by Stuart Rackham and has received contributions from many other individuals.
 
 == RESOURCES
 
@@ -180,10 +162,9 @@ GitHub organization: <**https://github.com/asciidoctor**>
 
 Discussion list / forum: <**http://discuss.asciidoctor.org**>
 
-
 == COPYING
 
-Copyright \(C) 2012-2014 Dan Allen, Ryan Waldron and the Asciidoctor Project. Free use of this
-software is granted under the terms of the MIT License.
+Copyright \(C) 2012-2014 Dan Allen, Ryan Waldron and the Asciidoctor Project.
+Free use of this software is granted under the terms of the MIT License.
 
 // vim: tw=80