asciidoctor-latex 1.5.0.dev

data/test/html_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+DocTest.examples_path = ['test/examples/html', 'test/examples/asciidoc-html']
+
+class HtmlTest < DocTest::Test
+  converter_opts backend_name: 'html'
+  generate_tests! DocTest::HTML::ExamplesSuite
+end

data/test/latex_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+DocTest.examples_path.unshift 'test/examples/tex', 'test/examples/adoc'
+
+class LatexTest < DocTest::Test
+  converter_opts backend_name: 'latex'
+  generate_tests! DocTest::Latex::ExamplesSuite
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'asciidoctor/doctest'
+require 'asciidoctor/latex'
+require 'minitest/autorun'
+require 'minitest/rg'

data/test_jc/admonition.adoc

@@ -0,0 +1,4 @@
+== Test: admonition
+
+NOTE: This is a note
+  

data/test_jc/click.adoc

@@ -0,0 +1,7 @@
+== Test: click
+
+[click.comment]
+--
+Be serious.
+--
+

data/test_jc/env.adoc

@@ -0,0 +1,31 @@
+== Test: Environment Blocks
+
+[env.theorem#pyth]
+--
+If $a$ and $b$ are the sides
+of a right triangle and $c$
+is the hypotenuse, then
+\[
+  a^2 + b^2 = c^2
+\]
+--
+
+[env.equation#binomial]
+--
+(a + b)^2 = a^2 + 2ab + b^2
+--
+
+[env.listing]
+--
+if a in b
+  foo(a,b)
+  blatzo(a+b)
+--
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam sit amet interdum elit. Quisque viverra feugiat massa hendrerit sagittis. Quisque at arcu massa. Nulla facilisi. Cras et ligula sapien. Donec commodo viverra dui at rhoncus. In consequat ut nisl in mollis. Nullam id turpis quam. Maecenas felis arcu, semper ut vulputate ut, maximus in elit. Etiam in tempor leo.
+
+Sed nec eleifend arcu. Nulla pulvinar nulla ac ornare rutrum. Fusce arcu lacus, convallis quis ante eu, pulvinar iaculis ante. Vivamus porta sagittis orci ut molestie. Fusce rhoncus porta est vel maximus. Proin tincidunt mauris ac augue pellentesque, et commodo sapien accumsan. In vel rhoncus odio. Cras congue, quam non dapibus sagittis, nibh ligula interdum nibh, vitae auctor enim ipsum sed enim.
+
+
+
+Most people know <<pyth>> and equation <<binomial>>.

data/test_jc/example.adoc

@@ -0,0 +1,17 @@
+.Sample document
+====
+Here's a sample AsciiDoc document:
+
+
+= Title of Document
+Doc Writer
+:toc:
+
+This guide provides...
+
+
+The document header is useful, but not required.
+
+== Technical appendix
+
+====

data/test_jc/floating_title.adoc

@@ -0,0 +1,15 @@
+:numbered:
+== Test Discrete
+
+=== Setting up the workshop
+
+[discrete]
+=== Advice to toolsmiths
+
+[float]
+=== Safety procedures
+
+
+
+
+=== Accounting procedures

data/test_jc/image.adoc

@@ -0,0 +1,84 @@
+== Test: Image
+
+:imagesdir: ./images
+
+
+Frogs can be both beautiful and poisonous.
+
+[.text-center]
+.Poisonous blue frog
+image::frog.jpg[width=200,align=center]
+
+
+
+
+
+Lorem ipsum dolor sit amet, dolor quis pede, et
+dignissim nec mauris vitae non, ut felis quam
+sagittis leo vulputate, purus massa praesent
+ultricies orci vivamus, imperdiet imperdiet ante.
+Tempor sit congue, quam pulvinar dictumst ante
+integer gravida, diam morbi facilisis placerat
+urna nam, pulvinar integer placerat aliquet nibh
+senectus. Tristique sed aliquet ultrices nulla,
+morbi egestas, dui phasellus. Sed nulla cras cum,
+egestas vel, dui tellus euismod lectus
+pellentesque commodo, montes at, pretium elementum
+ut suscipit nec vestibulum nulla. Viverra
+fermentum arcu, augue auctor dolor tortor vel
+mauris id, a eros proin dui. Orci eget mauris,
+vestibulum in posuere, dolor quam.
+
+image::yellow_frog.jpeg[float=left]
+
+Orci nunc ipsum curabitur sit, consectetuer
+suspendisse numquam nonummy neque et, praesent
+voluptas id sit donec eu posuere, eget tempus vel.
+Ante elit vestibulum sollicitudin suscipit a. Id
+ut fusce. Non duis sodales sed, in porttitor
+vulputate in sit morbi non, integer elementum quis
+quis, fringilla integer est enim vel, ac sed
+maecenas ut enim ridiculus nisl. Elit nec sed
+sodales, mauris egestas, aliquet volutpat
+suspendisse gravida duis tempus in, volutpat vitae
+egestas aliquet nec sit, libero orci tincidunt
+sed. Hendrerit ut dictum nascetur ullamcorper
+risus neque. Vestibulum a, maxime vestibulum quis
+est sit, erat porttitor, per mus. Quisque
+vestibulum, cras consequat risus eget risus,
+inceptos nulla id luctus ligula sunt, est inceptos
+arcu amet, vivamus integer tempor scelerisque.
+Libero fusce euismod, possimus eu erat convallis
+nunc, orci cras hymenaeos ut tempus mi viverra,
+fermentum dolor fames explicabo libero, vel in.
+Integer at est tellus etiam a, urna sed nunc, cras
+dictumst, velit integer. Sed montes velit
+venenatis, turpis bibendum pharetra luctus neque
+dui, in praesent, sed nec vitae. Imperdiet et
+neque nunc proin vulputate, velit fringilla in
+odio iaculis wisi, laboris lorem etiam ultricies.
+
+image::red_frog.jpeg[float=right, width=300]
+
+Condimentum amet semper orci pretium, at consequat
+pellentesque, interdum aut sed tempus vehicula
+egestas magna, sunt egestas. Mus auctor tempus
+aliquam, aliquam lorem nulla. Ut neque et
+scelerisque gravida convallis proin, vestibulum et
+mi nonummy sit pellentesque, eget nec aliquet
+posuere nonummy leo, risus integer, mattis justo
+enim nec urna quis. Tristique ipsum risus est ac.
+Tristique aliquam velit turpis feugiat nullam,
+scelerisque erat fringilla pulvinar, feugiat non
+per, magna phasellus erat aliquam blandit. Lorem
+in diam, quis ipsum blandit vestibulum sed.
+
+Justo sodales faucibus vel corporis. Lorem
+suspendisse. A leo purus, pede odio duis integer
+ligula eget mollis. Lorem interdum mus id. Nec
+duis odio vel aliquam felis gravida, nulla dolor
+morbi pede per cras tellus, gravida pellentesque
+aliquet, purus vitae ultrices non, vitae curae mi
+neque. Sit et feugiat bibendum sed mi inceptos,
+nibh integer, sed nec ac proin sed wisi sed,
+pretium volutpat enim pellentesque tellus.

data/test_jc/listing.adoc

@@ -0,0 +1,9 @@
+
+== Test: listing
+
+[listing]
+--
+abc
+  def
+    gi
+--

data/test_jc/lists.adoc

@@ -0,0 +1,20 @@
+== Test: lists
+
+=== Numbered List (Groceries)
+
+. Eggs
+. Milk
+. Flour
+
+=== Itemized List (Meeting)
+
+. Minutes
+. Old Business
+. New Business
+. Adjourn
+
+=== Definition List (Science)
+
+Physics:: atoms, electrons, etc
+
+Biology:: cells, organisms, evolution

data/test_jc/math.adoc

@@ -0,0 +1,10 @@
+== Test math
+
+This is is an inline formula: $a^2 + b^2 = c^2$.
+
+This is a displayed formula -- it costs \$100:
+\[
+   \int_0^1 x^n dx = \frac{1}{n}
+\]
+
+NOTE: At this time, `\$\$ ... \$\$` is not supported.

data/test_jc/preamble.adoc

@@ -0,0 +1,14 @@
+= The Dangerous and Thrilling Documentation Chronicles
+Kismet Chameleon
+
+This journey begins on a bleary Monday morning.
+Our intrepid team is in desperate need of double shot mochas, but the milk expired eight days ago.
+A trip to the dairy was out of the question.
+On Friday night, a mutant, script-injecting warlock had infected the Shetland cattle herd with a ravenous craving for tags and annotations.
+The security wolves were at a trust building retreat in Katchanga, and no one in the village could locate their defensive operations manual.
+
+Weak daylight trickled across the stripped pasture, chased by distant bovine screams...
+
+== Cavern Glow
+
+The river rages through the cavern, rattling its content...

data/test_jc/section-numbered.adoc

@@ -0,0 +1,9 @@
+:numbered:
+
+== Test: sections
+
+=== Subsection
+
+==== Subsubsection
+
+===== Subsubsubsection

data/test_jc/section.adoc

@@ -0,0 +1,7 @@
+== Test: sections
+
+=== Subsection
+
+==== Subsubsection
+
+===== Subsubsubsection

data/test_jc/sidebar.adoc

@@ -0,0 +1,61 @@
+== Test: Sidebar
+
+
+
+
+
+Lorem ipsum dolor sit amet, dolor quis pede, et
+dignissim nec mauris vitae non, ut felis quam
+sagittis leo vulputate, purus massa praesent
+ultricies orci vivamus, imperdiet imperdiet ante.
+Tempor sit congue, quam pulvinar dictumst ante
+integer gravida, diam morbi facilisis placerat
+urna nam, pulvinar integer placerat aliquet nibh
+senectus. Tristique sed aliquet ultrices nulla,
+morbi egestas, dui phasellus. Sed nulla cras cum,
+egestas vel, dui tellus euismod lectus
+pellentesque commodo, montes at, pretium elementum
+ut suscipit nec vestibulum nulla. Viverra
+fermentum arcu, augue auctor dolor tortor vel
+mauris id, a eros proin dui. Orci eget mauris,
+vestibulum in posuere, dolor quam.
+
+[sidebar]
+--
+Orci nunc ipsum curabitur sit, consectetuer
+suspendisse numquam nonummy neque et, praesent
+voluptas id sit donec eu posuere, eget tempus vel.
+Ante elit vestibulum sollicitudin suscipit a. Id
+ut fusce. Non duis sodales sed, in porttitor
+vulputate in sit morbi non, integer elementum quis
+quis, fringilla integer est enim vel, ac sed
+maecenas ut enim ridiculus nisl. Elit nec sed
+sodales, mauris egestas, aliquet volutpat
+suspendisse gravida duis tempus in, volutpat vitae
+egestas aliquet nec sit, libero orci tincidunt
+sed. Hendrerit ut dictum nascetur ullamcorper
+risus neque.
+--
+
+Condimentum amet semper orci pretium, at consequat
+pellentesque, interdum aut sed tempus vehicula
+egestas magna, sunt egestas. Mus auctor tempus
+aliquam, aliquam lorem nulla. Ut neque et
+scelerisque gravida convallis proin, vestibulum et
+mi nonummy sit pellentesque, eget nec aliquet
+posuere nonummy leo, risus integer, mattis justo
+enim nec urna quis. Tristique ipsum risus est ac.
+Tristique aliquam velit turpis feugiat nullam,
+scelerisque erat fringilla pulvinar, feugiat non
+per, magna phasellus erat aliquam blandit. Lorem
+in diam, quis ipsum blandit vestibulum sed.
+
+Justo sodales faucibus vel corporis. Lorem
+suspendisse. A leo purus, pede odio duis integer
+ligula eget mollis. Lorem interdum mus id. Nec
+duis odio vel aliquam felis gravida, nulla dolor
+morbi pede per cras tellus, gravida pellentesque
+aliquet, purus vitae ultrices non, vitae curae mi
+neque. Sit et feugiat bibendum sed mi inceptos,
+nibh integer, sed nec ac proin sed wisi sed,
+pretium volutpat enim pellentesque tellus.

data/test_jc/verse.adoc

@@ -0,0 +1,15 @@
+
+== Test: verse
+
+[verse]
+--
+I used to love my garden
+But now my love is dead
+For I found a bachelor’s button
+In black-eyed Susan’s bed.
+
+I used to love my garden
+But now my love is dead
+For I found a bachelor’s button
+In black-eyed Susan’s bed.
+--

data/try-out/README.adoc

@@ -0,0 +1,348 @@
+:numbered:
+:toc2:
+:max-width: 60%
+
+:stem: latexmath
+
+
+
+== Introduction
+
+
+
+The aim of Asciidoctor's LaTeX converter is
+
+. To render AsciiDoc documents as LaTeX.
+
+. To add to Asciidoctor's facilities for handling mathematical notation when rendered as HTML
+
+As an example of both features, you can write automatically numbered equations, e.g.,
+
+[env.equation]
+--
+\int_{|z| = 1} \frac{dz}{z} = 2\pi \sqrt{-1}
+--
+
+by writing this in Asciidoc
+
+----
+[env.equation]
+--
+\int_{|z| = 1} \frac{dz}{z} = 2\pi \sqrt{-1}
+--
+----
+
+
+To render your document as tex, type the commmand
+`asciidoctor-latex foo.adoc`.
+To render your document as HTML, use the `html`
+backend: type the
+command `asciidoctor-latex -b html foo.adoc`.
+
+
+Automatically numbered theorems, definitions, etc., are
+written in the same way
+
+----
+
+[env.theorem#th-pythag#integral]
+--
+For a right triangle, the square on the hypotenuse is equal to the summ
+of the squares of the two remaining sides, i.e.,
+\[
+     c^2 = a^2 + b^2.
+\]
+-
+----
+
+[env.theorem#th-pythag]
+--
+For a right triangle, the square on the hypotenuse is equal to the summ
+of the squares of the two remaining sides, i.e.,
+\[
+     c^2 = a^2 + b^2.
+\]
+--
+
+The optional string `#th-pythag` is a label for purposes of cross-referencing:
+----
+   <<th-pythag>>
+----
+Using the above code, we may later refer to <<th-pythag>>.
+The cross-referencing style applies to env-blocks in general,
+e.g., to
+
+[env.equation#eq-pythag]
+--
+c^2 = a^2 + b^2
+--
+Cross-references are made like this:
+----
+  <eq-pythag>>
+----
+but the rendered
+cross-reference is different: we refer to equation <<eq-pythag>>,
+formula <<eq-pythag>>, etc.  The ``[env.code]`` block also receives
+special treatment. The source text
+----
+[env.code#iter]
+--
+def iter(f, a, n)
+  n.times do
+    a = f.call(a)
+    puts a
+  end
+  return  a
+end
+--
+----
+is rendered as
+
+[env.code#iter]
+--
+def iter(f, a, n)
+  n.times do
+    a = f.call(a)
+    puts a
+  end
+  return  a
+end
+--
+
+
+
+
+== First tests
+
+
+
+Below are some examples you can run through Asciidoctor to see what you can do with it.
+We assume that you've already installed asciidoctor-latex (see README for instructions).
+Now try this
+
+```
+  $ asciidoctor -b html eq-latex.adoc
+```
+
+After running the above command, you should find the file `eq-latex.html`
+next to the source file `eq-latex.adoc`. View it in your browser.
+You will need to be connected to the internet so that your browser
+can load the MathJax fonts used to render mathematical
+notation.footnote:[You can also install the fonts on your system.
+See http://www.mathjax.org/help/fonts/[mathjax-fonts]. this will give you faster reponse.
+Turning off your internet conneection makes it better still:-(]
+
+Lets test the analogous file written in `stem` format:
+
+```
+  $ asciidoctor -r asciidoctor-latex -a stem eq-stem.adoc
+```
+
+Now convert our first file into LaTeX by running the command
+
+```
+  $ asciidoctor -r asciidoctor-latex -a stem=latexmath -b latex eq-latex.adoc
+```
+or simply with the wrapper script
+```
+  $ asciidoctor-latex eq-latex.adoc
+```
+
+If all was successful, there will be a file `eq-latex.tex` alongside
+your source file `eq-latex.adoc`.  You can process it as you
+would any LaTeX file.
+
+
+
+
+
+== Examples
+
+Below is a list of files which demsonstrate various features
+of the converter.  In some cases there are two versions, e.g.
+`eq-latex.adoc` and `eq-stem.adoc`, each written in the
+indicated format.footnote:[A missing entry in the table
+may mean that a feature has not yet been implemented,
+or that the file demonstrating it has not yet been
+written and/or tested.]  In other cases, there
+is the same file appears in both the LaTeX
+and the STEM columns.  In those cases
+the `-a stem` or `-a stem:latexmath` option
+is not required unless there is mathematical
+content.
+
+One of the best ways
+of learning how to use the features of
+Asciidotor LaTeX is to use your
+natural talent for reverse-engineering:
+run the example, the compare the rendered
+file and its source.
+
+[options=header, width=80%, align=center]
+|===
+| LaTeX | STEM | Comments
+| `eq-latex.adoc` | `eq-stem.adoc` | Basic equations
+| `eqno-latex.adoc` | --  | Numbered equations
+| `theorem-latex.adoc` | -- | Numbered theorems
+| `env.adoc` | `env.adoc` | Env blocks
+| `click.adoc` | `click.adoc`  | Click blocks
+| `code.adoc` | code.adoc` | Code blocks
+|===
+
+
+
+== Comments on the examples
+
+=== eq-latex
+
+Basic equations, both in-line, as with \(a^2 + b^2 = c^2\),
+and displayed, as with
+\[
+  a^n + b^n = c^n
+\]
+
+
+The environment `[env.equation]` is automatically
+numbered by default, as in the examples below.
+
+
+[env.equation]
+--
+  a^3 + b^3 = c^3
+--
+
+
+[env.equation]
+--
+  \int_0^1 x^n dx = \frac{1}{n}
+--
+
+Here is how the first equation is done:
+----
+[env.equation]
+--
+  a^3 + b^3 = c^3
+--
+----
+
+
+=== theorem-latex
+
+Numbered theorems, like the those below.
+
+
+[env.theorem]
+--
+\[
+  a + (b + c) = (a + b) + c
+\]
+--
+
+[env.theorem]
+--
+\[
+  a(b+c) = ab + ac
+\]
+--
+
+
+=== env
+
+The file `env.adoc`, which only requires the converter,
+illustrates general usage of the `env`-block.  It gives
+an automatically numbered and titled block.  Thus repeated use
+of `[env.objection]` gives this.
+
+[env.objection]
+--
+This is hearsay.
+--
+
+[env.objection]
+--
+That evidence has not been admitted before the court.
+--
+
+The first objection was written like this:
+
+----
+[env.objection]
+--
+This is hearsay.
+--
+----
+
+=== click
+
+
+Click blocks are like `env`-blocks, except that
+when you open a document, only the title,
+not the body of the block, is displayed.
+Click on the title to reveal the body;
+clicking again will return the body
+to its hidden sate.  Click blocks
+signal their presence by the blue
+color of the title.
+
+.Secret message
+[click.message]
+--
+The path to wisdom is written on no
+secret map.
+--
+
+Click blocks are useful in making up problem sets,
+homework assignments, study guides, etc.
+
+
+=== code
+
+The file `code.adoc` illstrates the versatilty of the `[env]`
+and `[click]` blocks which are used here in their `code` role.
+We explain how we do the two blocks below and related pieces
+of writing.
+
+
+[env.code#iter]
+--
+def iter(f, a, n)
+  n.times do
+    a = f.call(a)
+    puts a
+  end
+  return  a
+end
+--
+
+.Results
+[click.code%numbered]
+--
+irb> iter $g, 1.0, 6
+1.5
+1.4166666666666665
+1.4142156862745097
+1.4142135623746899
+1.414213562373095
+1.414213562373095
+=> 1.414213562373095
+--
+
+
+== Issues
+
+One should be able to tex this document wihout error
+and obtain the desired output.  This is very much a work
+in progress.  In particaulr, the following have not yet been resolved.
+
+. Dollars signs used to illustrated command cause LaTeX to choke.
+  We need to map dollar sign to escaped dollar sig in
+  post-processing for tex.  Or is there a better solution?
+
+. The table block in Asciidoc is not implmented -- or rather,
+  is partially implemnted.
+
+. The Click block is not implented in teh TeX output.
+
+. The matrix environment in `eq-stem.adoc` does not render correctly.
+
+. Fix title in latex mode