FooBarWidget-mizuho 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE.txt +20 -0
- data/README.markdown +68 -0
- data/Rakefile +9 -0
- data/asciidoc/BUGS +34 -0
- data/asciidoc/BUGS.txt +28 -0
- data/asciidoc/CHANGELOG +1585 -0
- data/asciidoc/CHANGELOG.txt +1595 -0
- data/asciidoc/COPYING +339 -0
- data/asciidoc/COPYRIGHT +18 -0
- data/asciidoc/INSTALL +82 -0
- data/asciidoc/INSTALL.txt +71 -0
- data/asciidoc/README +46 -0
- data/asciidoc/README.txt +36 -0
- data/asciidoc/a2x +641 -0
- data/asciidoc/asciidoc.conf +404 -0
- data/asciidoc/asciidoc.py +4255 -0
- data/asciidoc/common.aap +9 -0
- data/asciidoc/dblatex/asciidoc-dblatex.sty +18 -0
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +17 -0
- data/asciidoc/dblatex/dblatex-readme.txt +22 -0
- data/asciidoc/doc/a2x.1 +246 -0
- data/asciidoc/doc/a2x.1.txt +195 -0
- data/asciidoc/doc/article.css-embedded.html +579 -0
- data/asciidoc/doc/article.html +62 -0
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +124 -0
- data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
- data/asciidoc/doc/asciidoc.1 +161 -0
- data/asciidoc/doc/asciidoc.1.css-embedded.html +562 -0
- data/asciidoc/doc/asciidoc.1.css.html +212 -0
- data/asciidoc/doc/asciidoc.1.html +190 -0
- data/asciidoc/doc/asciidoc.1.txt +118 -0
- data/asciidoc/doc/asciidoc.conf +8 -0
- data/asciidoc/doc/asciidoc.css-embedded.html +7954 -0
- data/asciidoc/doc/asciidoc.css.html +7553 -0
- data/asciidoc/doc/asciidoc.dict +673 -0
- data/asciidoc/doc/asciidoc.html +3502 -0
- data/asciidoc/doc/asciidoc.txt +4757 -0
- data/asciidoc/doc/asciimath.txt +47 -0
- data/asciidoc/doc/book-multi.css-embedded.html +575 -0
- data/asciidoc/doc/book-multi.html +72 -0
- data/asciidoc/doc/book-multi.txt +159 -0
- data/asciidoc/doc/book.css-embedded.html +585 -0
- data/asciidoc/doc/book.html +60 -0
- data/asciidoc/doc/book.txt +133 -0
- data/asciidoc/doc/customers.csv +18 -0
- data/asciidoc/doc/faq.txt +262 -0
- data/asciidoc/doc/latex-backend.html +224 -0
- data/asciidoc/doc/latex-backend.txt +193 -0
- data/asciidoc/doc/latexmath.txt +35 -0
- data/asciidoc/doc/main.aap +293 -0
- data/asciidoc/doc/music-filter.html +513 -0
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +158 -0
- data/asciidoc/doc/source-highlight-filter.html +183 -0
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +174 -0
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +71 -0
- data/asciidoc/docbook-xsl/chunked.xsl +19 -0
- data/asciidoc/docbook-xsl/common.xsl +67 -0
- data/asciidoc/docbook-xsl/fo.xsl +117 -0
- data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
- data/asciidoc/docbook-xsl/manpage.xsl +28 -0
- data/asciidoc/docbook-xsl/shaded-literallayout.patch +32 -0
- data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
- data/asciidoc/docbook.conf +606 -0
- data/asciidoc/examples/website/CHANGELOG.html +3828 -0
- data/asciidoc/examples/website/INSTALL.html +163 -0
- data/asciidoc/examples/website/README-website.html +129 -0
- data/asciidoc/examples/website/README-website.txt +29 -0
- data/asciidoc/examples/website/README.html +125 -0
- data/asciidoc/examples/website/a2x.1.html +395 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +165 -0
- data/asciidoc/examples/website/asciimath.html +157 -0
- data/asciidoc/examples/website/build-website.sh +25 -0
- data/asciidoc/examples/website/downloads.html +219 -0
- data/asciidoc/examples/website/downloads.txt +98 -0
- data/asciidoc/examples/website/faq.html +372 -0
- data/asciidoc/examples/website/index.html +398 -0
- data/asciidoc/examples/website/index.txt +222 -0
- data/asciidoc/examples/website/latex-backend.html +640 -0
- data/asciidoc/examples/website/latexmath.html +119 -0
- data/asciidoc/examples/website/layout1.conf +161 -0
- data/asciidoc/examples/website/layout1.css +65 -0
- data/asciidoc/examples/website/layout2.conf +158 -0
- data/asciidoc/examples/website/layout2.css +93 -0
- data/asciidoc/examples/website/manpage.html +266 -0
- data/asciidoc/examples/website/music-filter.html +242 -0
- data/asciidoc/examples/website/music1.abc +12 -0
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +9 -0
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +251 -0
- data/asciidoc/examples/website/support.html +78 -0
- data/asciidoc/examples/website/support.txt +5 -0
- data/asciidoc/examples/website/userguide.html +7597 -0
- data/asciidoc/examples/website/version9.html +143 -0
- data/asciidoc/examples/website/version9.txt +48 -0
- data/asciidoc/filters/code-filter-readme.txt +37 -0
- data/asciidoc/filters/code-filter-test-c++.txt +7 -0
- data/asciidoc/filters/code-filter-test.txt +15 -0
- data/asciidoc/filters/code-filter.conf +8 -0
- data/asciidoc/filters/code-filter.py +239 -0
- data/asciidoc/filters/music-filter-test.txt +40 -0
- data/asciidoc/filters/music-filter.conf +40 -0
- data/asciidoc/filters/music2png.py +189 -0
- data/asciidoc/filters/source-highlight-filter-test.txt +19 -0
- data/asciidoc/filters/source-highlight-filter.conf +100 -0
- data/asciidoc/help.conf +213 -0
- data/asciidoc/html4.conf +363 -0
- data/asciidoc/images/highlighter.png +0 -0
- data/asciidoc/images/icons/README +5 -0
- data/asciidoc/images/icons/callouts/1.png +0 -0
- data/asciidoc/images/icons/callouts/10.png +0 -0
- data/asciidoc/images/icons/callouts/11.png +0 -0
- data/asciidoc/images/icons/callouts/12.png +0 -0
- data/asciidoc/images/icons/callouts/13.png +0 -0
- data/asciidoc/images/icons/callouts/14.png +0 -0
- data/asciidoc/images/icons/callouts/15.png +0 -0
- data/asciidoc/images/icons/callouts/2.png +0 -0
- data/asciidoc/images/icons/callouts/3.png +0 -0
- data/asciidoc/images/icons/callouts/4.png +0 -0
- data/asciidoc/images/icons/callouts/5.png +0 -0
- data/asciidoc/images/icons/callouts/6.png +0 -0
- data/asciidoc/images/icons/callouts/7.png +0 -0
- data/asciidoc/images/icons/callouts/8.png +0 -0
- data/asciidoc/images/icons/callouts/9.png +0 -0
- data/asciidoc/images/icons/caution.png +0 -0
- data/asciidoc/images/icons/example.png +0 -0
- data/asciidoc/images/icons/home.png +0 -0
- data/asciidoc/images/icons/important.png +0 -0
- data/asciidoc/images/icons/next.png +0 -0
- data/asciidoc/images/icons/note.png +0 -0
- data/asciidoc/images/icons/prev.png +0 -0
- data/asciidoc/images/icons/tip.png +0 -0
- data/asciidoc/images/icons/up.png +0 -0
- data/asciidoc/images/icons/warning.png +0 -0
- data/asciidoc/images/smallnew.png +0 -0
- data/asciidoc/images/tiger.png +0 -0
- data/asciidoc/install.sh +55 -0
- data/asciidoc/javascripts/ASCIIMathML.js +938 -0
- data/asciidoc/javascripts/LaTeXMathML.js +1223 -0
- data/asciidoc/javascripts/toc.js +69 -0
- data/asciidoc/lang-es.conf +15 -0
- data/asciidoc/latex.conf +663 -0
- data/asciidoc/linuxdoc.conf +285 -0
- data/asciidoc/math.conf +50 -0
- data/asciidoc/stylesheets/docbook-xsl.css +271 -0
- data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +21 -0
- data/asciidoc/stylesheets/xhtml-deprecated.css +247 -0
- data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
- data/asciidoc/stylesheets/xhtml11-quirks.css +49 -0
- data/asciidoc/stylesheets/xhtml11.css +284 -0
- data/asciidoc/t.conf +20 -0
- data/asciidoc/text.conf +16 -0
- data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
- data/asciidoc/vim/syntax/asciidoc.vim +139 -0
- data/asciidoc/xhtml-deprecated-css.conf +235 -0
- data/asciidoc/xhtml-deprecated.conf +351 -0
- data/asciidoc/xhtml11-quirks.conf +57 -0
- data/asciidoc/xhtml11.conf +514 -0
- data/bin/mizuho +40 -0
- data/lib/mizuho/chapter.rb +54 -0
- data/lib/mizuho/generator.rb +106 -0
- data/lib/mizuho/heading.rb +46 -0
- data/lib/mizuho/parser.rb +99 -0
- data/lib/mizuho/template.rb +50 -0
- data/mizuho.gemspec +34 -0
- data/templates/asciidoc.css +358 -0
- data/templates/asciidoc.html.erb +86 -0
- data/templates/manualsonrails.css +165 -0
- data/templates/manualsonrails.html.erb +97 -0
- data/test/parser_spec.rb +190 -0
- data/test/spec_helper.rb +43 -0
- metadata +234 -0
@@ -0,0 +1,93 @@
|
|
1
|
+
body {
|
2
|
+
margin: 0;
|
3
|
+
}
|
4
|
+
|
5
|
+
#layout-banner-box {
|
6
|
+
position: fixed;
|
7
|
+
top: 0px;
|
8
|
+
left: 0px;
|
9
|
+
width: 100%;
|
10
|
+
height: 110px;
|
11
|
+
z-index: 2;
|
12
|
+
background-color: #73a0c5;
|
13
|
+
}
|
14
|
+
|
15
|
+
#layout-menu-box {
|
16
|
+
position: fixed;
|
17
|
+
left: 0px;
|
18
|
+
top: 110px;
|
19
|
+
width: 175px;
|
20
|
+
height: 100%;
|
21
|
+
z-index: 1;
|
22
|
+
background-color: #f4f4f4;
|
23
|
+
}
|
24
|
+
|
25
|
+
#layout-content-box {
|
26
|
+
position: relative;
|
27
|
+
margin-top: 110px;
|
28
|
+
margin-left: 175px;
|
29
|
+
background-color: white;
|
30
|
+
}
|
31
|
+
|
32
|
+
h1 {
|
33
|
+
margin-top: 0.5em;
|
34
|
+
}
|
35
|
+
|
36
|
+
#layout-banner {
|
37
|
+
color: white;
|
38
|
+
font-family: sans-serif;
|
39
|
+
text-align: left;
|
40
|
+
padding: 0.8em 20px;
|
41
|
+
}
|
42
|
+
|
43
|
+
#layout-title {
|
44
|
+
font-family: monospace;
|
45
|
+
font-size: 3.5em;
|
46
|
+
font-weight: bold;
|
47
|
+
letter-spacing: 0.2em;
|
48
|
+
margin: 0;
|
49
|
+
}
|
50
|
+
|
51
|
+
#layout-description {
|
52
|
+
font-size: 1.2em;
|
53
|
+
letter-spacing: 0.1em;
|
54
|
+
}
|
55
|
+
|
56
|
+
#layout-menu {
|
57
|
+
height: 100%;
|
58
|
+
border-right: 3px solid #eeeeee;
|
59
|
+
padding-top: 0.8em;
|
60
|
+
padding-left: 20px;
|
61
|
+
padding-right: 0.8em;
|
62
|
+
font-size: 1.0em;
|
63
|
+
font-family: sans-serif;
|
64
|
+
font-weight: bold;
|
65
|
+
}
|
66
|
+
#layout-menu a {
|
67
|
+
line-height: 2em;
|
68
|
+
margin-left: 0.5em;
|
69
|
+
}
|
70
|
+
#layout-menu a:link, #layout-menu a:visited, #layout-menu a:hover {
|
71
|
+
color: #527bbd;
|
72
|
+
text-decoration: none;
|
73
|
+
}
|
74
|
+
#layout-menu a:hover {
|
75
|
+
color: navy;
|
76
|
+
text-decoration: none;
|
77
|
+
}
|
78
|
+
#layout-menu #page-source {
|
79
|
+
border-top: 2px solid silver;
|
80
|
+
margin-top: 0.2em;
|
81
|
+
}
|
82
|
+
|
83
|
+
#layout-content {
|
84
|
+
padding-top: 0.2em;
|
85
|
+
padding-left: 1.0em;
|
86
|
+
padding-right: 0.4em;
|
87
|
+
}
|
88
|
+
|
89
|
+
@media print {
|
90
|
+
#layout-banner-box { display: none; }
|
91
|
+
#layout-menu-box { display: none; }
|
92
|
+
#layout-content-box { margin-top: 0; margin-left: 0; }
|
93
|
+
}
|
@@ -0,0 +1,266 @@
|
|
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.2.7" />
|
7
|
+
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
8
|
+
<link rel="stylesheet" href="./xhtml11-manpage.css" type="text/css" />
|
9
|
+
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
10
|
+
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
11
|
+
<script type="text/javascript">
|
12
|
+
/*<![CDATA[*/
|
13
|
+
window.onload = function(){generateToc(1)}
|
14
|
+
/*]]>*/
|
15
|
+
</script>
|
16
|
+
<script type="text/javascript" src="./toc.js"></script>
|
17
|
+
<title>ASCIIDOC(1)</title>
|
18
|
+
</head>
|
19
|
+
<body>
|
20
|
+
<div id="layout-banner">
|
21
|
+
<div id="layout-title">AsciiDoc</div>
|
22
|
+
<div id="layout-description">Text based document generation</div>
|
23
|
+
</div>
|
24
|
+
<table>
|
25
|
+
<tr valign="top">
|
26
|
+
<td id="layout-menu">
|
27
|
+
<div>»<a href="index.html">Home</a></div>
|
28
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
29
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
30
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
31
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
32
|
+
<div>»<a href="README.html">README</a></div>
|
33
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
34
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
35
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
36
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
37
|
+
<div>»<a href="support.html">Support</a></div>
|
38
|
+
<div id="page-source">»<a href="manpage.txt">Page Source</a></div>
|
39
|
+
</td>
|
40
|
+
<td>
|
41
|
+
<div id="layout-content">
|
42
|
+
<div id="header">
|
43
|
+
<h1>
|
44
|
+
ASCIIDOC(1) Manual Page
|
45
|
+
</h1>
|
46
|
+
<div id="toc">
|
47
|
+
<div id="toctitle">Table of Contents</div>
|
48
|
+
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
|
49
|
+
</div>
|
50
|
+
<h2>NAME</h2>
|
51
|
+
<div class="sectionbody">
|
52
|
+
<p>asciidoc -
|
53
|
+
converts an AsciiDoc text file to DocBook, HTML or LinuxDoc
|
54
|
+
</p>
|
55
|
+
</div>
|
56
|
+
</div>
|
57
|
+
<h2>SYNOPSIS</h2>
|
58
|
+
<div class="sectionbody">
|
59
|
+
<div class="para"><p><strong>asciidoc</strong> [<em>OPTIONS</em>] <em>FILE</em></p></div>
|
60
|
+
</div>
|
61
|
+
<h2 id="_description">DESCRIPTION</h2>
|
62
|
+
<div class="sectionbody">
|
63
|
+
<div class="para"><p>The <tt>asciidoc(1)</tt> command translates the <em>AsciiDoc</em> text file <em>FILE</em> to a
|
64
|
+
DocBook, HTML or LinuxDoc file. If <em>FILE</em> is <em>-</em> then the standard
|
65
|
+
input is used.</p></div>
|
66
|
+
</div>
|
67
|
+
<h2 id="_options">OPTIONS</h2>
|
68
|
+
<div class="sectionbody">
|
69
|
+
<div class="vlist"><dl>
|
70
|
+
<dt>
|
71
|
+
<strong>-a, --attribute</strong>=<em>ATTRIBUTE</em>
|
72
|
+
</dt>
|
73
|
+
<dd>
|
74
|
+
<p>
|
75
|
+
Define or delete document attribute. <em>ATTRIBUTE</em> is formatted like
|
76
|
+
<em>NAME=VALUE</em>. Command-line attributes take precedence over
|
77
|
+
document and configuration file attributes. Alternate acceptable
|
78
|
+
forms are <em>NAME</em> (the <em>VALUE</em> defaults to an empty string);
|
79
|
+
<em>NAME!</em> (delete the <em>NAME</em> attribute); <em>NAME@</em> (do not override
|
80
|
+
document or configuration file attributes). Values containing
|
81
|
+
spaces should be enclosed in double-quote characters. This option
|
82
|
+
may be specified more than once.
|
83
|
+
</p>
|
84
|
+
</dd>
|
85
|
+
<dt>
|
86
|
+
<strong>-b, --backend</strong>=<em>BACKEND</em>
|
87
|
+
</dt>
|
88
|
+
<dd>
|
89
|
+
<p>
|
90
|
+
Backend output file format: <em>docbook</em>, <em>xhtml11</em> or <em>html4</em>.
|
91
|
+
Defaults to <em>xhtml11</em>.
|
92
|
+
</p>
|
93
|
+
</dd>
|
94
|
+
<dt>
|
95
|
+
<strong>-f, --conf-file</strong>=<em>CONF_FILE</em>
|
96
|
+
</dt>
|
97
|
+
<dd>
|
98
|
+
<p>
|
99
|
+
Use configuration file <em>CONF_FILE</em>.Configuration files processed
|
100
|
+
in command-line order (after implicit configuration files). This
|
101
|
+
option may be specified more than once.
|
102
|
+
</p>
|
103
|
+
</dd>
|
104
|
+
<dt>
|
105
|
+
<strong>-d, --doctype</strong>=<em>DOCTYPE</em>
|
106
|
+
</dt>
|
107
|
+
<dd>
|
108
|
+
<p>
|
109
|
+
Document type: <em>article</em>, <em>manpage</em> or <em>book</em>. The <em>book</em> document
|
110
|
+
type is only supported by the <em>docbook</em> backend. Default document
|
111
|
+
type is <em>article</em>.
|
112
|
+
</p>
|
113
|
+
</dd>
|
114
|
+
<dt>
|
115
|
+
<strong>-c, --dump-conf</strong>
|
116
|
+
</dt>
|
117
|
+
<dd>
|
118
|
+
<p>
|
119
|
+
Dump configuration to stdout.
|
120
|
+
</p>
|
121
|
+
</dd>
|
122
|
+
<dt>
|
123
|
+
<strong>-h, --help</strong>[=<em>TOPIC</em>]
|
124
|
+
</dt>
|
125
|
+
<dd>
|
126
|
+
<p>
|
127
|
+
Print help TOPIC. <strong>--help</strong>=<em>topics</em> will print a list of help
|
128
|
+
topics, <strong>--help</strong>=<em>syntax</em> summarizes <em>AsciiDoc</em> syntax,
|
129
|
+
<strong>--help</strong>=<em>manpage</em> prints the <em>AsciiDoc</em> manpage.
|
130
|
+
</p>
|
131
|
+
</dd>
|
132
|
+
<dt>
|
133
|
+
<strong>-e, --no-conf</strong>
|
134
|
+
</dt>
|
135
|
+
<dd>
|
136
|
+
<p>
|
137
|
+
Exclude implicitly loaded configuration files except for those
|
138
|
+
named like the input file (<em>infile.conf</em> and
|
139
|
+
<em>infile-backend.conf</em>).
|
140
|
+
</p>
|
141
|
+
</dd>
|
142
|
+
<dt>
|
143
|
+
<strong>-s, --no-header-footer</strong>
|
144
|
+
</dt>
|
145
|
+
<dd>
|
146
|
+
<p>
|
147
|
+
Suppress document header and footer output.
|
148
|
+
</p>
|
149
|
+
</dd>
|
150
|
+
<dt>
|
151
|
+
<strong>-o, --out-file</strong>=<em>OUT_FILE</em>
|
152
|
+
</dt>
|
153
|
+
<dd>
|
154
|
+
<p>
|
155
|
+
Write output to file <em>OUT_FILE</em>. Defaults to the base name of
|
156
|
+
input file with <em>backend</em> extension. If the input is stdin then
|
157
|
+
the outfile defaults to stdout. If <em>OUT_FILE</em> is <em>-</em> then the
|
158
|
+
standard output is used.
|
159
|
+
</p>
|
160
|
+
</dd>
|
161
|
+
<dt>
|
162
|
+
<strong>-n, --section-numbers</strong>
|
163
|
+
</dt>
|
164
|
+
<dd>
|
165
|
+
<p>
|
166
|
+
Auto-number HTML article section titles. Synonym for <strong>-a
|
167
|
+
numbered</strong>.
|
168
|
+
</p>
|
169
|
+
</dd>
|
170
|
+
<dt>
|
171
|
+
<strong>--unsafe</strong>
|
172
|
+
</dt>
|
173
|
+
<dd>
|
174
|
+
<p>
|
175
|
+
Disable safe mode. Safe mode is enabled by default, disabling
|
176
|
+
it is potentially dangerous.
|
177
|
+
</p>
|
178
|
+
</dd>
|
179
|
+
<dt>
|
180
|
+
<strong>-v, --verbose</strong>
|
181
|
+
</dt>
|
182
|
+
<dd>
|
183
|
+
<p>
|
184
|
+
Verbosely print processing information and configuration file
|
185
|
+
checks to stderr.
|
186
|
+
</p>
|
187
|
+
</dd>
|
188
|
+
<dt>
|
189
|
+
<strong>--version</strong>
|
190
|
+
</dt>
|
191
|
+
<dd>
|
192
|
+
<p>
|
193
|
+
Print program version number.
|
194
|
+
</p>
|
195
|
+
</dd>
|
196
|
+
</dl></div>
|
197
|
+
</div>
|
198
|
+
<h2 id="_exit_status">EXIT STATUS</h2>
|
199
|
+
<div class="sectionbody">
|
200
|
+
<div class="vlist"><dl>
|
201
|
+
<dt>
|
202
|
+
<strong>0</strong>
|
203
|
+
</dt>
|
204
|
+
<dd>
|
205
|
+
<p>
|
206
|
+
Success
|
207
|
+
</p>
|
208
|
+
</dd>
|
209
|
+
<dt>
|
210
|
+
<strong>1</strong>
|
211
|
+
</dt>
|
212
|
+
<dd>
|
213
|
+
<p>
|
214
|
+
Failure (syntax or usage error; configuration error; document
|
215
|
+
processing failure; unexpected error).
|
216
|
+
</p>
|
217
|
+
</dd>
|
218
|
+
</dl></div>
|
219
|
+
</div>
|
220
|
+
<h2 id="_bugs">BUGS</h2>
|
221
|
+
<div class="sectionbody">
|
222
|
+
<div class="para"><p>See the <em>AsciiDoc</em> distribution BUGS file.</p></div>
|
223
|
+
</div>
|
224
|
+
<h2 id="_author">AUTHOR</h2>
|
225
|
+
<div class="sectionbody">
|
226
|
+
<div class="para"><p>Written by Stuart Rackham, <<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>></p></div>
|
227
|
+
</div>
|
228
|
+
<h2 id="_resources">RESOURCES</h2>
|
229
|
+
<div class="sectionbody">
|
230
|
+
<div class="para"><p>SourceForge: <a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a></p></div>
|
231
|
+
<div class="para"><p>Main web site: <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a></p></div>
|
232
|
+
</div>
|
233
|
+
<h2 id="_copying">COPYING</h2>
|
234
|
+
<div class="sectionbody">
|
235
|
+
<div class="para"><p>Copyright (C) 2002-2008 Stuart Rackham. Free use of this software is
|
236
|
+
granted under the terms of the GNU General Public License (GPL).</p></div>
|
237
|
+
</div>
|
238
|
+
<div id="footer">
|
239
|
+
<div id="footer-text">
|
240
|
+
Version 8.2.7<br />
|
241
|
+
Last updated 2008-07-04 23:29:29 NZDT
|
242
|
+
</div>
|
243
|
+
<div id="footer-badges">
|
244
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
245
|
+
<img style="border:none; width:88px; height:31px;"
|
246
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
247
|
+
alt="Valid XHTML 1.1!" />
|
248
|
+
</a>
|
249
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
250
|
+
<img style="border:none; width:88px; height:31px;"
|
251
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
252
|
+
alt="Valid CSS!" />
|
253
|
+
</a>
|
254
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
255
|
+
<img style="border:none; width:110px; height:32px;"
|
256
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
257
|
+
alt="Get Firefox!" />
|
258
|
+
</a>
|
259
|
+
</div>
|
260
|
+
</div>
|
261
|
+
</div>
|
262
|
+
</td>
|
263
|
+
</tr>
|
264
|
+
</table>
|
265
|
+
</body>
|
266
|
+
</html>
|
@@ -0,0 +1,242 @@
|
|
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.2.7" />
|
7
|
+
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
|
8
|
+
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
|
9
|
+
<link rel="stylesheet" href="./layout1.css" type="text/css" />
|
10
|
+
<title>Music Filter</title>
|
11
|
+
</head>
|
12
|
+
<body>
|
13
|
+
<div id="layout-banner">
|
14
|
+
<div id="layout-title">AsciiDoc</div>
|
15
|
+
<div id="layout-description">Text based document generation</div>
|
16
|
+
</div>
|
17
|
+
<table>
|
18
|
+
<tr valign="top">
|
19
|
+
<td id="layout-menu">
|
20
|
+
<div>»<a href="index.html">Home</a></div>
|
21
|
+
<div>»<a href="manpage.html">Man Page</a></div>
|
22
|
+
<div>»<a href="userguide.html">User Guide</a></div>
|
23
|
+
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
|
24
|
+
<div>»<a href="a2x.1.html">a2x</a></div>
|
25
|
+
<div>»<a href="README.html">README</a></div>
|
26
|
+
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
|
27
|
+
<div>»<a href="INSTALL.html">Installation</a></div>
|
28
|
+
<div>»<a href="downloads.html">Downloads</a></div>
|
29
|
+
<div>»<a href="faq.html">FAQ</a></div>
|
30
|
+
<div>»<a href="support.html">Support</a></div>
|
31
|
+
<div id="page-source">»<a href="music-filter.txt">Page Source</a></div>
|
32
|
+
</td>
|
33
|
+
<td>
|
34
|
+
<div id="layout-content">
|
35
|
+
<div id="header">
|
36
|
+
<h1>Music Filter</h1>
|
37
|
+
</div>
|
38
|
+
<div id="preamble">
|
39
|
+
<div class="sectionbody">
|
40
|
+
<div class="para"><p>The <em>AsciiDoc</em> distribution includes a Music Block filter that
|
41
|
+
translates music in <a href="http://lilypond.org/">LilyPond</a> or
|
42
|
+
<a href="http://abcnotation.org.uk/">ABC</a> notation to standard classical
|
43
|
+
notation in the form of a trimmed PNG image which is automatically
|
44
|
+
inserted into the <em>AsciiDoc</em> output document (see the <a href="#X1">examples below</a>).</p></div>
|
45
|
+
<div class="para"><p>Actually the filter (<tt>./filters/music2png.py</tt>) can be used outside
|
46
|
+
<em>AsciiDoc</em> to convert LilyPond or ABC music files to PNG images.
|
47
|
+
Execute the following command to see how to use it:</p></div>
|
48
|
+
<div class="literalblock">
|
49
|
+
<div class="content">
|
50
|
+
<pre><tt>$ ./filters/music2png.py --help</tt></pre>
|
51
|
+
</div></div>
|
52
|
+
<div class="para"><p>The Music Filter can be used as a model for filters that convert a
|
53
|
+
block of text into a file that is linked or embedded into the <em>AsciiDoc</em>
|
54
|
+
output document.</p></div>
|
55
|
+
<div class="exampleblock" id="X1">
|
56
|
+
<div class="title">Example 1: Music Block containing ABC notation</div>
|
57
|
+
<div class="exampleblock-content">
|
58
|
+
<div class="para"><p>This Music Block:</p></div>
|
59
|
+
<div class="listingblock">
|
60
|
+
<div class="content">
|
61
|
+
<pre><tt> [music,music1.png]
|
62
|
+
---------------------------------------------------------------------
|
63
|
+
T:The Butterfly
|
64
|
+
R:slip jig
|
65
|
+
C:Tommy Potts
|
66
|
+
H:Fiddle player Tommy Potts made this tune from two older slip jigs,
|
67
|
+
H:one of which is called "Skin the Peelers" in Roche's collection.
|
68
|
+
H:This version by Peter Cooper.
|
69
|
+
D:Bothy Band: 1975.
|
70
|
+
M:9/8
|
71
|
+
K:Em
|
72
|
+
vB2(E G2)(E F3)|B2(E G2)(E F)ED|vB2(E G2)(E F3)|(B2d) d2(uB A)FD:|
|
73
|
+
|:(vB2c) (e2f) g3|(uB2d) (g2e) (dBA)|(B2c) (e2f) g2(ua|b2a) (g2e) (dBA):|
|
74
|
+
|:~B3 (B2A) G2A|~B3 BA(uB d)BA|~B3 (B2A) G2(A|B2d) (g2e) (dBA):|
|
75
|
+
---------------------------------------------------------------------</tt></pre>
|
76
|
+
</div></div>
|
77
|
+
<div class="para"><p>Renders:</p></div>
|
78
|
+
<div class="musicblock">
|
79
|
+
<div class="content">
|
80
|
+
<img style="border-width: 0;" src="music1.png" alt="music1.png" />
|
81
|
+
</div></div>
|
82
|
+
</div></div>
|
83
|
+
<div class="exampleblock" id="X2">
|
84
|
+
<div class="title">Example 2: Music Block containing LilyPond notation</div>
|
85
|
+
<div class="exampleblock-content">
|
86
|
+
<div class="para"><p>This example contains LilyPond musical markup, it uses the <em>link</em>
|
87
|
+
attribute so you can click on the music image to display the source
|
88
|
+
notation. The <tt>music2.ly</tt> source file is automatically created and
|
89
|
+
retained by the <tt>music2png.py</tt> filter when the <tt>-m</tt> option is used.</p></div>
|
90
|
+
<div class="listingblock">
|
91
|
+
<div class="content">
|
92
|
+
<pre><tt> ["music", "music2.png", "ly", link="music2.ly"]
|
93
|
+
---------------------------------------------------------------------
|
94
|
+
\version "2.10.0"
|
95
|
+
\paper {
|
96
|
+
ragged-right = ##t
|
97
|
+
}
|
98
|
+
{
|
99
|
+
\time 3/4
|
100
|
+
\clef bass
|
101
|
+
c2 e4 g2. f4 e d c2 r4
|
102
|
+
}
|
103
|
+
---------------------------------------------------------------------</tt></pre>
|
104
|
+
</div></div>
|
105
|
+
<div class="para"><p>Renders:</p></div>
|
106
|
+
<div class="musicblock">
|
107
|
+
<div class="content">
|
108
|
+
<a href="music2.ly">
|
109
|
+
<img style="border-width: 0;" src="music2.png" alt="music2.png" />
|
110
|
+
</a>
|
111
|
+
</div></div>
|
112
|
+
</div></div>
|
113
|
+
<div class="admonitionblock">
|
114
|
+
<table><tr>
|
115
|
+
<td class="icon">
|
116
|
+
<img src="./images/icons/note.png" alt="Note" />
|
117
|
+
</td>
|
118
|
+
<td class="content">If you get an error processing the above example it may be that
|
119
|
+
it is not compatible with your version of LilyPond. Use the LilyPond
|
120
|
+
<tt>convert-ly(1)</tt> utility to update the source to the version that you
|
121
|
+
are using.</td>
|
122
|
+
</tr></table>
|
123
|
+
</div>
|
124
|
+
</div>
|
125
|
+
</div>
|
126
|
+
<h2 id="_using_the_filter">Using the Filter</h2>
|
127
|
+
<div class="sectionbody">
|
128
|
+
<div class="para"><p>Insert a delimited Music Block containing valid ABC notation into your
|
129
|
+
<em>AsciiDoc</em> document:</p></div>
|
130
|
+
<div class="ilist"><ul>
|
131
|
+
<li>
|
132
|
+
<p>
|
133
|
+
The Music Block delimiter is the word <tt>music</tt> followed by four or
|
134
|
+
more tilde characters.
|
135
|
+
</p>
|
136
|
+
</li>
|
137
|
+
<li>
|
138
|
+
<p>
|
139
|
+
The Music Block attribute list must contain a file name for the PNG
|
140
|
+
output image file followed by the input format (either <em>abc</em> for ABC
|
141
|
+
or <em>ly</em> for LilyPond). If the format is omitted ABC notation is
|
142
|
+
assumed.
|
143
|
+
</p>
|
144
|
+
</li>
|
145
|
+
<li>
|
146
|
+
<p>
|
147
|
+
The filter invokes <tt>music2png</tt> with the <tt>-m</tt> option so that music
|
148
|
+
images will only be regenerated if the block content has changed.
|
149
|
+
</p>
|
150
|
+
</li>
|
151
|
+
<li>
|
152
|
+
<p>
|
153
|
+
The optional named block attributes <em>link</em>, <em>width</em> and <em>height</em> are
|
154
|
+
also available (see <a href="userguide.html#X55">Image macro attributes</a>
|
155
|
+
in the <em>AsciiDoc</em> User Guide).
|
156
|
+
</p>
|
157
|
+
</li>
|
158
|
+
</ul></div>
|
159
|
+
</div>
|
160
|
+
<h2 id="_limitations">Limitations</h2>
|
161
|
+
<div class="sectionbody">
|
162
|
+
<div class="ilist"><ul>
|
163
|
+
<li>
|
164
|
+
<p>
|
165
|
+
The <tt><tt>asciidoc(1)</tt></tt> output file cannot be <tt>-</tt> (stdout), you must
|
166
|
+
output to a named file.
|
167
|
+
</p>
|
168
|
+
</li>
|
169
|
+
<li>
|
170
|
+
<p>
|
171
|
+
If the music image file is linked to the output document then the
|
172
|
+
image file name in the Music Block attribute list should be a
|
173
|
+
relative path name relative to the <em>AsciiDoc</em> output file.
|
174
|
+
</p>
|
175
|
+
</li>
|
176
|
+
</ul></div>
|
177
|
+
</div>
|
178
|
+
<h2 id="_installation">Installation</h2>
|
179
|
+
<div class="sectionbody">
|
180
|
+
<div class="para"><p>In addition to <em>AsciiDoc</em> you will need to have installed:</p></div>
|
181
|
+
<div class="ilist"><ul>
|
182
|
+
<li>
|
183
|
+
<p>
|
184
|
+
<a href="http://lilypond.org/web/">LilyPond</a> (most Linux distributions include
|
185
|
+
this package).
|
186
|
+
</p>
|
187
|
+
</li>
|
188
|
+
<li>
|
189
|
+
<p>
|
190
|
+
<a href="http://www.imagemagick.org">ImageMagick</a> (most Linux distributions
|
191
|
+
include this package).
|
192
|
+
</p>
|
193
|
+
</li>
|
194
|
+
</ul></div>
|
195
|
+
<div class="para"><p>Test the music filter it by converting the test file to HTML with <em>AsciiDoc</em>:</p></div>
|
196
|
+
<div class="literalblock">
|
197
|
+
<div class="content">
|
198
|
+
<pre><tt>$ asciidoc -v ./filters/music-filter-test.txt
|
199
|
+
$ firefox ./filters/music-filter-test.html &</tt></pre>
|
200
|
+
</div></div>
|
201
|
+
<div class="para"><p>The filter was developed and tested on Xubuntu Linux using LilyPond
|
202
|
+
2.10.5 and ImageMagick 6.2.4.</p></div>
|
203
|
+
<div class="admonitionblock">
|
204
|
+
<table><tr>
|
205
|
+
<td class="icon">
|
206
|
+
<img src="./images/icons/note.png" alt="Note" />
|
207
|
+
</td>
|
208
|
+
<td class="content">The filter does not work with LilyPond 2.2.6 because it did not
|
209
|
+
generate the requested output file name correctly (2.6.3 does not have
|
210
|
+
a problem).</td>
|
211
|
+
</tr></table>
|
212
|
+
</div>
|
213
|
+
</div>
|
214
|
+
<div id="footer">
|
215
|
+
<div id="footer-text">
|
216
|
+
Version 8.2.7<br />
|
217
|
+
Last updated 2008-07-04 23:29:30 NZDT
|
218
|
+
</div>
|
219
|
+
<div id="footer-badges">
|
220
|
+
<a href="http://validator.w3.org/check?uri=referer">
|
221
|
+
<img style="border:none; width:88px; height:31px;"
|
222
|
+
src="http://www.w3.org/Icons/valid-xhtml11"
|
223
|
+
alt="Valid XHTML 1.1!" />
|
224
|
+
</a>
|
225
|
+
<a href="http://jigsaw.w3.org/css-validator/check/referer">
|
226
|
+
<img style="border:none; width:88px; height:31px;"
|
227
|
+
src="http://jigsaw.w3.org/css-validator/images/vcss"
|
228
|
+
alt="Valid CSS!" />
|
229
|
+
</a>
|
230
|
+
<a href="http://www.mozilla.org/products/firefox/">
|
231
|
+
<img style="border:none; width:110px; height:32px;"
|
232
|
+
src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
|
233
|
+
alt="Get Firefox!" />
|
234
|
+
</a>
|
235
|
+
</div>
|
236
|
+
</div>
|
237
|
+
</div>
|
238
|
+
</td>
|
239
|
+
</tr>
|
240
|
+
</table>
|
241
|
+
</body>
|
242
|
+
</html>
|