asciidoctor 0.1.3 → 0.1.4

data/lib/asciidoctor/table.rb

@@ -52,7 +52,7 @@ class Table < AbstractBlock
   attr_accessor :rows
 
   # Public: Boolean specifies whether this table has a header row
-  attr_reader :header_option
+  attr_accessor :has_header_option
 
   def initialize(parent, attributes)
     super(parent, :table)
@@ -110,10 +110,10 @@ class Table < AbstractBlock
     # set rowcount before splitting up body rows
     @attributes['rowcount'] = @rows.body.size
 
-    if !rows.body.empty? && attributes.has_key?('header-option')
+    if !rows.body.empty? && @has_header_option
       head = rows.body.shift
       # styles aren't applied to header row
-      head.each {|c| c.attributes.delete('style') }
+      head.each {|c| c.style = nil }
       # QUESTION why does AsciiDoc use an array for head? is it
       # possible to have more than one based on the syntax?
       rows.head = [head]
@@ -125,16 +125,6 @@ class Table < AbstractBlock
     
     nil
   end
-
-  # Public: Get the rendered String content for this Block.  If the block
-  # has child blocks, the content method should cause them to be
-  # rendered and returned as content that can be included in the
-  # parent block's template.
-  def render
-    @document.playback_attributes @attributes
-    renderer.render('block_table', self) 
-  end
-
 end
 
 # Public: A struct that encapsulates the collection of rows (head, foot, body) for a table
@@ -143,8 +133,12 @@ Table::Rows = Struct.new(:head, :foot, :body)
 # Public: Methods to manage the columns of an AsciiDoc table. In particular, it
 # keeps track of the column specs
 class Table::Column < AbstractNode
+  # Public: Get/Set the Symbol style for this column.
+  attr_accessor :style
+
   def initialize(table, index, attributes = {})
     super(table, :column)
+    @style = attributes['style']
     attributes['colnumber'] = index + 1
     attributes['width'] ||= 1
     attributes['halign'] ||= 'left'
@@ -177,6 +171,8 @@ end
 
 # Public: Methods for managing the a cell in an AsciiDoc table.
 class Table::Cell < AbstractNode
+  # Public: Get/Set the Symbol style for this cell (default: nil)
+  attr_accessor :style
 
   # Public: An Integer of the number of columns this cell will span (default: nil)
   attr_accessor :colspan
@@ -190,32 +186,43 @@ class Table::Cell < AbstractNode
   # Public: The internal Asciidoctor::Document for a cell that has the asciidoc style
   attr_reader :inner_document
 
-  def initialize(column, text, attributes = {})
+  def initialize(column, text, attributes = {}, cursor = nil)
     super(column, :cell)
     @text = text
+    @style = nil
     @colspan = nil
     @rowspan = nil
     # TODO feels hacky
     if !column.nil?
+      @style = column.attributes['style']
       update_attributes(column.attributes)
     end
     if !attributes.nil?
-      if attributes.has_key? 'colspan'
-        @colspan = attributes['colspan']
-        attributes.delete('colspan') 
-      end
-      if attributes.has_key? 'rowspan'
-        @rowspan = attributes['rowspan']
-        attributes.delete('rowspan') 
-      end
+      @colspan = attributes.delete('colspan')
+      @rowspan = attributes.delete('rowspan')
+      # TODO eventualy remove the style attribute from the attributes hash
+      #@style = attributes.delete('style') if attributes.has_key? 'style'
+      @style = attributes['style'] if attributes.has_key? 'style'
       update_attributes(attributes)
     end
     # only allow AsciiDoc cells in non-header rows
-    if @attributes['style'] == :asciidoc && !column.table.header_row?
+    if @style == :asciidoc && !column.table.header_row?
       # FIXME hide doctitle from nested document; temporary workaround to fix
       # nested document seeing doctitle and assuming it has its own document title
       parent_doctitle = @document.attributes.delete('doctitle')
-      @inner_document = Document.new(@text, :header_footer => false, :parent => @document)
+      # NOTE we need to process the first line of content as it may not have been processed
+      # the included content cannot expect to match conditional terminators in the remaining
+      # lines of table cell content, it must be self-contained logic
+      inner_document_lines = @text.each_line.to_a
+      unless inner_document_lines.empty? || !inner_document_lines.first.include?('::')
+        unprocessed_lines = inner_document_lines[0..0]
+        processed_lines = PreprocessorReader.new(@document, unprocessed_lines).readlines
+        if processed_lines != unprocessed_lines
+          inner_document_lines.shift
+          inner_document_lines.unshift(*processed_lines)
+        end
+      end
+      @inner_document = Document.new(inner_document_lines, :header_footer => false, :parent => @document, :cursor => cursor)
       @document.attributes['doctitle'] = parent_doctitle unless parent_doctitle.nil?
     end
   end
@@ -227,12 +234,11 @@ class Table::Cell < AbstractNode
 
   # Public: Handles the body data (tbody, tfoot), applying styles and partitioning into paragraphs
   def content
-    style = attr('style')
-    if style == :asciidoc
+    if @style == :asciidoc
       @inner_document.render
     else
       text.split(BLANK_LINE_PATTERN).map {|p|
-        !style || style == :header ? p : Inline.new(parent, :quoted, p, :type => attr('style')).render
+        !@style || @style == :header ? p : Inline.new(parent, :quoted, p, :type => @style).render
       }
     end
   end
@@ -272,8 +278,11 @@ class Table::ParserContext
   # Public: The cell delimiter compiled Regexp for this table.
   attr_reader :delimiter_re
 
-  def initialize(table, attributes = {})
+  def initialize(reader, table, attributes = {})
+    @reader = reader
     @table = table
+    # TODO if reader.cursor becomes a reference, this would require .dup
+    @last_cursor = reader.cursor
     if attributes.has_key? 'format'
       @format = attributes['format']
       if !Table::DATA_FORMATS.include? @format
@@ -416,7 +425,7 @@ class Table::ParserContext
     if format == 'psv'
       cell_spec = take_cell_spec
       if cell_spec.nil?
-        puts 'asciidoctor: ERROR: table missing leading separator, recovering automatically'
+        warn "asciidoctor: ERROR: #{@last_cursor.line_info}: table missing leading separator, recovering automatically"
         cell_spec = {}
         repeat = 1
       else
@@ -450,7 +459,8 @@ class Table::ParserContext
         column = @table.columns[@current_row.size]
       end
 
-      cell = Table::Cell.new(column, cell_text, cell_spec)
+      cell = Table::Cell.new(column, cell_text, cell_spec, @last_cursor)
+      @last_cursor = @reader.cursor
       unless cell.rowspan.nil? || cell.rowspan == 1
         activate_rowspan(cell.rowspan, (cell.colspan || 1))
       end

data/lib/asciidoctor/version.rb

@@ -1,3 +1,3 @@
 module Asciidoctor
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/man/asciidoctor.1

@@ -1,40 +1,23 @@
 '\" t
 .\"     Title: asciidoctor
-.\"    Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 05/30/2013
-.\"    Manual: \ \&
-.\"    Source: \ \&
+.\"    Author: Dan Allen
+.\" Generator: Asciidoctor 0.1.4
+.\"      Date: 2013-09-05
+.\"    Manual: Asciidoctor Manual
+.\"    Source: Asciidoctor 0.1.4
 .\"  Language: English
 .\"
-.TH "ASCIIDOCTOR" "1" "05/30/2013" "\ \&" "\ \&"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.TH "ASCIIDOCTOR" "1" "2013-09-05" "Asciidoctor 0\&.1\&.4" "Asciidoctor Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
 .nh
-.\" disable justification (adjust text to left margin only)
 .ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-asciidoctor \- converts an AsciiDoc source file to HTML, DocBook and other formats
 .SH "SYNOPSIS"
 .sp
-\fBasciidoctor\fR [\fIOPTION\fR]\&... \fIFILE\fR
+\fBasciidoctor\fR [\fIOPTION\fR]\&... \fIFILE\fR\&...
 .SH "DESCRIPTION"
 .sp
-The asciidoctor(1) command converts the AsciiDoc source file \fIFILE\fR to HTML 5, DocBook 4\&.5 and other output formats\&.
+The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\fR to HTML 5, DocBook 4\&.5, DocBook 5\&.0 and other custom output formats\&.
 .sp
 If \fIFILE\fR is \fI\-\fR then the AsciiDoc source is read from standard input\&.
 .SH "OPTIONS"
@@ -47,22 +30,12 @@ Base directory containing the document and resources\&. Defaults to the director
 .PP
 \fB\-S, \-\-safe\-mode\fR=\fISAFE_MODE\fR
 .RS 4
-Set safe mode level:
-\fIunsafe\fR,
-\fIsafe\fR,
-\fIserver\fR
-or
-\fIsecure\fR\&. Disables potentially dangerous macros in source files, such as include::[]\&. If not set, the safe mode level defaults to
-\fIunsafe\fR
-when Asciidoctor is invoked using this script\&.
+Set safe mode level: \fIunsafe\fR, \fIsafe\fR, \fIserver\fR or \fIsecure\fR\&. Disables potentially dangerous macros in source files, such as include::[]\&. If not set, the safe mode level defaults to \fIunsafe\fR when Asciidoctor is invoked using this script\&.
 .RE
 .PP
 \fB\-\-safe\fR
 .RS 4
-Set safe mode level to
-\fIsafe\fR\&. 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
-\fIunsafe\fR
-when Asciidoctor is invoked using this script\&.
+Set safe mode level to \fIsafe\fR\&. 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 \fIunsafe\fR when Asciidoctor is invoked using this script\&.
 .RE
 .SS "Document Settings"
 .PP
@@ -70,59 +43,19 @@ when Asciidoctor is invoked using this script\&.
 .RS 4
 Define, override or delete a document attribute\&. Command\-line attributes take precedence over attributes defined in the source file\&.
 .sp
-\fIATTRIBUTE\fR
-is normally formatted as a key\-value pair, in the form
-\fINAME=VALUE\fR\&. Alternate acceptable forms are
-\fINAME\fR
-(where the
-\fIVALUE\fR
-defaults to an empty string),
-\fINAME!\fR
-(unassigns the
-\fINAME\fR
-attribute) and
-\fINAME=VALUE@\fR
-(where
-\fIVALUE\fR
-does not override value of
-\fINAME\fR
-attribute if it\(cqs already defined in the source document)\&. Values containing spaces should be enclosed in quotes\&.
+\fIATTRIBUTE\fR is normally formatted as a key\-value pair, in the form \fINAME=VALUE\fR\&. Alternate acceptable forms are \fINAME\fR (where the \fIVALUE\fR defaults to an empty string), \fINAME!\fR (unassigns the \fINAME\fR attribute) and \fINAME=VALUE@\fR (where \fIVALUE\fR does not override value of \fINAME\fR attribute if it\(cqs already defined in the source document)\&. Values containing spaces should be enclosed in quotes\&.
 .sp
 This option may be specified more than once\&.
 .RE
 .PP
 \fB\-b, \-\-backend\fR=\fIBACKEND\fR
 .RS 4
-Backend output file format:
-\fIdocbook45\fR
-or
-\fIhtml5\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
-\fIdocbook45\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 \fIdocbook45\fR)\&. Defaults to \fIhtml5\fR\&. Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during rendering\&.
 .RE
 .PP
 \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR
 .RS 4
-Document type:
-\fIarticle\fR,
-\fIbook\fR
-or
-\fIinline\fR\&. Sets the root element when using the
-\fIdocbook\fR
-backend and the style class on the HTML body element when using the
-\fIhtml\fR
-backend\&. The
-\fIbook\fR
-document type allows multiple level\-0 section titles in a single document\&. The
-\fIinline\fR
-document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element\&. Defaults to
-\fIarticle\fR\&.
+Document type: \fIarticle\fR, \fIbook\fR, \fImanpage\fR or \fIinline\fR\&. Sets the root element when using the \fIdocbook\fR backend and the style class on the HTML body element when using the \fIhtml\fR backend\&. The \fIbook\fR document type allows multiple level\-0 section titles in a single document\&. The \fImanpage\fR document type enables parsing of metadata necessary to produce a manpage\&. The \fIinline\fR document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element\&. Defaults to \fIarticle\fR\&.
 .RE
 .SS "Rendering Control"
 .PP
@@ -136,31 +69,24 @@ Compact the output by removing blank lines\&. Not enabled by default\&.
 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\&.
 .RE
 .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\&.
+.RE
+.PP
 \fB\-e, \-\-eruby\fR
 .RS 4
-Specifies the eRuby implementation to use for rendering the built\-in templates\&. Supported values are
-\fIerb\fR
-and
-\fIerubis\fR\&. Defaults to
-\fIerb\fR\&.
+Specifies the eRuby implementation to use for rendering the built\-in templates\&. Supported values are \fIerb\fR and \fIerubis\fR\&. Defaults to \fIerb\fR\&.
 .RE
 .PP
 \fB\-n, \-\-section\-numbers\fR
 .RS 4
-Auto\-number section titles\&. Synonym for
-\fB\-\-attribute numbered\fR\&.
+Auto\-number section titles\&. Synonym for \fB\-\-attribute numbered\fR\&.
 .RE
 .PP
 \fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR
 .RS 4
-Write output to file
-\fIOUT_FILE\fR\&. Defaults to the base name of the input file suffixed with
-\fIbackend\fR
-extension\&. If the input is read from standard input, then the output file defaults to stdout\&. If
-\fIOUT_FILE\fR
-is
-\fI\-\fR
-then the standard output is also used\&. If specified, the file is resolved relative to the working directory\&.
+Write output to file \fIOUT_FILE\fR\&. Defaults to the base name of the input file suffixed with \fIbackend\fR extension\&. If the input is read from standard input, then the output file defaults to stdout\&. If \fIOUT_FILE\fR is \fI\-\fR then the standard output is also used\&. If specified, the file is resolved relative to the working directory\&.
 .RE
 .PP
 \fB\-s, \-\-no\-header\-footer\fR
@@ -170,7 +96,11 @@ Suppress the document header and footer in the output\&.
 .PP
 \fB\-T, \-\-template\-dir\fR=\fIDIR\fR
 .RS 4
-Directory containing custom render templates that override one or more templates from the built\-in set\&. If there is a folder in the directory that matches the backend, the templates from that folder will be used\&.
+A directory containing custom render 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
+This option may be specified more than once\&. Matching templates found in subsequent directories override ones previously discovered\&.
 .RE
 .SS "Processing Information"
 .PP
@@ -225,3 +155,9 @@ Mailinglist / forum: <\fBhttp://discuss\&.asciidoctor\&.org\fR>
 .SH "COPYING"
 .sp
 Copyright (C) 2012\-2013 Dan Allen and Ryan Waldron\&. Free use of this software is granted under the terms of the MIT License\&.
+.SH "AUTHOR"
+.PP
+\fBDan Allen\fR
+.RS 4
+Author.
+.RE

data/man/{asciidoctor.ad → asciidoctor.adoc}

@@ -1,32 +1,31 @@
-asciidoctor(1)
-==============
+= asciidoctor(1)
+Dan Allen; Ryan Waldron
 :doctype: manpage
+:man manual: Asciidoctor Manual
+:man source: Asciidoctor 0.1.4
 :awestruct-layout: base
 
+== NAME
 
-NAME
-----
-asciidoctor - converts an AsciiDoc source file to HTML, DocBook and other formats
+asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
 
 
-SYNOPSIS
---------
-*asciidoctor* ['OPTION']... 'FILE'
+== SYNOPSIS
 
+*asciidoctor* ['OPTION']... 'FILE'...
 
-DESCRIPTION
------------
-The asciidoctor(1) command converts the AsciiDoc source file 'FILE' to HTML 5,
-DocBook 4.5 and other output formats.
+
+== DESCRIPTION
+
+The asciidoctor(1) command converts the AsciiDoc source file(s) 'FILE' to HTML 5,
+DocBook 4.5, DocBook 5.0 and other custom output formats.
 
 If 'FILE' is '-' then the AsciiDoc source is read from standard input.
 
 
-OPTIONS
--------
+== OPTIONS
 
-Security Settings
-~~~~~~~~~~~~~~~~~
+=== Security Settings
 
 *-B, --base-dir*='DIR'::
     Base directory containing the document and resources. Defaults to the
@@ -46,8 +45,7 @@ Security Settings
     asciidoc command. If not set, the safe mode level defaults to 'unsafe' when
     Asciidoctor is invoked using this script.
 
-Document Settings
-~~~~~~~~~~~~~~~~~
+=== Document Settings
 
 *-a, --attribute*='ATTRIBUTE'::
     Define, override or delete a document attribute. Command-line attributes
@@ -62,22 +60,23 @@ 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: 'docbook45' or 'html5' supported out of the box.  
-    You can also use the backend alias names 'html' (aliased to 'html5') or 
-    'docbook' (aliased to 'docbook45'). Defaults to 'html5'. Other options can
-    be passed, but if Asciidoctor cannot find the backend, it will fail during
-    rendering.
+    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 'docbook45'). 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' 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 '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'.
+    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
-~~~~~~~~~~~~~~~~~
+=== Rendering Control
 
 *-C, --compact*::
     Compact the output by removing blank lines. Not enabled by default.
@@ -87,6 +86,11 @@ Rendering Control
     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.
+
 *-e, --eruby*::
     Specifies the eRuby implementation to use for rendering the built-in
     templates. Supported values are 'erb' and 'erubis'. Defaults to 'erb'.
@@ -105,12 +109,18 @@ Rendering Control
     Suppress the document header and footer in the output.
 
 *-T, --template-dir*='DIR'::
-    Directory containing custom render templates that override one or more
-    templates from the built-in set. If there is a folder in the directory
-    that matches the backend, the templates from that folder will be used.
+    A directory containing custom render 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.
++
+This option may be specified more than once. Matching templates found in
+subsequent directories override ones previously discovered.
 
-Processing Information
-~~~~~~~~~~~~~~~~~~~~~~
+=== Processing Information
 
 *--trace*::
     Include backtrace information on errors. Not enabled by default.
@@ -119,8 +129,7 @@ Processing Information
     Verbosely print processing information and configuration file checks to
     stderr.
 
-Program Information
-~~~~~~~~~~~~~~~~~~~
+=== Program Information
 
 *-h, --help*::
     Show the help message.
@@ -129,8 +138,8 @@ Program Information
     Print program version number.
 
 
-EXIT STATUS
------------
+== EXIT STATUS
+
 *0*::
     Success
 
@@ -139,13 +148,13 @@ EXIT STATUS
     failure; unexpected error).
 
 
-BUGS
-----
+== BUGS
+
 See the *Asciidoctor* issue tracker: <**https://github.com/asciidoctor/asciidoctor/issues?state=open**>
 
 
-AUTHORS
--------
+== AUTHORS
+
 *Asciidoctor* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick
 Hengeveld and other contributors.
 
@@ -153,8 +162,8 @@ Hengeveld and other contributors.
 many other individuals.
 
 
-RESOURCES
----------
+== RESOURCES
+
 Git source repository on GitHub: <**https://github.com/asciidoctor/asciidoctor**>
 
 Project web site: <**http://asciidoctor.org**>
@@ -164,8 +173,8 @@ GitHub organization: <**http://github.com/asciidoctor**>
 Mailinglist / forum: <**http://discuss.asciidoctor.org**>
 
 
-COPYING
--------
+== COPYING
+
 Copyright \(C) 2012-2013 Dan Allen and Ryan Waldron. Free use of this
 software is granted under the terms of the MIT License.