gerbil 3.0.0 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/bin/gerbil +127 -127
- data/doc/api/created.rid +1 -1
- data/doc/api/files/lib/gerbil_rb.html +2 -2
- data/doc/feed-icon-28x28.png +0 -0
- data/doc/guide.erb +16 -10
- data/doc/guide.html +156 -136
- data/lib/gerbil.rb +2 -2
- metadata +3 -2
data/bin/gerbil
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
# Otherwise, the final output document will be printed to STDOUT.
|
|
10
10
|
#
|
|
11
11
|
# * The --unindent option assumes that all beginning (<% ... do %>)
|
|
12
|
-
# and ending (<% end %>) eRuby directives
|
|
12
|
+
# and ending (<% end %>) eRuby directives are written one per line
|
|
13
13
|
# (with nothing else on the line, except whitespace) in the input.
|
|
14
14
|
|
|
15
15
|
# Copyright 2007 Suraj N. Kurapati
|
|
@@ -136,7 +136,7 @@ if __FILE__ == $0 or File.basename(__FILE__) == File.basename($0)
|
|
|
136
136
|
|
|
137
137
|
# load format specification file
|
|
138
138
|
specFile = ARGV.shift or
|
|
139
|
-
raise ArgumentError, "Format was not specified.
|
|
139
|
+
raise ArgumentError, "Format was not specified. Run `{$0} -h` for help."
|
|
140
140
|
|
|
141
141
|
File.file? specFile or
|
|
142
142
|
specFile = File.join(Gerbil[:format_home], specFile + '.yaml')
|
|
@@ -157,143 +157,143 @@ if __FILE__ == $0 or File.basename(__FILE__) == File.basename($0)
|
|
|
157
157
|
# load input document
|
|
158
158
|
input = ARGF.read
|
|
159
159
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
# unindent node content
|
|
166
|
-
if unindent
|
|
167
|
-
BLOCK_HEAD = /<%(?!%)(?:.(?!<%[^%]))*\bdo\s*%>/
|
|
168
|
-
BLOCK_TAIL = /<%\s*end\s*%>/
|
|
169
|
-
|
|
170
|
-
margins = input.scan(/#{BLOCK_HEAD}(?:\r?\n)*([ \t]*)/).flatten
|
|
171
|
-
lines = input.split(/^/)
|
|
172
|
-
|
|
173
|
-
# unindent each line by the inner margin of its containing node
|
|
174
|
-
stack = []
|
|
175
|
-
lines.each do |line|
|
|
176
|
-
case line
|
|
177
|
-
when BLOCK_HEAD
|
|
178
|
-
line.replace $&
|
|
179
|
-
stack.push margins.shift
|
|
180
|
-
|
|
181
|
-
when BLOCK_TAIL
|
|
182
|
-
line.replace $&
|
|
183
|
-
stack.pop
|
|
184
|
-
|
|
185
|
-
else
|
|
186
|
-
if margin = stack.last and line.include? margin
|
|
187
|
-
line[margin] = ''
|
|
188
|
-
end
|
|
160
|
+
begin
|
|
161
|
+
# expand all "include" directives in the input
|
|
162
|
+
begin end while input.gsub! %r{<%#\s*include\s+(.+?)\s*#%>} do
|
|
163
|
+
"<%#begin(#{name = $1.inspect})%>#{File.read $1}<%#end(#{name})%>"
|
|
189
164
|
end
|
|
190
|
-
end
|
|
191
|
-
|
|
192
|
-
input = lines.join
|
|
193
|
-
end
|
|
194
165
|
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
# calculate occurrence number for this node
|
|
222
|
-
if #{info['number']}
|
|
223
|
-
@count ||= Hash.new {|h,k| h[k] = []}
|
|
224
|
-
node.number = (@count[node.type] << node).length
|
|
166
|
+
# unindent node content
|
|
167
|
+
if unindent
|
|
168
|
+
BLOCK_HEAD = /<%[^%=].*?\bdo\b.*?%>/
|
|
169
|
+
BLOCK_TAIL = /<%\s*end\s*%>/
|
|
170
|
+
|
|
171
|
+
margins = input.scan(/#{BLOCK_HEAD}(?:\r?\n)*([ \t]*)/).flatten
|
|
172
|
+
lines = input.split(/^/)
|
|
173
|
+
|
|
174
|
+
# unindent each line by the inner margin of its containing node
|
|
175
|
+
stack = []
|
|
176
|
+
lines.each_with_index do |line, number|
|
|
177
|
+
case line
|
|
178
|
+
when BLOCK_HEAD
|
|
179
|
+
stack.push margins.shift
|
|
180
|
+
line.replace $&
|
|
181
|
+
|
|
182
|
+
when BLOCK_TAIL
|
|
183
|
+
stack.pop or raise "unmatched <% end %> at INPUT:#{number} -- ensure that all beginning (<% ... do %>) eRuby directives are written one per line (with nothing else on the line, except whitespace) in the input."
|
|
184
|
+
line.replace $&
|
|
185
|
+
|
|
186
|
+
else
|
|
187
|
+
if margin = stack.last and line.include? margin
|
|
188
|
+
line[margin] = ''
|
|
189
|
+
end
|
|
190
|
+
end
|
|
225
191
|
end
|
|
226
192
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
# assign node family
|
|
230
|
-
if parent = @stack.last
|
|
231
|
-
parent.children << node
|
|
232
|
-
node.parent = parent
|
|
233
|
-
node.depth = parent.depth.next
|
|
193
|
+
input = lines.join
|
|
194
|
+
end
|
|
234
195
|
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
196
|
+
# create sandbox for input evaluation
|
|
197
|
+
template = Template.new('INPUT', input)
|
|
198
|
+
|
|
199
|
+
templateVars = {
|
|
200
|
+
:@spec => specData,
|
|
201
|
+
:@roots => roots = [], # root nodes of all trees
|
|
202
|
+
:@nodes => nodes = [], # all nodes in the forest
|
|
203
|
+
:@types => types = Hash.new {|h,k| h[k] = []}, # nodes by type
|
|
204
|
+
}.each_pair {|k,v| template.instance_variable_set(k, v) }
|
|
205
|
+
|
|
206
|
+
nodeDefs = specData['nodes'].each_pair do |name, info|
|
|
207
|
+
template.instance_eval %{
|
|
208
|
+
#
|
|
209
|
+
# XXX: using a string because define_method()
|
|
210
|
+
# does not accept a block until Ruby 1.9
|
|
211
|
+
#
|
|
212
|
+
def #{name} *aArgs, &aBlock
|
|
213
|
+
node = Node.new(
|
|
214
|
+
:type => #{name.inspect},
|
|
215
|
+
:args => aArgs,
|
|
216
|
+
:trace => caller,
|
|
217
|
+
:children => []
|
|
218
|
+
)
|
|
219
|
+
@nodes << node
|
|
220
|
+
@types[node.type] << node
|
|
221
|
+
|
|
222
|
+
# calculate occurrence number for this node
|
|
223
|
+
if #{info['number']}
|
|
224
|
+
@count ||= Hash.new {|h,k| h[k] = []}
|
|
225
|
+
node.number = (@count[node.type] << node).length
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
@stack ||= []
|
|
229
|
+
|
|
230
|
+
# assign node family
|
|
231
|
+
if parent = @stack.last
|
|
232
|
+
parent.children << node
|
|
233
|
+
node.parent = parent
|
|
234
|
+
node.depth = parent.depth.next
|
|
235
|
+
|
|
236
|
+
# calculate latex-style index number for this node
|
|
237
|
+
if #{info['index']}
|
|
238
|
+
branches = parent.children.select {|n| n.index}
|
|
239
|
+
node.index = [parent.index, branches.length.next].join('.')
|
|
240
|
+
end
|
|
241
|
+
else
|
|
242
|
+
@roots << node
|
|
243
|
+
node.parent = nil
|
|
244
|
+
node.depth = 0
|
|
245
|
+
|
|
246
|
+
# calculate latex-style index number for this node
|
|
247
|
+
if #{info['index']}
|
|
248
|
+
branches = @roots.select {|n| n.index}
|
|
249
|
+
node.index = branches.length.next.to_s
|
|
250
|
+
end
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
# assign node content
|
|
254
|
+
if block_given?
|
|
255
|
+
@stack.push node
|
|
256
|
+
content = content_from_block(node, &aBlock)
|
|
257
|
+
@stack.pop
|
|
258
|
+
|
|
259
|
+
digest = content.digest
|
|
260
|
+
@buffer << digest
|
|
261
|
+
else
|
|
262
|
+
content = nil
|
|
263
|
+
digest = node.object_id.to_s.digest
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
node.content = content
|
|
267
|
+
node.digest = digest
|
|
268
|
+
|
|
269
|
+
digest
|
|
249
270
|
end
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
# assign node content
|
|
253
|
-
if block_given?
|
|
254
|
-
@stack.push node
|
|
255
|
-
content = content_from_block(node, &aBlock)
|
|
256
|
-
@stack.pop
|
|
271
|
+
}, __FILE__, Kernel.caller.first[/\d+/].to_i.next
|
|
272
|
+
end
|
|
257
273
|
|
|
258
|
-
|
|
259
|
-
|
|
274
|
+
# build the document tree
|
|
275
|
+
document = template.instance_eval { result(binding) }
|
|
276
|
+
|
|
277
|
+
# replace nodes with output
|
|
278
|
+
expander = lambda do |n, buf|
|
|
279
|
+
# calculate node output
|
|
280
|
+
source = "#{specFile}:nodes:#{n.type}:output"
|
|
281
|
+
n.output = Template.new(source, nodeDefs[n.type]['output'].to_s.chomp).
|
|
282
|
+
render_with(templateVars.merge(:@node => n))
|
|
283
|
+
|
|
284
|
+
# replace node with output
|
|
285
|
+
if nodeDefs[n.type]['silent']
|
|
286
|
+
buf[n.digest] = ''
|
|
287
|
+
buf = n.output
|
|
260
288
|
else
|
|
261
|
-
|
|
262
|
-
digest = node.object_id.to_s.digest
|
|
289
|
+
buf[n.digest] = n.output
|
|
263
290
|
end
|
|
264
291
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
digest
|
|
269
|
-
end
|
|
270
|
-
}, __FILE__, Kernel.caller.first[/\d+/].to_i.next
|
|
271
|
-
end
|
|
272
|
-
|
|
273
|
-
begin
|
|
274
|
-
# build the document tree
|
|
275
|
-
document = template.instance_eval { result(binding) }
|
|
276
|
-
|
|
277
|
-
# replace nodes with output
|
|
278
|
-
expander = lambda do |n, buf|
|
|
279
|
-
# calculate node output
|
|
280
|
-
source = "#{specFile}:nodes:#{n.type}:output"
|
|
281
|
-
n.output = Template.new(source, nodeDefs[n.type]['output'].to_s.chomp).
|
|
282
|
-
render_with(templateVars.merge(:@node => n))
|
|
283
|
-
|
|
284
|
-
# replace node with output
|
|
285
|
-
if nodeDefs[n.type]['silent']
|
|
286
|
-
buf[n.digest] = ''
|
|
287
|
-
buf = n.output
|
|
288
|
-
else
|
|
289
|
-
buf[n.digest] = n.output
|
|
292
|
+
# repeat for all child nodes
|
|
293
|
+
n.children.each {|c| expander[c, buf] }
|
|
290
294
|
end
|
|
291
295
|
|
|
292
|
-
|
|
293
|
-
n.children.each {|c| expander[c, buf] }
|
|
294
|
-
end
|
|
295
|
-
|
|
296
|
-
roots.each {|n| expander[n, document] }
|
|
296
|
+
roots.each {|n| expander[n, document] }
|
|
297
297
|
|
|
298
298
|
rescue Exception
|
|
299
299
|
puts input # so the user can debug the line numbers in the stack trace
|
data/doc/api/created.rid
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
Tue, 03 Jun 2008 21:04:07 -0700
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
</tr>
|
|
57
57
|
<tr class="top-aligned-row">
|
|
58
58
|
<td><strong>Last Update:</strong></td>
|
|
59
|
-
<td>
|
|
59
|
+
<td>Tue Jun 03 21:02:38 -0700 2008</td>
|
|
60
60
|
</tr>
|
|
61
61
|
</table>
|
|
62
62
|
</div>
|
|
@@ -95,7 +95,7 @@ project information
|
|
|
95
95
|
<tr class="top-aligned-row context-row">
|
|
96
96
|
<td class="context-item-name">Gerbil</td>
|
|
97
97
|
<td>=</td>
|
|
98
|
-
<td class="context-item-value">{ :name => 'Gerbil', :version => '3.0.
|
|
98
|
+
<td class="context-item-value">{ :name => 'Gerbil', :version => '3.0.1', :release => '2008-06-03', :website => 'http://gerbil.rubyforge.org', :home => File.expand_path(File.join(File.dirname(__FILE__), '..'))</td>
|
|
99
99
|
<td width="3em"> </td>
|
|
100
100
|
<td class="context-item-desc">
|
|
101
101
|
project information
|
|
Binary file
|
data/doc/guide.erb
CHANGED
|
@@ -14,11 +14,7 @@
|
|
|
14
14
|
%>
|
|
15
15
|
|
|
16
16
|
<% header_inside_below do %>
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
"Project news":<%= ann_url %> - announcements of new releases.
|
|
20
|
-
|
|
21
|
-
"Release notes":<%= log_url %> - history of project release notes.
|
|
17
|
+
"Release notes and project news":<%= log_url %> — "Subscribe !feed-icon-28x28.png!":<%= ann_url %>
|
|
22
18
|
|
|
23
19
|
"Downloads":<%= pkg_url %> - obtain the newest release package.
|
|
24
20
|
|
|
@@ -27,8 +23,6 @@
|
|
|
27
23
|
"Developer feed":<%= dev_url %> - news about repository commits.
|
|
28
24
|
|
|
29
25
|
To get help or provide feedback, simply <%= xref "License", "contact the author" %>.
|
|
30
|
-
|
|
31
|
-
---
|
|
32
26
|
<% end %>
|
|
33
27
|
|
|
34
28
|
<% chapter "Introduction" do %>
|
|
@@ -58,7 +52,19 @@
|
|
|
58
52
|
<% end %>
|
|
59
53
|
|
|
60
54
|
<% section "Reviews" do %>
|
|
61
|
-
bq. I actually felt like printing it [this 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 [this user guide].
|
|
55
|
+
bq. I actually felt like printing it [this 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 [this user guide].
|
|
56
|
+
|
|
57
|
+
p>. -- _Vitor Peres_ in "ruby-talk":http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
bq. [this user guide is] a insanely complete and nice looking bit of documentation [... Gerbil] looks like a great project
|
|
61
|
+
|
|
62
|
+
p>. -- _Ara T. Howard_ in "ruby-talk":http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/282949
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
bq. Very nice work indeed!
|
|
66
|
+
|
|
67
|
+
p>. -- _Martin DeMello_ in "ruby-talk":http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283304
|
|
62
68
|
<% end %>
|
|
63
69
|
<% end %>
|
|
64
70
|
|
|
@@ -418,9 +424,9 @@
|
|
|
418
424
|
|
|
419
425
|
RDoc::TopLevel.parse @spec['code']
|
|
420
426
|
RDoc::TopLevel.parse_file 'lib/gerbil/html.rb'
|
|
421
|
-
|
|
422
|
-
RDoc::TopLevel.all_methods.each do |m|
|
|
427
|
+
methods = RDoc::TopLevel.all_methods
|
|
423
428
|
%>
|
|
429
|
+
<% methods.each do |m| %>
|
|
424
430
|
| <code><%= m.decl %></code> | <noformat><%= m.comment_html %></noformat> |
|
|
425
431
|
<% end %>
|
|
426
432
|
<% end %>
|
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="03 June 2008"/>
|
|
6
6
|
<meta name="author" content="Suraj N. Kurapati"/>
|
|
7
|
-
<meta name="generator" content="Gerbil 3.0.
|
|
7
|
+
<meta name="generator" content="Gerbil 3.0.1"/>
|
|
8
8
|
<link rel="alternate" type="application/rss+xml" href="http://gerbil.rubyforge.org/ann"/>
|
|
9
|
-
<title>Gerbil 3.0.
|
|
9
|
+
<title>Gerbil 3.0.1 user guide</title>
|
|
10
10
|
|
|
11
11
|
<style type="text/css" media="screen">
|
|
12
12
|
body
|
|
@@ -818,16 +818,10 @@
|
|
|
818
818
|
<div id="header">
|
|
819
819
|
|
|
820
820
|
<img src="gerbil.png" alt="Gerbil logo" title="Gerbil logo"/>
|
|
821
|
-
<h1 class="title">Gerbil 3.0.
|
|
821
|
+
<h1 class="title">Gerbil 3.0.1 user guide</h1>
|
|
822
822
|
<h2 class="authors"><a href="http://snk.rubyforge.org">Suraj N. Kurapati</a></h2>
|
|
823
|
-
<h3 class="date">
|
|
824
|
-
<div class="header_inside_below"><
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
<p><a href="http://gerbil.rubyforge.org/ann">Project news</a> – announcements of new releases.</p>
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
<p><a href="http://gerbil.rubyforge.org/log">Release notes</a> – history of project release notes.</p>
|
|
823
|
+
<h3 class="date">03 June 2008</h3>
|
|
824
|
+
<div class="header_inside_below"><p><a href="http://gerbil.rubyforge.org/log">Release notes and project news</a> — <a href="http://gerbil.rubyforge.org/ann">Subscribe <img src="feed-icon-28x28.png" alt="" /></a></p>
|
|
831
825
|
|
|
832
826
|
|
|
833
827
|
<p><a href="http://gerbil.rubyforge.org/pkg">Downloads</a> – obtain the newest release package.</p>
|
|
@@ -839,24 +833,21 @@
|
|
|
839
833
|
<p><a href="http://gerbil.rubyforge.org/dev">Developer feed</a> – news about repository commits.</p>
|
|
840
834
|
|
|
841
835
|
|
|
842
|
-
<p>To get help or provide feedback, simply <a class="xref" href="#License">contact the author</a>.</p>
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
<hr /></div>
|
|
836
|
+
<p>To get help or provide feedback, simply <a class="xref" href="#License">contact the author</a>.</p></div>
|
|
846
837
|
</div>
|
|
847
838
|
|
|
848
839
|
|
|
849
840
|
|
|
850
841
|
|
|
851
|
-
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-
|
|
842
|
+
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-606118218" href="#Introduction">Introduction</a><ul><li>1.1 <a id="a-605758468" href="#Features">Features</a></li><li>1.2 <a id="a-605808488" href="#License">License</a></li><li>1.3 <a id="a-605632198" href="#Reviews">Reviews</a></li></ul></li><li>2 <a id="a-606224088" href="#Setup">Setup</a><ul><li>2.1 <a id="a-606230308" href="#Requirements">Requirements</a></li><li>2.2 <a id="a-606242938" href="#Installation">Installation</a></li><li>2.3 <a id="a-606249628" href="#Manifest">Manifest</a></li><li>2.4 <a id="a-606270528" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3 <a id="a-606275468" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="a-606297318" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="a-606311398" 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-606316358" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="a-606327518" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="a-606334598" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="a-606341178" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="a-606345928" href="#HelloWorld">Creating your own custom format</a></li></ul></li></ul></li><li>4 <a id="a-606380128" href="#Usage">Usage</a><ul><li>4.1 <a id="a-606387368" href="#include">The <strong>include</strong> directive</a></li></ul></li><li>5 <a id="a-606391088" href="#Formats">Formats</a><ul><li>5.1 <a id="a-606403658" href="#html">HTML</a><ul><li>5.1.1 <a id="a-606405368" href="#Text-to-HTML-conversion">Text to HTML conversion</a><ul><li>5.1.1.1 <a id="a-606410468" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="a-606413238" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="a-606418908" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="a-606424048" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="a-606428098" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="a-606435758" href="#Methods">Methods</a></li><li>5.1.4 <a id="a-607086158" href="#html.nodes">Nodes</a><ul><li>5.1.4.1 <a id="a-607097148" href="#Structure">Structure</a><ul><li>5.1.4.1.1 <a id="a-607098828" href="#html.nodes.header">header</a></li><li>5.1.4.1.2 <a id="a-607100888" href="#html.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="a-607102978" href="#html.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="a-607105098" href="#html.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="a-607110998" href="#Organization">Organization</a><ul><li>5.1.4.2.1 <a id="a-607112708" href="#html.nodes.part">part</a><ul><li>5.1.4.2.1.1 <a id="a-607114368" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.2 <a id="a-607116878" href="#html.nodes.chapter">chapter</a><ul><li>5.1.4.2.2.1 <a id="a-607118568" href="#An-example-607233838">An example</a></li></ul></li><li>5.1.4.2.3 <a id="a-607121078" href="#html.nodes.section">section</a><ul><li>5.1.4.2.3.1 <a id="a-607122798" href="#An-example-607318508">An example</a></li></ul></li><li>5.1.4.2.4 <a id="a-607125308" href="#html.nodes.paragraph">paragraph</a></li></ul></li><li>5.1.4.3 <a id="a-607129548" href="#Admonitions">Admonitions</a><ul><li>5.1.4.3.1 <a id="a-607137108" href="#html.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="a-607150658" href="#html.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="a-607171128" href="#html.nodes.important">important</a></li><li>5.1.4.3.4 <a id="a-607188888" href="#html.nodes.note">note</a></li><li>5.1.4.3.5 <a id="a-607204238" href="#html.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="a-607216148" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="a-607218348" href="#html.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="a-607230208" href="#html.nodes.table">table</a></li><li>5.1.4.4.3 <a id="a-607237168" href="#html.nodes.example">example</a></li><li>5.1.4.4.4 <a id="a-607247028" href="#html.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="a-607258168" href="#html.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="a-607272348" href="#Bibliography">Bibliography</a><ul><li>5.1.4.5.1 <a id="a-607282008" href="#html.nodes.reference">reference</a></li><li>5.1.4.5.2 <a id="a-607301808" href="#html.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="a-607310378" href="#text">Plain text</a></li><li>5.3 <a id="a-607312648" href="#latex">LaTeX</a></li><li>5.4 <a id="a-607314888" href="#man">UNIX man page</a></li></ul></li></ul></div>
|
|
852
843
|
|
|
853
|
-
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-
|
|
844
|
+
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-607162048" href="#An-example-607415138">An example</a></li></ol><h1>Equations</h1> <ol><li><a id="a-607252048" href="#An-example-607613748">An example</a></li></ol><h1>Examples</h1> <ol><li><a id="a-606367378" href="#HelloWorld.spec">HelloWorld format specification file</a></li><li><a id="a-606372658" href="#HelloWorld.input">Input document for HelloWorld format</a></li><li><a id="a-606375948" href="#HelloWorld.output">Output of HelloWorld format</a></li><li><a id="a-607243068" href="#An-example-607591898">An example</a></li></ol><h1>Figures</h1> <ol><li><a id="a-607223838" href="#An-example-607547218">An example</a></li></ol><h1>Importants</h1> <ol><li><a id="a-607180908" href="#An-example-607446208">An example</a></li></ol><h1>Notes</h1> <ol><li><a id="a-605709568" href="#See-the-source-of-this-guide">See the source of this guide</a></li><li><a id="a-607197468" href="#An-example-607482008">An example</a></li></ol><h1>Procedures</h1> <ol><li><a id="a-607264288" href="#An-example-607635968">An example</a></li></ol><h1>Tables</h1> <ol><li><a id="a-607232528" href="#An-example-607569478">An example</a></li></ol><h1>Tips</h1> <ol><li><a id="a-607210208" href="#An-example-607512348">An example</a></li></ol><h1>Warnings</h1> <ol><li><a id="a-607144268" href="#An-example-607385828">An example</a></li></ol></div>
|
|
854
845
|
|
|
855
846
|
<div id="content">
|
|
856
847
|
<div class="chapter">
|
|
857
848
|
<h1 class="title">
|
|
858
849
|
Chapter
|
|
859
|
-
<a class="toc" id="Introduction" href="#a-
|
|
850
|
+
<a class="toc" id="Introduction" href="#a-606118218">1</a>
|
|
860
851
|
|
|
861
852
|
<br/>
|
|
862
853
|
|
|
@@ -879,7 +870,7 @@
|
|
|
879
870
|
|
|
880
871
|
|
|
881
872
|
<p><div class="note">
|
|
882
|
-
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-
|
|
873
|
+
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-605709568">Note 1</a>. See the source of this guide</p>
|
|
883
874
|
|
|
884
875
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
885
876
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -943,7 +934,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
943
934
|
<div class="content">Did you know that this user guide was generated by Gerbil? Here is <a href="guide.erb">the source document</a> to prove it!</div>
|
|
944
935
|
</div><div class="section">
|
|
945
936
|
<h2 class="title">
|
|
946
|
-
<a class="toc" id="Features" href="#a-
|
|
937
|
+
<a class="toc" id="Features" href="#a-605758468">1.1</a> Features
|
|
947
938
|
</h2>
|
|
948
939
|
<div class="content"><ul>
|
|
949
940
|
<li>Composed of <strong>less than 200 lines</strong> of code!</li>
|
|
@@ -953,7 +944,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
953
944
|
</ul></div>
|
|
954
945
|
</div><div class="section">
|
|
955
946
|
<h2 class="title">
|
|
956
|
-
<a class="toc" id="License" href="#a-
|
|
947
|
+
<a class="toc" id="License" href="#a-605808488">1.2</a> License
|
|
957
948
|
</h2>
|
|
958
949
|
<div class="content"><p>Copyright 2006 Suraj N. Kurapati <SNK at GNA dot ORG></p>
|
|
959
950
|
|
|
@@ -988,17 +979,36 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
988
979
|
<span class="caps">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE</span>.</p></div>
|
|
989
980
|
</div><div class="section">
|
|
990
981
|
<h2 class="title">
|
|
991
|
-
<a class="toc" id="Reviews" href="#a-
|
|
982
|
+
<a class="toc" id="Reviews" href="#a-605632198">1.3</a> Reviews
|
|
992
983
|
</h2>
|
|
993
984
|
<div class="content"><blockquote>
|
|
994
|
-
<p>I actually felt like printing it [this 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 [this user guide]
|
|
995
|
-
</blockquote
|
|
985
|
+
<p>I actually felt like printing it [this 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 [this user guide].</p>
|
|
986
|
+
</blockquote>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
<p style="text-align:right;">—<em>Vitor Peres</em> in <a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052">ruby-talk</a></p>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
<blockquote>
|
|
993
|
+
<p>[this user guide is] a insanely complete and nice looking bit of documentation [... Gerbil] looks like a great project</p>
|
|
994
|
+
</blockquote>
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
<p style="text-align:right;">—<em>Ara T. Howard</em> in <a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/282949">ruby-talk</a></p>
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
<blockquote>
|
|
1001
|
+
<p>Very nice work indeed!</p>
|
|
1002
|
+
</blockquote>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
<p style="text-align:right;">—<em>Martin DeMello</em> in <a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283304">ruby-talk</a></p></div>
|
|
996
1006
|
</div></p></div>
|
|
997
1007
|
</div>
|
|
998
1008
|
<div class="chapter">
|
|
999
1009
|
<h1 class="title">
|
|
1000
1010
|
Chapter
|
|
1001
|
-
<a class="toc" id="Setup" href="#a-
|
|
1011
|
+
<a class="toc" id="Setup" href="#a-606224088">2</a>
|
|
1002
1012
|
|
|
1003
1013
|
<br/>
|
|
1004
1014
|
|
|
@@ -1007,7 +1017,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
1007
1017
|
|
|
1008
1018
|
<div class="content"><div class="section">
|
|
1009
1019
|
<h2 class="title">
|
|
1010
|
-
<a class="toc" id="Requirements" href="#a-
|
|
1020
|
+
<a class="toc" id="Requirements" href="#a-606230308">2.1</a> Requirements
|
|
1011
1021
|
</h2>
|
|
1012
1022
|
<div class="content"><p>Your system needs the following software to run Gerbil.</p>
|
|
1013
1023
|
|
|
@@ -1040,7 +1050,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
1040
1050
|
<pre>gem install RedCloth coderay</pre></div>
|
|
1041
1051
|
</div><div class="section">
|
|
1042
1052
|
<h2 class="title">
|
|
1043
|
-
<a class="toc" id="Installation" href="#a-
|
|
1053
|
+
<a class="toc" id="Installation" href="#a-606242938">2.2</a> Installation
|
|
1044
1054
|
</h2>
|
|
1045
1055
|
<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>
|
|
1046
1056
|
|
|
@@ -1060,14 +1070,14 @@ Otherwise, follow these instructions:
|
|
|
1060
1070
|
<pre>ruby bin/gerbil -v</pre>
|
|
1061
1071
|
|
|
1062
1072
|
|
|
1063
|
-
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 3.0.
|
|
1073
|
+
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 3.0.1 (2008-06-03) http://gerbil.rubyforge.org /home/sun/src/gerbil
|
|
1064
1074
|
</pre></p>
|
|
1065
1075
|
|
|
1066
1076
|
|
|
1067
1077
|
<p>Otherwise, you can <a class="xref" href="#License">contact the author</a> for help.</p></div>
|
|
1068
1078
|
</div><div class="section">
|
|
1069
1079
|
<h2 class="title">
|
|
1070
|
-
<a class="toc" id="Manifest" href="#a-
|
|
1080
|
+
<a class="toc" id="Manifest" href="#a-606249628">2.3</a> Manifest
|
|
1071
1081
|
</h2>
|
|
1072
1082
|
<div class="content">Now that Gerbil is installed on your system, let us examine its installation directory.
|
|
1073
1083
|
<ul>
|
|
@@ -1088,22 +1098,32 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1088
1098
|
<li><tt>latex.yaml</tt> – high-quality typesetting</li>
|
|
1089
1099
|
<li><tt>html.yaml</tt> – web page for the Internet</li>
|
|
1090
1100
|
<li><tt>man.yaml</tt> – manual page for UNIX</li>
|
|
1091
|
-
<li><tt>text.yaml</tt> – plain text, nothing fancy
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
</
|
|
1101
|
+
<li><tt>text.yaml</tt> – plain text, nothing fancy</li>
|
|
1102
|
+
</ul>
|
|
1103
|
+
</li>
|
|
1104
|
+
<li><tt>lib/</tt> – Gerbil automatically adds this directory to Ruby’s load path.
|
|
1105
|
+
<ul>
|
|
1106
|
+
<li><tt>gerbil.rb</tt> – project version information.</li>
|
|
1107
|
+
<li><tt>gerbil/</tt>
|
|
1108
|
+
<ul>
|
|
1109
|
+
<li><tt>html.rb</tt> – provides the <code class="code"><span style="color:#036; font-weight:bold">String</span><span style="color:#888">#to_html</span></code> method.</li>
|
|
1110
|
+
<li><tt>rdoc.rb</tt> – provides RDoc parse trees to Ruby code.</li>
|
|
1111
|
+
</ul>
|
|
1112
|
+
</li>
|
|
1113
|
+
</ul>
|
|
1114
|
+
</li>
|
|
1115
|
+
<li><tt>doc/</tt> – contains the user guide and other documentation.
|
|
1116
|
+
<ul>
|
|
1117
|
+
<li><tt>gerbil.svg</tt> – the source file of the Gerbil logo.</li>
|
|
1118
|
+
<li><tt>guide.erb</tt> – the source file of this user guide.</li>
|
|
1119
|
+
<li><tt>api/</tt> – contains API reference documentation for the provided Ruby code.</li>
|
|
1120
|
+
</ul>
|
|
1121
|
+
</li>
|
|
1122
|
+
<li><tt>LICENSE</tt> – the project license and copyright notice.</li>
|
|
1103
1123
|
</ul></div>
|
|
1104
1124
|
</div><div class="section">
|
|
1105
1125
|
<h2 class="title">
|
|
1106
|
-
<a class="toc" id="Version-numbering-system" href="#a-
|
|
1126
|
+
<a class="toc" id="Version-numbering-system" href="#a-606270528">2.4</a> Version numbering system
|
|
1107
1127
|
</h2>
|
|
1108
1128
|
<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.
|
|
1109
1129
|
|
|
@@ -1139,7 +1159,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1139
1159
|
<div class="chapter">
|
|
1140
1160
|
<h1 class="title">
|
|
1141
1161
|
Chapter
|
|
1142
|
-
<a class="toc" id="Theory-of-operation" href="#a-
|
|
1162
|
+
<a class="toc" id="Theory-of-operation" href="#a-606275468">3</a>
|
|
1143
1163
|
|
|
1144
1164
|
<br/>
|
|
1145
1165
|
|
|
@@ -1171,7 +1191,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1171
1191
|
|
|
1172
1192
|
<p><div class="section">
|
|
1173
1193
|
<h2 class="title">
|
|
1174
|
-
<a class="toc" id="Nodes" href="#a-
|
|
1194
|
+
<a class="toc" id="Nodes" href="#a-606297318">3.1</a> Nodes
|
|
1175
1195
|
</h2>
|
|
1176
1196
|
<div class="content"><p>A node is a block of text that appears like this:</p>
|
|
1177
1197
|
|
|
@@ -1229,7 +1249,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1229
1249
|
|
|
1230
1250
|
<p><div class="section">
|
|
1231
1251
|
<h3 class="title">
|
|
1232
|
-
<a class="toc" id="Node.class" href="#a-
|
|
1252
|
+
<a class="toc" id="Node.class" href="#a-606311398">3.1.1</a> The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class
|
|
1233
1253
|
</h3>
|
|
1234
1254
|
<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>
|
|
1235
1255
|
|
|
@@ -1305,7 +1325,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1305
1325
|
</div>
|
|
1306
1326
|
<div class="section">
|
|
1307
1327
|
<h2 class="title">
|
|
1308
|
-
<a class="toc" id="SpecFile" href="#a-
|
|
1328
|
+
<a class="toc" id="SpecFile" href="#a-606316358">3.2</a> Format specification file
|
|
1309
1329
|
</h2>
|
|
1310
1330
|
<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>
|
|
1311
1331
|
|
|
@@ -1343,7 +1363,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1343
1363
|
|
|
1344
1364
|
<p><div class="section">
|
|
1345
1365
|
<h3 class="title">
|
|
1346
|
-
<a class="toc" id="SpecFile.nodes" href="#a-
|
|
1366
|
+
<a class="toc" id="SpecFile.nodes" href="#a-606327518">3.2.1</a> Node definition
|
|
1347
1367
|
</h3>
|
|
1348
1368
|
<div class="content"><p>A node definition is a mapping from a name (the “node type”) to the following set of parameters:</p>
|
|
1349
1369
|
|
|
@@ -1384,7 +1404,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1384
1404
|
|
|
1385
1405
|
<p><div class="section">
|
|
1386
1406
|
<h4 class="title">
|
|
1387
|
-
<a class="toc" id="SpecFile.nodes.output" href="#a-
|
|
1407
|
+
<a class="toc" id="SpecFile.nodes.output" href="#a-606334598">3.2.1.1</a> Node output template
|
|
1388
1408
|
</h4>
|
|
1389
1409
|
<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>
|
|
1390
1410
|
|
|
@@ -1452,7 +1472,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1452
1472
|
</div>
|
|
1453
1473
|
<div class="section">
|
|
1454
1474
|
<h3 class="title">
|
|
1455
|
-
<a class="toc" id="SpecFile.output" href="#a-
|
|
1475
|
+
<a class="toc" id="SpecFile.output" href="#a-606341178">3.2.2</a> Document output template
|
|
1456
1476
|
</h3>
|
|
1457
1477
|
<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>
|
|
1458
1478
|
|
|
@@ -1518,7 +1538,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1518
1538
|
</table></div>
|
|
1519
1539
|
</div><div class="section">
|
|
1520
1540
|
<h3 class="title">
|
|
1521
|
-
<a class="toc" id="HelloWorld" href="#a-
|
|
1541
|
+
<a class="toc" id="HelloWorld" href="#a-606345928">3.2.3</a> Creating your own custom format
|
|
1522
1542
|
</h3>
|
|
1523
1543
|
<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:
|
|
1524
1544
|
<ul>
|
|
@@ -1537,7 +1557,7 @@ To run this example, perform the following steps:
|
|
|
1537
1557
|
|
|
1538
1558
|
|
|
1539
1559
|
<p><div class="example">
|
|
1540
|
-
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-
|
|
1560
|
+
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606367378">Example 1</a>. HelloWorld format specification file</p>
|
|
1541
1561
|
<div class="content"><pre class="code" lang="rhtml">desc: A illustrative format.
|
|
1542
1562
|
|
|
1543
1563
|
code: |
|
|
@@ -1606,7 +1626,7 @@ output: |
|
|
|
1606
1626
|
That's all folks!
|
|
1607
1627
|
</pre></div>
|
|
1608
1628
|
</div><div class="example">
|
|
1609
|
-
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-
|
|
1629
|
+
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-606372658">Example 2</a>. Input document for HelloWorld format</p>
|
|
1610
1630
|
<div class="content"><pre class="code" lang="rhtml"><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>
|
|
1611
1631
|
<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>
|
|
1612
1632
|
<span style="color:#070"><big></span>I'm<span style="color:#070"></big></span> the very first node, oh _yes_ I am! *sneer*
|
|
@@ -1645,10 +1665,10 @@ output: |
|
|
|
1645
1665
|
|
|
1646
1666
|
<span style="background: #eee"><span style="color:black"><%=</span> hello <span style="background-color:#fff0f0"><span style="color:#710">"</span><span style="color:#D20">Independent (no block, no parents, I am _free_!)</span><span style="color:#710">"</span></span> <span style="color:black">%></span></span></pre></div>
|
|
1647
1667
|
</div><div class="example">
|
|
1648
|
-
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-
|
|
1668
|
+
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-606375948">Example 3</a>. Output of HelloWorld format</p>
|
|
1649
1669
|
<div class="content">Welcome to the “HelloWorld” format.
|
|
1650
|
-
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “
|
|
1651
|
-
My name is “
|
|
1670
|
+
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “hojes”</h1>
|
|
1671
|
+
My name is “hojes” and these are my properties:
|
|
1652
1672
|
<table border="1">
|
|
1653
1673
|
<tr>
|
|
1654
1674
|
<th>Property</th>
|
|
@@ -1674,8 +1694,8 @@ My name is “riju” and these are my properties:
|
|
|
1674
1694
|
<td>content</td>
|
|
1675
1695
|
<td> <big>I’m</big> the very first node, oh <em>yes</em> I am! <strong>sneer</strong>
|
|
1676
1696
|
|
|
1677
|
-
<h1>hello #1.1: “
|
|
1678
|
-
My name is “
|
|
1697
|
+
<h1>hello #1.1: “pevu”</h1>
|
|
1698
|
+
My name is “pevu” and these are my properties:
|
|
1679
1699
|
<table border="1">
|
|
1680
1700
|
<tr>
|
|
1681
1701
|
<th>Property</th>
|
|
@@ -1695,14 +1715,14 @@ My name is “mokej” and these are my properties:
|
|
|
1695
1715
|
</tr>
|
|
1696
1716
|
<tr>
|
|
1697
1717
|
<td>trace</td>
|
|
1698
|
-
<td><ul><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1718
|
+
<td><ul><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1699
1719
|
</tr>
|
|
1700
1720
|
<tr>
|
|
1701
1721
|
<td>content</td>
|
|
1702
1722
|
<td> Hi, I… <strong>hide</strong>
|
|
1703
1723
|
|
|
1704
|
-
<h1>hello #1.1.1: “
|
|
1705
|
-
My name is “
|
|
1724
|
+
<h1>hello #1.1.1: “bepole”</h1>
|
|
1725
|
+
My name is “bepole” and these are my properties:
|
|
1706
1726
|
<table border="1">
|
|
1707
1727
|
<tr>
|
|
1708
1728
|
<th>Property</th>
|
|
@@ -1722,14 +1742,14 @@ My name is “fapusod” and these are my properties:
|
|
|
1722
1742
|
</tr>
|
|
1723
1743
|
<tr>
|
|
1724
1744
|
<td>trace</td>
|
|
1725
|
-
<td><ul><li>INPUT:5</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1745
|
+
<td><ul><li>INPUT:5</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1726
1746
|
</tr>
|
|
1727
1747
|
<tr>
|
|
1728
1748
|
<td>content</td>
|
|
1729
1749
|
<td> <strong>sigh</strong>
|
|
1730
1750
|
|
|
1731
|
-
<h1>hello #1.1.1.1: “
|
|
1732
|
-
My name is “
|
|
1751
|
+
<h1>hello #1.1.1.1: “sehobak”</h1>
|
|
1752
|
+
My name is “sehobak” and these are my properties:
|
|
1733
1753
|
<table border="1">
|
|
1734
1754
|
<tr>
|
|
1735
1755
|
<th>Property</th>
|
|
@@ -1749,7 +1769,7 @@ My name is “genebi” and these are my properties:
|
|
|
1749
1769
|
</tr>
|
|
1750
1770
|
<tr>
|
|
1751
1771
|
<td>trace</td>
|
|
1752
|
-
<td><ul><li>INPUT:7</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1772
|
+
<td><ul><li>INPUT:7</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:5</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1753
1773
|
</tr>
|
|
1754
1774
|
<tr>
|
|
1755
1775
|
<td>content</td>
|
|
@@ -1759,8 +1779,8 @@ My name is “genebi” and these are my properties:
|
|
|
1759
1779
|
</table></td>
|
|
1760
1780
|
</tr>
|
|
1761
1781
|
</table>
|
|
1762
|
-
<h1>hello #1.1.2: “
|
|
1763
|
-
My name is “
|
|
1782
|
+
<h1>hello #1.1.2: “bozobe”</h1>
|
|
1783
|
+
My name is “bozobe” and these are my properties:
|
|
1764
1784
|
<table border="1">
|
|
1765
1785
|
<tr>
|
|
1766
1786
|
<th>Property</th>
|
|
@@ -1780,7 +1800,7 @@ My name is “yel” and these are my properties:
|
|
|
1780
1800
|
</tr>
|
|
1781
1801
|
<tr>
|
|
1782
1802
|
<td>trace</td>
|
|
1783
|
-
<td><ul><li>INPUT:9</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1803
|
+
<td><ul><li>INPUT:9</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1784
1804
|
</tr>
|
|
1785
1805
|
<tr>
|
|
1786
1806
|
<td>content</td>
|
|
@@ -1790,8 +1810,8 @@ My name is “yel” and these are my properties:
|
|
|
1790
1810
|
</table></td>
|
|
1791
1811
|
</tr>
|
|
1792
1812
|
</table>
|
|
1793
|
-
<h1>hello #1.2: “
|
|
1794
|
-
My name is “
|
|
1813
|
+
<h1>hello #1.2: “bolajo”</h1>
|
|
1814
|
+
My name is “bolajo” and these are my properties:
|
|
1795
1815
|
<table border="1">
|
|
1796
1816
|
<tr>
|
|
1797
1817
|
<th>Property</th>
|
|
@@ -1811,14 +1831,14 @@ My name is “fadi” and these are my properties:
|
|
|
1811
1831
|
</tr>
|
|
1812
1832
|
<tr>
|
|
1813
1833
|
<td>trace</td>
|
|
1814
|
-
<td><ul><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1834
|
+
<td><ul><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1815
1835
|
</tr>
|
|
1816
1836
|
<tr>
|
|
1817
1837
|
<td>content</td>
|
|
1818
1838
|
<td> <strong>yawn</strong> Just five more minutes…
|
|
1819
1839
|
|
|
1820
|
-
<h1>hello #1.2.1: “
|
|
1821
|
-
My name is “
|
|
1840
|
+
<h1>hello #1.2.1: “zumuyuh”</h1>
|
|
1841
|
+
My name is “zumuyuh” and these are my properties:
|
|
1822
1842
|
<table border="1">
|
|
1823
1843
|
<tr>
|
|
1824
1844
|
<th>Property</th>
|
|
@@ -1838,14 +1858,14 @@ My name is “bibom” and these are my properties:
|
|
|
1838
1858
|
</tr>
|
|
1839
1859
|
<tr>
|
|
1840
1860
|
<td>trace</td>
|
|
1841
|
-
<td><ul><li>INPUT:13</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1861
|
+
<td><ul><li>INPUT:13</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1842
1862
|
</tr>
|
|
1843
1863
|
<tr>
|
|
1844
1864
|
<td>content</td>
|
|
1845
1865
|
<td> So <em>be</em> happy my friend, <strong>happy</strong>!
|
|
1846
1866
|
|
|
1847
|
-
<h1>hello #1.2.1.1: “
|
|
1848
|
-
My name is “
|
|
1867
|
+
<h1>hello #1.2.1.1: “jane”</h1>
|
|
1868
|
+
My name is “jane” and these are my properties:
|
|
1849
1869
|
<table border="1">
|
|
1850
1870
|
<tr>
|
|
1851
1871
|
<th>Property</th>
|
|
@@ -1865,7 +1885,7 @@ My name is “gehi” and these are my properties:
|
|
|
1865
1885
|
</tr>
|
|
1866
1886
|
<tr>
|
|
1867
1887
|
<td>trace</td>
|
|
1868
|
-
<td><ul><li>INPUT:15</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:
|
|
1888
|
+
<td><ul><li>INPUT:15</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:13</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
|
|
1869
1889
|
</tr>
|
|
1870
1890
|
<tr>
|
|
1871
1891
|
<td>content</td>
|
|
@@ -1879,8 +1899,8 @@ My name is “gehi” and these are my properties:
|
|
|
1879
1899
|
</table></td>
|
|
1880
1900
|
</tr>
|
|
1881
1901
|
</table>
|
|
1882
|
-
<h1>hello #2: “
|
|
1883
|
-
My name is “
|
|
1902
|
+
<h1>hello #2: “lukopu”</h1>
|
|
1903
|
+
My name is “lukopu” and these are my properties:
|
|
1884
1904
|
<table border="1">
|
|
1885
1905
|
<tr>
|
|
1886
1906
|
<th>Property</th>
|
|
@@ -1909,8 +1929,8 @@ My name is “tusulo” and these are my properties:
|
|
|
1909
1929
|
</td>
|
|
1910
1930
|
</tr>
|
|
1911
1931
|
</table>
|
|
1912
|
-
<h1>hello #3: “
|
|
1913
|
-
My name is “
|
|
1932
|
+
<h1>hello #3: “lipa”</h1>
|
|
1933
|
+
My name is “lipa” and these are my properties:
|
|
1914
1934
|
<table border="1">
|
|
1915
1935
|
<tr>
|
|
1916
1936
|
<th>Property</th>
|
|
@@ -1945,7 +1965,7 @@ That’s all folks!</div>
|
|
|
1945
1965
|
<div class="chapter">
|
|
1946
1966
|
<h1 class="title">
|
|
1947
1967
|
Chapter
|
|
1948
|
-
<a class="toc" id="Usage" href="#a-
|
|
1968
|
+
<a class="toc" id="Usage" href="#a-606380128">4</a>
|
|
1949
1969
|
|
|
1950
1970
|
<br/>
|
|
1951
1971
|
|
|
@@ -1969,7 +1989,7 @@ That’s all folks!</div>
|
|
|
1969
1989
|
|
|
1970
1990
|
<ul>
|
|
1971
1991
|
<li>The <tt>--unindent</tt> option assumes that all beginning (<% ... do %>)
|
|
1972
|
-
and ending (<% end %>) eRuby directives
|
|
1992
|
+
and ending (<% end %>) eRuby directives are written one per line
|
|
1973
1993
|
(with nothing else on the line, except whitespace) in the input.</li>
|
|
1974
1994
|
</ul>
|
|
1975
1995
|
|
|
@@ -2024,7 +2044,7 @@ That’s all folks!</div>
|
|
|
2024
2044
|
|
|
2025
2045
|
<p><div class="section">
|
|
2026
2046
|
<h2 class="title">
|
|
2027
|
-
<a class="toc" id="include" href="#a-
|
|
2047
|
+
<a class="toc" id="include" href="#a-606387368">4.1</a> The <strong>include</strong> directive
|
|
2028
2048
|
</h2>
|
|
2029
2049
|
<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>
|
|
2030
2050
|
|
|
@@ -2041,7 +2061,7 @@ That’s all folks!</div>
|
|
|
2041
2061
|
<div class="part">
|
|
2042
2062
|
<h1 class="title">
|
|
2043
2063
|
Part
|
|
2044
|
-
<a class="toc" id="Formats" href="#a-
|
|
2064
|
+
<a class="toc" id="Formats" href="#a-606391088">5</a>
|
|
2045
2065
|
|
|
2046
2066
|
<br/>
|
|
2047
2067
|
|
|
@@ -2057,7 +2077,7 @@ That’s all folks!</div>
|
|
|
2057
2077
|
<p><div class="chapter">
|
|
2058
2078
|
<h1 class="title">
|
|
2059
2079
|
Chapter
|
|
2060
|
-
<a class="toc" id="html" href="#a-
|
|
2080
|
+
<a class="toc" id="html" href="#a-606403658">5.1</a>
|
|
2061
2081
|
|
|
2062
2082
|
<br/>
|
|
2063
2083
|
|
|
@@ -2075,7 +2095,7 @@ That’s all folks!</div>
|
|
|
2075
2095
|
|
|
2076
2096
|
<p><div class="section">
|
|
2077
2097
|
<h3 class="title">
|
|
2078
|
-
<a class="toc" id="Text-to-HTML-conversion" href="#a-
|
|
2098
|
+
<a class="toc" id="Text-to-HTML-conversion" href="#a-606405368">5.1.1</a> Text to HTML conversion
|
|
2079
2099
|
</h3>
|
|
2080
2100
|
<div class="content"><p>Inside the <tt>fmt/</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>
|
|
2081
2101
|
|
|
@@ -2100,7 +2120,7 @@ That’s all folks!</div>
|
|
|
2100
2120
|
|
|
2101
2121
|
<p><div class="section">
|
|
2102
2122
|
<h4 class="title">
|
|
2103
|
-
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-
|
|
2123
|
+
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-606410468">5.1.1.1</a> Syntax coloring for source code
|
|
2104
2124
|
</h4>
|
|
2105
2125
|
<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>
|
|
2106
2126
|
|
|
@@ -2118,7 +2138,7 @@ The following programming languages are currently supported by <a href="http://c
|
|
|
2118
2138
|
|
|
2119
2139
|
<p><div class="section">
|
|
2120
2140
|
<h5 class="title">
|
|
2121
|
-
<a class="toc" id="Specifying-the-programming-language" href="#a-
|
|
2141
|
+
<a class="toc" id="Specifying-the-programming-language" href="#a-606413238">5.1.1.1.1</a> Specifying the programming language
|
|
2122
2142
|
</h5>
|
|
2123
2143
|
<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>
|
|
2124
2144
|
|
|
@@ -2206,7 +2226,7 @@ int main(int argc, char **argv) {
|
|
|
2206
2226
|
</div>
|
|
2207
2227
|
<div class="section">
|
|
2208
2228
|
<h4 class="title">
|
|
2209
|
-
<a class="toc" id="Smart-sizing-of-source-code" href="#a-
|
|
2229
|
+
<a class="toc" id="Smart-sizing-of-source-code" href="#a-606418908">5.1.1.2</a> Smart sizing of source code
|
|
2210
2230
|
</h4>
|
|
2211
2231
|
<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>
|
|
2212
2232
|
|
|
@@ -2224,14 +2244,14 @@ int main(int argc, char **argv) {
|
|
|
2224
2244
|
<span style="color:#038; font-weight:bold">true</span> <span style="color:#080; font-weight:bold">or</span> <span style="color:#038; font-weight:bold">false</span></pre></div>
|
|
2225
2245
|
</div><div class="section">
|
|
2226
2246
|
<h4 class="title">
|
|
2227
|
-
<a class="toc" id="Protecting-verbatim-text" href="#a-
|
|
2247
|
+
<a class="toc" id="Protecting-verbatim-text" href="#a-606424048">5.1.1.3</a> Protecting verbatim text
|
|
2228
2248
|
</h4>
|
|
2229
2249
|
<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>
|
|
2230
2250
|
</div></p></div>
|
|
2231
2251
|
</div>
|
|
2232
2252
|
<div class="section">
|
|
2233
2253
|
<h3 class="title">
|
|
2234
|
-
<a class="toc" id="Parameters" href="#a-
|
|
2254
|
+
<a class="toc" id="Parameters" href="#a-606428098">5.1.2</a> Parameters
|
|
2235
2255
|
</h3>
|
|
2236
2256
|
<div class="content">The HTML format accepts the following document parameters.
|
|
2237
2257
|
|
|
@@ -2282,7 +2302,7 @@ int main(int argc, char **argv) {
|
|
|
2282
2302
|
</table></div>
|
|
2283
2303
|
</div><div class="section">
|
|
2284
2304
|
<h3 class="title">
|
|
2285
|
-
<a class="toc" id="Methods" href="#a-
|
|
2305
|
+
<a class="toc" id="Methods" href="#a-606435758">5.1.3</a> Methods
|
|
2286
2306
|
</h3>
|
|
2287
2307
|
<div class="content">The HTML format provides the following methods. In the method declarations shown below,
|
|
2288
2308
|
<ul>
|
|
@@ -2378,7 +2398,7 @@ ruby.
|
|
|
2378
2398
|
<div class="chapter">
|
|
2379
2399
|
<h1 class="title">
|
|
2380
2400
|
Chapter
|
|
2381
|
-
<a class="toc" id="html.nodes" href="#a-
|
|
2401
|
+
<a class="toc" id="html.nodes" href="#a-607086158">5.1.4</a>
|
|
2382
2402
|
|
|
2383
2403
|
<br/>
|
|
2384
2404
|
|
|
@@ -2421,29 +2441,29 @@ ruby.
|
|
|
2421
2441
|
|
|
2422
2442
|
<p><div class="section">
|
|
2423
2443
|
<h4 class="title">
|
|
2424
|
-
<a class="toc" id="Structure" href="#a-
|
|
2444
|
+
<a class="toc" id="Structure" href="#a-607097148">5.1.4.1</a> Structure
|
|
2425
2445
|
</h4>
|
|
2426
2446
|
<div class="content"><p>The nodes described in this section form the overall structure of the output document.</p>
|
|
2427
2447
|
|
|
2428
2448
|
|
|
2429
2449
|
<p><div class="section">
|
|
2430
2450
|
<h5 class="title">
|
|
2431
|
-
<a class="toc" id="html.nodes.header" href="#a-
|
|
2451
|
+
<a class="toc" id="html.nodes.header" href="#a-607098828">5.1.4.1.1</a> header
|
|
2432
2452
|
</h5>
|
|
2433
2453
|
<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>
|
|
2434
2454
|
</div><div class="section">
|
|
2435
2455
|
<h5 class="title">
|
|
2436
|
-
<a class="toc" id="html.nodes.footer" href="#a-
|
|
2456
|
+
<a class="toc" id="html.nodes.footer" href="#a-607100888">5.1.4.1.2</a> footer
|
|
2437
2457
|
</h5>
|
|
2438
2458
|
<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>
|
|
2439
2459
|
</div><div class="section">
|
|
2440
2460
|
<h5 class="title">
|
|
2441
|
-
<a class="toc" id="html.nodes.abstract" href="#a-
|
|
2461
|
+
<a class="toc" id="html.nodes.abstract" href="#a-607102978">5.1.4.1.3</a> abstract
|
|
2442
2462
|
</h5>
|
|
2443
2463
|
<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>
|
|
2444
2464
|
</div><div class="section">
|
|
2445
2465
|
<h5 class="title">
|
|
2446
|
-
<a class="toc" id="html.nodes.xref" href="#a-
|
|
2466
|
+
<a class="toc" id="html.nodes.xref" href="#a-607105098">5.1.4.1.4</a> xref
|
|
2447
2467
|
</h5>
|
|
2448
2468
|
<div class="content"><p>A cross-reference; a hyperlink that takes you to any node in the document.</p>
|
|
2449
2469
|
|
|
@@ -2474,14 +2494,14 @@ ruby.
|
|
|
2474
2494
|
</div>
|
|
2475
2495
|
<div class="section">
|
|
2476
2496
|
<h4 class="title">
|
|
2477
|
-
<a class="toc" id="Organization" href="#a-
|
|
2497
|
+
<a class="toc" id="Organization" href="#a-607110998">5.1.4.2</a> Organization
|
|
2478
2498
|
</h4>
|
|
2479
2499
|
<div class="content"><p>The nodes described in this section are meant to help organize the document’s content logically.</p>
|
|
2480
2500
|
|
|
2481
2501
|
|
|
2482
2502
|
<p><div class="section">
|
|
2483
2503
|
<h5 class="title">
|
|
2484
|
-
<a class="toc" id="html.nodes.part" href="#a-
|
|
2504
|
+
<a class="toc" id="html.nodes.part" href="#a-607112708">5.1.4.2.1</a> part
|
|
2485
2505
|
</h5>
|
|
2486
2506
|
<div class="content"><p>A collection of chapters.</p>
|
|
2487
2507
|
|
|
@@ -2489,7 +2509,7 @@ ruby.
|
|
|
2489
2509
|
<p><div class="part">
|
|
2490
2510
|
<h1 class="title">
|
|
2491
2511
|
Part
|
|
2492
|
-
<a class="toc" id="An-example" href="#a-
|
|
2512
|
+
<a class="toc" id="An-example" href="#a-607114368">5.1.4.2.1.1</a>
|
|
2493
2513
|
|
|
2494
2514
|
<br/>
|
|
2495
2515
|
|
|
@@ -2501,7 +2521,7 @@ ruby.
|
|
|
2501
2521
|
</div>
|
|
2502
2522
|
<div class="section">
|
|
2503
2523
|
<h5 class="title">
|
|
2504
|
-
<a class="toc" id="html.nodes.chapter" href="#a-
|
|
2524
|
+
<a class="toc" id="html.nodes.chapter" href="#a-607116878">5.1.4.2.2</a> chapter
|
|
2505
2525
|
</h5>
|
|
2506
2526
|
<div class="content"><p>A collection of sections.</p>
|
|
2507
2527
|
|
|
@@ -2509,7 +2529,7 @@ ruby.
|
|
|
2509
2529
|
<p><div class="chapter">
|
|
2510
2530
|
<h1 class="title">
|
|
2511
2531
|
Chapter
|
|
2512
|
-
<a class="toc" id="An-example-
|
|
2532
|
+
<a class="toc" id="An-example-607233838" href="#a-607118568">5.1.4.2.2.1</a>
|
|
2513
2533
|
|
|
2514
2534
|
<br/>
|
|
2515
2535
|
|
|
@@ -2521,21 +2541,21 @@ ruby.
|
|
|
2521
2541
|
</div>
|
|
2522
2542
|
<div class="section">
|
|
2523
2543
|
<h5 class="title">
|
|
2524
|
-
<a class="toc" id="html.nodes.section" href="#a-
|
|
2544
|
+
<a class="toc" id="html.nodes.section" href="#a-607121078">5.1.4.2.3</a> section
|
|
2525
2545
|
</h5>
|
|
2526
2546
|
<div class="content"><p>A collection of paragraphs about a particular topic.</p>
|
|
2527
2547
|
|
|
2528
2548
|
|
|
2529
2549
|
<p><div class="section">
|
|
2530
2550
|
<h6 class="title">
|
|
2531
|
-
<a class="toc" id="An-example-
|
|
2551
|
+
<a class="toc" id="An-example-607318508" href="#a-607122798">5.1.4.2.3.1</a> An example
|
|
2532
2552
|
</h6>
|
|
2533
2553
|
<div class="content">This is what a <strong>section</strong> node appears like.</div>
|
|
2534
2554
|
</div></p></div>
|
|
2535
2555
|
</div>
|
|
2536
2556
|
<div class="section">
|
|
2537
2557
|
<h5 class="title">
|
|
2538
|
-
<a class="toc" id="html.nodes.paragraph" href="#a-
|
|
2558
|
+
<a class="toc" id="html.nodes.paragraph" href="#a-607125308">5.1.4.2.4</a> paragraph
|
|
2539
2559
|
</h5>
|
|
2540
2560
|
<div class="content"><p>A collection of sentences about a particular idea.</p>
|
|
2541
2561
|
|
|
@@ -2548,7 +2568,7 @@ ruby.
|
|
|
2548
2568
|
</div>
|
|
2549
2569
|
<div class="section">
|
|
2550
2570
|
<h4 class="title">
|
|
2551
|
-
<a class="toc" id="Admonitions" href="#a-
|
|
2571
|
+
<a class="toc" id="Admonitions" href="#a-607129548">5.1.4.3</a> Admonitions
|
|
2552
2572
|
</h4>
|
|
2553
2573
|
<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>
|
|
2554
2574
|
|
|
@@ -2558,13 +2578,13 @@ ruby.
|
|
|
2558
2578
|
|
|
2559
2579
|
<p><div class="section">
|
|
2560
2580
|
<h5 class="title">
|
|
2561
|
-
<a class="toc" id="html.nodes.warning" href="#a-
|
|
2581
|
+
<a class="toc" id="html.nodes.warning" href="#a-607137108">5.1.4.3.1</a> warning
|
|
2562
2582
|
</h5>
|
|
2563
2583
|
<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>
|
|
2564
2584
|
|
|
2565
2585
|
|
|
2566
2586
|
<p><div class="warning">
|
|
2567
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2587
|
+
<p class="title"><a class="toc" id="An-example-607385828" href="#a-607144268">Warning 1</a>. An example</p>
|
|
2568
2588
|
|
|
2569
2589
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2570
2590
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2629,7 +2649,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2629
2649
|
</div>
|
|
2630
2650
|
<div class="section">
|
|
2631
2651
|
<h5 class="title">
|
|
2632
|
-
<a class="toc" id="html.nodes.caution" href="#a-
|
|
2652
|
+
<a class="toc" id="html.nodes.caution" href="#a-607150658">5.1.4.3.2</a> caution
|
|
2633
2653
|
</h5>
|
|
2634
2654
|
<div class="content"><blockquote>
|
|
2635
2655
|
<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>
|
|
@@ -2637,7 +2657,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2637
2657
|
|
|
2638
2658
|
|
|
2639
2659
|
<p><div class="caution">
|
|
2640
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2660
|
+
<p class="title"><a class="toc" id="An-example-607415138" href="#a-607162048">Caution 1</a>. An example</p>
|
|
2641
2661
|
|
|
2642
2662
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2643
2663
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2698,7 +2718,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2698
2718
|
</div>
|
|
2699
2719
|
<div class="section">
|
|
2700
2720
|
<h5 class="title">
|
|
2701
|
-
<a class="toc" id="html.nodes.important" href="#a-
|
|
2721
|
+
<a class="toc" id="html.nodes.important" href="#a-607171128">5.1.4.3.3</a> important
|
|
2702
2722
|
</h5>
|
|
2703
2723
|
<div class="content"><p>Use an <strong>important</strong> node when:</p>
|
|
2704
2724
|
|
|
@@ -2709,7 +2729,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2709
2729
|
|
|
2710
2730
|
|
|
2711
2731
|
<p><div class="important">
|
|
2712
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2732
|
+
<p class="title"><a class="toc" id="An-example-607446208" href="#a-607180908">Important 1</a>. An example</p>
|
|
2713
2733
|
|
|
2714
2734
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2715
2735
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2774,7 +2794,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2774
2794
|
</div>
|
|
2775
2795
|
<div class="section">
|
|
2776
2796
|
<h5 class="title">
|
|
2777
|
-
<a class="toc" id="html.nodes.note" href="#a-
|
|
2797
|
+
<a class="toc" id="html.nodes.note" href="#a-607188888">5.1.4.3.4</a> note
|
|
2778
2798
|
</h5>
|
|
2779
2799
|
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
|
|
2780
2800
|
|
|
@@ -2785,7 +2805,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2785
2805
|
|
|
2786
2806
|
|
|
2787
2807
|
<p><div class="note">
|
|
2788
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2808
|
+
<p class="title"><a class="toc" id="An-example-607482008" href="#a-607197468">Note 2</a>. An example</p>
|
|
2789
2809
|
|
|
2790
2810
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2791
2811
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2851,7 +2871,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2851
2871
|
</div>
|
|
2852
2872
|
<div class="section">
|
|
2853
2873
|
<h5 class="title">
|
|
2854
|
-
<a class="toc" id="html.nodes.tip" href="#a-
|
|
2874
|
+
<a class="toc" id="html.nodes.tip" href="#a-607204238">5.1.4.3.5</a> tip
|
|
2855
2875
|
</h5>
|
|
2856
2876
|
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
|
|
2857
2877
|
|
|
@@ -2862,7 +2882,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2862
2882
|
|
|
2863
2883
|
|
|
2864
2884
|
<p><div class="tip">
|
|
2865
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2885
|
+
<p class="title"><a class="toc" id="An-example-607512348" href="#a-607210208">Tip 1</a>. An example</p>
|
|
2866
2886
|
|
|
2867
2887
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2868
2888
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2947,79 +2967,79 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
2947
2967
|
</div>
|
|
2948
2968
|
<div class="section">
|
|
2949
2969
|
<h4 class="title">
|
|
2950
|
-
<a class="toc" id="Auxilary-materials" href="#a-
|
|
2970
|
+
<a class="toc" id="Auxilary-materials" href="#a-607216148">5.1.4.4</a> Auxilary materials
|
|
2951
2971
|
</h4>
|
|
2952
2972
|
<div class="content"><div class="section">
|
|
2953
2973
|
<h5 class="title">
|
|
2954
|
-
<a class="toc" id="html.nodes.figure" href="#a-
|
|
2974
|
+
<a class="toc" id="html.nodes.figure" href="#a-607218348">5.1.4.4.1</a> figure
|
|
2955
2975
|
</h5>
|
|
2956
2976
|
<div class="content"><p>A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.</p>
|
|
2957
2977
|
|
|
2958
2978
|
|
|
2959
2979
|
<p><div class="figure">
|
|
2960
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2980
|
+
<p class="title"><a class="toc" id="An-example-607547218" href="#a-607223838">Figure 1</a>. An example</p>
|
|
2961
2981
|
<div class="content">This is what a <strong>figure</strong> node appears like.</div>
|
|
2962
2982
|
</div></p></div>
|
|
2963
2983
|
</div>
|
|
2964
2984
|
<div class="section">
|
|
2965
2985
|
<h5 class="title">
|
|
2966
|
-
<a class="toc" id="html.nodes.table" href="#a-
|
|
2986
|
+
<a class="toc" id="html.nodes.table" href="#a-607230208">5.1.4.4.2</a> table
|
|
2967
2987
|
</h5>
|
|
2968
2988
|
<div class="content"><p>Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.</p>
|
|
2969
2989
|
|
|
2970
2990
|
|
|
2971
2991
|
<p><div class="table">
|
|
2972
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2992
|
+
<p class="title"><a class="toc" id="An-example-607569478" href="#a-607232528">Table 1</a>. An example</p>
|
|
2973
2993
|
<div class="content">This is what a <strong>table</strong> node appears like.</div>
|
|
2974
2994
|
</div></p></div>
|
|
2975
2995
|
</div>
|
|
2976
2996
|
<div class="section">
|
|
2977
2997
|
<h5 class="title">
|
|
2978
|
-
<a class="toc" id="html.nodes.example" href="#a-
|
|
2998
|
+
<a class="toc" id="html.nodes.example" href="#a-607237168">5.1.4.4.3</a> example
|
|
2979
2999
|
</h5>
|
|
2980
3000
|
<div class="content"><p>A sample application of an idea or thought.</p>
|
|
2981
3001
|
|
|
2982
3002
|
|
|
2983
3003
|
<p><div class="example">
|
|
2984
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3004
|
+
<p class="title"><a class="toc" id="An-example-607591898" href="#a-607243068">Example 4</a>. An example</p>
|
|
2985
3005
|
<div class="content">This is what a <strong>example</strong> node appears like.</div>
|
|
2986
3006
|
</div></p></div>
|
|
2987
3007
|
</div>
|
|
2988
3008
|
<div class="section">
|
|
2989
3009
|
<h5 class="title">
|
|
2990
|
-
<a class="toc" id="html.nodes.equation" href="#a-
|
|
3010
|
+
<a class="toc" id="html.nodes.equation" href="#a-607247028">5.1.4.4.4</a> equation
|
|
2991
3011
|
</h5>
|
|
2992
3012
|
<div class="content"><p>A mathematical equation or formula.</p>
|
|
2993
3013
|
|
|
2994
3014
|
|
|
2995
3015
|
<p><div class="equation">
|
|
2996
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3016
|
+
<p class="title"><a class="toc" id="An-example-607613748" href="#a-607252048">Equation 1</a>. An example</p>
|
|
2997
3017
|
<div class="content">This is what a <strong>equation</strong> node appears like.</div>
|
|
2998
3018
|
</div></p></div>
|
|
2999
3019
|
</div>
|
|
3000
3020
|
<div class="section">
|
|
3001
3021
|
<h5 class="title">
|
|
3002
|
-
<a class="toc" id="html.nodes.procedure" href="#a-
|
|
3022
|
+
<a class="toc" id="html.nodes.procedure" href="#a-607258168">5.1.4.4.5</a> procedure
|
|
3003
3023
|
</h5>
|
|
3004
3024
|
<div class="content"><p>An outline; a series of steps outlining some kind of process.</p>
|
|
3005
3025
|
|
|
3006
3026
|
|
|
3007
3027
|
<p><div class="procedure">
|
|
3008
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3028
|
+
<p class="title"><a class="toc" id="An-example-607635968" href="#a-607264288">Procedure 1</a>. An example</p>
|
|
3009
3029
|
<div class="content">This is what a <strong>procedure</strong> node appears like.</div>
|
|
3010
3030
|
</div></p></div>
|
|
3011
3031
|
</div></div>
|
|
3012
3032
|
</div>
|
|
3013
3033
|
<div class="section">
|
|
3014
3034
|
<h4 class="title">
|
|
3015
|
-
<a class="toc" id="Bibliography" href="#a-
|
|
3035
|
+
<a class="toc" id="Bibliography" href="#a-607272348">5.1.4.5</a> Bibliography
|
|
3016
3036
|
</h4>
|
|
3017
3037
|
<div class="content"><p>The nodes in this section deal with attribution of ideas—an important weapon against plagiarism.</p>
|
|
3018
3038
|
|
|
3019
3039
|
|
|
3020
3040
|
<p><div class="section">
|
|
3021
3041
|
<h5 class="title">
|
|
3022
|
-
<a class="toc" id="html.nodes.reference" href="#a-
|
|
3042
|
+
<a class="toc" id="html.nodes.reference" href="#a-607282008">5.1.4.5.1</a> reference
|
|
3023
3043
|
</h5>
|
|
3024
3044
|
<div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
|
|
3025
3045
|
|
|
@@ -3034,7 +3054,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3034
3054
|
</div>
|
|
3035
3055
|
<div class="section">
|
|
3036
3056
|
<h5 class="title">
|
|
3037
|
-
<a class="toc" id="html.nodes.cite" href="#a-
|
|
3057
|
+
<a class="toc" id="html.nodes.cite" href="#a-607301808">5.1.4.5.2</a> cite
|
|
3038
3058
|
</h5>
|
|
3039
3059
|
<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>
|
|
3040
3060
|
|
|
@@ -3065,7 +3085,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3065
3085
|
<div class="chapter">
|
|
3066
3086
|
<h1 class="title">
|
|
3067
3087
|
Chapter
|
|
3068
|
-
<a class="toc" id="text" href="#a-
|
|
3088
|
+
<a class="toc" id="text" href="#a-607310378">5.2</a>
|
|
3069
3089
|
|
|
3070
3090
|
<br/>
|
|
3071
3091
|
|
|
@@ -3079,7 +3099,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3079
3099
|
</div><div class="chapter">
|
|
3080
3100
|
<h1 class="title">
|
|
3081
3101
|
Chapter
|
|
3082
|
-
<a class="toc" id="latex" href="#a-
|
|
3102
|
+
<a class="toc" id="latex" href="#a-607312648">5.3</a>
|
|
3083
3103
|
|
|
3084
3104
|
<br/>
|
|
3085
3105
|
|
|
@@ -3093,7 +3113,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3093
3113
|
</div><div class="chapter">
|
|
3094
3114
|
<h1 class="title">
|
|
3095
3115
|
Chapter
|
|
3096
|
-
<a class="toc" id="man" href="#a-
|
|
3116
|
+
<a class="toc" id="man" href="#a-607314888">5.4</a>
|
|
3097
3117
|
|
|
3098
3118
|
<br/>
|
|
3099
3119
|
|
|
@@ -3122,7 +3142,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3122
3142
|
|
|
3123
3143
|
<div id="footer">
|
|
3124
3144
|
|
|
3125
|
-
Generated on
|
|
3145
|
+
Generated on Tue Jun 03 21:04:07 -0700 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 3.0.1.
|
|
3126
3146
|
|
|
3127
3147
|
<p>The admonition icons (<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
3128
3148
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|