FooBarWidget-mizuho 0.9.1 → 0.9.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +1 -1
- data/Rakefile +14 -2
- data/asciidoc/BUGS +11 -6
- data/asciidoc/BUGS.txt +7 -3
- data/asciidoc/CHANGELOG +313 -151
- data/asciidoc/CHANGELOG.txt +177 -12
- data/asciidoc/INSTALL +30 -36
- data/asciidoc/INSTALL.txt +20 -20
- data/asciidoc/Makefile.in +145 -0
- data/asciidoc/README +11 -11
- data/asciidoc/README.txt +9 -9
- data/asciidoc/a2x +40 -7
- data/asciidoc/asciidoc.conf +180 -126
- data/asciidoc/asciidoc.py +1667 -977
- data/asciidoc/common.aap +2 -2
- data/asciidoc/configure +2840 -0
- data/asciidoc/configure.ac +11 -0
- data/asciidoc/dblatex/asciidoc-dblatex.sty +2 -0
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +15 -0
- data/asciidoc/dblatex/dblatex-readme.txt +19 -2
- data/asciidoc/doc/a2x.1 +77 -67
- data/asciidoc/doc/a2x.1.txt +11 -2
- data/asciidoc/doc/article.css-embedded.html +85 -63
- data/asciidoc/doc/article.html +644 -62
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +15 -17
- data/asciidoc/doc/asciidoc.1 +34 -40
- data/asciidoc/doc/asciidoc.1.css-embedded.html +67 -32
- data/asciidoc/doc/asciidoc.1.css.html +28 -28
- data/asciidoc/doc/asciidoc.1.html +33 -33
- data/asciidoc/doc/asciidoc.css-embedded.html +2234 -2348
- data/asciidoc/doc/asciidoc.css.html +2203 -2352
- data/asciidoc/doc/asciidoc.dict +52 -1
- data/asciidoc/doc/asciidoc.html +980 -1160
- data/asciidoc/doc/asciidoc.txt +941 -738
- data/asciidoc/doc/asciimathml.txt +63 -0
- data/asciidoc/doc/book-multi.html +26 -43
- data/asciidoc/doc/book-multi.txt +19 -23
- data/asciidoc/doc/book.css-embedded.html +92 -71
- data/asciidoc/doc/book.html +24 -41
- data/asciidoc/doc/book.txt +19 -21
- data/asciidoc/doc/docbook-xsl.css +1 -0
- data/asciidoc/doc/faq.txt +288 -60
- data/asciidoc/doc/images +1 -0
- data/asciidoc/doc/latex-backend.html +16 -123
- data/asciidoc/doc/latex-backend.txt +17 -19
- data/asciidoc/doc/latexmath.txt +233 -24
- data/asciidoc/doc/latexmathml.txt +41 -0
- data/asciidoc/doc/main.aap +9 -5
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +2 -2
- data/asciidoc/doc/source-highlight-filter.html +476 -105
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +39 -10
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +1 -29
- data/asciidoc/docbook-xsl/fo.xsl +35 -3
- data/asciidoc/docbook-xsl/manpage.xsl +3 -0
- data/asciidoc/docbook-xsl/text.xsl +50 -0
- data/asciidoc/docbook.conf +182 -73
- data/asciidoc/examples/website/ASCIIMathML.js +1 -0
- data/asciidoc/examples/website/CHANGELOG.html +618 -182
- data/asciidoc/examples/website/CHANGELOG.txt +1 -0
- data/asciidoc/examples/website/INSTALL.html +34 -36
- data/asciidoc/examples/website/INSTALL.txt +1 -0
- data/asciidoc/examples/website/LaTeXMathML.js +1 -0
- data/asciidoc/examples/website/README-website.html +26 -37
- data/asciidoc/examples/website/README-website.txt +6 -6
- data/asciidoc/examples/website/README.html +15 -15
- data/asciidoc/examples/website/README.txt +1 -0
- data/asciidoc/examples/website/a2x.1.html +74 -50
- data/asciidoc/examples/website/a2x.1.txt +1 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +13 -48
- data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +1 -0
- data/asciidoc/examples/website/asciimathml.txt +1 -0
- data/asciidoc/examples/website/customers.csv +1 -0
- data/asciidoc/examples/website/downloads.html +69 -31
- data/asciidoc/examples/website/downloads.txt +28 -5
- data/asciidoc/examples/website/faq.html +370 -124
- data/asciidoc/examples/website/faq.txt +1 -0
- data/asciidoc/examples/website/images +1 -0
- data/asciidoc/examples/website/index.html +64 -64
- data/asciidoc/examples/website/index.txt +22 -15
- data/asciidoc/examples/website/latex-backend.html +152 -257
- data/asciidoc/examples/website/latex-backend.txt +1 -0
- data/asciidoc/examples/website/latexmathml.txt +1 -0
- data/asciidoc/examples/website/manpage.html +27 -27
- data/asciidoc/examples/website/manpage.txt +1 -0
- data/asciidoc/examples/website/music-filter.html +18 -18
- data/asciidoc/examples/website/music-filter.txt +1 -0
- data/asciidoc/examples/website/music1.abc +1 -1
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +1 -1
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/newlists.txt +40 -0
- data/asciidoc/examples/website/newtables.txt +397 -0
- data/asciidoc/examples/website/source-highlight-filter.html +67 -32
- data/asciidoc/examples/website/source-highlight-filter.txt +1 -0
- data/asciidoc/examples/website/support.html +4 -4
- data/asciidoc/examples/website/toc.js +1 -0
- data/asciidoc/examples/website/userguide.html +2190 -2339
- data/asciidoc/examples/website/userguide.txt +1 -0
- data/asciidoc/examples/website/version83.txt +37 -0
- data/asciidoc/examples/website/version9.html +13 -13
- data/asciidoc/examples/website/xhtml11-manpage.css +1 -0
- data/asciidoc/examples/website/xhtml11-quirks.css +1 -0
- data/asciidoc/examples/website/xhtml11.css +1 -0
- data/asciidoc/filters/code-filter-readme.txt +3 -3
- data/asciidoc/filters/code-filter-test.txt +6 -6
- data/asciidoc/filters/source-highlight-filter.conf +12 -5
- data/asciidoc/html4.conf +152 -58
- data/asciidoc/install-sh +201 -0
- data/asciidoc/latex.conf +41 -41
- data/asciidoc/stylesheets/docbook-xsl.css +1 -0
- data/asciidoc/stylesheets/xhtml11.css +39 -4
- data/asciidoc/text.conf +4 -4
- data/asciidoc/vim/syntax/asciidoc.vim +58 -32
- data/asciidoc/wordpress.conf +48 -0
- data/asciidoc/xhtml11-quirks.conf +1 -1
- data/asciidoc/xhtml11.conf +198 -70
- data/bin/mizuho +5 -2
- data/lib/mizuho/generator.rb +48 -19
- data/mizuho.gemspec +16 -6
- metadata +58 -15
- data/asciidoc/doc/asciimath.txt +0 -47
- data/asciidoc/docbook-xsl/shaded-literallayout.patch +0 -32
- data/asciidoc/examples/website/asciimath.html +0 -157
- data/asciidoc/examples/website/latexmath.html +0 -119
- data/asciidoc/filters/code-filter-test-c++.txt +0 -7
- data/asciidoc/install.sh +0 -55
- data/asciidoc/linuxdoc.conf +0 -285
- data/asciidoc/math.conf +0 -50
- data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +0 -21
- data/asciidoc/stylesheets/xhtml-deprecated.css +0 -247
- data/asciidoc/t.conf +0 -20
- data/asciidoc/xhtml-deprecated-css.conf +0 -235
- data/asciidoc/xhtml-deprecated.conf +0 -351
data/asciidoc/doc/images
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
../images
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
1
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>LaTeX backend for Asciidoc</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.
|
|
2
|
+
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>LaTeX backend for Asciidoc</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id2425213"></a>LaTeX backend for Asciidoc</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Benjamin</span> <span class="surname">Klum</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:benjamin.klum@gmail.com">benjamin.klum@gmail.com</a>></code></p></div></div></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="3"><b>Revision History</b></th></tr><tr><td align="left">Revision 1.0</td><td align="left">June 2006</td><td align="left">BK</td></tr></table></div></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#_introduction">1. Introduction</a></span></dt><dt><span class="section"><a href="#_tutorial">2. Tutorial</a></span></dt><dt><span class="section"><a href="#_general_notes">3. General notes</a></span></dt><dd><dl><dt><span class="section"><a href="#_quality_of_latex_output">3.1. Quality of LaTeX output</a></span></dt><dt><span class="section"><a href="#_configuration_file_customization">3.2. Configuration file customization</a></span></dt><dt><span class="section"><a href="#_output_optimization">3.3. Output optimization</a></span></dt><dt><span class="section"><a href="#unicodeSupport">3.4. Unicode support</a></span></dt></dl></dd><dt><span class="section"><a href="#_backend_specific_features">4. Backend specific features</a></span></dt><dd><dl><dt><span class="section"><a href="#_special_sections">4.1. Special sections</a></span></dt><dt><span class="section"><a href="#internalCrossReferences">4.2. Internal cross references</a></span></dt><dt><span class="section"><a href="#_options">4.3. Options</a></span></dt></dl></dd><dt><span class="section"><a href="#_requirements">5. Requirements</a></span></dt><dd><dl><dt><span class="section"><a href="#_general">5.1. General</a></span></dt><dt><span class="section"><a href="#packageRequirements">5.2. TeX/LaTeX Package requirements</a></span></dt></dl></dd><dt><span class="section"><a href="#configurationFile">6. About the LaTeX backend configuration file</a></span></dt><dt><span class="section"><a href="#_ideas">7. Ideas</a></span></dt><dd><dl><dt><span class="section"><a href="#_code_listing_block">7.1. Code listing block</a></span></dt></dl></dd><dt><span class="section"><a href="#_known_bugs">8. Known Bugs</a></span></dt><dt><span class="section"><a href="#_todo_list">9. Todo List</a></span></dt></dl></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_introduction"></a>1. Introduction</h2></div></div></div><p>LaTeX backend is a configuration file for Stuart Rackham’s <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">Asciidoc</a>. It generates high-level LaTeX markup from Asciidoc documents. LaTeX is a document preparation system for TeX which in turn is a popular typesetting system. It is well known for producing excellently typesetted high quality printouts, especially suited for scientific text.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_tutorial"></a>2. Tutorial</h2></div></div></div><p>Getting a ready-to-print document from an Asciidoc document using the LaTeX backend involves at least two steps:</p><div class="orderedlist"><ol type="1"><li>
|
|
4
3
|
Conversion of the Asciidoc document into a LaTeX document (this is done by Asciidoc using the LaTeX backend)
|
|
5
4
|
</li><li>
|
|
6
5
|
Conversion of the LaTeX document into a PDF document (this is done by the TeX system)
|
|
7
6
|
</li></ol></div><p>Try to create a PDF document from the Asciidoc document <code class="literal">article.txt</code> which resides in the <code class="literal">doc</code> directory of Asciidoc:</p><div class="orderedlist"><ol type="a"><li>
|
|
8
|
-
Make a copy of <code class="literal">article.txt</code> in a directory of your choice, let
|
|
7
|
+
Make a copy of <code class="literal">article.txt</code> in a directory of your choice, let’s call it <code class="literal">latex-test</code>.
|
|
9
8
|
</li><li>
|
|
10
9
|
Make sure that all images referenced in <code class="literal">article.txt</code> exist in <code class="literal">latex-test</code>. Brute force approach: Copy the whole <code class="literal">images</code> directory from Asciidoc directory into <code class="literal">latex-test</code>.
|
|
11
10
|
</li><li><p>
|
|
@@ -16,8 +15,8 @@ Now there should be a file <code class="literal">article.pdf</code> in the <code
|
|
|
16
15
|
</li></ol></div><div class="important" style="margin-left: 0; margin-right: 10%;"><table border="0" summary="Important"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="./images/icons/important.png" /></td><th align="left"></th></tr><tr><td align="left" valign="top"><div class="itemizedlist"><ul type="disc"><li>
|
|
17
16
|
Asciidoc has to be started in <span class="emphasis"><em>unsafe mode</em></span> when using LaTeX backend.
|
|
18
17
|
</li><li>
|
|
19
|
-
Note that some special LaTeX packages are necessary, see <a href="#packageRequirements" title="5.2. TeX/LaTeX Package requirements">here</a>.
|
|
20
|
-
</li></ul></div></td></tr></table></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_general_notes"></a>3. General notes</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_quality_of_latex_output"></a>3.1. Quality of LaTeX output</h3></div></div></div><p>High-level LaTeX is not very straightforward to generate. Therefore there
|
|
18
|
+
Note that some special LaTeX packages are necessary, see <a class="link" href="#packageRequirements" title="5.2. TeX/LaTeX Package requirements">here</a>.
|
|
19
|
+
</li></ul></div></td></tr></table></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_general_notes"></a>3. General notes</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_quality_of_latex_output"></a>3.1. Quality of LaTeX output</h3></div></div></div><p>High-level LaTeX is not very straightforward to generate. Therefore there’s no guarantee that the generated output is valid and compiles successfully. At all, this backend should be considered as rather experimental. You should have been already in touch with LaTeX in order to use the backend effectively because LaTeX compilation errors can be really nasty.</p><p>Nevertheless good results can be achieved by using LaTeX backend. Try for example to compile Stuart Rackham’s Asciidoc documentation, a rather large document. It should compile without problems. However, the code filter might have to be reconfigured for the code filter example to work.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_configuration_file_customization"></a>3.2. Configuration file customization</h3></div></div></div><p>Like every other Asciidoc backend the LaTeX backend can be customized easily to fit the user’s needs. Actually it is very important to have this option since LaTeX doesn’t have a companion language like CSS which allows to put styling information in a separate file. Read more about the LaTeX backend configuration file <a class="link" href="#configurationFile" title="6. About the LaTeX backend configuration file">here</a>.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_output_optimization"></a>3.3. Output optimization</h3></div></div></div><p>The LaTeX output is optimized for creating PDF documents using <span class="emphasis"><em>pdflatex</em></span>.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="unicodeSupport"></a>3.4. Unicode support</h3></div></div></div><p>Unfortunately TeX/LaTeX does not have native unicode support. The package <span class="emphasis"><em>ucs</em></span> adds elementary unicode support by introducing UTF-8 input encoding recognition and by defining lookup tables which contain the corresponding LaTeX commands for unicode characters. But these lookup tables are far from being complete. When a unicode character is found which is not defined in the lookup tables an error is raised by the TeX/LaTeX compiler. Note that TeX/LaTeX compilation errors caused by missing unicode character definitions are not fatal, that means the result is probably readable but undefined unicode characters are replaced with <code class="literal">[U+…]</code>. You may (de)activate the recognition of escaped unicode characters. See the <a class="xref" href="#latex-recognize-escaped-unicode">[latex-recognize-escaped-unicode]</a> backend option.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_backend_specific_features"></a>4. Backend specific features</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_special_sections"></a>4.1. Special sections</h3></div></div></div><p>LaTeX backend supports the following special sections and replaces them with corresponding LaTeX commands or environments:</p><div class="itemizedlist"><ul type="disc"><li>
|
|
21
20
|
Abstract (only for document type <span class="emphasis"><em>article</em></span>)
|
|
22
21
|
</li><li>
|
|
23
22
|
Dedication (only for document type <span class="emphasis"><em>book</em></span>)
|
|
@@ -32,19 +31,19 @@ Contents
|
|
|
32
31
|
</li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="internalCrossReferences"></a>4.2. Internal cross references</h3></div></div></div><p>Macros for internal cross references have been extended by the attribute <span class="emphasis"><em>style</em></span>.</p><pre class="literallayout">xref:<id>[<caption>, style=<style>]</pre><p>or</p><pre class="literallayout"><<<id>,<caption>,<style>>></pre><p>The additional attribute <span class="emphasis"><em>style</em></span> can have following values:</p><div class="variablelist"><dl><dt><span class="term">
|
|
33
32
|
page
|
|
34
33
|
</span></dt><dd>
|
|
35
|
-
Let
|
|
34
|
+
Let’s LaTeX print the page number of the referenced anchor.
|
|
36
35
|
</dd><dt><span class="term">
|
|
37
36
|
ref
|
|
38
37
|
</span></dt><dd>
|
|
39
|
-
Let
|
|
38
|
+
Let’s LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides.
|
|
40
39
|
</dd><dt><span class="term">
|
|
41
40
|
autoref
|
|
42
41
|
</span></dt><dd>
|
|
43
|
-
Let
|
|
42
|
+
Let’s LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides preceded with a contextual label.
|
|
44
43
|
</dd><dt><span class="term">
|
|
45
44
|
cite
|
|
46
45
|
</span></dt><dd>
|
|
47
|
-
Let
|
|
46
|
+
Let’s LaTeX interprete this reference as a reference to a bibliography entry. If the attribute <span class="emphasis"><em>latex-use-bibliography-environment</em></span> is set, references with <span class="emphasis"><em>cite</em></span> style as well as their corresponding bibliography anchors are presented as automatically generated numbers.
|
|
48
47
|
</dd></dl></div><p>If the <span class="emphasis"><em>style</em></span> attribute is not set the reference is printed the common way.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_options"></a>4.3. Options</h3></div></div></div><p>LaTeX document generation is influenced by the following attributes:</p><div class="variablelist"><dl><dt><span class="term">
|
|
49
48
|
latex-table-rowlimit
|
|
50
49
|
</span></dt><dd>
|
|
@@ -52,7 +51,7 @@ The maximum number of rows for typesetting tables using the <span class="emphasi
|
|
|
52
51
|
</dd><dt><span class="term">
|
|
53
52
|
latex-use-bibliography-environment
|
|
54
53
|
</span></dt><dd>
|
|
55
|
-
If <span class="emphasis"><em>latex-use-bibliography-environment</em></span> is defined, <span class="emphasis"><em>thebibliography</em></span> environment is used for the bibliography section. As a result bibliography entries are automatically numbered. Note that this works only if the bibliography section contains exclusively bibliography list items which start with a bibliography entry ([[[…]]]). Otherwise a TeX/LaTeX compilation error will occur. In order to display bibliography references correctly their <span class="emphasis"><em>style</em></span> attribute must be set to <span class="emphasis"><em>cite</em></span>. For more information see <a href="#internalCrossReferences" title="4.2. Internal cross references">Internal cross references</a>.
|
|
54
|
+
If <span class="emphasis"><em>latex-use-bibliography-environment</em></span> is defined, <span class="emphasis"><em>thebibliography</em></span> environment is used for the bibliography section. As a result bibliography entries are automatically numbered. Note that this works only if the bibliography section contains exclusively bibliography list items which start with a bibliography entry ([[[…]]]). Otherwise a TeX/LaTeX compilation error will occur. In order to display bibliography references correctly their <span class="emphasis"><em>style</em></span> attribute must be set to <span class="emphasis"><em>cite</em></span>. For more information see <a class="link" href="#internalCrossReferences" title="4.2. Internal cross references">Internal cross references</a>.
|
|
56
55
|
</dd><dt><span class="term">
|
|
57
56
|
latex-indent-paragraphs
|
|
58
57
|
</span></dt><dd>
|
|
@@ -60,7 +59,7 @@ If <span class="emphasis"><em>latex-indent-paragraphs</em></span> is defined, th
|
|
|
60
59
|
</dd><dt><span class="term">
|
|
61
60
|
<a id="latex-recognize-escaped-unicode"></a> latex-recognize-escaped-unicode
|
|
62
61
|
</span></dt><dd>
|
|
63
|
-
If <span class="emphasis"><em>latex-recognize-escaped-unicode</em></span> is defined, escaped unicode characters (e.g. <code class="literal">{amp}#960;</code> or <code class="literal">{amp}#x3C0;</code>) will be recognized. This can lead to LaTeX compilation errors since LaTeX unicode support is only rudimentary. For more information see <a href="#unicodeSupport" title="3.4. Unicode support">Unicode support</a>.
|
|
62
|
+
If <span class="emphasis"><em>latex-recognize-escaped-unicode</em></span> is defined, escaped unicode characters (e.g. <code class="literal">{amp}#960;</code> or <code class="literal">{amp}#x3C0;</code>) will be recognized. This can lead to LaTeX compilation errors since LaTeX unicode support is only rudimentary. For more information see <a class="link" href="#unicodeSupport" title="3.4. Unicode support">Unicode support</a>.
|
|
64
63
|
</dd><dt><span class="term">
|
|
65
64
|
latex-use-custom-list-items
|
|
66
65
|
</span></dt><dd>
|
|
@@ -86,126 +85,20 @@ encoding
|
|
|
86
85
|
</span></dt><dd>
|
|
87
86
|
Set the input and output document character set encoding. Currently <code class="literal">ISO-8859-1</code> and <code class="literal">UTF-8</code> are supported.
|
|
88
87
|
</dd></dl></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_requirements"></a>5. Requirements</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_general"></a>5.1. General</h3></div></div></div><p>The following software is necessary for using the LaTeX backend:</p><div class="itemizedlist"><ul type="disc"><li>
|
|
89
|
-
An up-to-date version of <a href="http://www.methods.co.nz/asciidoc/" target="_top">Asciidoc</a>
|
|
88
|
+
An up-to-date version of <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">Asciidoc</a>
|
|
90
89
|
</li><li><p>
|
|
91
90
|
An up-to-date TeX distribution, e.g.:
|
|
92
91
|
</p><div class="itemizedlist"><ul type="circle"><li>
|
|
93
|
-
<a href="http://www.miktex.org/" target="_top">MiKTeX</a> for Windows
|
|
94
|
-
</li><li>
|
|
95
|
-
<a href="http://www.tug.org/tetex/" target="_top">teTeX</a> for Linux
|
|
96
|
-
</li></ul></div></li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="packageRequirements"></a>5.2. TeX/LaTeX Package requirements</h3></div></div></div><p>LaTeX backend makes use of some LaTeX specialities which don't belong to a minimal TeX/LaTeX distribution. However, I took special care not to employ exotic packages. Hence the following packages should be available in most package repositories. The table is not complete yet because I don't know the package names for all TeX distributions.</p><div class="informaltable"><table cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /><col align="left" /><col align="left" /></colgroup><thead><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
97
|
-
Speciality
|
|
98
|
-
</th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
99
|
-
MiKTeX package name
|
|
100
|
-
</th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
101
|
-
teTeX package name
|
|
102
|
-
</th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
103
|
-
TeX Live package name
|
|
104
|
-
</th><th style="border-bottom: 1px solid ; " align="left">
|
|
105
|
-
Description
|
|
106
|
-
</th></tr></thead><tbody><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
107
|
-
KOMA-Script
|
|
108
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
109
|
-
koma-script
|
|
110
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
111
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
112
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
113
|
-
LaTeX backend uses the document classes <span class="emphasis"><em>scrartcl</em></span> and <span class="emphasis"><em>scrbook</em></span> as well as some other specialities defined in the <span class="emphasis"><em>KOMA-Script</em></span> package, e.g. the commands <code class="literal">\addmargin{}</code> and <code class="literal">\minisec{}</code>.
|
|
114
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
115
|
-
xcolor.sty
|
|
116
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
117
|
-
xcolor
|
|
118
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
119
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
120
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
121
|
-
Used to produce colored boxes and tables.
|
|
122
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
123
|
-
colortbl.sty
|
|
124
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
125
|
-
colortbl
|
|
126
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
127
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
128
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
129
|
-
Used to produce colored tables.
|
|
130
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
131
|
-
type1ec.sty
|
|
132
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
133
|
-
cm-super
|
|
134
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
135
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
136
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
137
|
-
Enables high quality fonts for PDF output.
|
|
138
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
139
|
-
hyperref.sty
|
|
140
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
141
|
-
hyperref
|
|
142
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
143
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
144
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
145
|
-
Extensive support for hypertext in PDF documents.
|
|
146
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
147
|
-
enumerate.sty
|
|
148
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
149
|
-
tools
|
|
150
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
151
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
152
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
153
|
-
When <span class="emphasis"><em>latex-use-custom-list-items</em></span> is defined this package is used for determining the enumeration character.
|
|
154
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
155
|
-
graphicx.sty
|
|
156
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
157
|
-
graphics
|
|
158
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
159
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
160
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
161
|
-
Used for including images.
|
|
162
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
163
|
-
longtable.sty
|
|
164
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
165
|
-
tools
|
|
166
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
167
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
168
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
169
|
-
Enables page spanning tables.
|
|
170
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
171
|
-
ucs.sty
|
|
172
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
173
|
-
unicode
|
|
174
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
175
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
176
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
177
|
-
Enables support for unicode characters.
|
|
178
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
179
|
-
textcomp
|
|
180
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
181
|
-
ltxbase
|
|
182
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
183
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
184
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
185
|
-
Used for printing various symbols like arrows. Should be already installed.
|
|
186
|
-
</td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
187
|
-
alltt
|
|
188
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
189
|
-
ltxbase
|
|
190
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
191
|
-
</td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left">
|
|
192
|
-
</td><td style="border-bottom: 1px solid ; " align="left">
|
|
193
|
-
Used in literal-like blocks for retaining line and whitespace formatting. Should be already installed.
|
|
194
|
-
</td></tr><tr><td style="border-right: 1px solid ; " align="left">
|
|
195
|
-
listings.sty
|
|
196
|
-
</td><td style="border-right: 1px solid ; " align="left">
|
|
197
|
-
listings
|
|
198
|
-
</td><td style="border-right: 1px solid ; " align="left">
|
|
199
|
-
</td><td style="border-right: 1px solid ; " align="left">
|
|
200
|
-
</td><td style="" align="left">
|
|
201
|
-
Used for listing blocks.
|
|
202
|
-
</td></tr></tbody></table></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="configurationFile"></a>6. About the LaTeX backend configuration file</h2></div></div></div><p>An important note for people who want to adapt the LaTeX backend configuration file to their own needs:</p><p>LaTeX markup has a lot of special characters, most importantly <code class="literal">\</code>, <code class="literal">{</code>, <code class="literal">}</code>. In order to make things less complicated, I changed the default substitution order (see entry <span class="emphasis"><em>subsnormal</em></span> in the <code class="literal">[miscellaneous]</code> section). In contrast to the backends <span class="emphasis"><em>docbook</em></span> and <span class="emphasis"><em>xhtml11</em></span>, the <span class="emphasis"><em>specialcharacters</em></span> substitution is applied very late. As a result all special characters produced by <span class="emphasis"><em>quotes</em></span>, <span class="emphasis"><em>specialwords</em></span>, <span class="emphasis"><em>replacements</em></span>, <span class="emphasis"><em>attributes</em></span> and <span class="emphasis"><em>macros</em></span> become escaped at the end. If you don't want special characters in the corresponding sections to get escaped, you've to use following symbols instead of the special characters.</p><div class="itemizedlist"><ul type="disc"><li>
|
|
92
|
+
<a class="ulink" href="http://www.miktex.org/" target="_top">MiKTeX</a> for Windows
|
|
93
|
+
</li><li>
|
|
94
|
+
<a class="ulink" href="http://www.tug.org/tetex/" target="_top">teTeX</a> for Linux
|
|
95
|
+
</li></ul></div></li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="packageRequirements"></a>5.2. TeX/LaTeX Package requirements</h3></div></div></div><p>LaTeX backend makes use of some LaTeX specialities which don’t belong to a minimal TeX/LaTeX distribution. However, I took special care not to employ exotic packages. Hence the following packages should be available in most package repositories. The table is not complete yet because I don’t know the package names for all TeX distributions.</p><div class="informaltable"><table cellpadding="4px" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; border-left: 2px solid #527bbd; border-right: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /><col align="left" /><col align="left" /><col align="left" /></colgroup><thead valign="top"><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top">Speciality </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"> MiKTeX package name </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"> teTeX package name </th><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"> TeX Live package name </th><th style="border-bottom: 1px solid ; " align="left" valign="top"> Description</th></tr></thead><tbody valign="top"><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>KOMA-Script</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>koma-script</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>LaTeX backend uses the document classes <span class="emphasis"><em>scrartcl</em></span> and <span class="emphasis"><em>scrbook</em></span> as well as some other specialities defined in the <span class="emphasis"><em>KOMA-Script</em></span> package, e.g. the commands <code class="literal">\\addmargin{}</code> and <code class="literal">\minisec{}</code>.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>xcolor.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>xcolor</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Used to produce colored boxes and tables.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>colortbl.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>colortbl</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Used to produce colored tables.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>type1ec.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>cm-super</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Enables high quality fonts for PDF output.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>hyperref.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>hyperref</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Extensive support for hypertext in PDF documents.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>enumerate.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>tools</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>When <span class="emphasis"><em>latex-use-custom-list-items</em></span> is defined this package is used for determining the enumeration character.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>graphicx.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>graphics</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Used for including images.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>longtable.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>tools</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Enables page spanning tables.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>ucs.sty</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>unicode</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Enables support for unicode characters.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>textcomp</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>ltxbase</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Used for printing various symbols like arrows. Should be already installed.</p></td></tr><tr><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>alltt</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p>ltxbase</p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Used in literal-like blocks for retaining line and whitespace formatting. Should be already installed.</p></td></tr><tr><td style="border-right: 1px solid ; " align="left" valign="top"><p>listings.sty</p></td><td style="border-right: 1px solid ; " align="left" valign="top"><p>listings</p></td><td style="border-right: 1px solid ; " align="left" valign="top"><p></p></td><td style="border-right: 1px solid ; " align="left" valign="top"><p></p></td><td style="" align="left" valign="top"><p>Used for listing blocks.</p></td></tr></tbody></table></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="configurationFile"></a>6. About the LaTeX backend configuration file</h2></div></div></div><p>An important note for people who want to adapt the LaTeX backend configuration file to their own needs:</p><p>LaTeX markup has a lot of special characters, most importantly <code class="literal">\</code>, <code class="literal">{</code>, <code class="literal">}</code>. In order to make things less complicated, I changed the default substitution order (see entry <span class="emphasis"><em>subsnormal</em></span> in the <code class="literal">[miscellaneous]</code> section). In contrast to the backends <span class="emphasis"><em>docbook</em></span> and <span class="emphasis"><em>xhtml11</em></span>, the <span class="emphasis"><em>specialcharacters</em></span> substitution is applied very late. As a result all special characters produced by <span class="emphasis"><em>quotes</em></span>, <span class="emphasis"><em>specialwords</em></span>, <span class="emphasis"><em>replacements</em></span>, <span class="emphasis"><em>attributes</em></span> and <span class="emphasis"><em>macros</em></span> become escaped at the end. If you don’t want special characters in the corresponding sections to get escaped, you’ve to use following symbols instead of the special characters.</p><div class="itemizedlist"><ul type="disc"><li>
|
|
203
96
|
<code class="literal">!..backslash..!</code> instead of <code class="literal">\</code>
|
|
204
97
|
</li><li>
|
|
205
98
|
<code class="literal">!..braceleft..!</code> instead of <code class="literal">{</code>
|
|
206
99
|
</li><li>
|
|
207
100
|
<code class="literal">!..braceright..!</code> instead of <code class="literal">}</code>
|
|
208
|
-
</li></ul></div><p>For more special characters take a look in the <code class="literal">[replacements2]</code> sections. <code class="literal">[replacements2]</code> section is responsible for replacing the symbols with their corresponding special characters.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ideas"></a>7. Ideas</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_code_listing_block"></a>7.1. Code listing block</h3></div></div></div><p>For creating highlighted code listings I suggest the use of <a href="http://www.andre-simon.de/" target="_top">Highlight</a> or <a href="http://www.gnu.org/software/src-highlite/" target="_top">GNU Source Highlight</a>. Both are suited for use as Asciidoc filters.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_known_bugs"></a>8. Known Bugs</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li>
|
|
101
|
+
</li></ul></div><p>For more special characters take a look in the <code class="literal">[replacements2]</code> sections. <code class="literal">[replacements2]</code> section is responsible for replacing the symbols with their corresponding special characters.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ideas"></a>7. Ideas</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_code_listing_block"></a>7.1. Code listing block</h3></div></div></div><p>For creating highlighted code listings I suggest the use of <a class="ulink" href="http://www.andre-simon.de/" target="_top">Highlight</a> or <a class="ulink" href="http://www.gnu.org/software/src-highlite/" target="_top">GNU Source Highlight</a>. Both are suited for use as Asciidoc filters.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_known_bugs"></a>8. Known Bugs</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li>
|
|
209
102
|
Sometimes LaTeX backend handles things differently from the default backends
|
|
210
103
|
</li><li>
|
|
211
104
|
A lot of little bugs
|
|
@@ -139,24 +139,22 @@ The following software is necessary for using the LaTeX backend:
|
|
|
139
139
|
|
|
140
140
|
LaTeX backend makes use of some LaTeX specialities which don't belong to a minimal TeX/LaTeX distribution. However, I took special care not to employ exotic packages. Hence the following packages should be available in most package repositories. The table is not complete yet because I don't know the package names for all TeX distributions.
|
|
141
141
|
|
|
142
|
-
[
|
|
143
|
-
|
|
144
|
-
Speciality | MiKTeX package name | teTeX package name | TeX Live package name | Description
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
_______________________________________________________________
|
|
142
|
+
[cols="4*,4",options="header"]
|
|
143
|
+
|====================================================================
|
|
144
|
+
|Speciality | MiKTeX package name | teTeX package name | TeX Live package name | Description
|
|
145
|
+
|KOMA-Script | koma-script | | | LaTeX backend uses the document classes 'scrartcl' and 'scrbook' as well as some other specialities defined in the 'KOMA-Script' package, e.g. the commands `\\addmargin{}` and `\minisec{}`.
|
|
146
|
+
|xcolor.sty | xcolor | | | Used to produce colored boxes and tables.
|
|
147
|
+
|colortbl.sty | colortbl | | | Used to produce colored tables.
|
|
148
|
+
|type1ec.sty | cm-super | | | Enables high quality fonts for PDF output.
|
|
149
|
+
|hyperref.sty | hyperref | | | Extensive support for hypertext in PDF documents.
|
|
150
|
+
|enumerate.sty | tools | | | When 'latex-use-custom-list-items' is defined this package is used for determining the enumeration character.
|
|
151
|
+
|graphicx.sty | graphics | | | Used for including images.
|
|
152
|
+
|longtable.sty | tools | | | Enables page spanning tables.
|
|
153
|
+
|ucs.sty | unicode | | | Enables support for unicode characters.
|
|
154
|
+
|textcomp | ltxbase | | | Used for printing various symbols like arrows. Should be already installed.
|
|
155
|
+
|alltt | ltxbase | | | Used in literal-like blocks for retaining line and whitespace formatting. Should be already installed.
|
|
156
|
+
|listings.sty | listings | | | Used for listing blocks.
|
|
157
|
+
|====================================================================
|
|
160
158
|
|
|
161
159
|
[[configurationFile]]
|
|
162
160
|
== About the LaTeX backend configuration file
|
|
@@ -190,4 +188,4 @@ For creating highlighted code listings I suggest the use of http://www.andre-sim
|
|
|
190
188
|
- Better looking tables
|
|
191
189
|
- Option for squeezing output (smaller lists)
|
|
192
190
|
- Support for different languages (That would be a nice feature for Asciidoc in general)
|
|
193
|
-
- Option for switching titlepage on and off
|
|
191
|
+
- Option for switching titlepage on and off
|
data/asciidoc/doc/latexmath.txt
CHANGED
|
@@ -1,35 +1,244 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
Embedding LaTeX Math in AsciiDoc dblatex documents
|
|
2
|
+
==================================================
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
http://www.methods.co.nz/asciidoc/asciimath.html[ASCIIMathML]
|
|
8
|
-
notation.
|
|
4
|
+
You can include
|
|
5
|
+
ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf[LaTeX math]
|
|
6
|
+
equations in AsciiDoc documents that are processed by 'dblatex'.
|
|
9
7
|
|
|
10
|
-
'LaTeXMathML' is a derivative of
|
|
11
|
-
http://www.methods.co.nz/asciidoc/asciimath.html[ASCIIMathML] -- in
|
|
12
|
-
terms of usage the only difference it that you use the `latexmath`
|
|
13
|
-
attribute instead of the `asciimath` attribute.
|
|
14
8
|
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
Inline equations
|
|
10
|
+
----------------
|
|
11
|
+
This markup:
|
|
17
12
|
|
|
18
|
-
|
|
13
|
+
---------------------------------------------------------------------
|
|
14
|
+
An inline equation latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$]
|
|
15
|
+
using the 'math' inline macro.
|
|
19
16
|
|
|
20
|
-
|
|
17
|
+
You can use the same 'math' macro to inject arbitrary latexmath:[\LaTeX] markup
|
|
18
|
+
(but beware, this is an undocumented trick).
|
|
19
|
+
---------------------------------------------------------------------
|
|
21
20
|
|
|
22
|
-
|
|
21
|
+
Renders:
|
|
23
22
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
\right\} }$$$
|
|
23
|
+
An inline equation latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$]
|
|
24
|
+
using the 'math' inline macro.
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
You can use the same 'math' macro to inject arbitrary latexmath:[\LaTeX] markup
|
|
27
|
+
(but beware, this is an undocumented trick).
|
|
29
28
|
|
|
30
|
-
- $$$\begin{eqnarray} x & = & \frac{-7 \pm \sqrt{49 - 24}}{6} \\ & = &
|
|
31
|
-
-2 \textrm{ or } -\frac13. \end{eqnarray}$$$
|
|
32
29
|
|
|
33
|
-
|
|
34
|
-
|
|
30
|
+
Informal equations
|
|
31
|
+
------------------
|
|
32
|
+
Informal (untitled) equations are generated with a 'math' style
|
|
33
|
+
passthrough delimited block. This markup:
|
|
35
34
|
|
|
35
|
+
---------------------------------------------------------------------
|
|
36
|
+
[latexmath]
|
|
37
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
38
|
+
\[C = \alpha + \beta Y^{\gamma} + \epsilon\]
|
|
39
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
40
|
+
---------------------------------------------------------------------
|
|
41
|
+
|
|
42
|
+
Renders:
|
|
43
|
+
|
|
44
|
+
[latexmath]
|
|
45
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
46
|
+
\[C = \alpha + \beta Y^{\gamma} + \epsilon\]
|
|
47
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
48
|
+
|
|
49
|
+
Functionally identical block macro syntax:
|
|
50
|
+
|
|
51
|
+
---------------------------------------------------------------------
|
|
52
|
+
latexmath::[\[C = \alpha + \beta Y^{\gamma} + \epsilon\]]
|
|
53
|
+
---------------------------------------------------------------------
|
|
54
|
+
|
|
55
|
+
Renders:
|
|
56
|
+
|
|
57
|
+
latexmath::[\[C = \alpha + \beta Y^{\gamma} + \epsilon\]]
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
Formal equations
|
|
61
|
+
----------------
|
|
62
|
+
Formal equations are titled and are generated with a 'math' style
|
|
63
|
+
passthrough delimited block.
|
|
64
|
+
|
|
65
|
+
This markup:
|
|
66
|
+
|
|
67
|
+
---------------------------------------------------------------------
|
|
68
|
+
.Unnumbered
|
|
69
|
+
[latexmath]
|
|
70
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
71
|
+
\[C = \alpha + \beta Y^{\gamma} + \epsilon\]
|
|
72
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
73
|
+
---------------------------------------------------------------------
|
|
74
|
+
|
|
75
|
+
Renders:
|
|
76
|
+
|
|
77
|
+
.Unnumbered
|
|
78
|
+
[latexmath]
|
|
79
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
80
|
+
\[C = \alpha + \beta Y^{\gamma} + \epsilon\]
|
|
81
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
82
|
+
|
|
83
|
+
This markup:
|
|
84
|
+
|
|
85
|
+
---------------------------------------------------------------------
|
|
86
|
+
.Aligned
|
|
87
|
+
[latexmath]
|
|
88
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
89
|
+
\begin{align*}
|
|
90
|
+
2x^2 + 3(x-1)(x-2) & = 2x^2 + 3(x^2-3x+2) \\
|
|
91
|
+
&= 2x^2 + 3x^2 - 9x + 6 \\
|
|
92
|
+
&= 5x^2 - 9x + 6
|
|
93
|
+
\end{align*}
|
|
94
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
95
|
+
---------------------------------------------------------------------
|
|
96
|
+
|
|
97
|
+
Renders:
|
|
98
|
+
|
|
99
|
+
.Unnumbered
|
|
100
|
+
.Aligned
|
|
101
|
+
[latexmath]
|
|
102
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
103
|
+
\begin{align*}
|
|
104
|
+
2x^2 + 3(x-1)(x-2) & = 2x^2 + 3(x^2-3x+2) \\
|
|
105
|
+
&= 2x^2 + 3x^2 - 9x + 6 \\
|
|
106
|
+
&= 5x^2 - 9x + 6
|
|
107
|
+
\end{align*}
|
|
108
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
109
|
+
|
|
110
|
+
This markup:
|
|
111
|
+
|
|
112
|
+
---------------------------------------------------------------------
|
|
113
|
+
.Array
|
|
114
|
+
[latexmath]
|
|
115
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
116
|
+
\begin{eqnarray}
|
|
117
|
+
x & = & \frac{-7 \pm \sqrt{49 - 24}}{6} \\
|
|
118
|
+
& = & -2 \textrm{ or } -\frac13
|
|
119
|
+
\end{eqnarray}
|
|
120
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
121
|
+
---------------------------------------------------------------------
|
|
122
|
+
|
|
123
|
+
Renders:
|
|
124
|
+
|
|
125
|
+
.Array
|
|
126
|
+
[latexmath]
|
|
127
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
128
|
+
\begin{eqnarray}
|
|
129
|
+
x & = & \frac{-7 \pm \sqrt{49 - 24}}{6} \\
|
|
130
|
+
& = & -2 \textrm{ or } -\frac13
|
|
131
|
+
\end{eqnarray}
|
|
132
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
133
|
+
|
|
134
|
+
This markup:
|
|
135
|
+
|
|
136
|
+
---------------------------------------------------------------------
|
|
137
|
+
.Array
|
|
138
|
+
[latexmath]
|
|
139
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
140
|
+
\begin{eqnarray*}
|
|
141
|
+
4r^2\int_0^{\pi/2} \cos^2 \theta\, d\theta
|
|
142
|
+
&=& 4r^2\int_0^{\pi/2} \frac{1}{2}(1 + \cos 2\theta) \,d\theta\\
|
|
143
|
+
& = & {2r^2\theta}\Bigg{|}_0^{\pi/2}
|
|
144
|
+
+ 2r^2\int_0^{\pi/2} \cos 2\theta \,d\theta\\
|
|
145
|
+
& = & \pi r^2 + 2r^2(\sin2\theta)\Bigg{|}_0^{\pi/2}\\
|
|
146
|
+
& = & \pi r^2
|
|
147
|
+
\end{eqnarray*}
|
|
148
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
149
|
+
---------------------------------------------------------------------
|
|
150
|
+
|
|
151
|
+
Renders:
|
|
152
|
+
|
|
153
|
+
.Array
|
|
154
|
+
[latexmath]
|
|
155
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
156
|
+
\begin{eqnarray*}
|
|
157
|
+
4r^2\int_0^{\pi/2} \cos^2 \theta\, d\theta
|
|
158
|
+
&=& 4r^2\int_0^{\pi/2} \frac{1}{2}(1 + \cos 2\theta) \,d\theta\\
|
|
159
|
+
& = & {2r^2\theta}\Bigg{|}_0^{\pi/2}
|
|
160
|
+
+ 2r^2\int_0^{\pi/2} \cos 2\theta \,d\theta\\
|
|
161
|
+
& = & \pi r^2 + 2r^2(\sin2\theta)\Bigg{|}_0^{\pi/2}\\
|
|
162
|
+
& = & \pi r^2
|
|
163
|
+
\end{eqnarray*}
|
|
164
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
165
|
+
|
|
166
|
+
This markup:
|
|
167
|
+
|
|
168
|
+
---------------------------------------------------------------------
|
|
169
|
+
.List
|
|
170
|
+
[latexmath]
|
|
171
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
172
|
+
\begin{enumerate}
|
|
173
|
+
\item $\frac{da}{dx} = 0$
|
|
174
|
+
\item $\frac{d}{dx} ax = a$
|
|
175
|
+
\item $\frac{d}{dx} x^n = nx^{n-1}$
|
|
176
|
+
\item $\displaystyle \frac{d}{dx} (f(x) + g(x))
|
|
177
|
+
= \frac{d}{dx} f(x) + \frac{d}{dx} g(x)$
|
|
178
|
+
\item $\displaystyle \frac{d}{dx} f(x)g(x)
|
|
179
|
+
= g(x) \frac{d}{dx} f(x) + f(x) \frac{d}{dx} g(x)$
|
|
180
|
+
\item $\displaystyle \frac{d}{dx} \frac{f(x)}{g(x)}
|
|
181
|
+
= \frac{g(x) \frac{d}{dx} f(x) - f(x) \frac{d}{dx} g(x)}{(g(x))^2}$
|
|
182
|
+
\end{enumerate}
|
|
183
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
184
|
+
---------------------------------------------------------------------
|
|
185
|
+
|
|
186
|
+
Renders:
|
|
187
|
+
|
|
188
|
+
.List
|
|
189
|
+
[latexmath]
|
|
190
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
191
|
+
\begin{enumerate}
|
|
192
|
+
\item $\frac{da}{dx} = 0$
|
|
193
|
+
\item $\frac{d}{dx} ax = a$
|
|
194
|
+
\item $\frac{d}{dx} x^n = nx^{n-1}$
|
|
195
|
+
\item $\displaystyle \frac{d}{dx} (f(x) + g(x))
|
|
196
|
+
= \frac{d}{dx} f(x) + \frac{d}{dx} g(x)$
|
|
197
|
+
\item $\displaystyle \frac{d}{dx} f(x)g(x)
|
|
198
|
+
= g(x) \frac{d}{dx} f(x) + f(x) \frac{d}{dx} g(x)$
|
|
199
|
+
\item $\displaystyle \frac{d}{dx} \frac{f(x)}{g(x)}
|
|
200
|
+
= \frac{g(x) \frac{d}{dx} f(x) - f(x) \frac{d}{dx} g(x)}{(g(x))^2}$
|
|
201
|
+
\end{enumerate}
|
|
202
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
203
|
+
|
|
204
|
+
This markup:
|
|
205
|
+
|
|
206
|
+
---------------------------------------------------------------------
|
|
207
|
+
.Matrix
|
|
208
|
+
[latexmath]
|
|
209
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
210
|
+
\[ P^{e \rightarrow c}= \left[
|
|
211
|
+
\begin{array}{*{3}{r@{}l}}
|
|
212
|
+
& \cos \theta & & \sin \theta \sin \varphi & & \sin \theta \cos \varphi\\
|
|
213
|
+
|
|
214
|
+
& \sin \theta \sin \psi
|
|
215
|
+
& & \cos \varphi \cos \psi - \cos \theta \sin \varphi \sin \psi
|
|
216
|
+
& - & \sin \varphi \cos \psi - \cos \theta \cos \varphi \sin \psi\\
|
|
217
|
+
|
|
218
|
+
- & \sin \theta \cos \psi
|
|
219
|
+
& & \cos \varphi \sin \psi + \cos \theta \sin \varphi \cos \psi
|
|
220
|
+
& - & \sin \varphi \sin \psi + \cos \theta \cos \varphi \cos \psi\\
|
|
221
|
+
\end{array}
|
|
222
|
+
\right] \]
|
|
223
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
224
|
+
---------------------------------------------------------------------
|
|
225
|
+
|
|
226
|
+
Renders:
|
|
227
|
+
|
|
228
|
+
.Matrix
|
|
229
|
+
[latexmath]
|
|
230
|
+
++++++++++++++++++++++++++++++++++++++++++++
|
|
231
|
+
\[ P^{e \rightarrow c}= \left[
|
|
232
|
+
\begin{array}{*{3}{r@{}l}}
|
|
233
|
+
& \cos \theta & & \sin \theta \sin \varphi & & \sin \theta \cos \varphi\\
|
|
234
|
+
|
|
235
|
+
& \sin \theta \sin \psi
|
|
236
|
+
& & \cos \varphi \cos \psi - \cos \theta \sin \varphi \sin \psi
|
|
237
|
+
& - & \sin \varphi \cos \psi - \cos \theta \cos \varphi \sin \psi\\
|
|
238
|
+
|
|
239
|
+
- & \sin \theta \cos \psi
|
|
240
|
+
& & \cos \varphi \sin \psi + \cos \theta \sin \varphi \cos \psi
|
|
241
|
+
& - & \sin \varphi \sin \psi + \cos \theta \cos \varphi \cos \psi\\
|
|
242
|
+
\end{array}
|
|
243
|
+
\right] \]
|
|
244
|
+
++++++++++++++++++++++++++++++++++++++++++++
|