asciidoctor-latex 1.5.0.15.dev → 1.5.0.16.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb1be67600beb3fba62db4022504dc0d44c92ac
-  data.tar.gz: aa1699d76a04a60fbb483bb2bccc98b49ae84e5b
+  metadata.gz: 305e51b3ba921df5529a185dc2416c32ebf1e809
+  data.tar.gz: aad431dd346881c3c38c82e4ea639304969a32f0
 SHA512:
-  metadata.gz: 664b4a2771ff48b5c910edd1c8c0bc71285fb5f7c468e1892712f1c8971f4269ceb841919600e20e00321975b279efc04ececbbc10fb8270df59710df05fc5a8
-  data.tar.gz: 5ce18becc5a53d1f186754b5d4b2a0410f7f5336e984fcdec0f3d028bbe63cbb29dd8c28908afd6de66bcf2352fe251ee5bf8c76f2be82c9d78fa5fdca1ac378
+  metadata.gz: 34e9df9220194f123311a3068bf0cc78b97672f1cf94eb4953ff1b456ed89c6660c4a47e0cd89824af278b557cc67e0e995111afd8d418ea5361ab2e7f85a1a1
+  data.tar.gz: 555a6f69be2039d1e13e819e5ad8923968786cd1cccccd35fc10de1b20843260cf04373be2d3b405ab4631fe4c5bd5b45d6b129fc11e3662d9bbf5387c27db20

data/CHANGELOG.adoc

@@ -22,6 +22,9 @@ for cross-referencing, e.g.,
 `[env.equation#hohoho]`, then it is numbered.
 ////
 
+1.5.0.16.dev:: Update CSS for click blocks; remove duplicate injection of
+javascript code; update README.
+
 1.5.0.15.dev:: (1) Eliminate automatic inclusion of `macros.tex` if it is present.
 (2) Introduce the block macro `include_latex_macros::LATEX_FILE`, where LATEX_FILE is
 typically a LaTeX style or macro file, or a path thereto.  For the HTML backend, the file is included

data/README.adoc

@@ -1,14 +1,11 @@
-= AsciiDoc-LaTeX Converter for Asciidoctor
+= Asciidoc-LaTeX README
 James Carlson
-2015-04-19
-:numbered:
-:pagenums:
+2016-06-29
+:sectnums:
 :toc2:
-:stem:
 
-NOTE: CHANGELOG.adoc has been added to this repo.
 
-== Purpose
+:env_standard:
 
 :adl: Asciidoc-LaTeX
 :adlp: Asciidoctor-LaTeX
@@ -22,61 +19,194 @@ NOTE: CHANGELOG.adoc has been added to this repo.
 :tex: LaTeX
 :article: http://noteshare.io/book/transcendental-numbers-and-periods[article]
 :ns: http://www.noteshare.io[Noteshare.io]
+:sc: http://www.scripta.io[Scripta.io]
 
+== Introduction
 
-Asciidoc-LaTeX defines an extended mathematical syntax
+Asciidoc-LaTeX defines an extended syntax
 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.]
-
-Below, we descibe the main
-features of {adl}.  However, since
-it 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 on using {adl}, please consult the
-http://www.noteshare.io/book/asciidoctor-latex-manual[Asciidoctor-LaTeX manual].
-For more information on conversion of {adl}
-documents to {tex}, see the file `tech-report.adoc` in
-this repository or consult the
-https://vschool.s3.amazonaws.com/manuscripts/389.html[online version],
-which has a table of contents.
-
-Asciidoctor-LaTeX is developed by James Carlson, Jakub Jirutka, and Dan Allen.
+that closely parallels LaTeX for inline and display mathematical formulas and for environments.
+Documents written in this extended markup language can be converted into  HTML or LaTeX:
 
+Render as HTML::
+Use `asciidoctor-latex -b html foo.adoc` to produce `foo.html`.
 
-== Installation
+Render as LaTeX:: Use `sasciidoctor-latex foo.adoc`
+to produce `foo.tex`, then use `xelatex foo.tex` to create `foo.pdf`.
 
-=== From Rubygems
+Below, we describe the main
+features of {adl}.  However, since this document
+will not render fully in GitHub, you
+are encouraged to compile it yourself using
+`asciidoctor-latex -b html README.adoc` or to consult the
+http://vschool.s3.amazonaws.com/asciidoctor-latex/README.html[README at S3].
+There is also an online version hosted at http://www.shoobox.io/share/230[shoobox.io],
+a site for editing and distributing Asciidoc and Asciidoc-LaTeX documents.
 
-The development release, currenty 1.5.0.9.dev, is at
-https://rubygems.org/gems/asciidoctor-latex[RubyGems.org]
-Beta alert!
+Asciidoctor-LaTeX is developed by James Carlson, Jakub Jirutka, and Dan Allen.  Display of mathematical text
+relies on http://docs.mathjax.org/en/latest/start.html[MathJax].
 
-NOTE: Version 1.5.0.7 is "stable".  Version 1.5.0.9 introduces
+== Features
 
-new syntax with switches for three 'dialects'. See below.
+{adl} renders inline and displayed mathematical, and it supports a construct akin to LaTeX environments
+for theorems, equations, etc.  These and other features are described briefly below and more fully in <<Asciidoc-LaTeX environments>>.
 
-There are three dialects that you can set with the `:dialect` attribute:
+=== Inline and displayed formulas
 
-- `asciidoc`
-- `asciidoc-manuscript`
-- `asciidoc-latex`
+ifdef::env_standard[]
+.Example
+Imagine that `foo.adoc` contains the text below.
+The inline and displayed formulas will be correctly rendered as html or tex.
+----
+The formula $a^2 + b^2 = c^2$ relates the sides
+and hypotenuse of a right triangle.  The formula
+\[
+\int_0^1 x^n dx = \frac{1}{n+1}
+\]
+is something we all learn in Calculus
+----
+endif::[]
 
-See the option flag `-a` to set the dialect from the command line. For example:
+ifndef::env_standard[]
 
- $ asciidoctor-latex -a dialect=manuscript foo.adoc
+.Example
+Imagine that `foo.adoc` contains the text below.
+It will be correctly rendered as html or tex.
+----
+ The formula \$a^2 + b^2 = c^2\$ relates the sides
+ and hypotenuse of a right triangle.  The formula
+ \[
+ \int_0^1 x^n dx = \frac{1}{n+1}
+ \]
+ is something we all learn in Calculus
+----
 
-Be sure to use XeLaTex for tex'ing.
+.Rendered Text
+[blue]#The formula $a^2 + b^2 = c^2$ relates the sides
+and hypotenuse of a right triangle.  The formula
+\[
+\int_0^1 x^n dx = \frac{1}{n+1}
+\]
+is something we all learn in Calculus.#
+endif::[]
 
-To set the dialect with the Ruby API, use for example :
+=== Environments
 
+ifdef::env_standard[]
+.Example
+--
+--
+
+----
+  [env.theorem]
+  --
+ The Diophantine equation
+ \[
+    x^n + y^n = z^n
+ \]
+ for \$n > 2\$ has only trivial solutions
+--
 ----
-      Asciidoctor.convert str, { 'dialect' => 'latex' }
+endif::[]
+
+ifndef::env_standard[]
+.Example
+
 ----
+ [env.theorem]
+ --
+ The Diophantine equation
+ \[
+    x^n + y^n = z^n
+ \]
+ for \$n > 2\$ has only trivial solutions
+ --
+----
+
+.Rendered Text
+--
+--
+
+[env.theorem]
+--
+The Diophantine equation
+\[
+  x^n + y^n = z^n
+\]
+for $n > 2$ has only trivial solutions.
+--
+endif::[]
+
+
+=== Click blocks
+
+A click block displays its title but not its body.
+If you click on the title, the body is displayed.
+Click on the title again to hide the body.
+
+The title of a click block is displayed in blue.
+
+ifdef::env_standard[]
+.Example
+--
+--
+
+----
+  [env.question]
+  --
+  What is the speed of light?
+  --
+
+  [click.answer]
+  --
+  300,000 km/sec
+  --
+----
+endif::[]
+
+ifndef::env_standard[]
+.Example
+--
+--
+
+----
+  [env.question]
+  --
+  What is the speed of light?
+  --
+
+  [click.answer]
+  --
+  300,000 km/sec
+  --
+----
+
+.Rendered Text
+--
+--
+
+[env.question]
+--
+What is the speed of light?
+--
+
+[click.answer]
+--
+300,000 km/sec
+--
+
+endif::[]
+
+
+
+== Installation
+
+=== From Rubygems
+
+Run `gem install asciidoc-latex` to install from
+https://rubygems.org/gems/asciidoctor-latex[RubyGems.org].
+See the https://github.com/asciidoctor/asciidoctor-latex/blob/master/CHANGELOG.adoc[change log]
+for a list of updates.
 
 === From GitHub
 
@@ -88,23 +218,65 @@ If you would like to install a development version from the repository, use:
  $ gem install *.gem
 
 
-== Commands
+==  Contributing
 
-Asciidoc math files can be rendered as follows
+If you wish to contribute to the
+https://github.com/asciidoctor/asciidoctor-latex[asciidoctor-latex project], you should set up your environments to use
+Jakub Jirutka's https://github.com/asciidoctor/asciidoctor-doctest[asciidoctor-doctest].  At the moment you will need to
+use the https://github.com/jxxcarlson/asciidoctor-doctest[version which handles dialects] using
+```
+gem 'asciidoctor-doctest', github: 'jxxcarlson/asciidoctor-doctest', ref: 'latex'
+```
+in your Gemfile.  Run all tests with `rake doctest`,
+or run individual tests with `rake doctest:html` or
+`rake doctest:tex`.
 
-Render 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.
+At the moment the tests are for the latex dialect.
 
+== Dialects
 
-Render as LaTeX:: Use `$ asciidoctor-latex foo.adoc`
-to produce `foo.tex`.
+`Asciidoctor-LaTeX` processes three dialects of the core Asciidoc language:
 
+- `asciidoc` (the core language)
+- `manuscript`
+- `latex`
 
-=== Macro files
+`Asciidoc-latex` is the default dialect. Dialects can be set with the `:dialect` on the
+command line as in this example:
+
+```
+   asciidoctor-latex -a dialect=manuscript foo.adoc
+```
+To set the dialect with the Ruby API, use for example :
+
+```
+   Asciidoctor.convert str, { 'dialect' => 'latex' }
+```
+
+
+
+
+
+== Macros
+
+Macros can be included in the body of an Asciidoc-LaTeX
+file using the `texmacro` environment, as in the example
+below.
+
+----
+
+[env.texmacro]
+--
+\def\AA{\mathbb{A}}
+\def\BB{\mathbb{B}}
+
+\newcommand{\set}[1]{ \{\,#1\,  \} }
+\newcommand{\sett}[2]{ \{\,#1\, \mid\, #2\, \} }
+--
+----
 
 To include a LaTeX macro file MACRO_FILE, insert the code
-`include_latex_macros::MACRO_FILE[]`.  This works
+`include_latex_macros::MACRO_FILE[]`.  Here MACRO_FILE can be a file name or a an absolute or relative path.  Included macros work
 for both the html and tex backends.
 
 
@@ -112,7 +284,7 @@ NOTE: Automatic inclusion of the file `macros.tex`
 has been discontinued.
 
 
-=== Switches
+== Switches
 
 .Tex header
 To generate a tex file with a minimal header, do:
@@ -141,7 +313,7 @@ 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
+one can write `\$ a^2 + b^2 = c^2 \$` and
 ----
  \[
     e^{2\pi \sqrt{-1}} = 1,
@@ -163,7 +335,7 @@ and
   ++++
 ----
 
-
+ifdef::env_standard[]
 == Asciidoc-LaTeX environments
 
 Asciidoc-LaTeX supports an `env` construct that maps to LaTeX environments.
@@ -177,6 +349,119 @@ There exist infinitely many prime numbers.
 renders as an automatically numbered theorem.
 Environments can contain in-line and display mathematics, e.g.,
 ----
+ [env.theorem]
+ --
+ 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.
+--
+----
+
+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
+ than $\pm 1$ and $\pm n$.
+ --
+----
+or
+----
+[env.joke]
+--
+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>>+
+
+Certain environments receive special treatment.
+For numbered equations, use `[env.equation]`
+like this
+
+----
+[env.equation]
+--
+a^{p-1} \equiv 1\ \text{mod}\ p
+--
+----
+
+An equation number will be displayed only when
+a label for cross-referencing is provided, e.g.,
+
+----
+[env.equation#little-fermat]
+--
+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
+--
+----
+
+endif::[]
+
+
+ifndef::env_standard[]
+== Asciidoc-LaTeX environments
+
+Asciidoc-LaTeX supports an `env` construct that maps to LaTeX environments.
+Thus
+----
+[env.theorem]
+--
+There exist infinitely many prime numbers.
+--
+----
+renders as an automatically numbered theorem:
+
+
+[env.theorem]
+--
+There exist infinitely many prime numbers.
+--
+
+Environments can contain in-line and display mathematics, e.g.,
+----
+ [env.theorem]
+ --
+ 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.
+--
+----
+
 [env.theorem]
 --
 A two-by-two matrix is invertible if
@@ -189,19 +474,28 @@ its determinant is nonzero, i.e., if
 \]
 This result extends to $n\times n$ matrices.
 --
-----
+
 
 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
+ than \$\pm 1\$ and \$\pm n\$.
+ --
+----
+to obtain
+
 [env.definition]
 --
 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$.
 --
-----
-or
+
+Or one could write
 ----
 [env.joke]
 --
@@ -210,6 +504,15 @@ a lawyer met at the local bar
 for a drink.  The lawyer said ...
 --
 ----
+
+[env.joke]
+--
+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
 ----
@@ -220,7 +523,7 @@ a lawyer met at the local bar
 for a drink.  The lawyer said ...
 --
 ----
-then referencing it later as `<<mathjoke1>>`.
+then referencing it later as  +<<mathjoke1>>+
 
 Certain environments receive special treatment.
 For numbered equations, use `[env.equation]`
@@ -232,38 +535,46 @@ like this
 a^{p-1} \equiv 1\ \text{mod}\ p
 --
 ----
+Here is the rendered version:
 
-For sets of equations, use `[env,equationalign]`:
-----
-[env.equationalign]
+[env.equation]
 --
-A & = 4\pi r^2 \\
-V & = \frac{4}{3} \pi r^3
+a^{p-1} \equiv 1\ \text{mod}\ p
 --
-----
-
 
+An equation number will be displayed only when
+a label for cross-referencing is provided, e.g.,
 
+----
+[env.equation#little-fermat]
+--
+a^{p-1} \equiv 1\ \text{mod}\ p
+--
+----
 
-== Click blocks
+so that now one has
 
-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.
+[env.equation#little-fermat]
+--
+a^{p-1} \equiv 1\ \text{mod}\ p
+--
 
+For sets of equations, use `[env,equationalign]`:
 ----
-[click.comment]
+[env.equationalign]
+--
+A & = 4\pi r^2 \\
+V & = \frac{4}{3} \pi r^3
 --
-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.
 ----
+This text renders as
+[env.equationalign#area-volume]
+--
+A & = 4\pi r^2 \\
+V & = \frac{4}{3} \pi r^3
+--
+
+endif::[]
+
 
 
-The default for click blocks is not to number them.
-See the file `click.adoc` in the `exampless` directory
-for more information.

data/data/extras.css

@@ -3,7 +3,7 @@
 
 
 .openblock.click .title  {  color: blue;}
-.openblock.click {  margin-bottom:1.5em; }
+.openblock.click {  margin-top: 0.5em; margin-bottom:0.5em; }
 
 .click_oblique {
 

data/lib/asciidoctor/latex/converter.rb

@@ -513,10 +513,8 @@ module Asciidoctor::LaTeX
         preprocessor MacroInsert if (File.exist? 'macros.tex')
 
         inline_macro ChemInlineMacro
-
         block_macro IncludeLatexBlockMacro
 
-        postprocessor InjectHTML unless document.attributes['inject_javascript'] == 'no'
         postprocessor Chem if document.basebackend? 'html'
         postprocessor HTMLPostprocessor if document.basebackend? 'html'
         postprocessor TexPostprocessor if document.basebackend? 'tex'

data/lib/asciidoctor/latex/inject_html.rb

@@ -19,6 +19,7 @@ module Asciidoctor::LaTeX
 
 <style>
   .click .title { color: blue; }
+  .click {margin-top: 0.5em; margin-bottom: 0.5em;}
   .openblock>.box>.content { margin-top:1em;margin-bottom: 1em;margin-left:3em;margin-right:4em; }
 </style>
 

data/lib/asciidoctor/latex/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module LaTeX
-    VERSION = '1.5.0.15.dev'
+    VERSION = '1.5.0.16.dev'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-latex
 version: !ruby/object:Gem::Version
-  version: 1.5.0.15.dev
+  version: 1.5.0.16.dev
 platform: ruby
 authors:
 - James Carlson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Converts AsciiDoc documents to LaTeX, provides LaTeX extensions to Asciidoc