asciidoctor-latex 1.5.0.dev → 1.5.0.1.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e5580fadffd5a0ff5f968e8672225c1b387a434
-  data.tar.gz: 67f763319571a6cb2ee224bf79b5044d945e82fe
+  metadata.gz: b8311fb6bf67fe3fdad35eda206272fca2cee6bd
+  data.tar.gz: 9d9e0614a2e8bddb8f28776ab57fe58298659e64
 SHA512:
-  metadata.gz: f7aeb65738dea61724b8295e2f6fad7eebabd95b7daa0195a6faebee124194a37d44cf0fe50a7cb1498e7454d39b767728e8f0ac873ad4456c51730ff3ab138b
-  data.tar.gz: e47b504a4b7b0752656d675c632aef95e3f5247e00bed9785069c2102980427edbe9f6e5640fbf068de088dc9c601e9d49f1c6b1e8b5cf6cc21a594238057e36
+  metadata.gz: b0276015c4a3531b4768f42a0255653c7daa2c8a0d307ebc769428b4821b282f8d172893c300f5518963931d6689666bc01e9ddc8e9ed89385e60327d90d568e
+  data.tar.gz: 3eea9dd3976da80e860076185863868c4db050cb30496f093d68f75d487d51789e8d81d1c7a1e0cb139687614be182af943243e191dbb5a6977b12fe0cd08549

data/README.adoc

@@ -1,4 +1,4 @@
-= AsciiDoc to LaTeX Converter for Asciidoctor
+= AsciiDoc-LaTeX Converter for Asciidoctor
 James Carlson
 
 :numbered:
@@ -7,24 +7,48 @@ James Carlson
 
 == Purpose
 
-The aim of the LaTeX converter is to transform an AsciiDoc document containing
-mathematical notation into a LaTeX document.
-The converter also adds to Asciidoctor's facilities for handling mathematical
-notation when rendered as HTML.  Among these are the automatic numbering of theorems
-and equations.
-Please see the file [path]_manual.adoc_ in this repository for additional details
-and for technical information.
+Asciidoc-LaTeX defines an extended mathematical syntax
+for Asciidoc that closely parallels LaTeX.  The
+Asciidoctor-LaTeX converter renders documents written
+in this extended markup language into both HTML
+and LaTeX.footnote:[Many, but not all Asciidoc language
+features are covered by this release.]
 
-For examples and a quick start guide, see <<Getting started>>.
-Below, we describe the <<Document format,document formats>> used
-for mathematics and the <<Command for rendering,commands>> for rendering a document into HTML or LaTeX.
+This README is very brief because mathematical
+markup in Asciidoc-LaTeX will not render in GitHub.
+For a better view of what Asciidoc-LaTeX does, follow the
+installation instructions and then run
+
+----
+ $ asciidoctor-latex -b html start.adoc
+----
+on the files `start.adoc`, etc found
+in the directory `examples` of this repository.
+This command produces the file `start.html`.
+It can be viewed with any browser.  You will
+need an internet connection , since the browser
+ must load he MathJax fonts.
+
+NOTE: Consult the
+http://noteshare.io/book/asciidoctor-latex-manual[Asciidoctor-LaTeX manual]
+for more information and for a view of both
+source and rendered text for
+Asciidoc-LaTeX.  For more information on conversion
+of Asciidoc-LaTeX documents to LaTeX, see
+`manual.adoc` _(needs update)_.
+
+
+Asciidoctor-LaTeX is developed by James Carlson, Jakub Jirutka, and Dan Allen.
+_In progress: Cross-compilation to Asciidoctor.js by Guillaume Grossetie makes
+possible other uses, among which will be inclusion in the Chrome
+Live Preview Extension._
 
 
 == Installation
 
 === Using Rubygems
 
-_asciidoctor-latex has not been released yet_
+There is a development release.  Beta alert!
 
 === From repository
 
@@ -36,45 +60,37 @@ If you would like to install a development version from the repository, use:
  $ gem install *.gem
 
 
-== Getting started
-
-The directory `try-out` contains a set of examples which
-show what Asciidoctor LateX can do.  Consult the `README` file
-for directions on how to render an examples as
-HTML or LaTeX. By comparing the source and rendered files,
-you will quickly see how to write Asciidoc LaTeX.
-
-
-
 == Document format
 
-Asciidoctor supports two closely-related math formats, [blue]#AsciiMath# and [blue]#LaTeX#.
-For in-line mathematics, the first looks like `+++stem:[ a^2 + b^2 = c^2 ]+++`, while the
-second looks like `$ a^2 + b^2 = c^2 $`.  Both render as stem:[ a^2 + b^2 = c^2 ].
-For displayed text, one can use
+Asciidoctor supports two closely-related
+math formats, [blue]#Asciidoc-LaTeX#
+and [blue]#AsciiMath#.
+In Asciidoc-LaTeX,
+one can write `$ a^2 + b^2 = c^2 $` and
+----
+ \[
+    e^{2\pi \sqrt{-1}} = 1,
+ \]
+----
+for in-line and dipplay mathematial
+text, respectively.
+You will need to express dollar-denominated
+currency using
+escaped dollar signs: "He paid \$100 for that
+theore.m"  In AsciiMath, one writes
+`+++stem:[ a^2 + b^2 = c^2 ]+++`
+and
 ----
   [stem]
   ++++
-    e^{2\pi \sqrt{-1}} = 1
+    e^{2\pi \sqrt{-1}} = 1.
   ++++
 ----
-or
-----
-  \[
-     e^{2\pi \sqrt{-1}} = 1
-  \]
-----
-Both render as
-  \[
-     e^{2\pi \sqrt{-1}} = 1
-  \]
-_Please note that the formulae above will not render properly
-if you are reading it on GitHub.  It will, however, render properly if you run
-this file through Asciidoctor_.
 
-== Asciidoctor environments
 
-Asciidoctor supports an `env` construct that maps to LaTeX environments.
+== Asciidoc-LaTeX environments
+
+Asciidoc-LaTeX supports an `env` construct that maps to LaTeX environments.
 Thus
 ----
 [env.theorem]
@@ -82,48 +98,75 @@ Thus
 There exist infinitely many prime numbers.
 --
 ----
-renders as an automatically numbered theorem:
-
+renders as an automatically numbered theorem.
+Environments can contain in-line and display mathematics, e.g.,
+----
 [env.theorem]
 --
-There exist infinitely many prime numbers.
+A two-by-two matrix is invertible if
+its determinant is nonzero, i.e., if
+\[
+  \left|\begin{matrix}
+    a & b \\
+    c & d
+  \end{matrix}\right| \ne 0
+\]
+This result extends to $n\times n$ matrices.
 --
+----
 
-Likewise, using `[env.definition]`, we obtain
+There is complete freedom in parameter `NAME`
+of `[env.NAME]`, Thus,one can write
+----
 [env.definition]
 --
-An integer $n$ is *prime* if (a) it is not $\pm 1$
-and (b) it has no divisors other
+An integer $n$ is *prime* if (a) it is not
+$\pm 1$ and (b) it has no divisors other
 than $\pm 1$ and $\pm n$.
 --
-
-For numbered equations, use `[env.equation]` like this
-
 ----
-[env.equation]
+or
+----
+[env.joke]
 --
-a^{p-1} \equiv 1\ \text{mod}\ p
+A mathematician, a philosopher, and
+a lawyer met at the local bar
+for a drink.  The lawyer said ...
 --
 ----
+One can make cross references by labeling
+the environment as in
+----
+[env.joke#mathjoke1]
+--
+A mathematician, a philosopher, and
+a lawyer met at the local bar
+for a drink.  The lawyer said ...
+--
+----
+then referencing it later as `<<mathjoke1>>`.
 
-to obtain the rendered text
+Certain environments receive special treatment.
+For numbered equations, use `[env.equation]`
+like this
 
+----
 [env.equation]
 --
 a^{p-1} \equiv 1\ \text{mod}\ p
 --
+----
 
+For sets of equations, use `[env,equationalign]`:
+----
+[env.equationalign]
+--
+A & = 4\pi r^2 \\
+V & = \frac{4}{3} \pi r^3
+--
+----
 
 
-Except for `[env.equation]`, the TeX constructs `$ ... $` and
-`\[ ... \]` can be used in `[env]` blocks.
-For directions on making cross-references and labeling theorems, equations, etc., see
-the `README` file in the `try-out` directory.  For an extensive
-example of the use of Asciidoctor LaTeX, see
-http://www.noteshare.io/section/the-fundamental-class-of-projective-space[this].
-All of these constructs discussed above are translated into native LaTeX when
-the converter is used to produuce tex output.
-
 
 
 == Click blocks
@@ -133,77 +176,30 @@ the block is not displayed until the user clicks on the heading.
 The heading of a click block is displayed in blue.  Once a click
 block is "opened", it can be closed by clicking again on the heading.
 
-[click.comment]
---
-It is sometimes useful to "hide" a comment in a click block
-so as not to unduly disturb the flow of the prose. Click
-blocks are also useful for problem sets, since one
-can make hints, solutions, etc. clickable.
---
-
-The source for the above comment is
-
 ----
 [click.comment]
 --
-It is sometimes useful to "hide" a comment ...
---
+It is sometimes useful to "hide" a comment
+in a click block so as not to unduly
+disturb the flow of the prose. Click
+blocks are also useful for problem sets,
+since one can make hints, solutions, etc.
+clickable.
 ----
 
+
 The default for click blocks is not to number them.
-See the file `click.adoc` in the `try-out` directory
+See the file `click.adoc` in the `exampless` directory
 for more information.
 
 == Commands for rendering
 
 Asciidoc math files can be rendered
 
-. as HTML (the default)
-. with the LaTeX converter additions such as automatic theorem numbering
-. as LaTeX
-+
-*Note.* Forthcoming releases will make it possible to render
-+
-. as PDF
-. as EPUB3 (Electronic book)
-
-
-=== HTML output
-
-To render a file into HTML, the Asciidoctor default,
-use the usual `asciidoctor` command with this option:
-```
-  $ asciidoctor -a stem foo.adoc
-```
-or with this
-```
-  $ asciidoctor -a stem=latexmath foo.adoc
-```
-depending on the format.
-
-
-=== LaTeX converter additions
-
-To employ the converter additions such as automatic theorem numbering, use
-```
-  $ asciidoctor -r asciidoctor-latex -a stem=latexmath -b html foo.adoc
-```
-or
-```
-  $ asciidoctor-latex -b html foo.adoc
-```
-
-
-=== LaTeX output
-
-To render a file into LaTeX, use the `-r` (require rubygem) and `-b` (backend) option, e.g.:
-```
-  $ asciidoctor -r asciidoctor-latex -a stem=latexmath -b latex foo.adoc
-```
-or simply with the wrapper script:
-```
-  $ asciidoctor-latex foo.adoc
-```
+* as HTML.  Use `$ asciidoctor-latex -b html foo.adoc` to produce `foo.html`.
+With this command the Asciidoc-LaTeX syntax and extensions will be rendered.
+* as LaTeX.  Use `$ asciidoctor-latex foo.adoc`
+to produce `foo.tex`.
 
 
 == Switches

data/data/extras.css

@@ -0,0 +1,6 @@
+.openblock.box.content {
+    margin-top:1em;
+    margin-bottom: 1em;
+    margin-left:3em;
+    margin-right:4em;
+}

data/{try-out → examples}/README.adoc

@@ -10,11 +10,15 @@
 
 
 
-The aim of Asciidoctor's LaTeX converter is
+The aim of the Asciidoc-LaTeX converter is
 
-. To render AsciiDoc documents as LaTeX.
 
-. To add to Asciidoctor's facilities for handling mathematical notation when rendered as HTML
+. To add LaTeX-like facilities
+to  Asciidoc for handling mathematical notation when rendered as HTML.
+We refer to the extended Asciidoc markup language as Asciidoc-LaTeX.
+
+. To render AsciiDoc-LaTeX documents into LaTeX.
+
 
 As an example of both features, you can write automatically numbered equations, e.g.,
 
@@ -23,7 +27,7 @@ As an example of both features, you can write automatically numbered equations,
 \int_{|z| = 1} \frac{dz}{z} = 2\pi \sqrt{-1}
 --
 
-by writing this in Asciidoc
+by writing this
 
 ----
 [env.equation]

data/examples/box.adoc

@@ -0,0 +1,16 @@
+Ho hum, said the professor:
+
+.Foobar
+[env.box]
+--
+The curve $M'$ was compactified by adding $d$ points "at infnity".
+The locus "infinity" is the locus $Z = 0$.  Tha locus is la di dah di dah ..
+--
+
+.Laak Boribuul
+[env.box%numbered]
+--
+The curve $M'$ was compactified by adding $d$ points "at infnity".
+The locus "infinity" is the locus $Z = 0$.  Tha locus is la di dah di dah ..
+--
+

data/examples/chem.adoc

@@ -0,0 +1,17 @@
+== Test
+
+[env.code]
+--
+for k in foo:
+ do bar
+--
+
+[env.chem]
+--
+H2O
+--
+
+[env.equation]
+--
+a^7 = 1
+--

data/examples/eq-alignment.adoc

@@ -0,0 +1,5 @@
+[env.equationalign]
+--
+A & = 4\pi r^2 \\
+V & = \frac{4}{3} \pi r^3
+--

data/examples/eq-block.adoc

@@ -0,0 +1,60 @@
+== Some Equations
+:foo: 'locus'
+
+=== Number Theory
+
+The equation
+$a^2 + b^2 = c^2$ has infinitely many
+non-proportional integer solutions.
+The integer solutions of the equation
+[env.equation#eq-fermat]
+--
+  a^3 + b^3 = c^3
+--
+are trivial: at least one entry is
+zero and the others are "obvious"
+
+=== Calculus
+
+A definite integral with no equation number
+[env.equation%no-number]
+--
+  \int_0^1 x^n dx = \frac{1}{n}
+--
+
+A definite integral with an equation number:
+[env.equation]
+--
+  \int_0^1 x^n dx = \frac{1}{n}
+--
+
+The fundamental theorem of calculus:
+[env.equation]
+--
+   \frac{d}{dx} \int_a^x f(t) dt = f(x)
+--
+
+=== Linear algebra
+
+A matrix:
+[env.equation]
+--
+M = \left[
+  \begin{array}{ c c }
+	 1 & 2 \\
+	 3 & 4
+  \end{array} \right]
+--
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam sed lorem enim. Donec ut porta augue. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin vel pulvinar mi. Donec eu viverra arcu. Aenean accumsan lectus sit amet dui bibendum tristique. Vivamus a magna ut lectus tempus placerat quis in metus. Donec sagittis, lacus at porttitor porttitor, turpis ipsum malesuada risus, quis luctus magna ex ac neque. Curabitur a lacus et arcu vulputate sagittis eget ut leo. In at dolor mollis, semper nisl tempus, cursus turpis. Donec ipsum eros, pharetra pharetra molestie eu, posuere eget ipsum.
+
+Mauris vitae lorem a felis sollicitudin ornare. Nullam iaculis eleifend fermentum. Duis non justo sapien. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec sed diam nibh. Aliquam aliquam a urna ut scelerisque. Aliquam posuere lectus et condimentum fermentum. Quisque eleifend, purus eget sodales venenatis, leo enim egestas lectus, non semper felis felis in arcu. Phasellus sed turpis erat. Mauris scelerisque finibus sollicitudin. Nam non lectus orci. Pellentesque vitae aliquam orci. Quisque congue posuere dui. Vestibulum et ipsum nulla. Vivamus aliquet egestas lorem, non condimentum leo suscipit vel.
+
+Sed consectetur efficitur arcu vitae gravida. Donec non neque rhoncus, vehicula elit sit amet, sagittis metus. Nulla eleifend dui et finibus luctus. Quisque pulvinar elit libero, sit amet vestibulum sapien iaculis sed. Maecenas imperdiet massa id condimentum sollicitudin. Duis vestibulum feugiat elit, at tincidunt justo placerat vitae. Vivamus leo neque, posuere et risus vestibulum, molestie fermentum enim. Integer eget vulputate libero. Ut id ligula id massa dignissim dictum.
+
+Sed non libero aliquet, ultrices nulla ac, accumsan erat. Nulla posuere lectus ut imperdiet ullamcorper. Pellentesque consequat vestibulum neque eget ornare. Etiam porttitor nunc purus, non ullamcorper nulla sodales id. Aliquam dapibus maximus odio. Nunc rhoncus iaculis lectus in scelerisque. Vivamus est mauris, gravida vitae elementum in, euismod ac nibh. Phasellus mauris arcu, auctor id mauris nec, varius commodo risus. Aliquam interdum arcu porttitor eros rutrum, vitae malesuada erat cursus. Curabitur ut purus eu nunc viverra cursus. Praesent ut porttitor leo. Donec blandit efficitur auctor. Pellentesque fermentum, nisi non venenatis euismod, sapien tellus sodales libero, ut convallis augue dui quis nulla. Nulla facilisi. Nunc consectetur libero est, non aliquam ex sollicitudin ornare. Etiam porttitor nulla sed quam cursus, vitae ultricies sapien commodo.
+
+
+
+I refer to <<eq-fermat>>
+