mizuho 0.9.6 → 0.9.8
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +4 -2
- data/Rakefile +0 -37
- data/asciidoc/BUGS +9 -18
- data/asciidoc/BUGS.txt +5 -14
- data/asciidoc/CHANGELOG +1433 -266
- data/asciidoc/CHANGELOG.txt +2821 -1810
- data/asciidoc/COPYING +339 -339
- data/asciidoc/COPYRIGHT +18 -18
- data/asciidoc/INSTALL +189 -30
- data/asciidoc/INSTALL.txt +175 -19
- data/asciidoc/MANIFEST +88 -0
- data/asciidoc/Makefile.in +29 -13
- data/asciidoc/README +16 -17
- data/asciidoc/README.txt +35 -36
- data/asciidoc/a2x.py +902 -0
- data/asciidoc/asciidoc.conf +610 -455
- data/asciidoc/asciidoc.py +1965 -1061
- data/asciidoc/asciidocapi.py +257 -0
- data/asciidoc/common.aap +2 -2
- data/asciidoc/configure +1170 -1023
- data/asciidoc/configure.ac +1 -1
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +42 -0
- data/asciidoc/doc/a2x.1 +559 -102
- data/asciidoc/doc/a2x.1.txt +233 -91
- data/asciidoc/doc/article-docinfo.xml +87 -0
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +139 -122
- data/asciidoc/doc/asciidoc.1 +157 -46
- data/asciidoc/doc/asciidoc.1.txt +171 -118
- data/asciidoc/doc/asciidoc.conf +7 -8
- data/asciidoc/doc/asciidoc.dict +960 -635
- data/asciidoc/doc/asciidoc.txt +2335 -1464
- data/asciidoc/doc/asciidocapi.txt +189 -0
- data/asciidoc/doc/asciimathml.txt +14 -17
- data/asciidoc/doc/book-multi.txt +181 -155
- data/asciidoc/doc/book.epub +0 -0
- data/asciidoc/doc/book.txt +156 -131
- data/asciidoc/doc/customers.csv +18 -18
- data/asciidoc/doc/epub-notes.txt +210 -0
- data/asciidoc/doc/faq.txt +1122 -547
- data/asciidoc/doc/latex-backend.txt +192 -191
- data/asciidoc/doc/latex-bugs.txt +134 -0
- data/asciidoc/doc/latex-filter.pdf +0 -0
- data/asciidoc/doc/latex-filter.txt +196 -0
- data/asciidoc/doc/latexmath.txt +13 -136
- data/asciidoc/doc/latexmathml.txt +2 -2
- data/asciidoc/doc/main.aap +233 -297
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +55 -65
- data/asciidoc/doc/publishing-ebooks-with-asciidoc.txt +398 -0
- data/asciidoc/doc/slidy-example.txt +167 -0
- data/asciidoc/doc/slidy.txt +113 -0
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +45 -20
- data/asciidoc/doc/testasciidoc.txt +231 -0
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +30 -8
- data/asciidoc/docbook-xsl/chunked.xsl +17 -19
- data/asciidoc/docbook-xsl/common.xsl +106 -67
- data/asciidoc/docbook-xsl/epub.xsl +35 -0
- data/asciidoc/docbook-xsl/fo.xsl +3 -0
- data/asciidoc/docbook-xsl/htmlhelp.xsl +16 -17
- data/asciidoc/docbook-xsl/manpage.xsl +31 -31
- data/asciidoc/docbook-xsl/text.xsl +6 -1
- data/asciidoc/docbook-xsl/xhtml.xsl +14 -14
- data/asciidoc/docbook45.conf +759 -0
- data/asciidoc/filters/code/code-filter-readme.txt +37 -37
- data/asciidoc/filters/code/code-filter-test.txt +15 -15
- data/asciidoc/filters/code/code-filter.conf +8 -8
- data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt +104 -64
- data/asciidoc/filters/graphviz/graphviz-filter.conf +20 -16
- data/asciidoc/filters/graphviz/graphviz2png.py +54 -39
- data/asciidoc/filters/latex/latex-filter.conf +18 -0
- data/asciidoc/filters/latex/latex2png.py +216 -0
- data/asciidoc/filters/music/music-filter.conf +8 -17
- data/asciidoc/filters/music/music2png.py +40 -32
- data/asciidoc/filters/source/source-highlight-filter.conf +40 -34
- data/asciidoc/help.conf +261 -96
- data/asciidoc/html4.conf +505 -460
- data/asciidoc/html5.conf +686 -0
- data/asciidoc/images/highlighter.png +0 -0
- data/asciidoc/images/icons/caution.png +0 -0
- data/asciidoc/images/icons/example.png +0 -0
- data/asciidoc/images/icons/important.png +0 -0
- data/asciidoc/images/icons/note.png +0 -0
- data/asciidoc/images/icons/tip.png +0 -0
- data/asciidoc/images/icons/warning.png +0 -0
- data/asciidoc/images/smallnew.png +0 -0
- data/asciidoc/javascripts/asciidoc.js +189 -0
- data/asciidoc/javascripts/slidy.js +2845 -0
- data/asciidoc/javascripts/toc.js +8 -0
- data/asciidoc/lang-de.conf +57 -0
- data/asciidoc/lang-en.conf +54 -0
- data/asciidoc/lang-es.conf +49 -9
- data/asciidoc/lang-fr.conf +59 -0
- data/asciidoc/lang-hu.conf +55 -0
- data/asciidoc/lang-it.conf +55 -0
- data/asciidoc/lang-nl.conf +57 -0
- data/asciidoc/lang-pt-BR.conf +56 -0
- data/asciidoc/lang-ru.conf +60 -0
- data/asciidoc/lang-uk.conf +60 -0
- data/asciidoc/latex.conf +700 -663
- data/asciidoc/main.aap +77 -0
- data/asciidoc/slidy.conf +136 -0
- data/asciidoc/{examples/website/xhtml11-manpage.css → stylesheets/asciidoc-manpage.css} +1 -1
- data/asciidoc/stylesheets/asciidoc.css +508 -0
- data/asciidoc/stylesheets/docbook-xsl.css +322 -272
- data/asciidoc/stylesheets/flask-manpage.css +1 -0
- data/asciidoc/stylesheets/flask.css +584 -0
- data/asciidoc/stylesheets/pygments.css +66 -0
- data/asciidoc/stylesheets/slidy.css +445 -0
- data/asciidoc/stylesheets/toc2.css +33 -0
- data/asciidoc/stylesheets/volnitsky-manpage.css +1 -0
- data/asciidoc/stylesheets/volnitsky.css +435 -0
- data/asciidoc/stylesheets/xhtml11-quirks.css +5 -3
- data/asciidoc/tests/asciidocapi.py +257 -0
- data/asciidoc/tests/data/deprecated-quotes.txt +12 -0
- data/asciidoc/tests/data/filters-test.txt +90 -0
- data/asciidoc/tests/data/lang-de-test.txt +106 -0
- data/asciidoc/tests/data/lang-en-test.txt +114 -0
- data/asciidoc/tests/data/lang-es-test.txt +106 -0
- data/asciidoc/tests/data/lang-fr-test.txt +106 -0
- data/asciidoc/tests/data/lang-hu-test.txt +106 -0
- data/asciidoc/tests/data/lang-nl-test.txt +94 -0
- data/asciidoc/tests/data/lang-pt-BR-test.txt +106 -0
- data/asciidoc/tests/data/lang-ru-test.txt +106 -0
- data/asciidoc/tests/data/lang-uk-test.txt +106 -0
- data/asciidoc/tests/data/oldtables.txt +64 -0
- data/asciidoc/tests/data/rcs-id-marker-test.txt +6 -0
- data/asciidoc/tests/data/testcases.conf +2 -0
- data/asciidoc/tests/data/testcases.txt +740 -0
- data/asciidoc/tests/data/utf8-bom-test.txt +9 -0
- data/asciidoc/tests/data/utf8-examples.txt +217 -0
- data/asciidoc/tests/testasciidoc.conf +520 -0
- data/asciidoc/tests/testasciidoc.py +411 -0
- data/asciidoc/text.conf +16 -16
- data/asciidoc/vim/syntax/asciidoc.vim +99 -91
- data/asciidoc/wordpress.conf +43 -3
- data/asciidoc/xhtml11-quirks.conf +61 -57
- data/asciidoc/xhtml11.conf +684 -645
- data/lib/mizuho.rb +2 -0
- data/lib/mizuho/generator.rb +2 -2
- data/test/generator_spec.rb +1 -1
- data/test/parser_spec.rb +1 -1
- data/test/spec_helper.rb +3 -4
- metadata +87 -88
- data/asciidoc/a2x +0 -674
- data/asciidoc/doc/article.css-embedded.html +0 -602
- data/asciidoc/doc/article.html +0 -46
- data/asciidoc/doc/asciidoc-revhistory.xml +0 -27
- data/asciidoc/doc/asciidoc.1.css-embedded.html +0 -598
- data/asciidoc/doc/asciidoc.1.css.html +0 -212
- data/asciidoc/doc/asciidoc.1.html +0 -190
- data/asciidoc/doc/asciidoc.css-embedded.html +0 -7853
- data/asciidoc/doc/asciidoc.css.html +0 -7416
- data/asciidoc/doc/asciidoc.html +0 -3339
- data/asciidoc/doc/book-multi.css-embedded.html +0 -575
- data/asciidoc/doc/book-multi.html +0 -55
- data/asciidoc/doc/book.css-embedded.html +0 -607
- data/asciidoc/doc/book.html +0 -43
- data/asciidoc/doc/docbook-xsl.css +0 -272
- data/asciidoc/doc/latex-backend.html +0 -117
- data/asciidoc/doc/music-filter.html +0 -566
- data/asciidoc/doc/source-highlight-filter.html +0 -214
- data/asciidoc/docbook.conf +0 -721
- data/asciidoc/examples/website/ASCIIMathML.js +0 -938
- data/asciidoc/examples/website/CHANGELOG.html +0 -4389
- data/asciidoc/examples/website/CHANGELOG.txt +0 -1810
- data/asciidoc/examples/website/INSTALL.html +0 -161
- data/asciidoc/examples/website/INSTALL.txt +0 -71
- data/asciidoc/examples/website/LaTeXMathML.js +0 -1223
- data/asciidoc/examples/website/README-website.html +0 -118
- data/asciidoc/examples/website/README-website.txt +0 -29
- data/asciidoc/examples/website/README.html +0 -125
- data/asciidoc/examples/website/README.txt +0 -36
- data/asciidoc/examples/website/a2x.1.html +0 -419
- data/asciidoc/examples/website/a2x.1.txt +0 -204
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +0 -130
- data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +0 -43
- data/asciidoc/examples/website/asciidoc-graphviz-sample.txt +0 -130
- data/asciidoc/examples/website/asciimathml.txt +0 -64
- data/asciidoc/examples/website/build-website.sh +0 -25
- data/asciidoc/examples/website/customers.csv +0 -18
- data/asciidoc/examples/website/downloads.html +0 -257
- data/asciidoc/examples/website/downloads.txt +0 -121
- data/asciidoc/examples/website/faq.html +0 -673
- data/asciidoc/examples/website/faq.txt +0 -547
- data/asciidoc/examples/website/index.html +0 -419
- data/asciidoc/examples/website/index.txt +0 -245
- data/asciidoc/examples/website/latex-backend.html +0 -535
- data/asciidoc/examples/website/latex-backend.txt +0 -191
- data/asciidoc/examples/website/latexmathml.txt +0 -41
- data/asciidoc/examples/website/layout1.conf +0 -161
- data/asciidoc/examples/website/layout1.css +0 -65
- data/asciidoc/examples/website/layout2.conf +0 -158
- data/asciidoc/examples/website/layout2.css +0 -93
- data/asciidoc/examples/website/manpage.html +0 -266
- data/asciidoc/examples/website/manpage.txt +0 -118
- data/asciidoc/examples/website/music-filter.html +0 -242
- data/asciidoc/examples/website/music-filter.txt +0 -158
- data/asciidoc/examples/website/music1.abc +0 -12
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +0 -9
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/newlists.txt +0 -40
- data/asciidoc/examples/website/newtables.txt +0 -397
- data/asciidoc/examples/website/sample1.png +0 -0
- data/asciidoc/examples/website/sample3.png +0 -0
- data/asciidoc/examples/website/sample4.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +0 -286
- data/asciidoc/examples/website/source-highlight-filter.txt +0 -203
- data/asciidoc/examples/website/support.html +0 -78
- data/asciidoc/examples/website/support.txt +0 -5
- data/asciidoc/examples/website/toc.js +0 -69
- data/asciidoc/examples/website/userguide.html +0 -7460
- data/asciidoc/examples/website/userguide.txt +0 -4979
- data/asciidoc/examples/website/version83.txt +0 -37
- data/asciidoc/examples/website/version9.html +0 -143
- data/asciidoc/examples/website/version9.txt +0 -48
- data/asciidoc/examples/website/xhtml11-quirks.css +0 -41
- data/asciidoc/examples/website/xhtml11.css +0 -328
- data/asciidoc/stylesheets/xhtml11-manpage.css +0 -18
- data/asciidoc/stylesheets/xhtml11.css +0 -328
data/asciidoc/doc/book.html
DELETED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
2
|
-
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Book Title Goes Here</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="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2425213"></a>Book Title Goes Here</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Author's</span> <span class="surname">Name</span></h3></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">Dec 2003</td><td align="left">AN</td></tr></table></div></div></div><hr /></div><div class="dedication" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_dedication"></a>Dedication</h2></div></div></div><p>Optional dedication.</p><p>This document is an <span class="emphasis"><em>AsciiDoc</em></span> book skeleton containing briefly
|
|
3
|
-
annotated example elements plus a couple of example index entries and
|
|
4
|
-
footnotes.</p><p>Books are normally used to generate DocBook markup and the titles of
|
|
5
|
-
the preface, appendix, bibliography, glossary and index sections are
|
|
6
|
-
significant (<span class="emphasis"><em>specialsections</em></span>).</p></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#_preface">Preface</a></span></dt><dd><dl><dt><span class="section"><a href="#_preface_sub_section">1. Preface Sub-section</a></span></dt></dl></dd><dt><span class="chapter"><a href="#_the_first_chapter">1. The First Chapter</a></span></dt><dd><dl><dt><span class="section"><a href="#X1">1.1. Sub-section with Anchor</a></span></dt><dd><dl><dt><span class="section"><a href="#_chapter_sub_section">1.1.1. Chapter Sub-section</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#_the_second_chapter">2. The Second Chapter</a></span></dt><dt><span class="chapter"><a href="#_the_third_chapter">3. The Third Chapter</a></span></dt><dt><span class="appendix"><a href="#_example_appendix">A. Example Appendix</a></span></dt><dd><dl><dt><span class="section"><a href="#_appendix_sub_section">A.1. Appendix Sub-section</a></span></dt></dl></dd><dt><span class="bibliography"><a href="#_bibliography">Bibliography</a></span></dt><dt><span class="glossary"><a href="#_glossary">Glossary</a></span></dt><dt><span class="index"><a href="#_index">Index</a></span></dt></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>1.1. <a href="#id2477575">Tiger block image</a></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>1.1. <a href="#id2477601">An example table</a></dt></dl></div><div class="preface" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_preface"></a>Preface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#_preface_sub_section">1. Preface Sub-section</a></span></dt></dl></div><p>Optional preface.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_preface_sub_section"></a>1. Preface Sub-section</h2></div></div></div><p>Preface sub-section body.</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_the_first_chapter"></a>Chapter 1. The First Chapter</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#X1">1.1. Sub-section with Anchor</a></span></dt><dd><dl><dt><span class="section"><a href="#_chapter_sub_section">1.1.1. Chapter Sub-section</a></span></dt></dl></dd></dl></div><p>Chapters can contain sub-sections nested up to three deep.
|
|
7
|
-
<sup>[<a id="id2518172" href="#ftn.id2518172" class="footnote">1</a>]</sup>
|
|
8
|
-
<a id="id2518176" class="indexterm"></a></p><p>Chapters can have their own bibliography, glossary and index.</p><p>And now for something completely different: <a id="id2477454" class="indexterm"></a>monkeys, lions and
|
|
9
|
-
tigers (Bengal and Siberian) using the alternative syntax index
|
|
10
|
-
entries.
|
|
11
|
-
<a id="id2477463" class="indexterm"></a>
|
|
12
|
-
<a id="id2477475" class="indexterm"></a>
|
|
13
|
-
<a id="id2477484" class="indexterm"></a>
|
|
14
|
-
<a id="id2477498" class="indexterm"></a>
|
|
15
|
-
<a id="id2477509" class="indexterm"></a>
|
|
16
|
-
<a id="id2477518" class="indexterm"></a>
|
|
17
|
-
<a id="id2477532" class="indexterm"></a>
|
|
18
|
-
<a id="id2477543" class="indexterm"></a>
|
|
19
|
-
Note that multi-entry terms generate separate index entries.</p><p>Here are a couple of image examples: an <span class="inlinemediaobject"><img src="images/smallnew.png" alt="images/smallnew.png" /></span>
|
|
20
|
-
example inline image followed by an example block image:</p><div class="figure"><a id="id2477575"></a><p class="title"><b>Figure 1.1. Tiger block image</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/tiger.png" alt="Tiger image" /></div></div></div><br class="figure-break" /><p>Followed by an example table:</p><div class="table"><a id="id2477601"></a><p class="title"><b>Table 1.1. An example table</b></p><div class="table-contents"><table summary="An example 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" /></colgroup><thead valign="top"><tr><th style="border-right: 1px solid ; border-bottom: 1px solid ; " align="left" valign="top"> Option </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>-a <span class="emphasis"><em>USER GROUP</em></span></p></td><td style="border-bottom: 1px solid ; " align="left" valign="top"><p>Add <span class="emphasis"><em>USER</em></span> to <span class="emphasis"><em>GROUP</em></span>.</p></td></tr><tr><td style="border-right: 1px solid ; " align="left" valign="top"><p>-R <span class="emphasis"><em>GROUP</em></span></p></td><td style="" align="left" valign="top"><p>Disables access to <span class="emphasis"><em>GROUP</em></span>.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X1"></a>1.1. Sub-section with Anchor</h2></div></div></div><p>Sub-section at level 2.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_chapter_sub_section"></a>1.1.1. Chapter Sub-section</h3></div></div></div><p>Sub-section at level 3.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="_chapter_sub_section_2"></a>1.1.1.1. Chapter Sub-section</h4></div></div></div><p>Sub-section at level 4.</p><p>This is the maximum sub-section depth supported by the distributed
|
|
21
|
-
<span class="emphasis"><em>AsciiDoc</em></span> configuration.
|
|
22
|
-
<sup>[<a id="id2477784" href="#ftn.id2477784" class="footnote">2</a>]</sup></p></div></div></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id2518172" href="#id2518172" class="simpara">1</a>] </sup>An example footnote.</p></div><div class="footnote"><p><sup>[<a id="ftn.id2477784" href="#id2477784" class="simpara">2</a>] </sup>A second example footnote.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_the_second_chapter"></a>Chapter 2. The Second Chapter</h2></div></div></div><p>An example link to anchor at start of the <a class="link" href="#X1" title="1.1. Sub-section with Anchor">first sub-section</a>.
|
|
23
|
-
<a id="id2477912" class="indexterm"></a></p><p>An example link to a bibliography entry <a class="xref" href="#taoup">[taoup]</a>.</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_the_third_chapter"></a>Chapter 3. The Third Chapter</h2></div></div></div><p>Book chapters are at level 1 and can contain sub-sections.</p></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_example_appendix"></a>Appendix A. Example Appendix</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#_appendix_sub_section">A.1. Appendix Sub-section</a></span></dt></dl></div><p>One or more optional appendixes go here at section level 1.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_appendix_sub_section"></a>A.1. Appendix Sub-section</h2></div></div></div><p>Sub-section body.</p></div></div><div class="bibliography"><div class="titlepage"><div><div><h2 class="title"><a id="_bibliography"></a>Bibliography</h2></div></div></div><p>The bibliography list is a style of <span class="emphasis"><em>AsciiDoc</em></span> bulleted list.</p><div class="bibliomixed"><a id="id2478223"></a><p class="bibliomixed">
|
|
24
|
-
<span class="bibliomisc">
|
|
25
|
-
<a id="taoup"></a>[taoup] Eric Steven Raymond. <span class="emphasis"><em>The Art of Unix
|
|
26
|
-
Programming</em></span>. Addison-Wesley. ISBN 0-13-142901-9.
|
|
27
|
-
</span>
|
|
28
|
-
</p></div><div class="bibliomixed"><a id="id2478242"></a><p class="bibliomixed">
|
|
29
|
-
<span class="bibliomisc">
|
|
30
|
-
<a id="walsh-muellner"></a>[walsh-muellner] Norman Walsh & Leonard Muellner.
|
|
31
|
-
<span class="emphasis"><em>DocBook - The Definitive Guide</em></span>. O’Reilly & Associates. 1999.
|
|
32
|
-
ISBN 1-56592-580-7.
|
|
33
|
-
</span>
|
|
34
|
-
</p></div></div><div class="glossary"><div class="titlepage"><div><div><h2 class="title"><a id="_glossary"></a>Glossary</h2></div></div></div><p>Glossaries are optional. Glossaries entries are an example of a style
|
|
35
|
-
of <span class="emphasis"><em>AsciiDoc</em></span> labeled lists.</p><dl><dt>
|
|
36
|
-
A glossary term
|
|
37
|
-
</dt><dd><p>
|
|
38
|
-
The corresponding (indented) definition.
|
|
39
|
-
</p></dd><dt>
|
|
40
|
-
A second glossary term
|
|
41
|
-
</dt><dd><p>
|
|
42
|
-
The corresponding (indented) definition.
|
|
43
|
-
</p></dd></dl></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a id="_index"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>B</h3><dl><dt>Bengal Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Big cats</dt><dd><dl><dt>Lions, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>Example index entry, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lions, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>M</h3><dl><dt>monkeys, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>Second example index entry, <a class="indexterm" href="#_the_second_chapter">The Second Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>T</h3><dl><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt><dt>Siberian Tiger, <a class="indexterm" href="#_the_first_chapter">The First Chapter</a></dt></dl></dd></dl></div></div></div></div></body></html>
|
|
@@ -1,272 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
CSS stylesheet for XHTML produced by DocBook XSL stylesheets.
|
|
3
|
-
Tested with XSL stylesheets 1.61.2, 1.67.2
|
|
4
|
-
*/
|
|
5
|
-
|
|
6
|
-
span.strong {
|
|
7
|
-
font-weight: bold;
|
|
8
|
-
}
|
|
9
|
-
|
|
10
|
-
body blockquote {
|
|
11
|
-
margin-top: .75em;
|
|
12
|
-
line-height: 1.5;
|
|
13
|
-
margin-bottom: .75em;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
html body {
|
|
17
|
-
margin: 1em 5% 1em 5%;
|
|
18
|
-
line-height: 1.2;
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
body div {
|
|
22
|
-
margin: 0;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
h1, h2, h3, h4, h5, h6,
|
|
26
|
-
div.toc p b,
|
|
27
|
-
div.list-of-figures p b,
|
|
28
|
-
div.list-of-tables p b,
|
|
29
|
-
div.abstract p.title
|
|
30
|
-
{
|
|
31
|
-
color: #527bbd;
|
|
32
|
-
font-family: tahoma, verdana, sans-serif;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
div.toc p:first-child,
|
|
36
|
-
div.list-of-figures p:first-child,
|
|
37
|
-
div.list-of-tables p:first-child,
|
|
38
|
-
div.example p.title
|
|
39
|
-
{
|
|
40
|
-
margin-bottom: 0.2em;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
body h1 {
|
|
44
|
-
margin: .0em 0 0 -4%;
|
|
45
|
-
line-height: 1.3;
|
|
46
|
-
border-bottom: 2px solid silver;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
body h2 {
|
|
50
|
-
margin: 0.5em 0 0 -4%;
|
|
51
|
-
line-height: 1.3;
|
|
52
|
-
border-bottom: 2px solid silver;
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
body h3 {
|
|
56
|
-
margin: .8em 0 0 -3%;
|
|
57
|
-
line-height: 1.3;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
body h4 {
|
|
61
|
-
margin: .8em 0 0 -3%;
|
|
62
|
-
line-height: 1.3;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
body h5 {
|
|
66
|
-
margin: .8em 0 0 -2%;
|
|
67
|
-
line-height: 1.3;
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
body h6 {
|
|
71
|
-
margin: .8em 0 0 -1%;
|
|
72
|
-
line-height: 1.3;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
body hr {
|
|
76
|
-
border: none; /* Broken on IE6 */
|
|
77
|
-
}
|
|
78
|
-
div.footnotes hr {
|
|
79
|
-
border: 1px solid silver;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
div.navheader th, div.navheader td, div.navfooter td {
|
|
83
|
-
font-family: sans-serif;
|
|
84
|
-
font-size: 0.9em;
|
|
85
|
-
font-weight: bold;
|
|
86
|
-
color: #527bbd;
|
|
87
|
-
}
|
|
88
|
-
div.navheader img, div.navfooter img {
|
|
89
|
-
border-style: none;
|
|
90
|
-
}
|
|
91
|
-
div.navheader a, div.navfooter a {
|
|
92
|
-
font-weight: normal;
|
|
93
|
-
}
|
|
94
|
-
div.navfooter hr {
|
|
95
|
-
border: 1px solid silver;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
body td {
|
|
99
|
-
line-height: 1.2
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
body th {
|
|
103
|
-
line-height: 1.2;
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
ol {
|
|
107
|
-
line-height: 1.2;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
ul, body dir, body menu {
|
|
111
|
-
line-height: 1.2;
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
html {
|
|
115
|
-
margin: 0;
|
|
116
|
-
padding: 0;
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
body h1, body h2, body h3, body h4, body h5, body h6 {
|
|
120
|
-
margin-left: 0
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
body pre {
|
|
124
|
-
margin: 0.5em 10% 0.5em 1em;
|
|
125
|
-
line-height: 1.0;
|
|
126
|
-
color: navy;
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
tt.literal, code.literal {
|
|
130
|
-
color: navy;
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
.programlisting, .screen {
|
|
134
|
-
border: 1px solid silver;
|
|
135
|
-
background: #f4f4f4;
|
|
136
|
-
margin: 0.5em 10% 0.5em 0;
|
|
137
|
-
padding: 0.5em 1em;
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
div.sidebar {
|
|
141
|
-
background: #ffffee;
|
|
142
|
-
margin: 1.0em 10% 0.5em 0;
|
|
143
|
-
padding: 0.5em 1em;
|
|
144
|
-
border: 1px solid silver;
|
|
145
|
-
}
|
|
146
|
-
div.sidebar * { padding: 0; }
|
|
147
|
-
div.sidebar div { margin: 0; }
|
|
148
|
-
div.sidebar p.title {
|
|
149
|
-
font-family: sans-serif;
|
|
150
|
-
margin-top: 0.5em;
|
|
151
|
-
margin-bottom: 0.2em;
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
div.bibliomixed {
|
|
155
|
-
margin: 0.5em 5% 0.5em 1em;
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
div.glossary dt {
|
|
159
|
-
font-weight: bold;
|
|
160
|
-
}
|
|
161
|
-
div.glossary dd p {
|
|
162
|
-
margin-top: 0.2em;
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
dl {
|
|
166
|
-
margin: .8em 0;
|
|
167
|
-
line-height: 1.2;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
dt {
|
|
171
|
-
margin-top: 0.5em;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
dt span.term {
|
|
175
|
-
font-style: normal;
|
|
176
|
-
color: navy;
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
div.variablelist dd p {
|
|
180
|
-
margin-top: 0;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
div.itemizedlist li, div.orderedlist li {
|
|
184
|
-
margin-left: -0.8em;
|
|
185
|
-
margin-top: 0.5em;
|
|
186
|
-
}
|
|
187
|
-
|
|
188
|
-
ul, ol {
|
|
189
|
-
list-style-position: outside;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
div.sidebar ul, div.sidebar ol {
|
|
193
|
-
margin-left: 2.8em;
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
div.itemizedlist p.title,
|
|
197
|
-
div.orderedlist p.title,
|
|
198
|
-
div.variablelist p.title
|
|
199
|
-
{
|
|
200
|
-
margin-bottom: -0.8em;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
div.revhistory table {
|
|
204
|
-
border-collapse: collapse;
|
|
205
|
-
border: none;
|
|
206
|
-
}
|
|
207
|
-
div.revhistory th {
|
|
208
|
-
border: none;
|
|
209
|
-
color: #527bbd;
|
|
210
|
-
font-family: tahoma, verdana, sans-serif;
|
|
211
|
-
}
|
|
212
|
-
div.revhistory td {
|
|
213
|
-
border: 1px solid silver;
|
|
214
|
-
}
|
|
215
|
-
|
|
216
|
-
/* Keep TOC and index lines close together. */
|
|
217
|
-
div.toc dl, div.toc dt,
|
|
218
|
-
div.list-of-figures dl, div.list-of-figures dt,
|
|
219
|
-
div.list-of-tables dl, div.list-of-tables dt,
|
|
220
|
-
div.indexdiv dl, div.indexdiv dt
|
|
221
|
-
{
|
|
222
|
-
line-height: normal;
|
|
223
|
-
margin-top: 0;
|
|
224
|
-
margin-bottom: 0;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
/*
|
|
228
|
-
Table styling does not work because of overriding attributes in
|
|
229
|
-
generated HTML.
|
|
230
|
-
*/
|
|
231
|
-
div.table table,
|
|
232
|
-
div.informaltable table
|
|
233
|
-
{
|
|
234
|
-
margin-left: 0;
|
|
235
|
-
margin-right: 5%;
|
|
236
|
-
margin-bottom: 0.8em;
|
|
237
|
-
}
|
|
238
|
-
div.informaltable table
|
|
239
|
-
{
|
|
240
|
-
margin-top: 0.4em
|
|
241
|
-
}
|
|
242
|
-
div.table thead,
|
|
243
|
-
div.table tfoot,
|
|
244
|
-
div.table tbody,
|
|
245
|
-
div.informaltable thead,
|
|
246
|
-
div.informaltable tfoot,
|
|
247
|
-
div.informaltable tbody
|
|
248
|
-
{
|
|
249
|
-
/* No effect in IE6. */
|
|
250
|
-
border-top: 2px solid #527bbd;
|
|
251
|
-
border-bottom: 2px solid #527bbd;
|
|
252
|
-
}
|
|
253
|
-
div.table thead, div.table tfoot,
|
|
254
|
-
div.informaltable thead, div.informaltable tfoot
|
|
255
|
-
{
|
|
256
|
-
font-weight: bold;
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
div.mediaobject img {
|
|
260
|
-
border: 1px solid silver;
|
|
261
|
-
margin-bottom: 0.8em;
|
|
262
|
-
}
|
|
263
|
-
div.figure p.title,
|
|
264
|
-
div.table p.title
|
|
265
|
-
{
|
|
266
|
-
margin-top: 1em;
|
|
267
|
-
margin-bottom: 0.4em;
|
|
268
|
-
}
|
|
269
|
-
|
|
270
|
-
@media print {
|
|
271
|
-
div.navheader, div.navfooter { display: none; }
|
|
272
|
-
}
|
|
@@ -1,117 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
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>
|
|
3
|
-
Conversion of the Asciidoc document into a LaTeX document (this is done by Asciidoc using the LaTeX backend)
|
|
4
|
-
</li><li>
|
|
5
|
-
Conversion of the LaTeX document into a PDF document (this is done by the TeX system)
|
|
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>
|
|
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>.
|
|
8
|
-
</li><li>
|
|
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>.
|
|
10
|
-
</li><li><p>
|
|
11
|
-
Change directory to <code class="literal">latex-test</code> and type following commands:
|
|
12
|
-
</p><pre class="literallayout">asciidoc --unsafe --backend=latex article.txt
|
|
13
|
-
pdflatex article.tex</pre></li><li>
|
|
14
|
-
Now there should be a file <code class="literal">article.pdf</code> in the <code class="literal">latex-test</code> directory.
|
|
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>
|
|
16
|
-
Asciidoc has to be started in <span class="emphasis"><em>unsafe mode</em></span> when using LaTeX backend.
|
|
17
|
-
</li><li>
|
|
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>
|
|
20
|
-
Abstract (only for document type <span class="emphasis"><em>article</em></span>)
|
|
21
|
-
</li><li>
|
|
22
|
-
Dedication (only for document type <span class="emphasis"><em>book</em></span>)
|
|
23
|
-
</li><li>
|
|
24
|
-
Index
|
|
25
|
-
</li><li>
|
|
26
|
-
Bibliography (only when the attribute <span class="emphasis"><em>latex-use-bibliography-environment</em></span> is set)
|
|
27
|
-
</li><li>
|
|
28
|
-
Appendix
|
|
29
|
-
</li><li>
|
|
30
|
-
Contents
|
|
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">
|
|
32
|
-
page
|
|
33
|
-
</span></dt><dd>
|
|
34
|
-
Let’s LaTeX print the page number of the referenced anchor.
|
|
35
|
-
</dd><dt><span class="term">
|
|
36
|
-
ref
|
|
37
|
-
</span></dt><dd>
|
|
38
|
-
Let’s LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides.
|
|
39
|
-
</dd><dt><span class="term">
|
|
40
|
-
autoref
|
|
41
|
-
</span></dt><dd>
|
|
42
|
-
Let’s LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides preceded with a contextual label.
|
|
43
|
-
</dd><dt><span class="term">
|
|
44
|
-
cite
|
|
45
|
-
</span></dt><dd>
|
|
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.
|
|
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">
|
|
48
|
-
latex-table-rowlimit
|
|
49
|
-
</span></dt><dd>
|
|
50
|
-
The maximum number of rows for typesetting tables using the <span class="emphasis"><em>tabular</em></span> environment. If a table has more rows than <span class="emphasis"><em>latex-table-rowlimit</em></span>, <span class="emphasis"><em>longtable</em></span> environment is used instead of <span class="emphasis"><em>tabular</em></span> environment. <span class="emphasis"><em>longtable</em></span> environment supports tables spanning over several pages.
|
|
51
|
-
</dd><dt><span class="term">
|
|
52
|
-
latex-use-bibliography-environment
|
|
53
|
-
</span></dt><dd>
|
|
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>.
|
|
55
|
-
</dd><dt><span class="term">
|
|
56
|
-
latex-indent-paragraphs
|
|
57
|
-
</span></dt><dd>
|
|
58
|
-
If <span class="emphasis"><em>latex-indent-paragraphs</em></span> is defined, the first line of paragraphs will be indented. By default LaTeX backend prevents paragraph indentation and prints paragraphs with preceding vertical space.
|
|
59
|
-
</dd><dt><span class="term">
|
|
60
|
-
<a id="latex-recognize-escaped-unicode"></a> latex-recognize-escaped-unicode
|
|
61
|
-
</span></dt><dd>
|
|
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>.
|
|
63
|
-
</dd><dt><span class="term">
|
|
64
|
-
latex-use-custom-list-items
|
|
65
|
-
</span></dt><dd>
|
|
66
|
-
If <span class="emphasis"><em>latex-use-custom-list-items</em></span> is defined, lists will be bulleted or enumerated the way you have typed them in the original Asciidoc document. That means, <code class="literal">*</code> turns into a circle bullet, <code class="literal">-</code> turns into a dash, <code class="literal">.</code> turns into a number and <code class="literal">..</code> turns into a letter. Otherwise LaTeX will use different bullets and enumeration characters depending on the level of nesting.
|
|
67
|
-
</dd><dt><span class="term">
|
|
68
|
-
latex-use-colored-tables
|
|
69
|
-
</span></dt><dd>
|
|
70
|
-
If <span class="emphasis"><em>latex-use-colored-tables</em></span> is defined, tables will be printed colored.
|
|
71
|
-
</dd><dt><span class="term">
|
|
72
|
-
latex-use-running-title-headings
|
|
73
|
-
</span></dt><dd>
|
|
74
|
-
If <span class="emphasis"><em>latex-use-running-title-headings</em></span> is defined, <span class="emphasis"><em>pagestyle</em></span> will be set to <span class="emphasis"><em>headings</em></span> which results in running titles in the head.
|
|
75
|
-
</dd><dt><span class="term">
|
|
76
|
-
latex-use-colored-sidebar-blocks
|
|
77
|
-
</span></dt><dd>
|
|
78
|
-
If <span class="emphasis"><em>latex-use-colored-sidebar-blocks</em></span> is defined, sidebar block content will be put in a color box instead of being indented by a vertical bar.
|
|
79
|
-
</dd><dt><span class="term">
|
|
80
|
-
icons
|
|
81
|
-
</span></dt><dd>
|
|
82
|
-
Link admonition paragraph and admonition block icon images and badge images. By default icons is undefined and text is used in place of icon images.
|
|
83
|
-
</dd><dt><span class="term">
|
|
84
|
-
encoding
|
|
85
|
-
</span></dt><dd>
|
|
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.
|
|
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>
|
|
88
|
-
An up-to-date version of <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">Asciidoc</a>
|
|
89
|
-
</li><li><p>
|
|
90
|
-
An up-to-date TeX distribution, e.g.:
|
|
91
|
-
</p><div class="itemizedlist"><ul type="circle"><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>
|
|
96
|
-
<code class="literal">!..backslash..!</code> instead of <code class="literal">\</code>
|
|
97
|
-
</li><li>
|
|
98
|
-
<code class="literal">!..braceleft..!</code> instead of <code class="literal">{</code>
|
|
99
|
-
</li><li>
|
|
100
|
-
<code class="literal">!..braceright..!</code> instead of <code class="literal">}</code>
|
|
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>
|
|
102
|
-
Sometimes LaTeX backend handles things differently from the default backends
|
|
103
|
-
</li><li>
|
|
104
|
-
A lot of little bugs
|
|
105
|
-
</li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_todo_list"></a>9. Todo List</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li>
|
|
106
|
-
Remove bugs
|
|
107
|
-
</li><li>
|
|
108
|
-
Support for <span class="emphasis"><em>grid</em></span> attribute in tables
|
|
109
|
-
</li><li>
|
|
110
|
-
Better looking tables
|
|
111
|
-
</li><li>
|
|
112
|
-
Option for squeezing output (smaller lists)
|
|
113
|
-
</li><li>
|
|
114
|
-
Support for different languages (That would be a nice feature for Asciidoc in general)
|
|
115
|
-
</li><li>
|
|
116
|
-
Option for switching titlepage on and off
|
|
117
|
-
</li></ul></div></div></div></body></html>
|
|
@@ -1,566 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
|
2
|
-
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
4
|
-
<head>
|
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
-
<meta name="generator" content="AsciiDoc 8.3.1" />
|
|
7
|
-
<title>Music Filter</title>
|
|
8
|
-
<style type="text/css">
|
|
9
|
-
/* Debug borders */
|
|
10
|
-
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
|
|
11
|
-
/*
|
|
12
|
-
border: 1px solid red;
|
|
13
|
-
*/
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
body {
|
|
17
|
-
margin: 1em 5% 1em 5%;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
a {
|
|
21
|
-
color: blue;
|
|
22
|
-
text-decoration: underline;
|
|
23
|
-
}
|
|
24
|
-
a:visited {
|
|
25
|
-
color: fuchsia;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
em {
|
|
29
|
-
font-style: italic;
|
|
30
|
-
color: navy;
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
strong {
|
|
34
|
-
font-weight: bold;
|
|
35
|
-
color: #083194;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
tt {
|
|
39
|
-
color: navy;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
h1, h2, h3, h4, h5, h6 {
|
|
43
|
-
color: #527bbd;
|
|
44
|
-
font-family: sans-serif;
|
|
45
|
-
margin-top: 1.2em;
|
|
46
|
-
margin-bottom: 0.5em;
|
|
47
|
-
line-height: 1.3;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
h1, h2, h3 {
|
|
51
|
-
border-bottom: 2px solid silver;
|
|
52
|
-
}
|
|
53
|
-
h2 {
|
|
54
|
-
padding-top: 0.5em;
|
|
55
|
-
}
|
|
56
|
-
h3 {
|
|
57
|
-
float: left;
|
|
58
|
-
}
|
|
59
|
-
h3 + * {
|
|
60
|
-
clear: left;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
div.sectionbody {
|
|
64
|
-
font-family: serif;
|
|
65
|
-
margin-left: 0;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
hr {
|
|
69
|
-
border: 1px solid silver;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
p {
|
|
73
|
-
margin-top: 0.5em;
|
|
74
|
-
margin-bottom: 0.5em;
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
ul, ol, li > p {
|
|
78
|
-
margin-top: 0;
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
pre {
|
|
82
|
-
padding: 0;
|
|
83
|
-
margin: 0;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
span#author {
|
|
87
|
-
color: #527bbd;
|
|
88
|
-
font-family: sans-serif;
|
|
89
|
-
font-weight: bold;
|
|
90
|
-
font-size: 1.1em;
|
|
91
|
-
}
|
|
92
|
-
span#email {
|
|
93
|
-
}
|
|
94
|
-
span#revision {
|
|
95
|
-
font-family: sans-serif;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
div#footer {
|
|
99
|
-
font-family: sans-serif;
|
|
100
|
-
font-size: small;
|
|
101
|
-
border-top: 2px solid silver;
|
|
102
|
-
padding-top: 0.5em;
|
|
103
|
-
margin-top: 4.0em;
|
|
104
|
-
}
|
|
105
|
-
div#footer-text {
|
|
106
|
-
float: left;
|
|
107
|
-
padding-bottom: 0.5em;
|
|
108
|
-
}
|
|
109
|
-
div#footer-badges {
|
|
110
|
-
float: right;
|
|
111
|
-
padding-bottom: 0.5em;
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
div#preamble,
|
|
115
|
-
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
|
|
116
|
-
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
|
117
|
-
div.admonitionblock {
|
|
118
|
-
margin-right: 10%;
|
|
119
|
-
margin-top: 1.5em;
|
|
120
|
-
margin-bottom: 1.5em;
|
|
121
|
-
}
|
|
122
|
-
div.admonitionblock {
|
|
123
|
-
margin-top: 2.5em;
|
|
124
|
-
margin-bottom: 2.5em;
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
div.content { /* Block element content. */
|
|
128
|
-
padding: 0;
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
/* Block element titles. */
|
|
132
|
-
div.title, caption.title {
|
|
133
|
-
color: #527bbd;
|
|
134
|
-
font-family: sans-serif;
|
|
135
|
-
font-weight: bold;
|
|
136
|
-
text-align: left;
|
|
137
|
-
margin-top: 1.0em;
|
|
138
|
-
margin-bottom: 0.5em;
|
|
139
|
-
}
|
|
140
|
-
div.title + * {
|
|
141
|
-
margin-top: 0;
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
td div.title:first-child {
|
|
145
|
-
margin-top: 0.0em;
|
|
146
|
-
}
|
|
147
|
-
div.content div.title:first-child {
|
|
148
|
-
margin-top: 0.0em;
|
|
149
|
-
}
|
|
150
|
-
div.content + div.title {
|
|
151
|
-
margin-top: 0.0em;
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
div.sidebarblock > div.content {
|
|
155
|
-
background: #ffffee;
|
|
156
|
-
border: 1px solid silver;
|
|
157
|
-
padding: 0.5em;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
div.listingblock {
|
|
161
|
-
margin-right: 0%;
|
|
162
|
-
}
|
|
163
|
-
div.listingblock > div.content {
|
|
164
|
-
border: 1px solid silver;
|
|
165
|
-
background: #f4f4f4;
|
|
166
|
-
padding: 0.5em;
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
div.quoteblock {
|
|
170
|
-
padding-left: 2.0em;
|
|
171
|
-
}
|
|
172
|
-
div.quoteblock > div.attribution {
|
|
173
|
-
padding-top: 0.5em;
|
|
174
|
-
text-align: right;
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
div.verseblock {
|
|
178
|
-
padding-left: 2.0em;
|
|
179
|
-
}
|
|
180
|
-
div.verseblock > div.content {
|
|
181
|
-
white-space: pre;
|
|
182
|
-
}
|
|
183
|
-
div.verseblock > div.attribution {
|
|
184
|
-
padding-top: 0.75em;
|
|
185
|
-
text-align: left;
|
|
186
|
-
}
|
|
187
|
-
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
|
188
|
-
div.verseblock + div.attribution {
|
|
189
|
-
text-align: left;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
div.admonitionblock .icon {
|
|
193
|
-
vertical-align: top;
|
|
194
|
-
font-size: 1.1em;
|
|
195
|
-
font-weight: bold;
|
|
196
|
-
text-decoration: underline;
|
|
197
|
-
color: #527bbd;
|
|
198
|
-
padding-right: 0.5em;
|
|
199
|
-
}
|
|
200
|
-
div.admonitionblock td.content {
|
|
201
|
-
padding-left: 0.5em;
|
|
202
|
-
border-left: 2px solid silver;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
div.exampleblock > div.content {
|
|
206
|
-
border-left: 2px solid silver;
|
|
207
|
-
padding: 0.5em;
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
div.imageblock div.content { padding-left: 0; }
|
|
211
|
-
div.imageblock img { border: 1px solid silver; }
|
|
212
|
-
span.image img { border-style: none; }
|
|
213
|
-
|
|
214
|
-
dl {
|
|
215
|
-
margin-top: 0.8em;
|
|
216
|
-
margin-bottom: 0.8em;
|
|
217
|
-
}
|
|
218
|
-
dt {
|
|
219
|
-
margin-top: 0.5em;
|
|
220
|
-
margin-bottom: 0;
|
|
221
|
-
font-style: normal;
|
|
222
|
-
color: navy;
|
|
223
|
-
}
|
|
224
|
-
dd > *:first-child {
|
|
225
|
-
margin-top: 0.1em;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
ul, ol {
|
|
229
|
-
list-style-position: outside;
|
|
230
|
-
}
|
|
231
|
-
ol.arabic {
|
|
232
|
-
list-style-type: decimal;
|
|
233
|
-
}
|
|
234
|
-
ol.loweralpha {
|
|
235
|
-
list-style-type: lower-alpha;
|
|
236
|
-
}
|
|
237
|
-
ol.upperalpha {
|
|
238
|
-
list-style-type: upper-alpha;
|
|
239
|
-
}
|
|
240
|
-
ol.lowerroman {
|
|
241
|
-
list-style-type: lower-roman;
|
|
242
|
-
}
|
|
243
|
-
ol.upperroman {
|
|
244
|
-
list-style-type: upper-roman;
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
div.compact ul, div.compact ol,
|
|
248
|
-
div.compact p, div.compact p,
|
|
249
|
-
div.compact div, div.compact div {
|
|
250
|
-
margin-top: 0.1em;
|
|
251
|
-
margin-bottom: 0.1em;
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
div.tableblock > table {
|
|
255
|
-
border: 3px solid #527bbd;
|
|
256
|
-
}
|
|
257
|
-
thead {
|
|
258
|
-
font-family: sans-serif;
|
|
259
|
-
font-weight: bold;
|
|
260
|
-
}
|
|
261
|
-
tfoot {
|
|
262
|
-
font-weight: bold;
|
|
263
|
-
}
|
|
264
|
-
td > div.verse {
|
|
265
|
-
white-space: pre;
|
|
266
|
-
}
|
|
267
|
-
p.table {
|
|
268
|
-
margin-top: 0;
|
|
269
|
-
}
|
|
270
|
-
/* Because the table frame attribute is overriden by CSS in most browsers. */
|
|
271
|
-
div.tableblock > table[frame="void"] {
|
|
272
|
-
border-style: none;
|
|
273
|
-
}
|
|
274
|
-
div.tableblock > table[frame="hsides"] {
|
|
275
|
-
border-left-style: none;
|
|
276
|
-
border-right-style: none;
|
|
277
|
-
}
|
|
278
|
-
div.tableblock > table[frame="vsides"] {
|
|
279
|
-
border-top-style: none;
|
|
280
|
-
border-bottom-style: none;
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
div.hdlist {
|
|
285
|
-
margin-top: 0.8em;
|
|
286
|
-
margin-bottom: 0.8em;
|
|
287
|
-
}
|
|
288
|
-
div.hdlist tr {
|
|
289
|
-
padding-bottom: 15px;
|
|
290
|
-
}
|
|
291
|
-
dt.hdlist1.strong, td.hdlist1.strong {
|
|
292
|
-
font-weight: bold;
|
|
293
|
-
}
|
|
294
|
-
td.hdlist1 {
|
|
295
|
-
vertical-align: top;
|
|
296
|
-
font-style: normal;
|
|
297
|
-
padding-right: 0.8em;
|
|
298
|
-
color: navy;
|
|
299
|
-
}
|
|
300
|
-
td.hdlist2 {
|
|
301
|
-
vertical-align: top;
|
|
302
|
-
}
|
|
303
|
-
div.hdlist.compact tr {
|
|
304
|
-
margin: 0;
|
|
305
|
-
padding-bottom: 0;
|
|
306
|
-
}
|
|
307
|
-
|
|
308
|
-
@media print {
|
|
309
|
-
div#footer-badges { display: none; }
|
|
310
|
-
}
|
|
311
|
-
|
|
312
|
-
div#toctitle {
|
|
313
|
-
color: #527bbd;
|
|
314
|
-
font-family: sans-serif;
|
|
315
|
-
font-size: 1.1em;
|
|
316
|
-
font-weight: bold;
|
|
317
|
-
margin-top: 1.0em;
|
|
318
|
-
margin-bottom: 0.1em;
|
|
319
|
-
}
|
|
320
|
-
|
|
321
|
-
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
|
322
|
-
margin-top: 0;
|
|
323
|
-
margin-bottom: 0;
|
|
324
|
-
}
|
|
325
|
-
div.toclevel2 {
|
|
326
|
-
margin-left: 2em;
|
|
327
|
-
font-size: 0.9em;
|
|
328
|
-
}
|
|
329
|
-
div.toclevel3 {
|
|
330
|
-
margin-left: 4em;
|
|
331
|
-
font-size: 0.9em;
|
|
332
|
-
}
|
|
333
|
-
div.toclevel4 {
|
|
334
|
-
margin-left: 6em;
|
|
335
|
-
font-size: 0.9em;
|
|
336
|
-
}
|
|
337
|
-
/* Workarounds for IE6's broken and incomplete CSS2. */
|
|
338
|
-
|
|
339
|
-
div.sidebar-content {
|
|
340
|
-
background: #ffffee;
|
|
341
|
-
border: 1px solid silver;
|
|
342
|
-
padding: 0.5em;
|
|
343
|
-
}
|
|
344
|
-
div.sidebar-title, div.image-title {
|
|
345
|
-
color: #527bbd;
|
|
346
|
-
font-family: sans-serif;
|
|
347
|
-
font-weight: bold;
|
|
348
|
-
margin-top: 0.0em;
|
|
349
|
-
margin-bottom: 0.5em;
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
div.listingblock div.content {
|
|
353
|
-
border: 1px solid silver;
|
|
354
|
-
background: #f4f4f4;
|
|
355
|
-
padding: 0.5em;
|
|
356
|
-
}
|
|
357
|
-
|
|
358
|
-
div.quoteblock-attribution {
|
|
359
|
-
padding-top: 0.5em;
|
|
360
|
-
text-align: right;
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
div.verseblock-content {
|
|
364
|
-
white-space: pre;
|
|
365
|
-
}
|
|
366
|
-
div.verseblock-attribution {
|
|
367
|
-
padding-top: 0.75em;
|
|
368
|
-
text-align: left;
|
|
369
|
-
}
|
|
370
|
-
|
|
371
|
-
div.exampleblock-content {
|
|
372
|
-
border-left: 2px solid silver;
|
|
373
|
-
padding-left: 0.5em;
|
|
374
|
-
}
|
|
375
|
-
|
|
376
|
-
/* IE6 sets dynamically generated links as visited. */
|
|
377
|
-
div#toc a:visited { color: blue; }
|
|
378
|
-
</style>
|
|
379
|
-
</head>
|
|
380
|
-
<body>
|
|
381
|
-
<div id="header">
|
|
382
|
-
<h1>Music Filter</h1>
|
|
383
|
-
</div>
|
|
384
|
-
<div id="preamble">
|
|
385
|
-
<div class="sectionbody">
|
|
386
|
-
<div class="paragraph"><p>The <em>AsciiDoc</em> distribution includes a Music Block filter that
|
|
387
|
-
translates music in <a href="http://lilypond.org/">LilyPond</a> or
|
|
388
|
-
<a href="http://abcnotation.org.uk/">ABC</a> notation to standard classical
|
|
389
|
-
notation in the form of a trimmed PNG image which is automatically
|
|
390
|
-
inserted into the <em>AsciiDoc</em> output document (see the <a href="#X1">examples below</a>).</p></div>
|
|
391
|
-
<div class="paragraph"><p>Actually the filter (<tt>./filters/music2png.py</tt>) can be used outside
|
|
392
|
-
<em>AsciiDoc</em> to convert LilyPond or ABC music files to PNG images.
|
|
393
|
-
Execute the following command to see how to use it:</p></div>
|
|
394
|
-
<div class="literalblock">
|
|
395
|
-
<div class="content">
|
|
396
|
-
<pre><tt>$ ./filters/music2png.py --help</tt></pre>
|
|
397
|
-
</div></div>
|
|
398
|
-
<div class="paragraph"><p>The Music Filter can be used as a model for filters that convert a
|
|
399
|
-
block of text into a file that is linked or embedded into the <em>AsciiDoc</em>
|
|
400
|
-
output document.</p></div>
|
|
401
|
-
<div class="exampleblock" id="X1">
|
|
402
|
-
<div class="title">Example 1: Music Block containing ABC notation</div>
|
|
403
|
-
<div class="exampleblock-content">
|
|
404
|
-
<div class="paragraph"><p>This Music Block:</p></div>
|
|
405
|
-
<div class="listingblock">
|
|
406
|
-
<div class="content">
|
|
407
|
-
<pre><tt> ["music","music1.png",scaledwidth="100%"]
|
|
408
|
-
---------------------------------------------------------------------
|
|
409
|
-
T:The Butterfly
|
|
410
|
-
R:slip jig
|
|
411
|
-
C:Tommy Potts
|
|
412
|
-
H:Fiddle player Tommy Potts made this tune from two older slip jigs,
|
|
413
|
-
H:one of which is called "Skin the Peelers" in Roche's collection.
|
|
414
|
-
H:This version by Peter Cooper.
|
|
415
|
-
D:Bothy Band: 1975.
|
|
416
|
-
M:9/8
|
|
417
|
-
K:Em
|
|
418
|
-
vB2(E G2)(E F3)|B2(E G2)(E F)ED|vB2(E G2)(E F3)|(B2d) d2(uB A)FD:|
|
|
419
|
-
|:(vB2c) (e2f) g3|(uB2d) (g2e) (dBA)|(B2c) (e2f) g2(ua|b2a) (g2e) (dBA):|
|
|
420
|
-
|:~B3 (B2A) G2A|~B3 BA(uB d)BA|~B3 (B2A) G2(A|B2d) (g2e) (dBA):|
|
|
421
|
-
---------------------------------------------------------------------</tt></pre>
|
|
422
|
-
</div></div>
|
|
423
|
-
<div class="paragraph"><p>Renders:</p></div>
|
|
424
|
-
<div class="musicblock">
|
|
425
|
-
<div class="content">
|
|
426
|
-
<img style="border-width: 0;" src="music1.png" alt="music1.png" />
|
|
427
|
-
</div></div>
|
|
428
|
-
</div></div>
|
|
429
|
-
<div class="exampleblock" id="X2">
|
|
430
|
-
<div class="title">Example 2: Music Block containing LilyPond notation</div>
|
|
431
|
-
<div class="exampleblock-content">
|
|
432
|
-
<div class="paragraph"><p>This example contains LilyPond musical markup, it uses the <em>link</em>
|
|
433
|
-
attribute so you can click on the music image to display the source
|
|
434
|
-
notation. The <tt>music2.ly</tt> source file is automatically created and
|
|
435
|
-
retained by the <tt>music2png.py</tt> filter when the <tt>-m</tt> option is used.</p></div>
|
|
436
|
-
<div class="listingblock">
|
|
437
|
-
<div class="content">
|
|
438
|
-
<pre><tt> ["music", "music2.png", "ly", link="music2.ly"]
|
|
439
|
-
---------------------------------------------------------------------
|
|
440
|
-
\version "2.10.0"
|
|
441
|
-
\paper {
|
|
442
|
-
ragged-right = ##t
|
|
443
|
-
}
|
|
444
|
-
{
|
|
445
|
-
\time 3/4
|
|
446
|
-
\clef bass
|
|
447
|
-
c2 e4 g2. f4 e d c2 r4
|
|
448
|
-
}
|
|
449
|
-
---------------------------------------------------------------------</tt></pre>
|
|
450
|
-
</div></div>
|
|
451
|
-
<div class="paragraph"><p>Renders:</p></div>
|
|
452
|
-
<div class="musicblock">
|
|
453
|
-
<div class="content">
|
|
454
|
-
<a href="music2.ly">
|
|
455
|
-
<img style="border-width: 0;" src="music2.png" alt="music2.png" />
|
|
456
|
-
</a>
|
|
457
|
-
</div></div>
|
|
458
|
-
</div></div>
|
|
459
|
-
<div class="admonitionblock">
|
|
460
|
-
<table><tr>
|
|
461
|
-
<td class="icon">
|
|
462
|
-
<div class="title">Note</div>
|
|
463
|
-
</td>
|
|
464
|
-
<td class="content">If you get an error processing the above example it may be that
|
|
465
|
-
it is not compatible with your version of LilyPond. Use the LilyPond
|
|
466
|
-
<tt>convert-ly(1)</tt> utility to update the source to the version that you
|
|
467
|
-
are using.</td>
|
|
468
|
-
</tr></table>
|
|
469
|
-
</div>
|
|
470
|
-
</div>
|
|
471
|
-
</div>
|
|
472
|
-
<h2 id="_using_the_filter">Using the Filter</h2>
|
|
473
|
-
<div class="sectionbody">
|
|
474
|
-
<div class="paragraph"><p>Insert a delimited Music Block containing valid ABC notation into your
|
|
475
|
-
<em>AsciiDoc</em> document:</p></div>
|
|
476
|
-
<div class="ulist"><ul>
|
|
477
|
-
<li>
|
|
478
|
-
<p>
|
|
479
|
-
The Music Block delimiter is the word <tt>music</tt> followed by four or
|
|
480
|
-
more tilde characters.
|
|
481
|
-
</p>
|
|
482
|
-
</li>
|
|
483
|
-
<li>
|
|
484
|
-
<p>
|
|
485
|
-
The Music Block attribute list must contain a file name for the PNG
|
|
486
|
-
output image file followed by the input format (either <em>abc</em> for ABC
|
|
487
|
-
or <em>ly</em> for LilyPond). If the format is omitted ABC notation is
|
|
488
|
-
assumed.
|
|
489
|
-
</p>
|
|
490
|
-
</li>
|
|
491
|
-
<li>
|
|
492
|
-
<p>
|
|
493
|
-
The filter invokes <tt>music2png</tt> with the <tt>-m</tt> option so that music
|
|
494
|
-
images will only be regenerated if the block content has changed.
|
|
495
|
-
</p>
|
|
496
|
-
</li>
|
|
497
|
-
<li>
|
|
498
|
-
<p>
|
|
499
|
-
The optional named block attributes <em>link</em>, <em>width</em> and <em>height</em> are
|
|
500
|
-
also available (see <a href="userguide.html#X55">Image macro attributes</a>
|
|
501
|
-
in the <em>AsciiDoc</em> User Guide).
|
|
502
|
-
</p>
|
|
503
|
-
</li>
|
|
504
|
-
</ul></div>
|
|
505
|
-
</div>
|
|
506
|
-
<h2 id="_limitations">Limitations</h2>
|
|
507
|
-
<div class="sectionbody">
|
|
508
|
-
<div class="ulist"><ul>
|
|
509
|
-
<li>
|
|
510
|
-
<p>
|
|
511
|
-
The <tt><tt>asciidoc(1)</tt></tt> output file cannot be <tt>-</tt> (stdout), you must
|
|
512
|
-
output to a named file.
|
|
513
|
-
</p>
|
|
514
|
-
</li>
|
|
515
|
-
<li>
|
|
516
|
-
<p>
|
|
517
|
-
If the music image file is linked to the output document then the
|
|
518
|
-
image file name in the Music Block attribute list should be a
|
|
519
|
-
relative path name relative to the <em>AsciiDoc</em> output file.
|
|
520
|
-
</p>
|
|
521
|
-
</li>
|
|
522
|
-
</ul></div>
|
|
523
|
-
</div>
|
|
524
|
-
<h2 id="_installation">Installation</h2>
|
|
525
|
-
<div class="sectionbody">
|
|
526
|
-
<div class="paragraph"><p>In addition to <em>AsciiDoc</em> you will need to have installed:</p></div>
|
|
527
|
-
<div class="ulist"><ul>
|
|
528
|
-
<li>
|
|
529
|
-
<p>
|
|
530
|
-
<a href="http://lilypond.org/web/">LilyPond</a> (most Linux distributions include
|
|
531
|
-
this package).
|
|
532
|
-
</p>
|
|
533
|
-
</li>
|
|
534
|
-
<li>
|
|
535
|
-
<p>
|
|
536
|
-
<a href="http://www.imagemagick.org">ImageMagick</a> (most Linux distributions
|
|
537
|
-
include this package).
|
|
538
|
-
</p>
|
|
539
|
-
</li>
|
|
540
|
-
</ul></div>
|
|
541
|
-
<div class="paragraph"><p>Test the music filter it by converting the test file to HTML with <em>AsciiDoc</em>:</p></div>
|
|
542
|
-
<div class="literalblock">
|
|
543
|
-
<div class="content">
|
|
544
|
-
<pre><tt>$ asciidoc -v ./filters/music-filter-test.txt
|
|
545
|
-
$ firefox ./filters/music-filter-test.html &</tt></pre>
|
|
546
|
-
</div></div>
|
|
547
|
-
<div class="paragraph"><p>The filter was developed and tested on Xubuntu Linux using LilyPond
|
|
548
|
-
2.10.5 and ImageMagick 6.2.4.</p></div>
|
|
549
|
-
<div class="admonitionblock">
|
|
550
|
-
<table><tr>
|
|
551
|
-
<td class="icon">
|
|
552
|
-
<div class="title">Note</div>
|
|
553
|
-
</td>
|
|
554
|
-
<td class="content">The filter does not work with LilyPond 2.2.6 because it did not
|
|
555
|
-
generate the requested output file name correctly (2.6.3 does not have
|
|
556
|
-
a problem).</td>
|
|
557
|
-
</tr></table>
|
|
558
|
-
</div>
|
|
559
|
-
</div>
|
|
560
|
-
<div id="footer">
|
|
561
|
-
<div id="footer-text">
|
|
562
|
-
Last updated 2008-12-31 14:47:04 NZDT
|
|
563
|
-
</div>
|
|
564
|
-
</div>
|
|
565
|
-
</body>
|
|
566
|
-
</html>
|