gerbil 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/Rakefile +23 -12
- data/bin/gerbil +5 -4
- data/doc/api/classes/RDoc.html +164 -0
- data/doc/api/classes/RDoc.src/M000004.html +26 -0
- data/doc/api/classes/RDoc.src/M000005.html +59 -0
- data/doc/api/classes/RDoc/DummyMarkup.html +119 -0
- data/doc/api/classes/RDoc/DummyMixin.html +131 -0
- data/doc/api/classes/RDoc/DummyMixin.src/M000006.html +18 -0
- data/doc/api/classes/RDoc/DummyOptions.html +144 -0
- data/doc/api/classes/RDoc/DummyOptions.src/M000007.html +18 -0
- data/doc/api/classes/String.html +212 -0
- data/doc/api/classes/String.src/M000001.html +35 -0
- data/doc/api/classes/String.src/M000002.html +44 -0
- data/doc/api/classes/String.src/M000003.html +38 -0
- data/doc/api/created.rid +1 -0
- data/doc/api/files/lib/gerbil/html_rb.html +124 -0
- data/doc/api/files/lib/gerbil/rdoc_rb.html +116 -0
- data/doc/api/files/lib/gerbil_rb.html +125 -0
- data/doc/api/fr_class_index.html +31 -0
- data/doc/api/fr_file_index.html +29 -0
- data/doc/api/fr_method_index.html +33 -0
- data/doc/api/index.html +24 -0
- data/doc/api/rdoc-style.css +208 -0
- data/doc/guide.erb +13 -6
- data/doc/guide.html +144 -122
- data/fmt/html.yaml +14 -0
- data/lib/gerbil.rb +3 -3
- data/lib/gerbil/rdoc.rb +2 -2
- metadata +35 -4
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
|
|
2
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
3
|
+
<!DOCTYPE html
|
|
4
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
5
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
|
|
9
|
+
Classes
|
|
10
|
+
|
|
11
|
+
-->
|
|
12
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
13
|
+
<head>
|
|
14
|
+
<title>Classes</title>
|
|
15
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
16
|
+
<link rel="stylesheet" href="rdoc-style.css" type="text/css" />
|
|
17
|
+
<base target="docwin" />
|
|
18
|
+
</head>
|
|
19
|
+
<body>
|
|
20
|
+
<div id="index">
|
|
21
|
+
<h1 class="section-bar">Classes</h1>
|
|
22
|
+
<div id="index-entries">
|
|
23
|
+
<a href="classes/RDoc.html">RDoc</a><br />
|
|
24
|
+
<a href="classes/RDoc/DummyMarkup.html">RDoc::DummyMarkup</a><br />
|
|
25
|
+
<a href="classes/RDoc/DummyMixin.html">RDoc::DummyMixin</a><br />
|
|
26
|
+
<a href="classes/RDoc/DummyOptions.html">RDoc::DummyOptions</a><br />
|
|
27
|
+
<a href="classes/String.html">String</a><br />
|
|
28
|
+
</div>
|
|
29
|
+
</div>
|
|
30
|
+
</body>
|
|
31
|
+
</html>
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
|
|
2
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
3
|
+
<!DOCTYPE html
|
|
4
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
5
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
|
|
9
|
+
Files
|
|
10
|
+
|
|
11
|
+
-->
|
|
12
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
13
|
+
<head>
|
|
14
|
+
<title>Files</title>
|
|
15
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
16
|
+
<link rel="stylesheet" href="rdoc-style.css" type="text/css" />
|
|
17
|
+
<base target="docwin" />
|
|
18
|
+
</head>
|
|
19
|
+
<body>
|
|
20
|
+
<div id="index">
|
|
21
|
+
<h1 class="section-bar">Files</h1>
|
|
22
|
+
<div id="index-entries">
|
|
23
|
+
<a href="files/lib/gerbil_rb.html">lib/gerbil.rb</a><br />
|
|
24
|
+
<a href="files/lib/gerbil/html_rb.html">lib/gerbil/html.rb</a><br />
|
|
25
|
+
<a href="files/lib/gerbil/rdoc_rb.html">lib/gerbil/rdoc.rb</a><br />
|
|
26
|
+
</div>
|
|
27
|
+
</div>
|
|
28
|
+
</body>
|
|
29
|
+
</html>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
3
|
+
<!DOCTYPE html
|
|
4
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
5
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
6
|
+
|
|
7
|
+
<!--
|
|
8
|
+
|
|
9
|
+
Methods
|
|
10
|
+
|
|
11
|
+
-->
|
|
12
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
13
|
+
<head>
|
|
14
|
+
<title>Methods</title>
|
|
15
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
16
|
+
<link rel="stylesheet" href="rdoc-style.css" type="text/css" />
|
|
17
|
+
<base target="docwin" />
|
|
18
|
+
</head>
|
|
19
|
+
<body>
|
|
20
|
+
<div id="index">
|
|
21
|
+
<h1 class="section-bar">Methods</h1>
|
|
22
|
+
<div id="index-entries">
|
|
23
|
+
<a href="classes/RDoc.html#M000005">gen_method_infos (RDoc)</a><br />
|
|
24
|
+
<a href="classes/RDoc.html#M000004">gen_parse_trees (RDoc)</a><br />
|
|
25
|
+
<a href="classes/RDoc/DummyMixin.html#M000006">method_missing (RDoc::DummyMixin)</a><br />
|
|
26
|
+
<a href="classes/RDoc/DummyOptions.html#M000007">quiet (RDoc::DummyOptions)</a><br />
|
|
27
|
+
<a href="classes/String.html#M000003">thru_coderay (String)</a><br />
|
|
28
|
+
<a href="classes/String.html#M000002">thru_redcloth (String)</a><br />
|
|
29
|
+
<a href="classes/String.html#M000001">to_html (String)</a><br />
|
|
30
|
+
</div>
|
|
31
|
+
</div>
|
|
32
|
+
</body>
|
|
33
|
+
</html>
|
data/doc/api/index.html
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
|
5
|
+
|
|
6
|
+
<!--
|
|
7
|
+
|
|
8
|
+
RDoc Documentation
|
|
9
|
+
|
|
10
|
+
-->
|
|
11
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
12
|
+
<head>
|
|
13
|
+
<title>RDoc Documentation</title>
|
|
14
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
15
|
+
</head>
|
|
16
|
+
<frameset rows="20%, 80%">
|
|
17
|
+
<frameset cols="25%,35%,45%">
|
|
18
|
+
<frame src="fr_file_index.html" title="Files" name="Files" />
|
|
19
|
+
<frame src="fr_class_index.html" name="Classes" />
|
|
20
|
+
<frame src="fr_method_index.html" name="Methods" />
|
|
21
|
+
</frameset>
|
|
22
|
+
<frame src="files/lib/gerbil/html_rb.html" name="docwin" />
|
|
23
|
+
</frameset>
|
|
24
|
+
</html>
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
|
|
2
|
+
body {
|
|
3
|
+
font-family: Verdana,Arial,Helvetica,sans-serif;
|
|
4
|
+
font-size: 90%;
|
|
5
|
+
margin: 0;
|
|
6
|
+
margin-left: 40px;
|
|
7
|
+
padding: 0;
|
|
8
|
+
background: white;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
|
|
12
|
+
h1 { font-size: 150%; }
|
|
13
|
+
h2,h3,h4 { margin-top: 1em; }
|
|
14
|
+
|
|
15
|
+
a { background: #eef; color: #039; text-decoration: none; }
|
|
16
|
+
a:hover { background: #039; color: #eef; }
|
|
17
|
+
|
|
18
|
+
/* Override the base stylesheet's Anchor inside a table cell */
|
|
19
|
+
td > a {
|
|
20
|
+
background: transparent;
|
|
21
|
+
color: #039;
|
|
22
|
+
text-decoration: none;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/* and inside a section title */
|
|
26
|
+
.section-title > a {
|
|
27
|
+
background: transparent;
|
|
28
|
+
color: #eee;
|
|
29
|
+
text-decoration: none;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/* === Structural elements =================================== */
|
|
33
|
+
|
|
34
|
+
div#index {
|
|
35
|
+
margin: 0;
|
|
36
|
+
margin-left: -40px;
|
|
37
|
+
padding: 0;
|
|
38
|
+
font-size: 90%;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
div#index a {
|
|
43
|
+
margin-left: 0.7em;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
div#index .section-bar {
|
|
47
|
+
margin-left: 0px;
|
|
48
|
+
padding-left: 0.7em;
|
|
49
|
+
background: #ccc;
|
|
50
|
+
font-size: small;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
div#classHeader, div#fileHeader {
|
|
55
|
+
width: auto;
|
|
56
|
+
color: white;
|
|
57
|
+
padding: 0.5em 1.5em 0.5em 1.5em;
|
|
58
|
+
margin: 0;
|
|
59
|
+
margin-left: -40px;
|
|
60
|
+
border-bottom: 3px solid #006;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
div#classHeader a, div#fileHeader a {
|
|
64
|
+
background: inherit;
|
|
65
|
+
color: white;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
div#classHeader td, div#fileHeader td {
|
|
69
|
+
background: inherit;
|
|
70
|
+
color: white;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
div#fileHeader {
|
|
75
|
+
background: #057;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
div#classHeader {
|
|
79
|
+
background: #048;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
.class-name-in-header {
|
|
84
|
+
font-size: 180%;
|
|
85
|
+
font-weight: bold;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
div#bodyContent {
|
|
90
|
+
padding: 0 1.5em 0 1.5em;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
div#description {
|
|
94
|
+
padding: 0.5em 1.5em;
|
|
95
|
+
background: #efefef;
|
|
96
|
+
border: 1px dotted #999;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
div#description h1,h2,h3,h4,h5,h6 {
|
|
100
|
+
color: #125;;
|
|
101
|
+
background: transparent;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
div#validator-badges {
|
|
105
|
+
text-align: center;
|
|
106
|
+
}
|
|
107
|
+
div#validator-badges img { border: 0; }
|
|
108
|
+
|
|
109
|
+
div#copyright {
|
|
110
|
+
color: #333;
|
|
111
|
+
background: #efefef;
|
|
112
|
+
font: 0.75em sans-serif;
|
|
113
|
+
margin-top: 5em;
|
|
114
|
+
margin-bottom: 0;
|
|
115
|
+
padding: 0.5em 2em;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
/* === Classes =================================== */
|
|
120
|
+
|
|
121
|
+
table.header-table {
|
|
122
|
+
color: white;
|
|
123
|
+
font-size: small;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
.type-note {
|
|
127
|
+
font-size: small;
|
|
128
|
+
color: #DEDEDE;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
.xxsection-bar {
|
|
132
|
+
background: #eee;
|
|
133
|
+
color: #333;
|
|
134
|
+
padding: 3px;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
.section-bar {
|
|
138
|
+
color: #333;
|
|
139
|
+
border-bottom: 1px solid #999;
|
|
140
|
+
margin-left: -20px;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
.section-title {
|
|
145
|
+
background: #79a;
|
|
146
|
+
color: #eee;
|
|
147
|
+
padding: 3px;
|
|
148
|
+
margin-top: 2em;
|
|
149
|
+
margin-left: -30px;
|
|
150
|
+
border: 1px solid #999;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
.top-aligned-row { vertical-align: top }
|
|
154
|
+
.bottom-aligned-row { vertical-align: bottom }
|
|
155
|
+
|
|
156
|
+
/* --- Context section classes ----------------------- */
|
|
157
|
+
|
|
158
|
+
.context-row { }
|
|
159
|
+
.context-item-name { font-family: monospace; font-weight: bold; color: black; }
|
|
160
|
+
.context-item-value { font-size: small; color: #448; }
|
|
161
|
+
.context-item-desc { color: #333; padding-left: 2em; }
|
|
162
|
+
|
|
163
|
+
/* --- Method classes -------------------------- */
|
|
164
|
+
.method-detail {
|
|
165
|
+
background: #efefef;
|
|
166
|
+
padding: 0;
|
|
167
|
+
margin-top: 0.5em;
|
|
168
|
+
margin-bottom: 1em;
|
|
169
|
+
border: 1px dotted #ccc;
|
|
170
|
+
}
|
|
171
|
+
.method-heading {
|
|
172
|
+
color: black;
|
|
173
|
+
background: #ccc;
|
|
174
|
+
border-bottom: 1px solid #666;
|
|
175
|
+
padding: 0.2em 0.5em 0 0.5em;
|
|
176
|
+
}
|
|
177
|
+
.method-signature { color: black; background: inherit; }
|
|
178
|
+
.method-name { font-weight: bold; }
|
|
179
|
+
.method-args { font-style: italic; }
|
|
180
|
+
.method-description { padding: 0 0.5em 0 0.5em; }
|
|
181
|
+
|
|
182
|
+
/* --- Source code sections -------------------- */
|
|
183
|
+
|
|
184
|
+
a.source-toggle { font-size: 90%; }
|
|
185
|
+
div.method-source-code {
|
|
186
|
+
background: #262626;
|
|
187
|
+
color: #ffdead;
|
|
188
|
+
margin: 1em;
|
|
189
|
+
padding: 0.5em;
|
|
190
|
+
border: 1px dashed #999;
|
|
191
|
+
overflow: hidden;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
div.method-source-code pre { color: #ffdead; overflow: hidden; }
|
|
195
|
+
|
|
196
|
+
/* --- Ruby keyword styles --------------------- */
|
|
197
|
+
|
|
198
|
+
.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
|
|
199
|
+
|
|
200
|
+
.ruby-constant { color: #7fffd4; background: transparent; }
|
|
201
|
+
.ruby-keyword { color: #00ffff; background: transparent; }
|
|
202
|
+
.ruby-ivar { color: #eedd82; background: transparent; }
|
|
203
|
+
.ruby-operator { color: #00ffee; background: transparent; }
|
|
204
|
+
.ruby-identifier { color: #ffdead; background: transparent; }
|
|
205
|
+
.ruby-node { color: #ffa07a; background: transparent; }
|
|
206
|
+
.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
|
|
207
|
+
.ruby-regexp { color: #ffa07a; background: transparent; }
|
|
208
|
+
.ruby-value { color: #7fffd4; background: transparent; }
|
data/doc/guide.erb
CHANGED
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
|
|
23
23
|
Gerbil is *lighter* and more *flexible* than "DocBook":http://www.docbook.org, "Deplate":http://deplate.sourceforge.net, and "SiSU":http://www.jus.uio.no/sisu/SiSU/ because it is small, fast, and lets you <%= xref "HelloWorld", "define your own custom format" %>. Furthermore, Gerbil is *scriptable* unlike raw text generators such as "AsciiDoc":http://www.methods.co.nz/asciidoc/, "txt2tags":http://txt2tags.sourceforge.net, and "Grutatxt":http://www.triptico.com/software/grutatxt.html because it lets you inject Ruby code directly into your documents for dynamic content generation.
|
|
24
24
|
|
|
25
|
-
Gerbil is *open-source software* (see <%= xref "License" %>) so feel free to contribute your improvements and discuss your ideas in the <%= mailing_list_link %>. You can obtain the source code from
|
|
25
|
+
Gerbil is *open-source software* (see <%= xref "License" %>) so feel free to contribute your improvements and discuss your ideas in the <%= mailing_list_link %>. You can obtain the source code from the project "Darcs":http://darcs.net repository by running the following command:
|
|
26
26
|
|
|
27
27
|
darcs get <%= source_repo_url %> gerbil
|
|
28
28
|
|
|
@@ -41,10 +41,15 @@
|
|
|
41
41
|
<%=h File.read('LICENSE') %>
|
|
42
42
|
<% end %>
|
|
43
43
|
|
|
44
|
-
<% section "
|
|
45
|
-
* "Announcements":<%= feed_url %> !<%= feed_icon_url %>(RSS icon)!
|
|
46
|
-
|
|
47
|
-
* "
|
|
44
|
+
<% section "Resources" do %>
|
|
45
|
+
* "Announcements":<%= feed_url %> !<%= feed_icon_url %>(RSS icon)!
|
|
46
|
+
- project news and release announcements.
|
|
47
|
+
* "Download area":<%= download_url %>
|
|
48
|
+
- place to obtain release packages.
|
|
49
|
+
* "Mailing list":<%= mailing_list_url %>
|
|
50
|
+
- ask questions, get help, discuss.
|
|
51
|
+
* "API reference":api/
|
|
52
|
+
- documentation for all Ruby code provided with Gerbil.
|
|
48
53
|
<% end %>
|
|
49
54
|
|
|
50
55
|
<% section "Testimonials" do %>
|
|
@@ -76,7 +81,8 @@
|
|
|
76
81
|
# Download the newest release package from "the download area":<%= download_url %>.
|
|
77
82
|
# Extract the release package anywhere you want on your system.
|
|
78
83
|
# Go inside the extracted directory and run the following command:
|
|
79
|
-
|
|
84
|
+
|
|
85
|
+
ruby bin/gerbil -v
|
|
80
86
|
|
|
81
87
|
If the installation was successful, then you will see output like this: <pre><%=h `ruby bin/gerbil -v` %></pre>
|
|
82
88
|
|
|
@@ -103,6 +109,7 @@
|
|
|
103
109
|
* <tt>doc/</tt> - contains the user guide and other documentation.
|
|
104
110
|
** <tt>gerbil.svg</tt> - the source file of the Gerbil logo.
|
|
105
111
|
** <tt>guide.erb</tt> - the source file of this user guide.
|
|
112
|
+
** <tt>api/</tt> - contains API reference documentation for the provided Ruby code.
|
|
106
113
|
* <tt>LICENSE</tt> - the project license and copyright notice.
|
|
107
114
|
<% end %>
|
|
108
115
|
|
data/doc/guide.html
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
|
5
|
-
<meta name="date" content="
|
|
5
|
+
<meta name="date" content="22 January 2008"/>
|
|
6
6
|
<meta name="author" content="Suraj N. Kurapati"/>
|
|
7
|
-
<meta name="generator" content="Gerbil 1.
|
|
7
|
+
<meta name="generator" content="Gerbil 1.1.0"/>
|
|
8
8
|
<link rel="alternate" type="application/rss+xml" href="http://gerbil.rubyforge.org/news.xml"/>
|
|
9
|
-
<title>Gerbil 1.
|
|
9
|
+
<title>Gerbil 1.1.0 user guide</title>
|
|
10
10
|
|
|
11
11
|
<style type="text/css" media="screen">
|
|
12
12
|
body
|
|
@@ -319,6 +319,20 @@
|
|
|
319
319
|
border : none;
|
|
320
320
|
}
|
|
321
321
|
|
|
322
|
+
/*
|
|
323
|
+
mark external links with a symbol to help the user
|
|
324
|
+
distinguish between internal and external links
|
|
325
|
+
*/
|
|
326
|
+
a:after
|
|
327
|
+
{
|
|
328
|
+
content: "∗";
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
a[href^="#"]:after
|
|
332
|
+
{
|
|
333
|
+
content: "";
|
|
334
|
+
}
|
|
335
|
+
|
|
322
336
|
/* source code */
|
|
323
337
|
|
|
324
338
|
tt,
|
|
@@ -748,21 +762,21 @@
|
|
|
748
762
|
<body>
|
|
749
763
|
<div id="header">
|
|
750
764
|
<img src="gerbil.png" alt="Gerbil logo" title="Gerbil logo"/>
|
|
751
|
-
<h1 class="title">Gerbil 1.
|
|
765
|
+
<h1 class="title">Gerbil 1.1.0 user guide</h1>
|
|
752
766
|
<h2 class="authors"><a href="http://snk.tuxfamily.org">Suraj N. Kurapati</a></h2>
|
|
753
|
-
<h3 class="date">
|
|
767
|
+
<h3 class="date">22 January 2008</h3>
|
|
754
768
|
</div>
|
|
755
769
|
|
|
756
770
|
|
|
757
|
-
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-
|
|
771
|
+
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-605850848" href="#Introduction">Introduction</a><ul><li>1.1 <a id="a-606403768" href="#Features">Features</a></li><li>1.2 <a id="a-606414148" href="#License">License</a></li><li>1.3 <a id="a-606420778" href="#Resources">Resources</a></li><li>1.4 <a id="a-606425838" href="#Testimonials">Testimonials</a></li></ul></li><li>2 <a id="a-606430548" href="#Setup">Setup</a><ul><li>2.1 <a id="a-606433878" href="#Requirements">Requirements</a></li><li>2.2 <a id="a-606445148" href="#Installation">Installation</a></li><li>2.3 <a id="a-606450378" href="#Manifest">Manifest</a></li><li>2.4 <a id="a-606469758" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3 <a id="a-606475308" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="a-606495388" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="a-606506338" href="#Node.class">The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class</a></li></ul></li><li>3.2 <a id="a-606511988" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="a-606522728" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="a-606530908" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="a-606537868" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="a-606540548" href="#HelloWorld">Creating your own custom format</a></li></ul></li></ul></li><li>4 <a id="a-606572528" href="#Usage">Usage</a><ul><li>4.1 <a id="a-606579038" href="#include">The <strong>include</strong> directive</a></li><li>4.2 <a id="a-606581928" href="#unindent">The <code class="code"><span style="color:#d70; font-weight:bold">$unindent</span></code> variable</a></li></ul></li><li>5 <a id="a-606587218" href="#Formats">Formats</a><ul><li>5.1 <a id="a-606593188" href="#html">HTML</a><ul><li>5.1.1 <a id="a-606596138" href="#Text-to-HTML-conversion">Text to HTML conversion</a><ul><li>5.1.1.1 <a id="a-606600398" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="a-606603748" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="a-606607298" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="a-606610078" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="a-606613988" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="a-606619058" href="#Methods">Methods</a></li><li>5.1.4 <a id="a-607056648" href="#html.nodes">Nodes</a><ul><li>5.1.4.1 <a id="a-607061138" href="#Structure">Structure</a><ul><li>5.1.4.1.1 <a id="a-607062818" href="#html.nodes.header">header</a></li><li>5.1.4.1.2 <a id="a-607064888" href="#html.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="a-607067338" href="#html.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="a-607070998" href="#html.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="a-607088368" href="#Organization">Organization</a><ul><li>5.1.4.2.1 <a id="a-607091258" href="#html.nodes.part">part</a><ul><li>5.1.4.2.1.1 <a id="a-607093188" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.2 <a id="a-607103588" href="#html.nodes.chapter">chapter</a><ul><li>5.1.4.2.2.1 <a id="a-607111178" href="#An-example-607429468">An example</a></li></ul></li><li>5.1.4.2.3 <a id="a-607122318" href="#html.nodes.section">section</a><ul><li>5.1.4.2.3.1 <a id="a-607129768" href="#An-example-607473738">An example</a></li></ul></li><li>5.1.4.2.4 <a id="a-607140508" href="#html.nodes.paragraph">paragraph</a></li></ul></li><li>5.1.4.3 <a id="a-607158488" href="#Admonitions">Admonitions</a><ul><li>5.1.4.3.1 <a id="a-607173688" href="#html.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="a-607197698" href="#html.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="a-607213238" href="#html.nodes.important">important</a></li><li>5.1.4.3.4 <a id="a-607230378" href="#html.nodes.note">note</a></li><li>5.1.4.3.5 <a id="a-607243718" href="#html.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="a-607262008" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="a-607265358" href="#html.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="a-607269308" href="#html.nodes.table">table</a></li><li>5.1.4.4.3 <a id="a-607273288" href="#html.nodes.example">example</a></li><li>5.1.4.4.4 <a id="a-607277258" href="#html.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="a-607281298" href="#html.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="a-607285768" href="#Bibliography">Bibliography</a><ul><li>5.1.4.5.1 <a id="a-607287568" href="#html.nodes.reference">reference</a></li><li>5.1.4.5.2 <a id="a-607296008" href="#html.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="a-607305848" href="#text">Plain text</a></li><li>5.3 <a id="a-607311408" href="#latex">LaTeX</a></li><li>5.4 <a id="a-607316408" href="#man">UNIX man page</a></li></ul></li></ul></div>
|
|
758
772
|
|
|
759
|
-
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-
|
|
773
|
+
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-607209208" href="#An-example-607569808">An example</a></li></ol><h1>Equations</h1> <ol><li><a id="a-607279008" href="#An-example-607209188">An example</a></li></ol><h1>Examples</h1> <ol><li><a id="a-606559528" href="#HelloWorld.spec">HelloWorld format specification file</a></li><li><a id="a-606564398" href="#HelloWorld.input">Input document for HelloWorld format</a></li><li><a id="a-606568308" href="#HelloWorld.output">Output of HelloWorld format</a></li><li><a id="a-607275008" href="#An-example-607053988">An example</a></li></ol><h1>Figures</h1> <ol><li><a id="a-607267018" href="#An-example-607703968">An example</a></li></ol><h1>Importants</h1> <ol><li><a id="a-607225448" href="#An-example-607601028">An example</a></li></ol><h1>Notes</h1> <ol><li><a id="a-605759468" href="#See-the-source-of-this-guide">See the source of this guide</a></li><li><a id="a-606554688" href="#Author-s-note-about-documentation-quality">Author’s note about documentation quality</a></li><li><a id="a-607239848" href="#An-example-607637408">An example</a></li></ol><h1>Procedures</h1> <ol><li><a id="a-607283078" href="#An-example-607299988">An example</a></li></ol><h1>Tables</h1> <ol><li><a id="a-607270998" href="#An-example-607008348">An example</a></li></ol><h1>Tips</h1> <ol><li><a id="a-607254868" href="#An-example-607668348">An example</a></li></ol><h1>Warnings</h1> <ol><li><a id="a-607185678" href="#An-example-607540568">An example</a></li></ol></div>
|
|
760
774
|
|
|
761
775
|
<div id="content">
|
|
762
776
|
<div class="chapter">
|
|
763
777
|
<h1 class="title">
|
|
764
778
|
Chapter
|
|
765
|
-
<a class="toc" id="Introduction" href="#a-
|
|
779
|
+
<a class="toc" id="Introduction" href="#a-605850848">1</a>
|
|
766
780
|
|
|
767
781
|
<br/>
|
|
768
782
|
|
|
@@ -775,14 +789,14 @@
|
|
|
775
789
|
<p>Gerbil is <strong>lighter</strong> and more <strong>flexible</strong> than <a href="http://www.docbook.org">DocBook</a>, <a href="http://deplate.sourceforge.net">Deplate</a>, and <a href="http://www.jus.uio.no/sisu/SiSU/">SiSU</a> because it is small, fast, and lets you <a class="xref" href="#HelloWorld">define your own custom format</a>. Furthermore, Gerbil is <strong>scriptable</strong> unlike raw text generators such as <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a>, <a href="http://txt2tags.sourceforge.net">txt2tags</a>, and <a href="http://www.triptico.com/software/grutatxt.html">Grutatxt</a> because it lets you inject Ruby code directly into your documents for dynamic content generation.</p>
|
|
776
790
|
|
|
777
791
|
|
|
778
|
-
<p>Gerbil is <strong>open-source software</strong> (see <a class="xref" href="#License">Section 1.2: <em>License</em></a>) so feel free to contribute your improvements and discuss your ideas in the <a href="http://rubyforge.org/mailman/listinfo/gerbil-talk">project mailing list</a>. You can obtain the source code from
|
|
792
|
+
<p>Gerbil is <strong>open-source software</strong> (see <a class="xref" href="#License">Section 1.2: <em>License</em></a>) so feel free to contribute your improvements and discuss your ideas in the <a href="http://rubyforge.org/mailman/listinfo/gerbil-talk">project mailing list</a>. You can obtain the source code from the project <a href="http://darcs.net">Darcs</a> repository by running the following command:</p>
|
|
779
793
|
|
|
780
794
|
|
|
781
795
|
<pre>darcs get http://gerbil.rubyforge.org/src gerbil</pre>
|
|
782
796
|
|
|
783
797
|
|
|
784
798
|
<p><div class="note">
|
|
785
|
-
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-
|
|
799
|
+
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-605759468">Note 1</a>. See the source of this guide</p>
|
|
786
800
|
|
|
787
801
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
788
802
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -847,7 +861,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
847
861
|
</div>
|
|
848
862
|
<div class="section">
|
|
849
863
|
<h2 class="title">
|
|
850
|
-
<a class="toc" id="Features" href="#a-
|
|
864
|
+
<a class="toc" id="Features" href="#a-606403768">1.1</a> Features
|
|
851
865
|
</h2>
|
|
852
866
|
<div class="content"><ul>
|
|
853
867
|
<li>Composed of <strong>less than 200 lines</strong> of code!</li>
|
|
@@ -858,7 +872,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
858
872
|
</div>
|
|
859
873
|
<div class="section">
|
|
860
874
|
<h2 class="title">
|
|
861
|
-
<a class="toc" id="License" href="#a-
|
|
875
|
+
<a class="toc" id="License" href="#a-606414148">1.2</a> License
|
|
862
876
|
</h2>
|
|
863
877
|
<div class="content"><p>Copyright 2006 Suraj N. Kurapati <SNK at GNA dot ORG></p>
|
|
864
878
|
|
|
@@ -894,17 +908,22 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
894
908
|
</div>
|
|
895
909
|
<div class="section">
|
|
896
910
|
<h2 class="title">
|
|
897
|
-
<a class="toc" id="
|
|
911
|
+
<a class="toc" id="Resources" href="#a-606420778">1.3</a> Resources
|
|
898
912
|
</h2>
|
|
899
913
|
<div class="content"><ul>
|
|
900
|
-
<li><a href="http://gerbil.rubyforge.org/news.xml">Announcements</a> <img src="http://gerbil.rubyforge.org/feed-icon-28x28.png" title="RSS icon" alt="RSS icon" />
|
|
901
|
-
|
|
902
|
-
<li><a href="http://rubyforge.org/
|
|
914
|
+
<li><a href="http://gerbil.rubyforge.org/news.xml">Announcements</a> <img src="http://gerbil.rubyforge.org/feed-icon-28x28.png" title="RSS icon" alt="RSS icon" />
|
|
915
|
+
– project news and release announcements.</li>
|
|
916
|
+
<li><a href="http://rubyforge.org/frs/?group_id=4905">Download area</a>
|
|
917
|
+
– place to obtain release packages.</li>
|
|
918
|
+
<li><a href="http://rubyforge.org/mailman/listinfo/gerbil-talk">Mailing list</a>
|
|
919
|
+
– ask questions, get help, discuss.</li>
|
|
920
|
+
<li><a href="api/">API reference</a>
|
|
921
|
+
– documentation for all Ruby code provided with Gerbil.</li>
|
|
903
922
|
</ul></div>
|
|
904
923
|
</div>
|
|
905
924
|
<div class="section">
|
|
906
925
|
<h2 class="title">
|
|
907
|
-
<a class="toc" id="Testimonials" href="#a-
|
|
926
|
+
<a class="toc" id="Testimonials" href="#a-606425838">1.4</a> Testimonials
|
|
908
927
|
</h2>
|
|
909
928
|
<div class="content"><blockquote>
|
|
910
929
|
<p>I actually felt like printing it [the user guide], because it’s just so well-thought typographically… Even if it [Gerbil] weren’t great by itself, I’d feel good just looking at the manual. —<a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052"><em>Vitor Peres</em> in [ruby-talk:283052]</a></p>
|
|
@@ -914,7 +933,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
914
933
|
<div class="chapter">
|
|
915
934
|
<h1 class="title">
|
|
916
935
|
Chapter
|
|
917
|
-
<a class="toc" id="Setup" href="#a-
|
|
936
|
+
<a class="toc" id="Setup" href="#a-606430548">2</a>
|
|
918
937
|
|
|
919
938
|
<br/>
|
|
920
939
|
|
|
@@ -923,7 +942,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
923
942
|
|
|
924
943
|
<div class="content"><div class="section">
|
|
925
944
|
<h2 class="title">
|
|
926
|
-
<a class="toc" id="Requirements" href="#a-
|
|
945
|
+
<a class="toc" id="Requirements" href="#a-606433878">2.1</a> Requirements
|
|
927
946
|
</h2>
|
|
928
947
|
<div class="content"><p>Your system needs the following software to run Gerbil.</p>
|
|
929
948
|
|
|
@@ -957,7 +976,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
957
976
|
</div>
|
|
958
977
|
<div class="section">
|
|
959
978
|
<h2 class="title">
|
|
960
|
-
<a class="toc" id="Installation" href="#a-
|
|
979
|
+
<a class="toc" id="Installation" href="#a-606445148">2.2</a> Installation
|
|
961
980
|
</h2>
|
|
962
981
|
<div class="content"><p>If your system has <a href="http://rubygems.org/">RubyGems</a>, then you can install Gerbil by running the following commands:</p>
|
|
963
982
|
|
|
@@ -970,12 +989,14 @@ Otherwise, follow these instructions:
|
|
|
970
989
|
<ol>
|
|
971
990
|
<li>Download the newest release package from <a href="http://rubyforge.org/frs/?group_id=4905">the download area</a>.</li>
|
|
972
991
|
<li>Extract the release package anywhere you want on your system.</li>
|
|
973
|
-
<li>Go inside the extracted directory and run the following command
|
|
974
|
-
<pre>ruby bin/gerbil -v</pre></li>
|
|
992
|
+
<li>Go inside the extracted directory and run the following command:</li>
|
|
975
993
|
</ol>
|
|
976
994
|
|
|
977
995
|
|
|
978
|
-
<
|
|
996
|
+
<pre>ruby bin/gerbil -v</pre>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 1.1.0 (2008-01-22) http://gerbil.rubyforge.org /home/sun/src/gerbil
|
|
979
1000
|
</pre></p>
|
|
980
1001
|
|
|
981
1002
|
|
|
@@ -983,7 +1004,7 @@ Otherwise, follow these instructions:
|
|
|
983
1004
|
</div>
|
|
984
1005
|
<div class="section">
|
|
985
1006
|
<h2 class="title">
|
|
986
|
-
<a class="toc" id="Manifest" href="#a-
|
|
1007
|
+
<a class="toc" id="Manifest" href="#a-606450378">2.3</a> Manifest
|
|
987
1008
|
</h2>
|
|
988
1009
|
<div class="content">Now that Gerbil is installed on your system, let us examine its installation directory.
|
|
989
1010
|
<ul>
|
|
@@ -1022,6 +1043,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1022
1043
|
<ul>
|
|
1023
1044
|
<li><tt>gerbil.svg</tt> – the source file of the Gerbil logo.</li>
|
|
1024
1045
|
<li><tt>guide.erb</tt> – the source file of this user guide.</li>
|
|
1046
|
+
<li><tt>api/</tt> – contains API reference documentation for the provided Ruby code.</li>
|
|
1025
1047
|
</ul>
|
|
1026
1048
|
</li>
|
|
1027
1049
|
<li><tt>LICENSE</tt> – the project license and copyright notice.</li>
|
|
@@ -1029,7 +1051,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1029
1051
|
</div>
|
|
1030
1052
|
<div class="section">
|
|
1031
1053
|
<h2 class="title">
|
|
1032
|
-
<a class="toc" id="Version-numbering-system" href="#a-
|
|
1054
|
+
<a class="toc" id="Version-numbering-system" href="#a-606469758">2.4</a> Version numbering system
|
|
1033
1055
|
</h2>
|
|
1034
1056
|
<div class="content">Gerbil uses the <a href="http://www.rubygems.org/read/chapter/7">RubyGems rational versioning policy</a> to number its releases. This <strong>major.minor.patch</strong> numbering policy <a href="http://ablog.apress.com/?p=738">is summarized</a> as follows.
|
|
1035
1057
|
|
|
@@ -1065,7 +1087,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1065
1087
|
<div class="chapter">
|
|
1066
1088
|
<h1 class="title">
|
|
1067
1089
|
Chapter
|
|
1068
|
-
<a class="toc" id="Theory-of-operation" href="#a-
|
|
1090
|
+
<a class="toc" id="Theory-of-operation" href="#a-606475308">3</a>
|
|
1069
1091
|
|
|
1070
1092
|
<br/>
|
|
1071
1093
|
|
|
@@ -1097,7 +1119,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1097
1119
|
|
|
1098
1120
|
<p><div class="section">
|
|
1099
1121
|
<h2 class="title">
|
|
1100
|
-
<a class="toc" id="Nodes" href="#a-
|
|
1122
|
+
<a class="toc" id="Nodes" href="#a-606495388">3.1</a> Nodes
|
|
1101
1123
|
</h2>
|
|
1102
1124
|
<div class="content"><p>A node is a block of text that appears like this:</p>
|
|
1103
1125
|
|
|
@@ -1155,7 +1177,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1155
1177
|
|
|
1156
1178
|
<p><div class="section">
|
|
1157
1179
|
<h3 class="title">
|
|
1158
|
-
<a class="toc" id="Node.class" href="#a-
|
|
1180
|
+
<a class="toc" id="Node.class" href="#a-606506338">3.1.1</a> The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class
|
|
1159
1181
|
</h3>
|
|
1160
1182
|
<div class="content"><p>When Gerbil builds a document tree from nodes present in an input document, it stores information about these nodes into <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> objects. A <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> object has the following properties (methods):</p>
|
|
1161
1183
|
|
|
@@ -1231,7 +1253,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1231
1253
|
</div>
|
|
1232
1254
|
<div class="section">
|
|
1233
1255
|
<h2 class="title">
|
|
1234
|
-
<a class="toc" id="SpecFile" href="#a-
|
|
1256
|
+
<a class="toc" id="SpecFile" href="#a-606511988">3.2</a> Format specification file
|
|
1235
1257
|
</h2>
|
|
1236
1258
|
<div class="content"><p>A format specification file is a plain-text file marked up in <a href="http://yaml4r.sourceforge.net/cookbook/">YAML syntax</a>. Through the following parameters, it defines (1) what types of nodes an input document may contain, (2) how the content of those nodes is transformed into output, and (3) how the processed document is transformed into the output document.</p>
|
|
1237
1259
|
|
|
@@ -1269,7 +1291,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1269
1291
|
|
|
1270
1292
|
<p><div class="section">
|
|
1271
1293
|
<h3 class="title">
|
|
1272
|
-
<a class="toc" id="SpecFile.nodes" href="#a-
|
|
1294
|
+
<a class="toc" id="SpecFile.nodes" href="#a-606522728">3.2.1</a> Node definition
|
|
1273
1295
|
</h3>
|
|
1274
1296
|
<div class="content"><p>A node definition is a mapping from a name (the “node type”) to the following set of parameters:</p>
|
|
1275
1297
|
|
|
@@ -1310,7 +1332,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1310
1332
|
|
|
1311
1333
|
<p><div class="section">
|
|
1312
1334
|
<h4 class="title">
|
|
1313
|
-
<a class="toc" id="SpecFile.nodes.output" href="#a-
|
|
1335
|
+
<a class="toc" id="SpecFile.nodes.output" href="#a-606530908">3.2.1.1</a> Node output template
|
|
1314
1336
|
</h4>
|
|
1315
1337
|
<div class="content"><p>A node output template (the <strong>output</strong> parameter in a node definition) is an eRuby template that transforms a node’s content into output. During the processing stage, Gerbil replaces all nodes in the input document with the result of this template <em>unless</em> the <strong>silent</strong> parameter is enabled in this node’s definition.</p>
|
|
1316
1338
|
|
|
@@ -1378,7 +1400,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1378
1400
|
</div>
|
|
1379
1401
|
<div class="section">
|
|
1380
1402
|
<h3 class="title">
|
|
1381
|
-
<a class="toc" id="SpecFile.output" href="#a-
|
|
1403
|
+
<a class="toc" id="SpecFile.output" href="#a-606537868">3.2.2</a> Document output template
|
|
1382
1404
|
</h3>
|
|
1383
1405
|
<div class="content"><p>A document output template (the <strong>output</strong> parameter in a format specification file) is an eRuby template that transforms a processed document into the final output document.</p>
|
|
1384
1406
|
|
|
@@ -1445,7 +1467,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1445
1467
|
</div>
|
|
1446
1468
|
<div class="section">
|
|
1447
1469
|
<h3 class="title">
|
|
1448
|
-
<a class="toc" id="HelloWorld" href="#a-
|
|
1470
|
+
<a class="toc" id="HelloWorld" href="#a-606540548">3.2.3</a> Creating your own custom format
|
|
1449
1471
|
</h3>
|
|
1450
1472
|
<div class="content">Here is a working example to help you digest all that you’ve learned so far about format specification files. A few things to notice in this example are:
|
|
1451
1473
|
<ul>
|
|
@@ -1464,7 +1486,7 @@ To run this example, perform the following steps:
|
|
|
1464
1486
|
|
|
1465
1487
|
|
|
1466
1488
|
<p><div class="note">
|
|
1467
|
-
<p class="title"><a class="toc" id="Author-s-note-about-documentation-quality" href="#a-
|
|
1489
|
+
<p class="title"><a class="toc" id="Author-s-note-about-documentation-quality" href="#a-606554688">Note 2</a>. Author’s note about documentation quality</p>
|
|
1468
1490
|
|
|
1469
1491
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
1470
1492
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -1534,7 +1556,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
1534
1556
|
<p>On the other hand, if you have ideas on how to improve this example, please speak up in the <a href="http://rubyforge.org/mailman/listinfo/gerbil-talk">project mailing list</a>. Thanks!</p></div>
|
|
1535
1557
|
</div>
|
|
1536
1558
|
<div class="example">
|
|
1537
|
-
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-
|
|
1559
|
+
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606559528">Example 1</a>. HelloWorld format specification file</p>
|
|
1538
1560
|
<div class="content"><pre class="code" lang="rhtml">
|
|
1539
1561
|
desc: A illustrative format.
|
|
1540
1562
|
|
|
@@ -1606,7 +1628,7 @@ output: |
|
|
|
1606
1628
|
</pre></div>
|
|
1607
1629
|
</div>
|
|
1608
1630
|
<div class="example">
|
|
1609
|
-
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-
|
|
1631
|
+
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-606564398">Example 2</a>. Input document for HelloWorld format</p>
|
|
1610
1632
|
<div class="content"><pre class="code" lang="rhtml">
|
|
1611
1633
|
<span style="background: #eee"><span style="color:black"><%</span> <span style="color:#d70; font-weight:bold">$style</span> = <span style="background-color:#fff0f0"><span style="color:#710">"</span><span style="color:#D20">border-left: thick solid salmon; padding-left: 1em;</span><span style="color:#710">"</span></span> <span style="color:black">%></span></span>
|
|
1612
1634
|
<span style="background: #eee"><span style="color:black"><%</span> hello <span style="background-color:#fff0f0"><span style="color:#710">"</span><span style="color:#D20">Pretentious</span><span style="color:#710">"</span></span> <span style="color:#080; font-weight:bold">do</span> <span style="color:black">%></span></span>
|
|
@@ -1648,10 +1670,10 @@ output: |
|
|
|
1648
1670
|
</pre></div>
|
|
1649
1671
|
</div>
|
|
1650
1672
|
<div class="example">
|
|
1651
|
-
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-
|
|
1673
|
+
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-606568308">Example 3</a>. Output of HelloWorld format</p>
|
|
1652
1674
|
<div class="content">Welcome to the “HelloWorld” format.
|
|
1653
|
-
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “
|
|
1654
|
-
My name is “
|
|
1675
|
+
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “zeh”</h1>
|
|
1676
|
+
My name is “zeh” and these are my properties:
|
|
1655
1677
|
<table border="1">
|
|
1656
1678
|
<tr>
|
|
1657
1679
|
<th>Property</th>
|
|
@@ -1671,14 +1693,14 @@ My name is “gel” and these are my properties:
|
|
|
1671
1693
|
</tr>
|
|
1672
1694
|
<tr>
|
|
1673
1695
|
<td>trace</td>
|
|
1674
|
-
<td><ul><li>INPUT:1</li><li>bin/gerbil:
|
|
1696
|
+
<td><ul><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1675
1697
|
</tr>
|
|
1676
1698
|
<tr>
|
|
1677
1699
|
<td>content</td>
|
|
1678
1700
|
<td> <big>I’m</big> the very first node, oh <em>yes</em> I am! <strong>sneer</strong>
|
|
1679
1701
|
|
|
1680
|
-
<h1>hello #1.1: “
|
|
1681
|
-
My name is “
|
|
1702
|
+
<h1>hello #1.1: “posobet”</h1>
|
|
1703
|
+
My name is “posobet” and these are my properties:
|
|
1682
1704
|
<table border="1">
|
|
1683
1705
|
<tr>
|
|
1684
1706
|
<th>Property</th>
|
|
@@ -1698,14 +1720,14 @@ My name is “guvamuy” and these are my properties:
|
|
|
1698
1720
|
</tr>
|
|
1699
1721
|
<tr>
|
|
1700
1722
|
<td>trace</td>
|
|
1701
|
-
<td><ul><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1723
|
+
<td><ul><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1702
1724
|
</tr>
|
|
1703
1725
|
<tr>
|
|
1704
1726
|
<td>content</td>
|
|
1705
1727
|
<td> Hi, I… <strong>hide</strong>
|
|
1706
1728
|
|
|
1707
|
-
<h1>hello #1.1.1: “
|
|
1708
|
-
My name is “
|
|
1729
|
+
<h1>hello #1.1.1: “fotaseb”</h1>
|
|
1730
|
+
My name is “fotaseb” and these are my properties:
|
|
1709
1731
|
<table border="1">
|
|
1710
1732
|
<tr>
|
|
1711
1733
|
<th>Property</th>
|
|
@@ -1725,14 +1747,14 @@ My name is “nuvub” and these are my properties:
|
|
|
1725
1747
|
</tr>
|
|
1726
1748
|
<tr>
|
|
1727
1749
|
<td>trace</td>
|
|
1728
|
-
<td><ul><li>INPUT:5</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1750
|
+
<td><ul><li>INPUT:5</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1729
1751
|
</tr>
|
|
1730
1752
|
<tr>
|
|
1731
1753
|
<td>content</td>
|
|
1732
1754
|
<td> <strong>sigh</strong>
|
|
1733
1755
|
|
|
1734
|
-
<h1>hello #1.1.1.1: “
|
|
1735
|
-
My name is “
|
|
1756
|
+
<h1>hello #1.1.1.1: “juk”</h1>
|
|
1757
|
+
My name is “juk” and these are my properties:
|
|
1736
1758
|
<table border="1">
|
|
1737
1759
|
<tr>
|
|
1738
1760
|
<th>Property</th>
|
|
@@ -1752,7 +1774,7 @@ My name is “gaguy” and these are my properties:
|
|
|
1752
1774
|
</tr>
|
|
1753
1775
|
<tr>
|
|
1754
1776
|
<td>trace</td>
|
|
1755
|
-
<td><ul><li>INPUT:7</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1777
|
+
<td><ul><li>INPUT:7</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:5</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1756
1778
|
</tr>
|
|
1757
1779
|
<tr>
|
|
1758
1780
|
<td>content</td>
|
|
@@ -1762,8 +1784,8 @@ My name is “gaguy” and these are my properties:
|
|
|
1762
1784
|
</table></td>
|
|
1763
1785
|
</tr>
|
|
1764
1786
|
</table>
|
|
1765
|
-
<h1>hello #1.1.2: “
|
|
1766
|
-
My name is “
|
|
1787
|
+
<h1>hello #1.1.2: “noma”</h1>
|
|
1788
|
+
My name is “noma” and these are my properties:
|
|
1767
1789
|
<table border="1">
|
|
1768
1790
|
<tr>
|
|
1769
1791
|
<th>Property</th>
|
|
@@ -1783,7 +1805,7 @@ My name is “lozije” and these are my properties:
|
|
|
1783
1805
|
</tr>
|
|
1784
1806
|
<tr>
|
|
1785
1807
|
<td>trace</td>
|
|
1786
|
-
<td><ul><li>INPUT:9</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1808
|
+
<td><ul><li>INPUT:9</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1787
1809
|
</tr>
|
|
1788
1810
|
<tr>
|
|
1789
1811
|
<td>content</td>
|
|
@@ -1793,8 +1815,8 @@ My name is “lozije” and these are my properties:
|
|
|
1793
1815
|
</table></td>
|
|
1794
1816
|
</tr>
|
|
1795
1817
|
</table>
|
|
1796
|
-
<h1>hello #1.2: “
|
|
1797
|
-
My name is “
|
|
1818
|
+
<h1>hello #1.2: “diboha”</h1>
|
|
1819
|
+
My name is “diboha” and these are my properties:
|
|
1798
1820
|
<table border="1">
|
|
1799
1821
|
<tr>
|
|
1800
1822
|
<th>Property</th>
|
|
@@ -1814,14 +1836,14 @@ My name is “rame” and these are my properties:
|
|
|
1814
1836
|
</tr>
|
|
1815
1837
|
<tr>
|
|
1816
1838
|
<td>trace</td>
|
|
1817
|
-
<td><ul><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1839
|
+
<td><ul><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1818
1840
|
</tr>
|
|
1819
1841
|
<tr>
|
|
1820
1842
|
<td>content</td>
|
|
1821
1843
|
<td> <strong>yawn</strong> Just five more minutes…
|
|
1822
1844
|
|
|
1823
|
-
<h1>hello #1.2.1: “
|
|
1824
|
-
My name is “
|
|
1845
|
+
<h1>hello #1.2.1: “vehokeh”</h1>
|
|
1846
|
+
My name is “vehokeh” and these are my properties:
|
|
1825
1847
|
<table border="1">
|
|
1826
1848
|
<tr>
|
|
1827
1849
|
<th>Property</th>
|
|
@@ -1841,14 +1863,14 @@ My name is “rojed” and these are my properties:
|
|
|
1841
1863
|
</tr>
|
|
1842
1864
|
<tr>
|
|
1843
1865
|
<td>trace</td>
|
|
1844
|
-
<td><ul><li>INPUT:13</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1866
|
+
<td><ul><li>INPUT:13</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1845
1867
|
</tr>
|
|
1846
1868
|
<tr>
|
|
1847
1869
|
<td>content</td>
|
|
1848
1870
|
<td> So <em>be</em> happy my friend, <strong>happy</strong>!
|
|
1849
1871
|
|
|
1850
|
-
<h1>hello #1.2.1.1: “
|
|
1851
|
-
My name is “
|
|
1872
|
+
<h1>hello #1.2.1.1: “hif”</h1>
|
|
1873
|
+
My name is “hif” and these are my properties:
|
|
1852
1874
|
<table border="1">
|
|
1853
1875
|
<tr>
|
|
1854
1876
|
<th>Property</th>
|
|
@@ -1868,7 +1890,7 @@ My name is “tehen” and these are my properties:
|
|
|
1868
1890
|
</tr>
|
|
1869
1891
|
<tr>
|
|
1870
1892
|
<td>trace</td>
|
|
1871
|
-
<td><ul><li>INPUT:15</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
|
1893
|
+
<td><ul><li>INPUT:15</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:13</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:217:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1872
1894
|
</tr>
|
|
1873
1895
|
<tr>
|
|
1874
1896
|
<td>content</td>
|
|
@@ -1882,8 +1904,8 @@ My name is “tehen” and these are my properties:
|
|
|
1882
1904
|
</table></td>
|
|
1883
1905
|
</tr>
|
|
1884
1906
|
</table>
|
|
1885
|
-
<h1>hello #2: “
|
|
1886
|
-
My name is “
|
|
1907
|
+
<h1>hello #2: “zanugi”</h1>
|
|
1908
|
+
My name is “zanugi” and these are my properties:
|
|
1887
1909
|
<table border="1">
|
|
1888
1910
|
<tr>
|
|
1889
1911
|
<th>Property</th>
|
|
@@ -1903,7 +1925,7 @@ My name is “vubose” and these are my properties:
|
|
|
1903
1925
|
</tr>
|
|
1904
1926
|
<tr>
|
|
1905
1927
|
<td>trace</td>
|
|
1906
|
-
<td><ul><li>INPUT:17</li><li>bin/gerbil:
|
|
1928
|
+
<td><ul><li>INPUT:17</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1907
1929
|
</tr>
|
|
1908
1930
|
<tr>
|
|
1909
1931
|
<td>content</td>
|
|
@@ -1912,8 +1934,8 @@ My name is “vubose” and these are my properties:
|
|
|
1912
1934
|
</td>
|
|
1913
1935
|
</tr>
|
|
1914
1936
|
</table>
|
|
1915
|
-
<h1>hello #3: “
|
|
1916
|
-
My name is “
|
|
1937
|
+
<h1>hello #3: “zemi”</h1>
|
|
1938
|
+
My name is “zemi” and these are my properties:
|
|
1917
1939
|
<table border="1">
|
|
1918
1940
|
<tr>
|
|
1919
1941
|
<th>Property</th>
|
|
@@ -1933,7 +1955,7 @@ My name is “dopeg” and these are my properties:
|
|
|
1933
1955
|
</tr>
|
|
1934
1956
|
<tr>
|
|
1935
1957
|
<td>trace</td>
|
|
1936
|
-
<td><ul><li>INPUT:20</li><li>bin/gerbil:
|
|
1958
|
+
<td><ul><li>INPUT:20</li><li>bin/gerbil:238</li><li>bin/gerbil:238:in `instance_eval’</li><li>bin/gerbil:238</li></ul></td>
|
|
1937
1959
|
</tr>
|
|
1938
1960
|
<tr>
|
|
1939
1961
|
<td>content</td>
|
|
@@ -1948,7 +1970,7 @@ That’s all folks!</div>
|
|
|
1948
1970
|
<div class="chapter">
|
|
1949
1971
|
<h1 class="title">
|
|
1950
1972
|
Chapter
|
|
1951
|
-
<a class="toc" id="Usage" href="#a-
|
|
1973
|
+
<a class="toc" id="Usage" href="#a-606572528">4</a>
|
|
1952
1974
|
|
|
1953
1975
|
<br/>
|
|
1954
1976
|
|
|
@@ -1984,7 +2006,7 @@ Format:
|
|
|
1984
2006
|
|
|
1985
2007
|
<p><div class="section">
|
|
1986
2008
|
<h2 class="title">
|
|
1987
|
-
<a class="toc" id="include" href="#a-
|
|
2009
|
+
<a class="toc" id="include" href="#a-606579038">4.1</a> The <strong>include</strong> directive
|
|
1988
2010
|
</h2>
|
|
1989
2011
|
<div class="content"><p>The <strong>include</strong> directive allows you to insert the content of an arbitrary file at a certain place in the input document. It is written like this:</p>
|
|
1990
2012
|
|
|
@@ -1999,7 +2021,7 @@ Format:
|
|
|
1999
2021
|
</div>
|
|
2000
2022
|
<div class="section">
|
|
2001
2023
|
<h2 class="title">
|
|
2002
|
-
<a class="toc" id="unindent" href="#a-
|
|
2024
|
+
<a class="toc" id="unindent" href="#a-606581928">4.2</a> The <code class="code"><span style="color:#d70; font-weight:bold">$unindent</span></code> variable
|
|
2003
2025
|
</h2>
|
|
2004
2026
|
<div class="content"><p>The <code class="code"><span style="color:#d70; font-weight:bold">$unindent</span></code> variable allows you to unindent the content of every node in the input document by a specified amount of whitespace (spaces, tabs, newlines, and so on).</p>
|
|
2005
2027
|
|
|
@@ -2016,7 +2038,7 @@ Format:
|
|
|
2016
2038
|
<div class="part">
|
|
2017
2039
|
<h1 class="title">
|
|
2018
2040
|
Part
|
|
2019
|
-
<a class="toc" id="Formats" href="#a-
|
|
2041
|
+
<a class="toc" id="Formats" href="#a-606587218">5</a>
|
|
2020
2042
|
|
|
2021
2043
|
<br/>
|
|
2022
2044
|
|
|
@@ -2032,7 +2054,7 @@ Format:
|
|
|
2032
2054
|
<p><div class="chapter">
|
|
2033
2055
|
<h1 class="title">
|
|
2034
2056
|
Chapter
|
|
2035
|
-
<a class="toc" id="html" href="#a-
|
|
2057
|
+
<a class="toc" id="html" href="#a-606593188">5.1</a>
|
|
2036
2058
|
|
|
2037
2059
|
<br/>
|
|
2038
2060
|
|
|
@@ -2050,7 +2072,7 @@ Format:
|
|
|
2050
2072
|
|
|
2051
2073
|
<p><div class="section">
|
|
2052
2074
|
<h3 class="title">
|
|
2053
|
-
<a class="toc" id="Text-to-HTML-conversion" href="#a-
|
|
2075
|
+
<a class="toc" id="Text-to-HTML-conversion" href="#a-606596138">5.1.1</a> Text to HTML conversion
|
|
2054
2076
|
</h3>
|
|
2055
2077
|
<div class="content"><p>Inside the <tt>format/</tt> subdirectory of the Gerbil installation directory (see <a class="xref" href="#Manifest">Section 2.3: <em>Manifest</em></a>), you will see a <tt>html.rb</tt> file. This file defines a <code class="code"><span style="color:#036; font-weight:bold">String</span>.to_html</code> method which is used to transform text in an input document into HTML.</p>
|
|
2056
2078
|
|
|
@@ -2075,7 +2097,7 @@ Format:
|
|
|
2075
2097
|
|
|
2076
2098
|
<p><div class="section">
|
|
2077
2099
|
<h4 class="title">
|
|
2078
|
-
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-
|
|
2100
|
+
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-606600398">5.1.1.1</a> Syntax coloring for source code
|
|
2079
2101
|
</h4>
|
|
2080
2102
|
<div class="content"><p>Syntax coloring is <em>automatically added</em> to source code found inside the <strong><code></strong> and <strong></code></strong> HTML tags. Note that in Textile, any text enclosed within a pair of at-signs (@ and @) is also considered to be source code.</p>
|
|
2081
2103
|
|
|
@@ -2093,7 +2115,7 @@ The following programming languages are currently supported by <a href="http://c
|
|
|
2093
2115
|
|
|
2094
2116
|
<p><div class="section">
|
|
2095
2117
|
<h5 class="title">
|
|
2096
|
-
<a class="toc" id="Specifying-the-programming-language" href="#a-
|
|
2118
|
+
<a class="toc" id="Specifying-the-programming-language" href="#a-606603748">5.1.1.1.1</a> Specifying the programming language
|
|
2097
2119
|
</h5>
|
|
2098
2120
|
<div class="content"><p>Because different programming languages have different syntax coloring schemes, you can specify the language of your source code using the <code class="code">lang</code> attribute to ensure that only the appropriate coloring scheme is used. Note that unless the <code class="code">lang</code> attribute is specified, <em>Ruby</em> is assumed to be the programming language of all source code by default.</p>
|
|
2099
2121
|
|
|
@@ -2181,7 +2203,7 @@ int main(int argc, char **argv) {
|
|
|
2181
2203
|
</div>
|
|
2182
2204
|
<div class="section">
|
|
2183
2205
|
<h4 class="title">
|
|
2184
|
-
<a class="toc" id="Smart-sizing-of-source-code" href="#a-
|
|
2206
|
+
<a class="toc" id="Smart-sizing-of-source-code" href="#a-606607298">5.1.1.2</a> Smart sizing of source code
|
|
2185
2207
|
</h4>
|
|
2186
2208
|
<div class="content"><p>Source code is <em>automatically sized</em> to be displayed as either a line or paragraph of text, depending on whether it contains line breaks.</p>
|
|
2187
2209
|
|
|
@@ -2200,14 +2222,14 @@ int main(int argc, char **argv) {
|
|
|
2200
2222
|
</div>
|
|
2201
2223
|
<div class="section">
|
|
2202
2224
|
<h4 class="title">
|
|
2203
|
-
<a class="toc" id="Protecting-verbatim-text" href="#a-
|
|
2225
|
+
<a class="toc" id="Protecting-verbatim-text" href="#a-606610078">5.1.1.3</a> Protecting verbatim text
|
|
2204
2226
|
</h4>
|
|
2205
2227
|
<div class="content">Sometimes you just need to protect some text from being mangled by the text-to-HTML conversion process . In such cases, you can wrap the text you want to proctect within <strong><noformat></strong> and <strong></noformat></strong> tags.</div>
|
|
2206
2228
|
</div></p></div>
|
|
2207
2229
|
</div>
|
|
2208
2230
|
<div class="section">
|
|
2209
2231
|
<h3 class="title">
|
|
2210
|
-
<a class="toc" id="Parameters" href="#a-
|
|
2232
|
+
<a class="toc" id="Parameters" href="#a-606613988">5.1.2</a> Parameters
|
|
2211
2233
|
</h3>
|
|
2212
2234
|
<div class="content">The HTML format accepts the following document parameters.
|
|
2213
2235
|
|
|
@@ -2259,7 +2281,7 @@ int main(int argc, char **argv) {
|
|
|
2259
2281
|
</div>
|
|
2260
2282
|
<div class="section">
|
|
2261
2283
|
<h3 class="title">
|
|
2262
|
-
<a class="toc" id="Methods" href="#a-
|
|
2284
|
+
<a class="toc" id="Methods" href="#a-606619058">5.1.3</a> Methods
|
|
2263
2285
|
</h3>
|
|
2264
2286
|
<div class="content">The HTML format provides the following methods. In the method declarations shown below,
|
|
2265
2287
|
<ul>
|
|
@@ -2363,7 +2385,7 @@ ruby.
|
|
|
2363
2385
|
<div class="chapter">
|
|
2364
2386
|
<h1 class="title">
|
|
2365
2387
|
Chapter
|
|
2366
|
-
<a class="toc" id="html.nodes" href="#a-
|
|
2388
|
+
<a class="toc" id="html.nodes" href="#a-607056648">5.1.4</a>
|
|
2367
2389
|
|
|
2368
2390
|
<br/>
|
|
2369
2391
|
|
|
@@ -2406,32 +2428,32 @@ ruby.
|
|
|
2406
2428
|
|
|
2407
2429
|
<p><div class="section">
|
|
2408
2430
|
<h4 class="title">
|
|
2409
|
-
<a class="toc" id="Structure" href="#a-
|
|
2431
|
+
<a class="toc" id="Structure" href="#a-607061138">5.1.4.1</a> Structure
|
|
2410
2432
|
</h4>
|
|
2411
2433
|
<div class="content"><p>The nodes described in this section form the overall structure of the output document.</p>
|
|
2412
2434
|
|
|
2413
2435
|
|
|
2414
2436
|
<p><div class="section">
|
|
2415
2437
|
<h5 class="title">
|
|
2416
|
-
<a class="toc" id="html.nodes.header" href="#a-
|
|
2438
|
+
<a class="toc" id="html.nodes.header" href="#a-607062818">5.1.4.1.1</a> header
|
|
2417
2439
|
</h5>
|
|
2418
2440
|
<div class="content">This node overrides the logo, title, list of authors, and date when the document was written, all of which are shown at the top of the document.</div>
|
|
2419
2441
|
</div>
|
|
2420
2442
|
<div class="section">
|
|
2421
2443
|
<h5 class="title">
|
|
2422
|
-
<a class="toc" id="html.nodes.footer" href="#a-
|
|
2444
|
+
<a class="toc" id="html.nodes.footer" href="#a-607064888">5.1.4.1.2</a> footer
|
|
2423
2445
|
</h5>
|
|
2424
2446
|
<div class="content">This node overrides (1) the date when this document was generated and (2) the hyperlink to the Gerbil website, shown at the bottom of the document. The hyperlink is there as a way of saying thanks for Gerbil, the <em>wonderful</em> little utility you have grown so fond of! ;-)</div>
|
|
2425
2447
|
</div>
|
|
2426
2448
|
<div class="section">
|
|
2427
2449
|
<h5 class="title">
|
|
2428
|
-
<a class="toc" id="html.nodes.abstract" href="#a-
|
|
2450
|
+
<a class="toc" id="html.nodes.abstract" href="#a-607067338">5.1.4.1.3</a> abstract
|
|
2429
2451
|
</h5>
|
|
2430
2452
|
<div class="content">A summary of the entire document. This is what most readers will <em>skim</em> through, if you are lucky. Alas, nobody reads entire documents these days! :-(</div>
|
|
2431
2453
|
</div>
|
|
2432
2454
|
<div class="section">
|
|
2433
2455
|
<h5 class="title">
|
|
2434
|
-
<a class="toc" id="html.nodes.xref" href="#a-
|
|
2456
|
+
<a class="toc" id="html.nodes.xref" href="#a-607070998">5.1.4.1.4</a> xref
|
|
2435
2457
|
</h5>
|
|
2436
2458
|
<div class="content"><p>A cross-reference; a hyperlink that takes you to any node in the document.</p>
|
|
2437
2459
|
|
|
@@ -2462,14 +2484,14 @@ ruby.
|
|
|
2462
2484
|
</div>
|
|
2463
2485
|
<div class="section">
|
|
2464
2486
|
<h4 class="title">
|
|
2465
|
-
<a class="toc" id="Organization" href="#a-
|
|
2487
|
+
<a class="toc" id="Organization" href="#a-607088368">5.1.4.2</a> Organization
|
|
2466
2488
|
</h4>
|
|
2467
2489
|
<div class="content"><p>The nodes described in this section are meant to help organize the document’s content logically.</p>
|
|
2468
2490
|
|
|
2469
2491
|
|
|
2470
2492
|
<p><div class="section">
|
|
2471
2493
|
<h5 class="title">
|
|
2472
|
-
<a class="toc" id="html.nodes.part" href="#a-
|
|
2494
|
+
<a class="toc" id="html.nodes.part" href="#a-607091258">5.1.4.2.1</a> part
|
|
2473
2495
|
</h5>
|
|
2474
2496
|
<div class="content"><p>A collection of chapters.</p>
|
|
2475
2497
|
|
|
@@ -2477,7 +2499,7 @@ ruby.
|
|
|
2477
2499
|
<p><div class="part">
|
|
2478
2500
|
<h1 class="title">
|
|
2479
2501
|
Part
|
|
2480
|
-
<a class="toc" id="An-example" href="#a-
|
|
2502
|
+
<a class="toc" id="An-example" href="#a-607093188">5.1.4.2.1.1</a>
|
|
2481
2503
|
|
|
2482
2504
|
<br/>
|
|
2483
2505
|
|
|
@@ -2489,7 +2511,7 @@ ruby.
|
|
|
2489
2511
|
</div>
|
|
2490
2512
|
<div class="section">
|
|
2491
2513
|
<h5 class="title">
|
|
2492
|
-
<a class="toc" id="html.nodes.chapter" href="#a-
|
|
2514
|
+
<a class="toc" id="html.nodes.chapter" href="#a-607103588">5.1.4.2.2</a> chapter
|
|
2493
2515
|
</h5>
|
|
2494
2516
|
<div class="content"><p>A collection of sections.</p>
|
|
2495
2517
|
|
|
@@ -2497,7 +2519,7 @@ ruby.
|
|
|
2497
2519
|
<p><div class="chapter">
|
|
2498
2520
|
<h1 class="title">
|
|
2499
2521
|
Chapter
|
|
2500
|
-
<a class="toc" id="An-example-
|
|
2522
|
+
<a class="toc" id="An-example-607429468" href="#a-607111178">5.1.4.2.2.1</a>
|
|
2501
2523
|
|
|
2502
2524
|
<br/>
|
|
2503
2525
|
|
|
@@ -2509,21 +2531,21 @@ ruby.
|
|
|
2509
2531
|
</div>
|
|
2510
2532
|
<div class="section">
|
|
2511
2533
|
<h5 class="title">
|
|
2512
|
-
<a class="toc" id="html.nodes.section" href="#a-
|
|
2534
|
+
<a class="toc" id="html.nodes.section" href="#a-607122318">5.1.4.2.3</a> section
|
|
2513
2535
|
</h5>
|
|
2514
2536
|
<div class="content"><p>A collection of paragraphs about a particular topic.</p>
|
|
2515
2537
|
|
|
2516
2538
|
|
|
2517
2539
|
<p><div class="section">
|
|
2518
2540
|
<h6 class="title">
|
|
2519
|
-
<a class="toc" id="An-example-
|
|
2541
|
+
<a class="toc" id="An-example-607473738" href="#a-607129768">5.1.4.2.3.1</a> An example
|
|
2520
2542
|
</h6>
|
|
2521
2543
|
<div class="content">This is what a <strong>section</strong> node appears like.</div>
|
|
2522
2544
|
</div></p></div>
|
|
2523
2545
|
</div>
|
|
2524
2546
|
<div class="section">
|
|
2525
2547
|
<h5 class="title">
|
|
2526
|
-
<a class="toc" id="html.nodes.paragraph" href="#a-
|
|
2548
|
+
<a class="toc" id="html.nodes.paragraph" href="#a-607140508">5.1.4.2.4</a> paragraph
|
|
2527
2549
|
</h5>
|
|
2528
2550
|
<div class="content"><p>A collection of sentences about a particular idea.</p>
|
|
2529
2551
|
|
|
@@ -2536,7 +2558,7 @@ ruby.
|
|
|
2536
2558
|
</div>
|
|
2537
2559
|
<div class="section">
|
|
2538
2560
|
<h4 class="title">
|
|
2539
|
-
<a class="toc" id="Admonitions" href="#a-
|
|
2561
|
+
<a class="toc" id="Admonitions" href="#a-607158488">5.1.4.3</a> Admonitions
|
|
2540
2562
|
</h4>
|
|
2541
2563
|
<div class="content"><p>An admonition is basically a box that is indented more deeply than the text surrounding it. It is typically used to convey extraneous or pertinent information about the application of ideas discussed in the surrounding text.</p>
|
|
2542
2564
|
|
|
@@ -2547,13 +2569,13 @@ ruby.
|
|
|
2547
2569
|
<p>
|
|
2548
2570
|
<div class="section">
|
|
2549
2571
|
<h5 class="title">
|
|
2550
|
-
<a class="toc" id="html.nodes.warning" href="#a-
|
|
2572
|
+
<a class="toc" id="html.nodes.warning" href="#a-607173688">5.1.4.3.1</a> warning
|
|
2551
2573
|
</h5>
|
|
2552
2574
|
<div class="content"><p>Use a <strong>warning</strong> node when “data loss could occur if you follow the procedure being described.” <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
|
|
2553
2575
|
|
|
2554
2576
|
|
|
2555
2577
|
<p><div class="warning">
|
|
2556
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2578
|
+
<p class="title"><a class="toc" id="An-example-607540568" href="#a-607185678">Warning 1</a>. An example</p>
|
|
2557
2579
|
|
|
2558
2580
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2559
2581
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2618,7 +2640,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2618
2640
|
</div>
|
|
2619
2641
|
<div class="section">
|
|
2620
2642
|
<h5 class="title">
|
|
2621
|
-
<a class="toc" id="html.nodes.caution" href="#a-
|
|
2643
|
+
<a class="toc" id="html.nodes.caution" href="#a-607197698">5.1.4.3.2</a> caution
|
|
2622
2644
|
</h5>
|
|
2623
2645
|
<div class="content"><blockquote>
|
|
2624
2646
|
<p>A note of caution. Use this for example when the reader may lose easily recovered or replaceable information (e.g. user settings), or when they could cause data loss if they don’t correctly follow the procedure being outlined. <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
|
|
@@ -2626,7 +2648,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2626
2648
|
|
|
2627
2649
|
|
|
2628
2650
|
<p><div class="caution">
|
|
2629
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2651
|
+
<p class="title"><a class="toc" id="An-example-607569808" href="#a-607209208">Caution 1</a>. An example</p>
|
|
2630
2652
|
|
|
2631
2653
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2632
2654
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2687,7 +2709,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2687
2709
|
</div>
|
|
2688
2710
|
<div class="section">
|
|
2689
2711
|
<h5 class="title">
|
|
2690
|
-
<a class="toc" id="html.nodes.important" href="#a-
|
|
2712
|
+
<a class="toc" id="html.nodes.important" href="#a-607213238">5.1.4.3.3</a> important
|
|
2691
2713
|
</h5>
|
|
2692
2714
|
<div class="content"><p>Use an <strong>important</strong> node when:</p>
|
|
2693
2715
|
|
|
@@ -2698,7 +2720,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2698
2720
|
|
|
2699
2721
|
|
|
2700
2722
|
<p><div class="important">
|
|
2701
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2723
|
+
<p class="title"><a class="toc" id="An-example-607601028" href="#a-607225448">Important 1</a>. An example</p>
|
|
2702
2724
|
|
|
2703
2725
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2704
2726
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2763,7 +2785,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2763
2785
|
</div>
|
|
2764
2786
|
<div class="section">
|
|
2765
2787
|
<h5 class="title">
|
|
2766
|
-
<a class="toc" id="html.nodes.note" href="#a-
|
|
2788
|
+
<a class="toc" id="html.nodes.note" href="#a-607230378">5.1.4.3.4</a> note
|
|
2767
2789
|
</h5>
|
|
2768
2790
|
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
|
|
2769
2791
|
|
|
@@ -2774,7 +2796,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2774
2796
|
|
|
2775
2797
|
|
|
2776
2798
|
<p><div class="note">
|
|
2777
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2799
|
+
<p class="title"><a class="toc" id="An-example-607637408" href="#a-607239848">Note 3</a>. An example</p>
|
|
2778
2800
|
|
|
2779
2801
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2780
2802
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2840,7 +2862,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2840
2862
|
</div>
|
|
2841
2863
|
<div class="section">
|
|
2842
2864
|
<h5 class="title">
|
|
2843
|
-
<a class="toc" id="html.nodes.tip" href="#a-
|
|
2865
|
+
<a class="toc" id="html.nodes.tip" href="#a-607243718">5.1.4.3.5</a> tip
|
|
2844
2866
|
</h5>
|
|
2845
2867
|
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
|
|
2846
2868
|
|
|
@@ -2851,7 +2873,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2851
2873
|
|
|
2852
2874
|
|
|
2853
2875
|
<p><div class="tip">
|
|
2854
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2876
|
+
<p class="title"><a class="toc" id="An-example-607668348" href="#a-607254868">Tip 1</a>. An example</p>
|
|
2855
2877
|
|
|
2856
2878
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2857
2879
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2936,79 +2958,79 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
2936
2958
|
</div>
|
|
2937
2959
|
<div class="section">
|
|
2938
2960
|
<h4 class="title">
|
|
2939
|
-
<a class="toc" id="Auxilary-materials" href="#a-
|
|
2961
|
+
<a class="toc" id="Auxilary-materials" href="#a-607262008">5.1.4.4</a> Auxilary materials
|
|
2940
2962
|
</h4>
|
|
2941
2963
|
<div class="content"><div class="section">
|
|
2942
2964
|
<h5 class="title">
|
|
2943
|
-
<a class="toc" id="html.nodes.figure" href="#a-
|
|
2965
|
+
<a class="toc" id="html.nodes.figure" href="#a-607265358">5.1.4.4.1</a> figure
|
|
2944
2966
|
</h5>
|
|
2945
2967
|
<div class="content"><p>A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.</p>
|
|
2946
2968
|
|
|
2947
2969
|
|
|
2948
2970
|
<p><div class="figure">
|
|
2949
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2971
|
+
<p class="title"><a class="toc" id="An-example-607703968" href="#a-607267018">Figure 1</a>. An example</p>
|
|
2950
2972
|
<div class="content">This is what a <strong>figure</strong> node appears like.</div>
|
|
2951
2973
|
</div></p></div>
|
|
2952
2974
|
</div>
|
|
2953
2975
|
<div class="section">
|
|
2954
2976
|
<h5 class="title">
|
|
2955
|
-
<a class="toc" id="html.nodes.table" href="#a-
|
|
2977
|
+
<a class="toc" id="html.nodes.table" href="#a-607269308">5.1.4.4.2</a> table
|
|
2956
2978
|
</h5>
|
|
2957
2979
|
<div class="content"><p>Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.</p>
|
|
2958
2980
|
|
|
2959
2981
|
|
|
2960
2982
|
<p><div class="table">
|
|
2961
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2983
|
+
<p class="title"><a class="toc" id="An-example-607008348" href="#a-607270998">Table 1</a>. An example</p>
|
|
2962
2984
|
<div class="content">This is what a <strong>table</strong> node appears like.</div>
|
|
2963
2985
|
</div></p></div>
|
|
2964
2986
|
</div>
|
|
2965
2987
|
<div class="section">
|
|
2966
2988
|
<h5 class="title">
|
|
2967
|
-
<a class="toc" id="html.nodes.example" href="#a-
|
|
2989
|
+
<a class="toc" id="html.nodes.example" href="#a-607273288">5.1.4.4.3</a> example
|
|
2968
2990
|
</h5>
|
|
2969
2991
|
<div class="content"><p>A sample application of an idea or thought.</p>
|
|
2970
2992
|
|
|
2971
2993
|
|
|
2972
2994
|
<p><div class="example">
|
|
2973
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2995
|
+
<p class="title"><a class="toc" id="An-example-607053988" href="#a-607275008">Example 4</a>. An example</p>
|
|
2974
2996
|
<div class="content">This is what a <strong>example</strong> node appears like.</div>
|
|
2975
2997
|
</div></p></div>
|
|
2976
2998
|
</div>
|
|
2977
2999
|
<div class="section">
|
|
2978
3000
|
<h5 class="title">
|
|
2979
|
-
<a class="toc" id="html.nodes.equation" href="#a-
|
|
3001
|
+
<a class="toc" id="html.nodes.equation" href="#a-607277258">5.1.4.4.4</a> equation
|
|
2980
3002
|
</h5>
|
|
2981
3003
|
<div class="content"><p>A mathematical equation or formula.</p>
|
|
2982
3004
|
|
|
2983
3005
|
|
|
2984
3006
|
<p><div class="equation">
|
|
2985
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3007
|
+
<p class="title"><a class="toc" id="An-example-607209188" href="#a-607279008">Equation 1</a>. An example</p>
|
|
2986
3008
|
<div class="content">This is what a <strong>equation</strong> node appears like.</div>
|
|
2987
3009
|
</div></p></div>
|
|
2988
3010
|
</div>
|
|
2989
3011
|
<div class="section">
|
|
2990
3012
|
<h5 class="title">
|
|
2991
|
-
<a class="toc" id="html.nodes.procedure" href="#a-
|
|
3013
|
+
<a class="toc" id="html.nodes.procedure" href="#a-607281298">5.1.4.4.5</a> procedure
|
|
2992
3014
|
</h5>
|
|
2993
3015
|
<div class="content"><p>An outline; a series of steps outlining some kind of process.</p>
|
|
2994
3016
|
|
|
2995
3017
|
|
|
2996
3018
|
<p><div class="procedure">
|
|
2997
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3019
|
+
<p class="title"><a class="toc" id="An-example-607299988" href="#a-607283078">Procedure 1</a>. An example</p>
|
|
2998
3020
|
<div class="content">This is what a <strong>procedure</strong> node appears like.</div>
|
|
2999
3021
|
</div></p></div>
|
|
3000
3022
|
</div></div>
|
|
3001
3023
|
</div>
|
|
3002
3024
|
<div class="section">
|
|
3003
3025
|
<h4 class="title">
|
|
3004
|
-
<a class="toc" id="Bibliography" href="#a-
|
|
3026
|
+
<a class="toc" id="Bibliography" href="#a-607285768">5.1.4.5</a> Bibliography
|
|
3005
3027
|
</h4>
|
|
3006
3028
|
<div class="content"><p>The nodes in this section deal with attribution of ideas—an important weapon against plagiarism.</p>
|
|
3007
3029
|
|
|
3008
3030
|
|
|
3009
3031
|
<p><div class="section">
|
|
3010
3032
|
<h5 class="title">
|
|
3011
|
-
<a class="toc" id="html.nodes.reference" href="#a-
|
|
3033
|
+
<a class="toc" id="html.nodes.reference" href="#a-607287568">5.1.4.5.1</a> reference
|
|
3012
3034
|
</h5>
|
|
3013
3035
|
<div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
|
|
3014
3036
|
|
|
@@ -3024,7 +3046,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3024
3046
|
</div>
|
|
3025
3047
|
<div class="section">
|
|
3026
3048
|
<h5 class="title">
|
|
3027
|
-
<a class="toc" id="html.nodes.cite" href="#a-
|
|
3049
|
+
<a class="toc" id="html.nodes.cite" href="#a-607296008">5.1.4.5.2</a> cite
|
|
3028
3050
|
</h5>
|
|
3029
3051
|
<div class="content"><p>A citation to a <strong>reference</strong> node (see <a class="xref" href="#html.nodes.reference">Section 5.1.4.5.1: <em>reference</em></a>) in the document’s bibliography.</p>
|
|
3030
3052
|
|
|
@@ -3055,7 +3077,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3055
3077
|
<div class="chapter">
|
|
3056
3078
|
<h1 class="title">
|
|
3057
3079
|
Chapter
|
|
3058
|
-
<a class="toc" id="text" href="#a-
|
|
3080
|
+
<a class="toc" id="text" href="#a-607305848">5.2</a>
|
|
3059
3081
|
|
|
3060
3082
|
<br/>
|
|
3061
3083
|
|
|
@@ -3070,7 +3092,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3070
3092
|
<div class="chapter">
|
|
3071
3093
|
<h1 class="title">
|
|
3072
3094
|
Chapter
|
|
3073
|
-
<a class="toc" id="latex" href="#a-
|
|
3095
|
+
<a class="toc" id="latex" href="#a-607311408">5.3</a>
|
|
3074
3096
|
|
|
3075
3097
|
<br/>
|
|
3076
3098
|
|
|
@@ -3085,7 +3107,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3085
3107
|
<div class="chapter">
|
|
3086
3108
|
<h1 class="title">
|
|
3087
3109
|
Chapter
|
|
3088
|
-
<a class="toc" id="man" href="#a-
|
|
3110
|
+
<a class="toc" id="man" href="#a-607316408">5.4</a>
|
|
3089
3111
|
|
|
3090
3112
|
<br/>
|
|
3091
3113
|
|
|
@@ -3112,7 +3134,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3112
3134
|
<br style="display: none"/>
|
|
3113
3135
|
|
|
3114
3136
|
<div id="footer">
|
|
3115
|
-
Generated on
|
|
3137
|
+
Generated on Tue Jan 22 21:35:07 -0800 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 1.1.0.
|
|
3116
3138
|
|
|
3117
3139
|
<p>The admonition icons (<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
3118
3140
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|