git-scribe 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +1 -0
- data/Rakefile +31 -0
- data/SPEC.asciidoc +126 -0
- data/TODO.txt +29 -0
- data/bin/git-scribe +2 -1
- data/docbook-xsl/.CatalogManager.properties.example +61 -0
- data/docbook-xsl/.urilist +1 -0
- data/git-scribe.gemspec +32 -0
- data/lib/git-scribe.rb +21 -315
- data/lib/git-scribe/check.rb +60 -0
- data/lib/git-scribe/cli.rb +84 -0
- data/lib/git-scribe/generate.rb +222 -0
- data/lib/git-scribe/init.rb +16 -0
- data/lib/git-scribe/version.rb +3 -0
- data/template/.gitignore +1 -0
- data/template/.gitscribe +5 -0
- data/test/check_test.rb +12 -0
- data/test/gen_test.rb +78 -0
- data/test/init_test.rb +36 -0
- data/test/test_helper.rb +44 -0
- metadata +49 -161
- data/example/book/big.asc +0 -5604
- data/example/book/holmes.asc +0 -12983
- data/example/output/META-INF/container.xml +0 -6
- data/example/output/OEBPS/ar01s02.html +0 -15
- data/example/output/OEBPS/ar01s03.html +0 -3
- data/example/output/OEBPS/content.opf +0 -21
- data/example/output/OEBPS/index.html +0 -5
- data/example/output/OEBPS/toc.ncx +0 -37
- data/example/output/a_case_of_identity.html +0 -725
- data/example/output/a_example_appendix.html +0 -63
- data/example/output/a_migration_notes.html +0 -95
- data/example/output/apa.html +0 -20
- data/example/output/apb.html +0 -6
- data/example/output/apc.html +0 -24
- data/example/output/apd.html +0 -30
- data/example/output/ape.html +0 -26
- data/example/output/apf.html +0 -9
- data/example/output/apg.html +0 -42
- data/example/output/aph.html +0 -89
- data/example/output/ar01s02.html +0 -12
- data/example/output/ar01s03.html +0 -34
- data/example/output/ar01s04.html +0 -77
- data/example/output/ar01s05.html +0 -272
- data/example/output/ar01s06.html +0 -35
- data/example/output/ar01s07.html +0 -105
- data/example/output/ar01s08.html +0 -33
- data/example/output/ar01s09.html +0 -12
- data/example/output/ar01s10.html +0 -14
- data/example/output/ar01s11.html +0 -34
- data/example/output/ar01s12.html +0 -63
- data/example/output/ar01s13.html +0 -156
- data/example/output/ar01s14.html +0 -330
- data/example/output/ar01s15.html +0 -22
- data/example/output/ar01s16.html +0 -27
- data/example/output/ar01s17.html +0 -94
- data/example/output/ar01s18.html +0 -359
- data/example/output/ar01s19.html +0 -373
- data/example/output/ar01s20.html +0 -27
- data/example/output/ar01s21.html +0 -33
- data/example/output/ar01s22.html +0 -351
- data/example/output/ar01s23.html +0 -21
- data/example/output/ar01s24.html +0 -69
- data/example/output/ar01s25.html +0 -60
- data/example/output/ar01s26.html +0 -217
- data/example/output/ar01s27.html +0 -88
- data/example/output/ar01s28.html +0 -237
- data/example/output/ar01s29.html +0 -68
- data/example/output/ar01s30.html +0 -154
- data/example/output/ar01s31.html +0 -6
- data/example/output/ar01s32.html +0 -22
- data/example/output/ar01s33.html +0 -209
- data/example/output/asciidoc_backends.html +0 -190
- data/example/output/asciidoc_document_types.html +0 -131
- data/example/output/attribute_entries.html +0 -185
- data/example/output/attribute_lists.html +0 -157
- data/example/output/attribute_references.html +0 -414
- data/example/output/attributelist_element.html +0 -143
- data/example/output/b_packager_notes.html +0 -68
- data/example/output/bi01.html +0 -18
- data/example/output/big.asc +0 -5604
- data/example/output/block_element_definitions.html +0 -448
- data/example/output/block_titles.html +0 -83
- data/example/output/blockid_element.html +0 -80
- data/example/output/book.asc +0 -5604
- data/example/output/book.epub +0 -0
- data/example/output/book.fo +0 -3788
- data/example/output/book.html +0 -8793
- data/example/output/book.xml +0 -8265
- data/example/output/c_asciidoc_safe_mode.html +0 -105
- data/example/output/callouts.html +0 -214
- data/example/output/catalog +0 -10
- data/example/output/colophon.html +0 -397
- data/example/output/configuration_files.html +0 -672
- data/example/output/converting_docbook_to_other_file_formats.html +0 -324
- data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
- data/example/output/delimited_blocks.html +0 -455
- data/example/output/document_attributes.html +0 -95
- data/example/output/document_processing.html +0 -116
- data/example/output/document_structure.html +0 -493
- data/example/output/e_vim_syntax_highlighter.html +0 -111
- data/example/output/example_bibliography.html +0 -82
- data/example/output/example_colophon.html +0 -58
- data/example/output/example_glossary.html +0 -73
- data/example/output/example_index.html +0 -108
- data/example/output/f_attribute_options.html +0 -129
- data/example/output/filters.html +0 -179
- data/example/output/footnotes.html +0 -103
- data/example/output/g_diagnostics.html +0 -148
- data/example/output/generating_plain_text_files.html +0 -68
- data/example/output/getting_started.html +0 -87
- data/example/output/glossary.html +0 -95
- data/example/output/go01.html +0 -24
- data/example/output/h_backend_attributes.html +0 -308
- data/example/output/help_commands.html +0 -96
- data/example/output/holmes.asc +0 -12983
- data/example/output/image/octocat_professor.png +0 -0
- data/example/output/include/hello.c +0 -10
- data/example/output/index.html +0 -656
- data/example/output/indexes.html +0 -104
- data/example/output/intrinsic_attributes.html +0 -165
- data/example/output/ix01.html +0 -3
- data/example/output/lists.html +0 -666
- data/example/output/macros.html +0 -737
- data/example/output/manpage_documents.html +0 -124
- data/example/output/master.css +0 -281
- data/example/output/mathematical_formulas.html +0 -125
- data/example/output/page.html +0 -60
- data/example/output/paragraphs.html +0 -192
- data/example/output/pr01.html +0 -3
- data/example/output/source_code_highlighting.html +0 -59
- data/example/output/stylesheets/handbookish-quirks.css +0 -0
- data/example/output/stylesheets/handbookish.css +0 -233
- data/example/output/tables.html +0 -797
- data/example/output/text_formatting.html +0 -273
- data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
- data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
- data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
- data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
- data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
- data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
- data/example/output/the_boscombe_valley_mystery.html +0 -974
- data/example/output/the_first_chapter.html +0 -110
- data/example/output/the_five_orange_pips.html +0 -776
- data/example/output/the_man_with_the_twisted_lip.html +0 -946
- data/example/output/the_red-headed_league.html +0 -950
- data/example/output/the_second_chapter.html +0 -95
- data/example/output/the_third_chapter.html +0 -58
- data/example/output/tips_and_tricks.html +0 -452
- data/example/output/title.html +0 -120
- data/example/output/titles.html +0 -126
|
@@ -1,124 +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">
|
|
3
|
-
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
5
|
-
<link rel="stylesheet" href="master.css" type="text/css" />
|
|
6
|
-
<title>Manpage Documents</title>
|
|
7
|
-
</head>
|
|
8
|
-
|
|
9
|
-
<body>
|
|
10
|
-
<div class="nav" id="navheader">
|
|
11
|
-
<table width="100%">
|
|
12
|
-
<tr><td width="33%" align="left">
|
|
13
|
-
|
|
14
|
-
<a href="tables.html">Prev</a><br/>
|
|
15
|
-
Tables
|
|
16
|
-
|
|
17
|
-
</td><td width="33%" align="center">
|
|
18
|
-
|
|
19
|
-
<a href="index.html">Home</a><br/>
|
|
20
|
-
<strong>AsciiDoc User Guide</strong>
|
|
21
|
-
|
|
22
|
-
</td><td width="33%" align="right">
|
|
23
|
-
|
|
24
|
-
<a href="mathematical_formulas.html">Next</a><br/>
|
|
25
|
-
Mathematical Formulas
|
|
26
|
-
|
|
27
|
-
</td></tr>
|
|
28
|
-
</table>
|
|
29
|
-
</div>
|
|
30
|
-
|
|
31
|
-
<hr/>
|
|
32
|
-
|
|
33
|
-
<div class="content">
|
|
34
|
-
<div class="section" lang="en" xml:lang="en">
|
|
35
|
-
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
|
36
|
-
<a id="X1"></a>Manpage Documents</h2></div></div></div>
|
|
37
|
-
<p>Sooner or later, if you program in a UNIX environment, you’re going
|
|
38
|
-
to have to write a man page.</p>
|
|
39
|
-
<p>By observing a couple of additional conventions you can compose
|
|
40
|
-
AsciiDoc files that will generate DocBook refentry (man page)
|
|
41
|
-
documents. The resulting DocBook file can then be translated to the
|
|
42
|
-
native roff man page format (or other formats).</p>
|
|
43
|
-
<p>For example, the <code class="literal">asciidoc.1.txt</code> file in the AsciiDoc distribution
|
|
44
|
-
<code class="literal">./doc</code> directory was used to generate both the
|
|
45
|
-
<code class="literal">asciidoc.1.css-embedded.html</code> HTML file the <code class="literal">asciidoc.1</code> roff
|
|
46
|
-
formatted <code class="literal">asciidoc(1)</code> man page.</p>
|
|
47
|
-
<div class="sidebar">
|
|
48
|
-
<p class="title"><b>Viewing and printing manpage files</b></p>
|
|
49
|
-
<p>Use the <code class="literal">man(1)</code> command to view the manpage file:</p>
|
|
50
|
-
<pre class="literallayout">$ man -l asciidoc.1</pre>
|
|
51
|
-
<p>To print a high quality man page to a postscript printer:</p>
|
|
52
|
-
<pre class="literallayout">$ man -l -Tps asciidoc.1 | lpr</pre>
|
|
53
|
-
<p>You could also create a PDF version of the man page by converting
|
|
54
|
-
PostScript to PDF using <code class="literal">ps2pdf(1)</code>:</p>
|
|
55
|
-
<pre class="literallayout">$ man -l -Tps asciidoc.1 | ps2pdf - asciidoc.1.pdf</pre>
|
|
56
|
-
<p>The <code class="literal">ps2pdf(1)</code> command is included in the Ghostscript distribution.</p>
|
|
57
|
-
</div>
|
|
58
|
-
<p>To find out more about man pages view the <code class="literal">man(7)</code> manpage
|
|
59
|
-
(<code class="literal">man 7 man</code> and <code class="literal">man man-pages</code> commands).</p>
|
|
60
|
-
<div class="section" lang="en" xml:lang="en">
|
|
61
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
62
|
-
<a id="_document_header"></a>Document Header</h3></div></div></div>
|
|
63
|
-
<p>A manpage document Header is mandatory. The title line contains the
|
|
64
|
-
man page name followed immediately by the manual section number in
|
|
65
|
-
brackets, for example <span class="emphasis"><em>ASCIIDOC(1)</em></span>. The title name should not contain
|
|
66
|
-
white space and the manual section number is a single digit optionally
|
|
67
|
-
followed by a single character.</p>
|
|
68
|
-
</div>
|
|
69
|
-
<div class="section" lang="en" xml:lang="en">
|
|
70
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
71
|
-
<a id="_the_name_section"></a>The NAME Section</h3></div></div></div>
|
|
72
|
-
<p>The first manpage section is mandatory, must be titled <span class="emphasis"><em>NAME</em></span> and must
|
|
73
|
-
contain a single paragraph (usually a single line) consisting of a
|
|
74
|
-
list of one or more comma separated command name(s) separated from the
|
|
75
|
-
command purpose by a dash character. The dash must have at least one
|
|
76
|
-
white space character on either side. For example:</p>
|
|
77
|
-
<pre class="literallayout">printf, fprintf, sprintf - print formatted output</pre>
|
|
78
|
-
</div>
|
|
79
|
-
<div class="section" lang="en" xml:lang="en">
|
|
80
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
81
|
-
<a id="_the_synopsis_section"></a>The SYNOPSIS Section</h3></div></div></div>
|
|
82
|
-
<p>The second manpage section is mandatory and must be titled <span class="emphasis"><em>SYNOPSIS</em></span>.</p>
|
|
83
|
-
</div>
|
|
84
|
-
<div class="section" lang="en" xml:lang="en">
|
|
85
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
86
|
-
<a id="_refmiscinfo_attributes"></a>refmiscinfo attributes</h3></div></div></div>
|
|
87
|
-
<p>In addition to the automatically created man page <a class="link" href="intrinsic_attributes.html" title="Intrinsic Attributes">intrinsic attributes</a> you can assign DocBook
|
|
88
|
-
<a class="ulink" href="http://www.docbook.org/tdg5/en/html/refmiscinfo.html" target="_top">refmiscinfo</a>
|
|
89
|
-
element <span class="emphasis"><em>source</em></span>, <span class="emphasis"><em>version</em></span> and <span class="emphasis"><em>manual</em></span> values using AsciiDoc
|
|
90
|
-
<code class="literal">{mansource}</code>, <code class="literal">{manversion}</code> and <code class="literal">{manmanual}</code> attributes
|
|
91
|
-
respectively. This example is from the AsciiDoc header of a man page
|
|
92
|
-
source file:</p>
|
|
93
|
-
<pre class="literallayout">:man source: AsciiDoc
|
|
94
|
-
:man version: {revnumber}
|
|
95
|
-
:man manual: AsciiDoc Manual</pre>
|
|
96
|
-
</div>
|
|
97
|
-
</div>
|
|
98
|
-
|
|
99
|
-
</div>
|
|
100
|
-
|
|
101
|
-
<hr/>
|
|
102
|
-
|
|
103
|
-
<div class="nav" id="navfooter">
|
|
104
|
-
<table width="100%">
|
|
105
|
-
<tr><td width="33%" align="left">
|
|
106
|
-
|
|
107
|
-
<a href="tables.html">Prev</a><br/>
|
|
108
|
-
Tables
|
|
109
|
-
|
|
110
|
-
</td><td width="33%" align="center">
|
|
111
|
-
|
|
112
|
-
<a href="index.html">Home</a><br/>
|
|
113
|
-
AsciiDoc User Guide
|
|
114
|
-
|
|
115
|
-
</td><td width="33%" align="right">
|
|
116
|
-
|
|
117
|
-
<a href="mathematical_formulas.html">Next</a><br/>
|
|
118
|
-
Mathematical Formulas
|
|
119
|
-
|
|
120
|
-
</td></tr>
|
|
121
|
-
</table>
|
|
122
|
-
</div>
|
|
123
|
-
</body>
|
|
124
|
-
</html>
|
data/example/output/master.css
DELETED
|
@@ -1,281 +0,0 @@
|
|
|
1
|
-
/* BEG */
|
|
2
|
-
/* ---------------------------------------------------------------------------
|
|
3
|
-
Bare AsciiDoc styles
|
|
4
|
-
Ryan Tomayko <r@tomayko.com>
|
|
5
|
-
--------------------------------------------------------------------------- */
|
|
6
|
-
|
|
7
|
-
body {
|
|
8
|
-
font-family:"Helvetica Neue", Helvetica, Arial, sans-serif;
|
|
9
|
-
font-size: 1.0em;
|
|
10
|
-
line-height:140%;
|
|
11
|
-
margin-left: 10%;
|
|
12
|
-
margin-right: 10%;
|
|
13
|
-
min-width: 790px;
|
|
14
|
-
color:#222;
|
|
15
|
-
background: #eee;
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
.tip {
|
|
19
|
-
background: #eee;
|
|
20
|
-
padding: 0 10px;
|
|
21
|
-
}
|
|
22
|
-
.warning {
|
|
23
|
-
background: #fcc;
|
|
24
|
-
padding: 0 10px;
|
|
25
|
-
}
|
|
26
|
-
.important {
|
|
27
|
-
background: #ccf;
|
|
28
|
-
padding: 0 10px;
|
|
29
|
-
}
|
|
30
|
-
.caution {
|
|
31
|
-
background: #ffc;
|
|
32
|
-
padding: 0 10px;
|
|
33
|
-
}
|
|
34
|
-
.content {
|
|
35
|
-
background: #fff;
|
|
36
|
-
padding: 20px;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
a {
|
|
40
|
-
color: #336;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
a:visited {
|
|
44
|
-
color: #447;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
.nav {
|
|
48
|
-
color: #777;
|
|
49
|
-
}
|
|
50
|
-
.nav a {
|
|
51
|
-
color: #555;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
#toc a {
|
|
55
|
-
text-decoration: none;
|
|
56
|
-
color: #444;
|
|
57
|
-
}
|
|
58
|
-
#toc > ul {
|
|
59
|
-
list-style: none;
|
|
60
|
-
padding-left: 0;
|
|
61
|
-
}
|
|
62
|
-
#toc > ul ul {
|
|
63
|
-
list-style: none;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
hr { border: none; border-bottom: 1px solid #ccc; }
|
|
67
|
-
|
|
68
|
-
em {
|
|
69
|
-
font-style:italic;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
strong {
|
|
73
|
-
font-weight:bold;
|
|
74
|
-
color:#000;
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
tt {
|
|
78
|
-
font-family:consolas, 'lucida console', 'bitstream vera sans mono',
|
|
79
|
-
'courier new', monospace;
|
|
80
|
-
color:#000;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
p, ul, ol, dl {
|
|
84
|
-
margin:10px 0
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
dl {
|
|
88
|
-
margin-left:40px
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
dt {
|
|
92
|
-
font-weight:normal;
|
|
93
|
-
color:#000;
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
h1, h2, h3, h4, h5 {
|
|
97
|
-
font-family:'lucida grande',georgia,verdana,helvetica,arial,sans-serif;
|
|
98
|
-
font-weight:normal;
|
|
99
|
-
color:#000;
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
h1 {
|
|
103
|
-
font-size:30px;
|
|
104
|
-
line-height:1.428;
|
|
105
|
-
margin:20px 0;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
h2 {
|
|
109
|
-
font-size:23px;
|
|
110
|
-
line-height:1.36363636; /* repeating, of course */
|
|
111
|
-
margin:20px 0;
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
h2 + .sectionbody {}
|
|
115
|
-
|
|
116
|
-
h3 {
|
|
117
|
-
font-size:18px;
|
|
118
|
-
line-height:1.1;
|
|
119
|
-
margin:30px 0 10px 0;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
h4 {
|
|
123
|
-
font-size:13px;
|
|
124
|
-
font-weight:bold;
|
|
125
|
-
line-height:1.538;
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
h5 {
|
|
129
|
-
font-size:13px;
|
|
130
|
-
font-style:italic;
|
|
131
|
-
line-height:1.538;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
pre {
|
|
135
|
-
font-size:larger;
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
#header {
|
|
139
|
-
text-align:center;
|
|
140
|
-
margin-bottom:30px;
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
#header h1 { margin-bottom:0 }
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
.title, .sidebar-title {
|
|
147
|
-
font-weight:normal;
|
|
148
|
-
margin-bottom:0;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
.admonitionblock .title {
|
|
152
|
-
font-weight:bold;
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
.admonitionblock {
|
|
156
|
-
margin:30px 0px;
|
|
157
|
-
color:#555;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
.admonitionblock td.icon {
|
|
161
|
-
width:30px;
|
|
162
|
-
padding-right:20px;
|
|
163
|
-
padding-left:20px;
|
|
164
|
-
text-transform:uppercase;
|
|
165
|
-
font-weight:bold;
|
|
166
|
-
color:#888;
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
.listingblock .content {
|
|
170
|
-
border:1px solid silver;
|
|
171
|
-
background:#eee;
|
|
172
|
-
padding:5px;
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
.listingblock .content pre {
|
|
176
|
-
margin:0;
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
.literalblock .content {
|
|
180
|
-
margin-left:40px;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
.verseblock .content {
|
|
184
|
-
white-space:pre
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
.sidebarblock .sidebar-content {
|
|
188
|
-
border:1px solid silver;
|
|
189
|
-
background:#FFFFEE;
|
|
190
|
-
padding:0 10px;
|
|
191
|
-
color:#222;
|
|
192
|
-
font-size:smaller;
|
|
193
|
-
line-height:1.5;
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
.sidebar-title {
|
|
197
|
-
margin:10px 0;
|
|
198
|
-
font-weight:bold;
|
|
199
|
-
color:#442;
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
.quoteblock-content {
|
|
203
|
-
font-style:italic;
|
|
204
|
-
color:#444;
|
|
205
|
-
margin-left:40px;
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
.quoteblock-content .attribution {
|
|
209
|
-
font-style:normal;
|
|
210
|
-
text-align:right;
|
|
211
|
-
color:#000;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
.exampleblock-content *:first-child { margin-top:0 }
|
|
215
|
-
.exampleblock-content {
|
|
216
|
-
border-left:2px solid silver;
|
|
217
|
-
padding-left:8px;
|
|
218
|
-
}
|
|
219
|
-
|
|
220
|
-
#footer {
|
|
221
|
-
font-size:11px;
|
|
222
|
-
margin-top:40px;
|
|
223
|
-
border-top:1px solid silver;
|
|
224
|
-
color:#555;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
#author {
|
|
228
|
-
color:#000;
|
|
229
|
-
text-transform:uppercase
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
/* vim: set ft=css ts=4 sw=4 noexpandtab: */
|
|
233
|
-
|
|
234
|
-
/* END @import url(bare.css); */
|
|
235
|
-
|
|
236
|
-
/* ---------------------------------------------------------------------------
|
|
237
|
-
FreeBSD AsciiDoc Theme
|
|
238
|
-
Ryan Tomayko <r@tomayko.com>
|
|
239
|
-
|
|
240
|
-
Based on The FreeBSD Handbook and various other FreeBSD documenration.
|
|
241
|
-
--------------------------------------------------------------------------- */
|
|
242
|
-
|
|
243
|
-
tt { color:#007A00 }
|
|
244
|
-
pre tt { color:#000 }
|
|
245
|
-
|
|
246
|
-
dt { color:#000 }
|
|
247
|
-
|
|
248
|
-
h1, h2, h3, h4, h5 {
|
|
249
|
-
font-family:'lucida grande',helvetica,verdana,sans-serif;
|
|
250
|
-
color:#900;
|
|
251
|
-
font-weight:bold;
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
#header {
|
|
255
|
-
text-align:left;
|
|
256
|
-
}
|
|
257
|
-
#header h1 { margin-bottom:40px }
|
|
258
|
-
|
|
259
|
-
h1 {
|
|
260
|
-
font-size:36px;
|
|
261
|
-
line-height:1;
|
|
262
|
-
margin:40px 0;
|
|
263
|
-
}
|
|
264
|
-
|
|
265
|
-
h2 {
|
|
266
|
-
font-size:28px;
|
|
267
|
-
line-height:1;
|
|
268
|
-
margin:30px 0 20px 0;
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
.sectionbody {
|
|
272
|
-
margin-left:30px;
|
|
273
|
-
}
|
|
274
|
-
|
|
275
|
-
pre {
|
|
276
|
-
background:#000;
|
|
277
|
-
color:#fff;
|
|
278
|
-
padding: 15px;
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
/* vim: set ft=css ts=4 sw=4 noexpandtab: */
|
|
@@ -1,125 +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">
|
|
3
|
-
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
5
|
-
<link rel="stylesheet" href="master.css" type="text/css" />
|
|
6
|
-
<title>Mathematical Formulas</title>
|
|
7
|
-
</head>
|
|
8
|
-
|
|
9
|
-
<body>
|
|
10
|
-
<div class="nav" id="navheader">
|
|
11
|
-
<table width="100%">
|
|
12
|
-
<tr><td width="33%" align="left">
|
|
13
|
-
|
|
14
|
-
<a href="manpage_documents.html">Prev</a><br/>
|
|
15
|
-
Manpage Documents
|
|
16
|
-
|
|
17
|
-
</td><td width="33%" align="center">
|
|
18
|
-
|
|
19
|
-
<a href="index.html">Home</a><br/>
|
|
20
|
-
<strong>AsciiDoc User Guide</strong>
|
|
21
|
-
|
|
22
|
-
</td><td width="33%" align="right">
|
|
23
|
-
|
|
24
|
-
<a href="configuration_files.html">Next</a><br/>
|
|
25
|
-
Configuration Files
|
|
26
|
-
|
|
27
|
-
</td></tr>
|
|
28
|
-
</table>
|
|
29
|
-
</div>
|
|
30
|
-
|
|
31
|
-
<hr/>
|
|
32
|
-
|
|
33
|
-
<div class="content">
|
|
34
|
-
<div class="section" lang="en" xml:lang="en">
|
|
35
|
-
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
|
36
|
-
<a id="X78"></a>Mathematical Formulas</h2></div></div></div>
|
|
37
|
-
<p>The <span class="emphasis"><em>asciimath</em></span> and <span class="emphasis"><em>latexmath</em></span> <a class="link" href="macros.html#X77" title="Passthrough macros">passthrough macros</a> along with
|
|
38
|
-
<span class="emphasis"><em>asciimath</em></span> and <span class="emphasis"><em>latexmath</em></span> <a class="link" href="delimited_blocks.html#X76" title="Passthrough Blocks">passthrough blocks</a> provide a
|
|
39
|
-
(backend dependent) mechanism for rendering mathematical formulas. You
|
|
40
|
-
can use the following math markups:</p>
|
|
41
|
-
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
|
42
|
-
<h3 class="title">Note</h3>
|
|
43
|
-
<p>The <span class="emphasis"><em>latexmath</em></span> macro used to include <span class="emphasis"><em>LaTeX Math</em></span> in DocBook
|
|
44
|
-
outputs is not the same as the <span class="emphasis"><em>latexmath</em></span> macro used to include
|
|
45
|
-
<span class="emphasis"><em>LaTeX MathML</em></span> in XHTML outputs. <span class="emphasis"><em>LaTeX Math</em></span> applies to DocBook
|
|
46
|
-
outputs that are processed by <a class="link" href="converting_docbook_to_other_file_formats.html#X31">dblatex</a> and is normally used to
|
|
47
|
-
generate PDF files. <span class="emphasis"><em>LaTeXMathML</em></span> is very much a subset of <span class="emphasis"><em>LaTeX
|
|
48
|
-
Math</em></span> and applies to XHTML documents.</p>
|
|
49
|
-
</div>
|
|
50
|
-
<div class="section" lang="en" xml:lang="en">
|
|
51
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
52
|
-
<a id="_latex_math"></a>LaTeX Math</h3></div></div></div>
|
|
53
|
-
<p><a class="ulink" href="ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf" target="_top">LaTeX
|
|
54
|
-
math</a> can be included in documents that are processed by
|
|
55
|
-
<a class="link" href="converting_docbook_to_other_file_formats.html#X31">dblatex(1)</a>. Example inline formula:</p>
|
|
56
|
-
<pre class="literallayout">latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$]</pre>
|
|
57
|
-
<p>For more examples see the <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">AsciiDoc website</a> or the
|
|
58
|
-
distributed <code class="literal">doc/latexmath.txt</code> file.</p>
|
|
59
|
-
</div>
|
|
60
|
-
<div class="section" lang="en" xml:lang="en">
|
|
61
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
62
|
-
<a id="_asciimathml"></a>ASCIIMathML</h3></div></div></div>
|
|
63
|
-
<p><a class="ulink" href="http://www1.chapman.edu/~jipsen/mathml/asciimath.html" target="_top">ASCIIMathML</a>
|
|
64
|
-
formulas can be included in XHTML documents generated using the
|
|
65
|
-
<span class="emphasis"><em>xhtml11</em></span> backend. To enable ASCIIMathML support you must define the
|
|
66
|
-
<span class="emphasis"><em>asciimath</em></span> attribute, for example using the <code class="literal">-a asciimath</code>
|
|
67
|
-
command-line option. Example inline formula:</p>
|
|
68
|
-
<pre class="literallayout">asciimath:[`x/x={(1,if x!=0),(text{undefined},if x=0):}`]</pre>
|
|
69
|
-
<p>For more examples see the <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">AsciiDoc website</a> or the
|
|
70
|
-
distributed <code class="literal">doc/asciimathml.txt</code> file.</p>
|
|
71
|
-
</div>
|
|
72
|
-
<div class="section" lang="en" xml:lang="en">
|
|
73
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
74
|
-
<a id="_latexmathml"></a>LaTeXMathML</h3></div></div></div>
|
|
75
|
-
<p><span class="emphasis"><em>LaTeXMathML</em></span> allows LaTeX Math style formulas to be included in XHTML
|
|
76
|
-
documents generated using the AsciiDoc <span class="emphasis"><em>xhtml11</em></span> backend. AsciiDoc
|
|
77
|
-
uses the
|
|
78
|
-
<a class="ulink" href="http://www.maths.nottingham.ac.uk/personal/drw/lm.html" target="_top">original
|
|
79
|
-
LaTeXMathML</a> by Douglas Woodall. <span class="emphasis"><em>LaTeXMathML</em></span> is derived from
|
|
80
|
-
ASCIIMathML and is for users who are more familiar with or prefer
|
|
81
|
-
using LaTeX math formulas (it recognizes a subset of LaTeX Math, the
|
|
82
|
-
differences are documented on the <span class="emphasis"><em>LaTeXMathML</em></span> web page). To enable
|
|
83
|
-
LaTeXMathML support you must define the <span class="emphasis"><em>latexmath</em></span> attribute, for
|
|
84
|
-
example using the <code class="literal">-a latexmath</code> command-line option. Example inline
|
|
85
|
-
formula:</p>
|
|
86
|
-
<pre class="literallayout">latexmath:[$\sum_{n=1}^\infty \frac{1}{2^n}$]</pre>
|
|
87
|
-
<p>For more examples see the <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">AsciiDoc website</a> or the
|
|
88
|
-
distributed <code class="literal">doc/latexmathml.txt</code> file.</p>
|
|
89
|
-
</div>
|
|
90
|
-
<div class="section" lang="en" xml:lang="en">
|
|
91
|
-
<div class="titlepage"><div><div><h3 class="title">
|
|
92
|
-
<a id="_mathml"></a>MathML</h3></div></div></div>
|
|
93
|
-
<p><a class="ulink" href="http://www.w3.org/Math/" target="_top">MathML</a> is a low level XML markup for
|
|
94
|
-
mathematics. AsciiDoc has no macros for MathML but users familiar with
|
|
95
|
-
this markup could use passthrough macros and passthrough blocks to
|
|
96
|
-
include MathML in output documents.</p>
|
|
97
|
-
</div>
|
|
98
|
-
</div>
|
|
99
|
-
|
|
100
|
-
</div>
|
|
101
|
-
|
|
102
|
-
<hr/>
|
|
103
|
-
|
|
104
|
-
<div class="nav" id="navfooter">
|
|
105
|
-
<table width="100%">
|
|
106
|
-
<tr><td width="33%" align="left">
|
|
107
|
-
|
|
108
|
-
<a href="manpage_documents.html">Prev</a><br/>
|
|
109
|
-
Manpage Documents
|
|
110
|
-
|
|
111
|
-
</td><td width="33%" align="center">
|
|
112
|
-
|
|
113
|
-
<a href="index.html">Home</a><br/>
|
|
114
|
-
AsciiDoc User Guide
|
|
115
|
-
|
|
116
|
-
</td><td width="33%" align="right">
|
|
117
|
-
|
|
118
|
-
<a href="configuration_files.html">Next</a><br/>
|
|
119
|
-
Configuration Files
|
|
120
|
-
|
|
121
|
-
</td></tr>
|
|
122
|
-
</table>
|
|
123
|
-
</div>
|
|
124
|
-
</body>
|
|
125
|
-
</html>
|