asciidoctor-latex 1.5.0.1.dev → 1.5.0.2.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8311fb6bf67fe3fdad35eda206272fca2cee6bd
-  data.tar.gz: 9d9e0614a2e8bddb8f28776ab57fe58298659e64
+  metadata.gz: 1cf66b3d913348a3e7d5f6c5a3006c5a3375df78
+  data.tar.gz: 98e6b9948d24b68e3f0265c755cff59578f2713a
 SHA512:
-  metadata.gz: b0276015c4a3531b4768f42a0255653c7daa2c8a0d307ebc769428b4821b282f8d172893c300f5518963931d6689666bc01e9ddc8e9ed89385e60327d90d568e
-  data.tar.gz: 3eea9dd3976da80e860076185863868c4db050cb30496f093d68f75d487d51789e8d81d1c7a1e0cb139687614be182af943243e191dbb5a6977b12fe0cd08549
+  metadata.gz: d2c2ddd62e2dc6cf680a42bd2f62be8bcef105574812ae07e3cec6b97c677fc5e40625b0f4e438dd180d24a66973b3ddaeb4a38a23bb1a6b05264e8c9fd37801
+  data.tar.gz: 916024d755d904cda6e0265ed31f1a50736d6e7fdbcd6e035635b77062bdddcfaae3cfea3ff1d3427798e440bd47a5a863e82709ba960df48d026134b7b02dc8

data/README.adoc

@@ -8,49 +8,34 @@ James Carlson
 == Purpose
 
 Asciidoc-LaTeX defines an extended mathematical syntax
-for Asciidoc that closely parallels LaTeX.  The
+for the Asciidoc markup language
+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.]
 
-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)_.
+Below, we descibe the main
+features of Asciidoc-LaTeX.  However, since
+Asciidoc-LaTeX will not render in GitHub, you
+are encouraged to view this write-up:
+https://vschool.s3.amazonaws.com/manuscripts/372.html[Asciidoc-LaTeX].
+For more information, please consult
+http://www.noteshare.io/book/asciidoctor-latex-manual[Asciidoctor-LaTeX manual].
 
 
 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
 
-There is a development release.  Beta alert!
+There is a development release at
+https://rubygems.org/gems/asciidoctor-latex[RubyGems.org]
+  Beta alert!
 
-=== From repository
+=== From GitHub
 
 If you would like to install a development version from the repository, use:
 
@@ -72,11 +57,12 @@ one can write `$ a^2 + b^2 = c^2 $` and
     e^{2\pi \sqrt{-1}} = 1,
  \]
 ----
-for in-line and dipplay mathematial
+for in-line and display mathematial
 text, respectively.
 You will need to express dollar-denominated
 currency using
-escaped dollar signs: "He paid \$100 for that
+escaped dollar signs, as
+ in the sentence, "He paid \$100 for that
 theore.m"  In AsciiMath, one writes
 `+++stem:[ a^2 + b^2 = c^2 ]+++`
 and
@@ -171,7 +157,7 @@ V & = \frac{4}{3} \pi r^3
 
 == Click blocks
 
-Click blocks are similar to `[env]` blocks excep that the body of
+Click blocks are similar to `[env]` blocks exceptiipoo that the body of
 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.

data/examples/README.adoc

@@ -1,352 +1,12 @@
-:numbered:
-:toc2:
-:max-width: 60%
+= README
 
-:stem: latexmath
 
+Read the file `start.html` to
+get an overview of Asciidoc-Latex.
+To install `asciidoctor-latex`, read the
+README at the root of this repository.
 
-
-== Introduction
-
-
-
-The aim of the Asciidoc-LaTeX converter is
-
-
-. 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.,
-
-[env.equation]
---
-\int_{|z| = 1} \frac{dz}{z} = 2\pi \sqrt{-1}
---
-
-by writing this
-
-----
-[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
+To learn more, consult the
+http://noteshare.io/section/asciidoctor-latex-manual-intro[Asciidoctor-latex manual].
+or run `asciidoctor-latex` on the `.adoc`
+files in this directory.