asciidoctor-latex 1.5.0.5.dev → 1.5.0.7.dev

data/doc/top-level-namespace.html

@@ -75,6 +75,10 @@
     
   
     
+      <dt class="r1">Includes:</dt>
+      <dd class="r1"><span class='object_link'><a href="Asciidoctor.html" title="Asciidoctor (module)">Asciidoctor</a></span></dd>
+      
+    
   
   
   
@@ -85,11 +89,11 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Asciidoctor.html" title="Asciidoctor (module)">Asciidoctor</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Asciidoctor.html" title="Asciidoctor (module)">Asciidoctor</a></span>, <span class='object_link'><a href="TexUtilities.html" title="TexUtilities (module)">TexUtilities</a></span>
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="PreambleProcessor.html" title="PreambleProcessor (class)">PreambleProcessor</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="CSSDocinfoProcessor.html" title="CSSDocinfoProcessor (class)">CSSDocinfoProcessor</a></span>, <span class='object_link'><a href="PreambleProcessor.html" title="PreambleProcessor (class)">PreambleProcessor</a></span>, <span class='object_link'><a href="String.html" title="String (class)">String</a></span>
     
   
 </p>
@@ -101,13 +105,30 @@
 
 
 
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  <h2>Method Summary</h2>
+  
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="TexUtilities.html" title="TexUtilities (module)">TexUtilities</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="TexUtilities.html#apply_macros-class_method" title="TexUtilities.apply_macros (method)">apply_macros</a></span>, <span class='object_link'><a href="TexUtilities.html#begin-class_method" title="TexUtilities.begin (method)">begin</a></span>, <span class='object_link'><a href="TexUtilities.html#end-class_method" title="TexUtilities.end (method)">end</a></span>, <span class='object_link'><a href="TexUtilities.html#env-class_method" title="TexUtilities.env (method)">env</a></span>, <span class='object_link'><a href="TexUtilities.html#hypertarget-class_method" title="TexUtilities.hypertarget (method)">hypertarget</a></span>, <span class='object_link'><a href="TexUtilities.html#macro-class_method" title="TexUtilities.macro (method)">macro</a></span>, <span class='object_link'><a href="TexUtilities.html#macro_opt-class_method" title="TexUtilities.macro_opt (method)">macro_opt</a></span>, <span class='object_link'><a href="TexUtilities.html#region-class_method" title="TexUtilities.region (method)">region</a></span></p>
+
 
 </div>
 
     <div id="footer">
-  Generated on Sun Apr 19 18:37:45 2015 by
+  Generated on Tue May  3 13:31:55 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.1.2).
+  0.8.7.6 (ruby-2.3.0).
 </div>
 
   </body>

data/lib/asciidoctor/latex/converter.rb

@@ -3,17 +3,46 @@
 # File: latex-converter.rb
 # Author: J. Carlson (jxxcarlson@gmail.com)
 # First commit: 9/26/2014
-# Date: 2/20/1015
+# Date: 2/20/2015
 #
 # OVERVIEW
 #
-# Asciidoctor-latex does two things:
+# Asciidoctor-latex adds certain latex-like constructs to the asciidoc markup
+# language and provides two backends:
 #
-#   -- provides an HTML backend which adds latex-like features to asciidoctor
-#      asciidoc(tor) with these additional features will be called 'asciidoctor-latex'
+#   - a converter with HTML as output
 #
-#  -- provides a converter from asciidoctor-latex to asciidoctor.  This converter
-#     is 'usable' but has limited coverage of asciidoctor-latex
+#  -- a convert with LaTeX as output
+#
+# The goal of this project is to be able to combine the
+# strengths of asciidoc and late:
+#
+#  - to use asciidoc for most of the non-mathematical text
+#
+#  - to write inline mathematical text as one does in LaTeX:
+#
+#       $ a^2 + b^2 = c^1 $,
+#
+#    for example.
+#
+#  - the same for displayed mathematical text
+#
+#    \[
+#        \int_0^1 x^n dx = \frac{1}{n+1}
+#    \]
+#
+#  - to provide constructs which map to LaTeX environments.
+#    Thus one can say
+#
+#    [env.theorem]
+#    --
+#    There are infinitely many primes
+#    --
+#
+#     In the HTML converter the output will appear just
+#     as if it had been rendered by xelatex.  If the
+#     LaTeX backend is used, the output is as one would
+#     expect
 #
 # See http://www.noteshare.io/section/asciidoctor-latex-manual-intro
 # for a description (with examples) of asciidoctor-latex.
@@ -30,12 +59,14 @@
 #
 # to render an asciidoctor-latex document to html
 #
-# Some documents (those with 'click blocks', see http://www.noteshare.io/section/homework-problems)
-# For these, run
+# Some documents -- those with 'click blocks',
+# use a variant of the regular command:
 #
 #     'asciidoctor-latex -b html -a click_extras=include foo.adoc'
 #
 # In both cases the output is 'foo.html'
+# see http://www.noteshare.io/section/homework-problems)
+# for information on this topic.
 #
 # USAGE (2: latex)
 #
@@ -43,37 +74,33 @@
 #
 #      'asciidoctor-latex foo.adoc'
 #
-# to convert foo.adoc to foo.tex.  This feature
-# needs a lot of work.
+# to convert foo.adoc to foo.tex.  The resulting
+# file should be typeset with xelatex
+# because of the likely appearance of unicode
+# characters.
 #
-# to convert foo.tex to the latex file foo.latex
+# To convert foo.tex to the latex file foo.latex,
 # You can put files 'macros.tex' and 'preamble.tex' to
 # replace the default preamble and set of macros.
-# Define your own 'newEnvironments.tex' to use yours
+# Define your own 'newEnvironments.tex' to use your definitions
 # as opposed to the default definitons of environments
-# in tex mapping to [tex.ENVIRNOMENT] in asciidoctor-latex.
+# in tex mapping to [tex.ENVIRONOMENT] in asciidoctor-latex.
 #
-# TECHNICAL NOTES
+# TECHNICAL NOTES (This section needs a thorough rewrite)
 #
 # This is a first step towards writing a LaTeX backend
 # for Asciidoctor. It is based on the
-# Dan Allen's demo-converter.rb.  The "convert" method
-# is unchanged, the methods "document node" and "section node"
-# have been redefined, and several new methods have been added.
+# Dan Allen's demo-converter.rb.
 #
 # The main work will be in identifying asciidoc elements
 # that need to be transformed and adding a method for
 # each such element.  As noted below, the "warn" clause
 # in the "convert" method is a useful tool for this task.
 #
-# Usage:
-#
-#   $ asciidoctor -r ./latex-converter.rb -b latex test/sample1.adoc
-#
 # Comments
 #
 #   1.  The "warn" clause in the converter code is quite useful.
-#       For example, you will discover in running the converter on
+#       For example, you may discover in running the converter on
 #       "test/sample-1.adoc" that you have not implemented code for
 #       the "olist" node. Thus you can work through ever more complex
 #       examples to discover what you need to do to increase the coverage
@@ -81,7 +108,7 @@
 #
 #   2.  The converter simply passes on what it does not understand, e.g.,
 #       LaTeX, This is good. However, we will have to map constructs
-#       like"+\( a^2 = b^2 \)+" to $ a^2 + b^2 $, etc.
+#       like "+\( a^2 = b^2 \)+" to $ a^2 + b^2 $, etc.
 #       This can be done at the preprocessor level.
 #
 #   3.  In view of the preceding, we may need to chain a frontend
@@ -110,22 +137,13 @@
 #       in "node_processors.rb" to date was written using this
 #       hackish process.
 #
-#
-#  CURRENT STATUS
-#
-#  The following constructs are processed
-#
-#  * sections to a depth of five, e.g., == foo, === foobar, etc.
-#  * ordered and unordered lists, though nestings is untested and
-#    likely does not work.
-#  * *bold* and _italic_
-#  * hyperlinks like http://foo.com[Nerdy Stuff]
-#
+
 
 require 'asciidoctor'
 require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 require 'asciidoctor/converter/html5'
-require 'asciidoctor/latex/css'
+
+require 'asciidoctor/latex/css_doc_info'
 require 'asciidoctor/latex/inline_macros'
 require 'asciidoctor/latex/core_ext/colored_string'
 require 'asciidoctor/latex/click_block'
@@ -137,15 +155,17 @@ require 'asciidoctor/latex/prepend_processor'
 require 'asciidoctor/latex/macro_insert'
 require 'asciidoctor/latex/tex_block'
 require 'asciidoctor/latex/tex_preprocessor'
+require 'asciidoctor/latex/macro_preprocessor'
 require 'asciidoctor/latex/dollar'
 require 'asciidoctor/latex/tex_postprocessor'
 require 'asciidoctor/latex/chem'
+require 'asciidoctor/latex/sectnumoffset-treeprocessor'
 
 
 
 # require 'asciidoctor/latex/preamble_processor'
 
-$VERBOSE = true
+$VERBOSE = false
 
 
 
@@ -186,25 +206,79 @@ module Asciidoctor::LaTeX
           handle_equation(node)
         when 'equationalign'
           handle_equation_align(node)
+        when 'cd'
+          handle_cd(node)
         when 'chem'
           handle_chem(node)
         when 'jsxgraph'
           handle_jsxgraph(node)
         when 'texmacro'
           handle_texmacro(node)
+        when 'include_latex'
+          handle_include_latex(node)
         else
           handle_default(node)
       end
 
       node.attributes['roles'] = (node.roles + ['environment']) * ' '
       self.open node
-    end
+    end # method environment
+
+    def environment_literal node
+
+      warn "entering environment(node)".red if $VERBOSE
+
+      attrs = node.attributes
+
+      warn "attrs['role'] = #{attrs['role']}".blue if $VERBOSE
+
+      case attrs['role']
+        when 'box', 'capsule'
+          handle_null(node)
+        when 'code'
+          handle_code(node)
+        when 'equation'
+          handle_equation_literal(node)
+        when 'equationalign'
+          handle_equation_align(node)
+        when 'cd'
+          handle_cd(node)
+        when 'chem'
+          handle_chem(node)
+        when 'jsxgraph'
+          handle_jsxgraph(node)
+        when 'texmacro'
+          handle_texmacro(node)
+        else
+          handle_default(node)
+      end
+
+      node.attributes['roles'] = (node.roles + ['environment']) * ' '
+      self.open node
+    end # method environment_literal
 
     def handle_texmacro node
       node.title = nil
       node.lines = ["+++\n\\("] + node.lines + ["\\)\n+++"]
     end
 
+    # Example:
+    # [env.include_latex]
+    # --
+    # \nput abc.text
+    # \usepackage{def}
+    # --
+    # Nothing appears in the HTML,
+    # bu lines
+    # \nput abc.text
+    # \usepackage{def}
+    # appear in the generated tex file.
+    def handle_include_latex node
+      node.title = nil
+      node.lines = [] # ["// "] + node.lines
+      self.open node
+    end
+
     def click node
       if node.attributes['plain-option']
         node.lines = [ENV_CSS_PLAIN] + node.lines + [DIV_END]
@@ -215,9 +289,37 @@ module Asciidoctor::LaTeX
       self.open node
     end
 
+    def old_inline_anchor node
+      target = node.target
+      case node.type
+        when :xref
+          refid = node.attributes['refid'] || target
+          # NOTE we lookup text in converter because DocBook doesn't need this logic
+          text = node.text || (node.document.references[:ids][refid] || %([#{refid}]))
+          # FIXME shouldn't target be refid? logic seems confused here
+          %(<a href="#{target}">#{text}</a>)
+        when :ref
+          %(<a id="#{target}"></a>)
+        when :link
+          attrs = []
+          attrs << %( id="#{node.id}") if node.id
+          if (role = node.role)
+            attrs << %( class="#{role}")
+          end
+          attrs << %( title="#{node.attr 'title'}") if node.attr? 'title', nil, false
+          attrs << %( target="#{node.attr 'window'}") if node.attr? 'window', nil, false
+          %(<a href="#{target}"#{attrs.join}>#{node.text}</a>)
+        when :bibref
+          %(<a id="#{target}"></a>[#{target}])
+        else
+          warn %(asciidoctor: WARNING: unknown anchor type: #{node.type.inspect})
+      end
+    end
+
     def inline_anchor node
 
       case node.type.to_s
+
       when 'xref'
         refid = node.attributes['refid']
         if refid and refid[0] == '_'
@@ -239,13 +341,13 @@ module Asciidoctor::LaTeX
               output = "<span class='xref'><a href=\##{refid}>#{reftext}</a></span>"
             end
           else
-            output = 'ERROR: refs[refid] was nil'
+            output = old_inline_anchor node
           end
         end
       when 'link'
         output = "<a href=#{node.target}>#{node.text}</a>"
       else
-        output = 'FOOBAR'
+        output =  old_inline_anchor node
       end
       output
     end
@@ -266,6 +368,21 @@ module Asciidoctor::LaTeX
       end
     end
 
+    def handle_equation_literal(node)
+      attrs = node.attributes
+      options = attrs['options']
+      node.title = nil
+      number_part = '<td class="equation_number_style">' + "(#{node.caption}) </td>"
+      equation_part = ['<td class="equation_content_style";>'] + ['\\['] + node.lines + ['\\]'] + ['</td>']
+      table_style='class="equation_table_style"'
+      row_style='class="equation_row_style"'
+      if options.include? 'numbered'
+        node.lines =  ["<table #{table_style}><tr #{row_style}>"] + equation_part + number_part + ['</tr></table>']
+      else
+        node.lines =  ["<table #{table_style}><tr #{row_style}>"] + equation_part + ['</tr></table>']
+      end
+    end
+
     def handle_equation_align(node)
       attrs = node.attributes
       options = attrs['options']
@@ -282,6 +399,11 @@ module Asciidoctor::LaTeX
       end
     end
 
+    def handle_cd(node)
+      node.title = nil
+      node.lines  = ['\\[', '\require{AMScd}', '\\begin{CD}', node.lines, '\\end{CD}', '\\]']
+    end
+
     def handle_chem(node)
       node.title = nil
       number_part = '<td class="equation_number_style">' + "(#{node.caption}) </td>"
@@ -319,9 +441,6 @@ module Asciidoctor::LaTeX
       node.lines = line_array
     end
 
-
-
-
     def handle_null(node)
 
     end
@@ -354,12 +473,16 @@ module Asciidoctor::LaTeX
     Asciidoctor::Extensions.register do
       docinfo_processor CSSDocinfoProcessor
       preprocessor TeXPreprocessor
-      preprocessor MacroInsert if (File.exist? 'macros.tex' and document.basebackend? 'html') and !(document.attributes['noteshare'] == 'yes')
+      preprocessor MacroPreprocessor
+      preprocessor MacroInsert if (File.exist? 'macros.tex' and document.basebackend? 'html' and document.attributes['include_macros'] == 'yes')
       block EnvironmentBlock
+      block EnvironmentBlock2
       block ClickBlock
       inline_macro ChemInlineMacro
+      inline_macro GlossInlineMacro
+      inline_macro IndexTermInlineMacro
       # preprocessor ClickStyleInsert if document.attributes['click_extras'] == 'include2'
-      postprocessor InjectHTML unless document.attributes['noteshare'] == 'yes'
+      postprocessor InjectHTML unless document.attributes['inject_javascript'] == 'no'
       postprocessor EntToUni if document.basebackend? 'tex' unless document.attributes['unicode'] == 'no'
       postprocessor Chem if document.basebackend? 'html'
       postprocessor HTMLPostprocessor if document.basebackend? 'html'
@@ -398,7 +521,7 @@ module Asciidoctor::LaTeX
       if NODE_TYPES.include? node.node_name
         node.tex_process
       else
-        warn %(Node to implement: #{node.node_name}, class = #{node.class}).magenta  if $VERBOSE
+        warn %(Node to implement: #{node.node_name}, class = #{node.class}).magenta  # if $VERBOSE
         # This warning should not be switched off by $VERBOSE
       end
 
@@ -410,6 +533,9 @@ end # module Asciidoctor::LaTeX
 
 class Asciidoctor::Converter::Html5Converter
   # inject our custom code into the existing Html5Converter class (Ruby 2.0 and above)
+  # the ideal is to use 'prepend'; however, this is incompatible
+  # with the current version of Opal, so the alternative of 'include' is provided for
+  # cases in which 'prepend' is not available
   if respond_to? :prepend
     prepend Asciidoctor::LaTeX::Html5ConverterExtensions
   else

data/lib/asciidoctor/latex/environment_block.rb

@@ -86,6 +86,8 @@ module Asciidoctor::LaTeX
 
   class EnvironmentBlock < Asciidoctor::Extensions::BlockProcessor
 
+    # include Common # for method process
+
     use_dsl
 
     named :env
@@ -212,4 +214,139 @@ module Asciidoctor::LaTeX
     end
 
   end
+
+  class EnvironmentBlock2 < Asciidoctor::Extensions::BlockProcessor
+
+    # include Common # for method process
+
+    use_dsl
+
+    named :envv
+    on_context :literal
+    # parse_context_as :complex
+    # ^^^ The above line gave me an error.  I'm not sure what do to with it.
+
+    def process parent, reader, attrs
+
+      original_title = attrs['title']
+      attrs['original_title'] = attrs['title']
+
+      # Ensure that role is defined
+      if attrs['role'] == nil
+        role = 'item'
+      else
+        role = attrs['role']
+      end
+
+      # fixme: this should not be necessary
+      if attrs['role'] =~ /\\/
+        attrs['role'] = attrs['role'].gsub(/\\/, '')
+      end
+
+      # Determine whether the block is numbered
+      # Use the option set if present (numbered, no+_number) otherwise
+      # use a default value, e.g. 'box' is not numbered, the others are numbered
+      if !(attrs['options'] =~ /no_number|numbered/)
+        if %w(capsule box equation equationalign).include? role
+          attrs['options'] = 'no_number'
+        else
+          attrs['options'] = 'numbered'
+        end
+      end
+      if attrs['id']
+        attrs['options'] = 'numbered'
+      end
+
+
+      # Adjust title according to environment name
+      env_name = role # roles.first # FIXME: roles.first is probably best
+      if %w(equation equationalign chem).include? role
+        attrs['title'] = env_name
+      elsif role == 'code'
+        if attrs['id'] or attrs['title']
+          attrs['title'] = 'Listing'
+        else
+          attrs['title'] = ''
+          attrs['options'] = 'no_number'
+        end
+      elsif role == 'jsxgraph'
+        attrs['title'] = 'JSXGraph'
+      elsif role == 'box'or role == 'capsule'
+        attrs['title'] = ''
+      else
+        attrs['title'] = env_name.capitalize
+      end
+      env_title = attrs['title']
+
+
+      # Creat the block
+      if attrs['role'] == 'code'
+        warn "for rode = code, attrs = #{attrs}".cyan
+        block = create_block parent, :listing, reader.lines, attrs
+      else
+        #  block = create_block parent, :environment, reader.lines, attrs
+        # block = create_pass_block parent, html, attrs, subs: nil
+        block = create_block parent, :environment_literal, reader.lines, attrs, subs: nil
+      end
+
+      if attrs['options'] =~ /numbered/
+        # THE NUMBERED OPTION
+        # Use same prefix for cross referencing for the
+        # equation_align environment as for the equation
+        # environment so as not to have separate numbering
+        # sequences
+        if env_name == 'equationalign'
+          env_ref_prefix = 'equation'
+        else
+          env_ref_prefix = env_name
+        end
+        # Define caption_num so that we can make references
+        # that display as "(17)", for example
+        # This is where we can set the caption number by hand
+        # once I figure out how to do so.
+        caption_num = parent.document.counter_increment("#{env_ref_prefix}-number", block)
+        attrs['caption-num'] = caption_num
+        caption = "#{caption_num}"
+        # Set the title, e.g., "Theorem 3: Pythagoras" or just "Theorem 3"
+        # depending on whether the user sets a title, .e.g, ".Pythagoras"
+        # in the line preceding "[env.theorem]"
+        if original_title
+          attrs['title'] = "#{env_title} #{caption_num}: #{original_title}"
+        else
+          attrs['title'] = "#{env_title} #{caption_num}."
+        end
+      else
+        # THE NON-NUMBERED OPTION
+        # Set the title, e.g., "Pythagoras" or just "Theorem"
+        # depending on whether the user sets a title, .e.g, ".Pythgoras"
+        # in the line preceding "[env.theorem]"
+        # FIXME: this code is a tad spaghetti-like
+        if original_title
+          if  %w(box).include? role
+            attrs['title'] = "#{original_title}"
+          else
+            attrs['title'] = "#{env_title}: #{original_title}"
+          end
+        else
+          attrs['title'] = "#{env_title}"
+        end
+      end
+
+      if attrs['role'] == 'code'
+        caption = nil
+      end
+
+      block.assign_caption caption
+      if %w(equation equationalign chem).include? role
+        block.title = "#{caption_num}"
+      else
+        block.title = attrs['title']
+      end
+      block
+
+    end
+
+  end
+
+
 end