asciidoctor-latex 1.5.0.2.dev → 1.5.0.3.dev

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.adoc +17 -0
  3. data/README.adoc +18 -4
  4. data/doc/Asciidoctor.html +131 -0
  5. data/doc/Asciidoctor/Block.html +1700 -0
  6. data/doc/Asciidoctor/Converter/Html5Converter.html +120 -0
  7. data/doc/Asciidoctor/Document.html +327 -0
  8. data/doc/Asciidoctor/Inline.html +594 -0
  9. data/doc/Asciidoctor/LaTeX.html +167 -0
  10. data/doc/Asciidoctor/LaTeX/Chem.html +210 -0
  11. data/doc/Asciidoctor/LaTeX/ChemInlineMacro.html +194 -0
  12. data/doc/Asciidoctor/LaTeX/ClickBlock.html +344 -0
  13. data/doc/Asciidoctor/LaTeX/ClickStyleInsert.html +283 -0
  14. data/doc/Asciidoctor/LaTeX/Converter.html +321 -0
  15. data/doc/Asciidoctor/LaTeX/Dollar.html +203 -0
  16. data/doc/Asciidoctor/LaTeX/EntToUni.html +194 -0
  17. data/doc/Asciidoctor/LaTeX/EnvironmentBlock.html +420 -0
  18. data/doc/Asciidoctor/LaTeX/HTMLPostprocessor.html +204 -0
  19. data/doc/Asciidoctor/LaTeX/Html5ConverterExtensions.html +905 -0
  20. data/doc/Asciidoctor/LaTeX/InjectHTML.html +192 -0
  21. data/doc/Asciidoctor/LaTeX/MacroInsert.html +300 -0
  22. data/doc/Asciidoctor/LaTeX/TeXBlock.html +644 -0
  23. data/doc/Asciidoctor/LaTeX/TeXPostProcess.html +504 -0
  24. data/doc/Asciidoctor/LaTeX/TeXPreprocessor.html +287 -0
  25. data/doc/Asciidoctor/LaTeX/TexPostprocessor.html +209 -0
  26. data/doc/Asciidoctor/List.html +483 -0
  27. data/doc/Asciidoctor/Section.html +219 -0
  28. data/doc/Asciidoctor/Table.html +227 -0
  29. data/doc/PreambleProcessor.html +202 -0
  30. data/doc/String.html +587 -0
  31. data/doc/_index.html +382 -0
  32. data/doc/class_list.html +58 -0
  33. data/doc/css/common.css +1 -0
  34. data/doc/css/full_list.css +57 -0
  35. data/doc/css/style.css +339 -0
  36. data/doc/file.LICENSE.html +96 -0
  37. data/doc/file.README.html +335 -0
  38. data/doc/file.manual.html +479 -0
  39. data/doc/file_list.html +63 -0
  40. data/doc/frames.html +26 -0
  41. data/doc/index.html +335 -0
  42. data/doc/js/app.js +219 -0
  43. data/doc/js/full_list.js +181 -0
  44. data/doc/js/jquery.js +4 -0
  45. data/doc/method_list.html +549 -0
  46. data/doc/top-level-namespace.html +114 -0
  47. data/lib/asciidoctor/latex/converter.rb +2 -4
  48. data/lib/asciidoctor/latex/tex_preprocessor.rb +19 -4
  49. data/lib/asciidoctor/latex/version.rb +1 -1
  50. data/test/examples/adoc/exponent1.adoc +2 -0
  51. data/test/examples/adoc/exponent2.adoc +4 -0
  52. data/test/examples/adoc/macro_underscore.adoc +5 -0
  53. data/test/examples/adoc/math.adoc +2 -2
  54. metadata +51 -29
  55. data/rspec/README.adoc +0 -45
  56. data/rspec/a.rb +0 -79
  57. data/rspec/b.rb +0 -111
  58. data/rspec/c.rb +0 -121
  59. data/rspec/data/tex1 +0 -65
  60. data/rspec/data/tex2 +0 -5
  61. data/rspec/data/tex2.expect +0 -5
  62. data/rspec/transform.rb +0 -36
  63. data/spec/README.adoc +0 -45
  64. data/spec/a.rb +0 -79
  65. data/spec/b.rb +0 -111
  66. data/spec/c.rb +0 -121
  67. data/spec/data/foo +0 -1
  68. data/spec/data/lorem +0 -1
  69. data/spec/data/tex1 +0 -65
  70. data/spec/data/tex2 +0 -5
  71. data/spec/data/tex2.expect +0 -5
  72. data/spec/transform.rb +0 -36
@@ -0,0 +1,479 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>
7
+ File: manual
8
+
9
+ &mdash; Asciidoctor LaTeX Documentation
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!file.manual.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: manual</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'><div class="sect1">
65
+ <h2 id="_introduction">1. Introduction</h2>
66
+ <div class="sectionbody">
67
+ <div class="paragraph">
68
+ <p>TexConverter translates a file written
69
+ in a subset of Asciidoc to LaTeX. The
70
+ subset is described below. While not
71
+ complete, it is adequate for the preparation
72
+ of a wide range of mathematical documents,
73
+ from one-page handouts to articles to entire books.</p>
74
+ </div>
75
+ <div class="paragraph">
76
+ <p>As a demonstration of the current state of this
77
+ project, the file you are looking at, <code>manual.adoc</code>,
78
+ can be rendered into HTML by</p>
79
+ </div>
80
+ <div class="listingblock">
81
+ <div class="content">
82
+ <pre class="code ruby"><code class="ruby"> </code></pre>
83
+ </div>
84
+ </div>
85
+ <div class="paragraph">
86
+ <p>or can be rendered as a LaTeX file via</p>
87
+ </div>
88
+ <div class="listingblock">
89
+ <div class="content">
90
+ <pre class="code ruby"><code class="ruby"> </code></pre>
91
+ </div>
92
+ </div>
93
+ <div class="paragraph">
94
+ <p>The <code>.tex</code> file can in turn be rendred into pdf via
95
+ <code>pdflatex</code> or <code>xelatex</code>. We recommend the latter.</p>
96
+ </div>
97
+ <div class="paragraph">
98
+ <p>Mathematical text in Asciidoc can be written as
99
+ one usually does in LaTeX if one invokes the
100
+ latex option.<span class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnote_1" title="View footnote.">1</a>]</span>. You do this via <code>asciidoctor -latex foo.adoc</code>.
101
+ Thus for the Pythagorean
102
+ theorem $a^2 + b^2 = c^2$, one writes</p>
103
+ </div>
104
+ <div class="listingblock">
105
+ <div class="content">
106
+ <pre class="code ruby"><code class="ruby"> </code></pre>
107
+ </div>
108
+ </div>
109
+ <div class="paragraph">
110
+ <p>For the famous formula of Euler,
111
+ \[
112
+ e^\sqrt{-1} = 1
113
+ \]
114
+ one writes</p>
115
+ </div>
116
+ <div class="listingblock">
117
+ <div class="content">
118
+ <pre class="code ruby"><code class="ruby">\[
119
+ e^{2\pi \sqrt{-1}} = 1
120
+ \]</code></pre>
121
+ </div>
122
+ </div>
123
+ </div>
124
+ </div>
125
+ <div class="sect1">
126
+ <h2 id="_the_asciidoc_latex_subset">2. The Asciidoc-LaTeX subset</h2>
127
+ <div class="sectionbody">
128
+ <div class="sect2">
129
+ <h3 id="_sections_levels_1_through_5">2.1. Sections, levels 1 through 5</h3>
130
+
131
+ </div>
132
+ <div class="sect2">
133
+ <h3 id="_ordered_and_unordered_lists">2.2. Ordered and unordered lists</h3>
134
+ <div class="paragraph">
135
+ <p>In Asciidoc, an unordered list like</p>
136
+ </div>
137
+ <div class="ulist">
138
+ <ul>
139
+ <li>
140
+ <p>Pay Bills</p>
141
+ </li>
142
+ <li>
143
+ <p>Get Groceries</p>
144
+ <div class="ulist">
145
+ <ul>
146
+ <li>
147
+ <p>Milk</p>
148
+ </li>
149
+ <li>
150
+ <p>Bread</p>
151
+ </li>
152
+ <li>
153
+ <p>Orange Juice</p>
154
+ </li>
155
+ </ul>
156
+ </div>
157
+ </li>
158
+ <li>
159
+ <p>Change Oil Filter on Car</p>
160
+ </li>
161
+ </ul>
162
+ </div>
163
+ <div class="paragraph">
164
+ <p>is written like this</p>
165
+ </div>
166
+ <div class="listingblock">
167
+ <div class="content">
168
+ <pre class="code ruby"><code class="ruby"> * Pay Bills
169
+ * Get Groceries
170
+ ** Milk
171
+ ** Bread
172
+ ** Orange Juice
173
+ * Change Oil Filter on Car</code></pre>
174
+ </div>
175
+ </div>
176
+ <div class="paragraph">
177
+ <p>Its translation into LaTeX is</p>
178
+ </div>
179
+ <div class="listingblock">
180
+ <div class="content">
181
+ <pre class="code ruby"><code class="ruby"> \begin{itemize}
182
+ \item Pay Bills
183
+ \item Get Groceries
184
+ \begin{itemize}
185
+ \item Milk
186
+ \item Bread
187
+ \item Orange Juice
188
+ \end{itemize}
189
+ \item Change Oil Filter on Car
190
+ \end{itemize}</code></pre>
191
+ </div>
192
+ </div>
193
+ <div class="paragraph">
194
+ <p>The corresponding ordered list,</p>
195
+ </div>
196
+ <div class="olist arabic">
197
+ <ol class="arabic">
198
+ <li>
199
+ <p>Pay Bills</p>
200
+ </li>
201
+ <li>
202
+ <p>Get Groceries</p>
203
+ <div class="olist loweralpha">
204
+ <ol class="loweralpha" type="a">
205
+ <li>
206
+ <p>Milk</p>
207
+ </li>
208
+ <li>
209
+ <p>Bread</p>
210
+ </li>
211
+ <li>
212
+ <p>Orange Juice</p>
213
+ </li>
214
+ </ol>
215
+ </div>
216
+ </li>
217
+ <li>
218
+ <p>Change Oil Filter on Car</p>
219
+ </li>
220
+ </ol>
221
+ </div>
222
+ <div class="paragraph">
223
+ <p>is written as</p>
224
+ </div>
225
+ <div class="listingblock">
226
+ <div class="content">
227
+ <pre class="code ruby"><code class="ruby"> . Pay Bills
228
+ . Get Groceries
229
+ .. Milk
230
+ .. Bread
231
+ .. Orange Juice
232
+ . Change Oil Filter on Car</code></pre>
233
+ </div>
234
+ </div>
235
+ <div class="paragraph">
236
+ <p>with the following source in LaTex:</p>
237
+ </div>
238
+ <div class="listingblock">
239
+ <div class="content">
240
+ <pre class="code ruby"><code class="ruby"> \begin{enumerate}
241
+ \item Pay Bills
242
+ \item Get Groceries
243
+ \begin{enumerate}
244
+ \item Milk
245
+ \item Bread
246
+ \item Orange Juice
247
+ \end{enumerate}
248
+ \item Change Oil Filter on Car
249
+ \end{enumerate}</code></pre>
250
+ </div>
251
+ </div>
252
+ </div>
253
+ <div class="sect2">
254
+ <h3 id="_bold_italic_and_monospaced_text">2.3. Bold, italic, and monospaced text</h3>
255
+ <div class="paragraph">
256
+ <p>The text "She said <em>potatoes</em> but he said <strong>potaatoes</strong>", written
257
+ in Asciidoc as</p>
258
+ </div>
259
+ <div class="listingblock">
260
+ <div class="content">
261
+ <pre class="code ruby"><code class="ruby"> She said _potatoes_ but he said *potaatoes*</code></pre>
262
+ </div>
263
+ </div>
264
+ <div class="paragraph">
265
+ <p>is mapped to</p>
266
+ </div>
267
+ <div class="listingblock">
268
+ <div class="content">
269
+ <pre class="code ruby"><code class="ruby"> She said \emph{potatoes} but he said \textbf{potaatoes}</code></pre>
270
+ </div>
271
+ </div>
272
+ <div class="paragraph">
273
+ <p>The text</p>
274
+ </div>
275
+ <div class="listingblock">
276
+ <div class="content">
277
+ <pre class="code ruby"><code class="ruby"> <span class='backtick'>`</span><span class='tstring_content'>monospaced</span><span class='tstring_end'>`</span></span></code></pre>
278
+ </div>
279
+ </div>
280
+ <div class="paragraph">
281
+ <p>is mapped to</p>
282
+ </div>
283
+ <div class="listingblock">
284
+ <div class="content">
285
+ <pre class="code ruby"><code class="ruby"> {\tt monospaced}</code></pre>
286
+ </div>
287
+ </div>
288
+ </div>
289
+ <div class="sect2">
290
+ <h3 id="_quotations">2.4. Quotations</h3>
291
+ <div class="paragraph">
292
+ <p>The text</p>
293
+ </div>
294
+ <div class="listingblock">
295
+ <div class="content">
296
+ <pre class="code ruby"><code class="ruby"> [quote, Abraham Lincoln, Soldiers&#39; National Cemetery Dedication]
297
+ ____
298
+ Four score and seven years ago our fathers brought forth
299
+ on this continent a new nation
300
+ ____</code></pre>
301
+ </div>
302
+ </div>
303
+ <div class="paragraph">
304
+ <p>is mapped to</p>
305
+ </div>
306
+ <div class="listingblock">
307
+ <div class="content">
308
+ <pre class="code ruby"><code class="ruby"> \begin{quote}
309
+ Four score and seven years ago our fathers brought forth
310
+ on this continent a new nation
311
+ \end{quote}</code></pre>
312
+ </div>
313
+ </div>
314
+ </div>
315
+ <div class="sect2">
316
+ <h3 id="_footnotes">2.5. Footnotes</h3>
317
+ <div class="paragraph">
318
+ <p>Text like this</p>
319
+ </div>
320
+ <div class="listingblock">
321
+ <div class="content">
322
+ <pre class="code ruby"><code class="ruby"> Ho hum.footnote:[An epression of boredem]</code></pre>
323
+ </div>
324
+ </div>
325
+ <div class="paragraph">
326
+ <p>is mapped to</p>
327
+ </div>
328
+ <div class="listingblock">
329
+ <div class="content">
330
+ <pre class="code ruby"><code class="ruby"> Ho hum\footnote{An epression of boredem}</code></pre>
331
+ </div>
332
+ </div>
333
+ </div>
334
+ <div class="sect2">
335
+ <h3 id="_references_and_labels">2.6. References and labels</h3>
336
+ <div class="paragraph">
337
+ <p>The label</p>
338
+ </div>
339
+ <div class="listingblock">
340
+ <div class="content">
341
+ <pre class="code ruby"><code class="ruby"> <span class='const'>Ho</span> <span class='id identifier rubyid_hum'>hum</span><span class='lbracket'>[</span><span class='lbracket'>[</span><span class='id identifier rubyid_foo'>foo</span><span class='rbracket'>]</span><span class='rbracket'>]</span></code></pre>
342
+ </div>
343
+ </div>
344
+ <div class="paragraph">
345
+ <p>is mapped to</p>
346
+ </div>
347
+ <div class="listingblock">
348
+ <div class="content">
349
+ <pre class="code ruby"><code class="ruby"> Ho hum\label{foo}</code></pre>
350
+ </div>
351
+ </div>
352
+ <div class="paragraph">
353
+ <p>The cross-reference</p>
354
+ </div>
355
+ <div class="listingblock">
356
+ <div class="content">
357
+ <pre class="code ruby"><code class="ruby"> Please see &lt;&lt;foo&gt;&gt;</code></pre>
358
+ </div>
359
+ </div>
360
+ <div class="paragraph">
361
+ <p>is mapped to</p>
362
+ </div>
363
+ <div class="listingblock">
364
+ <div class="content">
365
+ <pre class="code ruby"><code class="ruby"> Please see \ref{foo}</code></pre>
366
+ </div>
367
+ </div>
368
+ </div>
369
+ <div class="sect2">
370
+ <h3 id="_hyperlinks">2.7. Hyperlinks</h3>
371
+ <div class="paragraph">
372
+ <p>The hyperlink</p>
373
+ </div>
374
+ <div class="listingblock">
375
+ <div class="content">
376
+ <pre class="code ruby"><code class="ruby"> <span class='id identifier rubyid_http'>http</span><span class='symbol'>:/</span><span class='op'>/</span><span class='id identifier rubyid_nytimes'>nytimes</span><span class='period'>.</span><span class='id identifier rubyid_com'>com</span><span class='lbracket'>[</span><span class='const'>All</span> <span class='id identifier rubyid_the'>the</span> <span class='id identifier rubyid_news'>news</span> <span class='id identifier rubyid_that'>that</span> <span class='id identifier rubyid_is'>is</span> <span class='id identifier rubyid_fit'>fit</span> <span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_print'>print</span><span class='rbracket'>]</span></code></pre>
377
+ </div>
378
+ </div>
379
+ <div class="paragraph">
380
+ <p>is mapped to</p>
381
+ </div>
382
+ <div class="listingblock">
383
+ <div class="content">
384
+ <pre class="code ruby"><code class="ruby"> \href{http://nytimes.com}{All the news that is fit to print}</code></pre>
385
+ </div>
386
+ </div>
387
+ </div>
388
+ <div class="sect2">
389
+ <h3 id="_line_breaks_code_code">2.8. Line breaks <code>+</code></h3>
390
+
391
+ </div>
392
+ <div class="sect2">
393
+ <h3 id="_listing">2.9. Listing</h3>
394
+
395
+ </div>
396
+ <div class="sect2">
397
+ <h3 id="_open_blocks">2.10. Open blocks</h3>
398
+
399
+ </div>
400
+ <div class="sect2">
401
+ <h3 id="_literal">2.11. Literal</h3>
402
+
403
+ </div>
404
+ <div class="sect2">
405
+ <h3 id="_page_break">2.12. Page break</h3>
406
+
407
+ </div>
408
+ <div class="sect2">
409
+ <h3 id="_pass">2.13. Pass</h3>
410
+
411
+ </div>
412
+ </div>
413
+ </div>
414
+ <div class="sect1">
415
+ <h2 id="_mathematical_text">3. Mathematical text</h2>
416
+ <div class="sectionbody">
417
+ <div class="paragraph">
418
+ <p>We distinguish between <em>inner text</em> amd <em>outer text</em>. the first
419
+ appears between math delimiters, while the second does not.</p>
420
+ </div>
421
+ <div class="sect2">
422
+ <h3 id="_inner_text">3.1. Inner text</h3>
423
+ <div class="paragraph">
424
+ <p>As noted in the introduction, mathematical text is enclosed in the
425
+ standard delimiters and is written in the normal way. Environments
426
+ supported in display math mode are</p>
427
+ </div>
428
+ <div class="ulist">
429
+ <ul>
430
+ <li>
431
+ <p>matrix</p>
432
+ </li>
433
+ <li>
434
+ <p>equation, including the label macro</p>
435
+ </li>
436
+ </ul>
437
+ </div>
438
+ </div>
439
+ <div class="sect2">
440
+ <h3 id="_outer_text">3.2. Outer text</h3>
441
+ <div class="paragraph">
442
+ <p>To write a theorem, do this:</p>
443
+ </div>
444
+ <div class="listingblock">
445
+ <div class="content">
446
+ <pre class="code ruby"><code class="ruby">.Theorem {counter:theorem}
447
+ --
448
+ For all $a$, $b$, $c$, the relation $a(b+c) = ab + ac$ holds.
449
+ --</code></pre>
450
+ </div>
451
+ </div>
452
+ <div class="paragraph">
453
+ <p>This will render in Asciidoc as</p>
454
+ </div>
455
+ <div class="openblock">
456
+ <div class="title">Theorem 1</div><div class="content">
457
+ <div class="paragraph">
458
+ <p><em>For all $a$, $b$, $c$, the relation $a(b+c) = ab + ac$ holds.</em></p>
459
+ </div>
460
+ </div>
461
+ </div>
462
+ </div>
463
+ </div>
464
+ </div>
465
+ <div id="footnotes">
466
+ <hr>
467
+ <div class="footnote" id="_footnote_1">
468
+ <a href="#_footnoteref_1">1</a> This option exists but has not yet been released. To use the option at <a href="http://noteshare.io">noteshare.io</a>, include the code <code>:latex:</code> in your document
469
+ </div>
470
+ </div></div></div>
471
+
472
+ <div id="footer">
473
+ Generated on Sun Apr 19 09:57:30 2015 by
474
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
475
+ 0.8.7.6 (ruby-2.1.2).
476
+ </div>
477
+
478
+ </body>
479
+ </html>