asciidoctor-latex 1.5.0.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e5580fadffd5a0ff5f968e8672225c1b387a434
+  data.tar.gz: 67f763319571a6cb2ee224bf79b5044d945e82fe
+SHA512:
+  metadata.gz: f7aeb65738dea61724b8295e2f6fad7eebabd95b7daa0195a6faebee124194a37d44cf0fe50a7cb1498e7454d39b767728e8f0ac873ad4456c51730ff3ab138b
+  data.tar.gz: e47b504a4b7b0752656d675c632aef95e3f5247e00bed9785069c2102980427edbe9f6e5640fbf068de088dc9c601e9d49f1c6b1e8b5cf6cc21a594238057e36

data/LICENSE.adoc

@@ -0,0 +1,22 @@
+.The MIT License
+....
+Copyright (C) 2014 James Carlson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+....

data/README.adoc

@@ -0,0 +1,213 @@
+= AsciiDoc to LaTeX Converter for Asciidoctor
+James Carlson
+
+:numbered:
+:toc2:
+:stem:
+
+== 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.
+
+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.
+
+
+== Installation
+
+=== Using Rubygems
+
+_asciidoctor-latex has not been released yet_
+
+=== From repository
+
+If you would like to install a development version from the repository, use:
+
+ $ git clone https://github.com/asciidoctor/asciidoctor-latex.git
+ $ cd asciidoctor-latex
+ $ gem build asciidoctor-latex.gemspec
+ $ 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
+----
+  [stem]
+  ++++
+    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.
+Thus
+----
+[env.theorem]
+--
+There exist infinitely many prime numbers.
+--
+----
+renders as an automatically numbered theorem:
+
+[env.theorem]
+--
+There exist infinitely many prime numbers.
+--
+
+Likewise, using `[env.definition]`, we 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$.
+--
+
+For numbered equations, use `[env.equation]` like this
+
+----
+[env.equation]
+--
+a^{p-1} \equiv 1\ \text{mod}\ p
+--
+----
+
+to obtain the rendered text
+
+[env.equation]
+--
+a^{p-1} \equiv 1\ \text{mod}\ p
+--
+
+
+
+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
+
+Click blocks are similar to `[env]` blocks excep 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.
+
+[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 ...
+--
+----
+
+The default for click blocks is not to number them.
+See the file `click.adoc` in the `try-out` 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
+```
+
+
+== Switches
+
+Switch `:stem:` processing on by puttinng the text `:stem:`
+in your file.  To turn the switch on and set it to `latexmath`, say
+instead of `stem:latexmth`.

data/Rakefile

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+
+require 'rake/clean'
+require 'bundler/gem_tasks'
+
+begin
+  require 'yard'
+  # options are defined in .yardopts
+  YARD::Rake::YardocTask.new
+
+  task :doc => :yard
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end
+
+begin
+  require 'asciidoctor-doctest'
+  require 'asciidoctor-latex'
+  require 'rake/testtask'
+
+  namespace :doctest do
+    Rake::TestTask.new(:latex) do |t|
+      t.description = 'Run integration tests for LaTeX output.'
+      t.pattern = 'test/latex_test.rb'
+      t.libs << 'test'
+    end
+
+    Rake::TestTask.new(:html) do |t|
+      t.description = 'Run integration tests for HTML output.'
+      t.pattern = 'test/html_test.rb'
+      t.libs << 'test'
+    end
+  end
+
+  task :doctest => [ 'doctest:latex', 'doctest:html' ]
+  task :test    => :doctest
+  task :default => :test
+
+  namespace :generate do
+    DocTest::GeneratorTask.new(:latex) do |t|
+      t.converter_opts[:backend_name] = :latex
+      t.output_suite = DocTest::Latex::ExamplesSuite.new(examples_path: 'test/examples/tex')
+      t.examples_path.unshift 'test/examples/adoc'  # extra input examples
+    end
+
+    DocTest::GeneratorTask.new(:html) do |t|
+      t.converter_opts[:backend_name] = :html
+      t.output_suite = DocTest::HTML::ExamplesSuite.new(examples_path: 'test/examples/html')
+      t.examples_path = ['test/examples/asciidoc-html']  # input examples
+    end
+  end
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end

data/bin/asciidoctor-latex

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+LIB_DIR = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift LIB_DIR unless $LOAD_PATH.include? LIB_DIR
+
+require 'asciidoctor/latex'
+require 'asciidoctor/cli'
+
+DEFAULT_OPTS = {
+  backend: 'latex',
+  attributes: { 'stem' => 'latexmath' }
+}
+options = Asciidoctor::Cli::Options.new DEFAULT_OPTS
+# FIXME This is a really bizarre API. Please make me simpler.
+if (options.parse! ARGV) == 0
+  exit 0
+else
+  invoker = Asciidoctor::Cli::Invoker.new options
+  GC.start
+  invoker.invoke!
+  exit invoker.code
+end

data/data/asciidoc_tex_macros.tex

@@ -0,0 +1,42 @@
+
+% Needed for Asciidoc
+
+\newcommand{\admonition}[2]{\textbf{#1}: {#2}}
+\newcommand{\rolered}[1]{ \textcolor{red}{#1} }
+
+\newtheorem{theorem}{Theorem}
+\newtheorem{proposition}{Proposition}
+\newtheorem{corollary}{Corollary}
+\newtheorem{lemma}{Lemma}
+\newtheorem{definition}{Definition}
+\newtheorem{conjecture}{Conjecture}
+\newtheorem{problem}{Problem}
+\newtheorem{example}{Example}
+\newtheorem{remark}{Remark}
+\newtheorem{note}{Note}
+
+
+%%%
+%  Extended quote environment with author
+\def\signed#1{{\leavevmode\unskip\nobreak\hfil\penalty50\hskip2em
+  \hbox{}\nobreak\hfil\raise-3pt\hbox{(#1)}%
+  \parfillskip=0pt \finalhyphendemerits=0 \endgraf}}
+
+\newsavebox\mybox
+\newenvironment{aquote}[1]
+  {\savebox\mybox{#1}\begin{quotation}}
+  {\signed{\usebox\mybox}\end{quotation}}
+%%%
+
+\newenvironment{preamble}
+  {}
+  {}
+
+%% http://tex.stackexchange.com/questions/99809/box-or-sidebar-for-additional-text
+\newenvironment{sidebar}[1][r]
+  {\wrapfigure{#1}{0.5\textwidth}\tcolorbox}
+  {\endtcolorbox\endwrapfigure}
+
+%% Style
+\parindent0pt
+\parskip8pt

data/data/preamble_article.tex

@@ -0,0 +1,45 @@
+%% A minimal LaTeX preamble
+
+\documentclass[11pt]{amsart}
+\usepackage{geometry}                % See geometry.pdf to learn the layout options. There are lots.
+\geometry{letterpaper}               % ... or a4paper or a5paper or ...
+%\geometry{landscape}                % Activate for for rotated page geometry
+%\usepackage[parfill]{parskip}       % Activate to begin paragraphs with an empty line rather than an indent
+\usepackage{graphicx}
+\graphicspath{ {images/} }
+\usepackage{wrapfig}
+\usepackage{tcolorbox}
+\usepackage{lipsum}
+\usepackage{amssymb}
+\usepackage{epstopdf}
+\usepackage{color}
+\usepackage{alltt}
+\usepackage[version=3]{mhchem}
+\usepackage{amsmath}
+
+% Needed to properly typeset
+% standard unicode characters:
+%
+\RequirePackage{fix-cm}
+\usepackage{fontspec}
+\usepackage[Latin,Greek]{ucharclasses}
+%
+% NOTE: you must also use xelatex
+% as the typesetting engine
+
+
+% \usepackage{fontspec}
+% \usepackage{polyglossia}
+% \setmainlanguage{en}
+
+\usepackage{hyperref}
+\hypersetup{
+    colorlinks=true,
+    linkcolor=blue,
+    filecolor=magenta,
+    urlcolor=cyan,
+}
+
+\DeclareGraphicsExtensions{.png, .jpg, jpeg, .pdf}
+
+%% \DeclareGraphicsRule{.tif}{png}{.png}{`convert #1 `dirname #1`/`basename #1 .tif`.png}

data/data/preamble_book.tex

@@ -0,0 +1,44 @@
+%% A minimal LaTeX preamble
+
+\documentclass[11pt]{amsbook}
+\usepackage{geometry}                % See geometry.pdf to learn the layout options. There are lots.
+\geometry{letterpaper}               % ... or a4paper or a5paper or ...
+%\geometry{landscape}                % Activate for for rotated page geometry
+%\usepackage[parfill]{parskip}       % Activate to begin paragraphs with an empty line rather than an indent
+\usepackage{graphicx}
+\graphicspath{ {images/} }
+\usepackage{wrapfig}
+\usepackage{tcolorbox}
+\usepackage{lipsum}
+\usepackage{amssymb}
+\usepackage{epstopdf}
+\usepackage{color}
+\usepackage{alltt}
+\usepackage[version=3]{mhchem}
+\usepackage{amsmath}
+
+% Needed to properly typeset
+% standard unicode charaters:
+%
+\RequirePackage{fix-cm}
+\usepackage{fontspec}
+\usepackage[Latin,Greek]{ucharclasses}
+%
+% NOTE: you must also use xelatex
+% as the typesetting engine
+
+
+% \usepackage{fontspec}
+%\usepackage{polyglossia}
+%\setmainlanguage{en}
+\usepackage{hyperref}
+\hypersetup{
+    colorlinks=true,
+    linkcolor=blue,
+    filecolor=magenta,
+    urlcolor=cyan,
+}
+
+\DeclareGraphicsExtensions{.png, .jpg, jpeg, .pdf}
+
+%% \DeclareGraphicsRule{.tif}{png}{.png}{`convert #1 `dirname #1`/`basename #1 .tif`.png}