gerbil 1.1.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/Rakefile +2 -1
- data/bin/gerbil +2 -2
- data/doc/api/classes/RDoc.html +2 -54
- data/doc/api/classes/RDoc/{DummyOptions.html → AnyMethod.html} +64 -13
- data/doc/api/classes/RDoc/AnyMethod.src/M000004.html +18 -0
- data/doc/api/classes/RDoc/AnyMethod.src/M000005.html +23 -0
- data/doc/api/classes/RDoc/{DummyMixin.src → AnyMethod.src}/M000006.html +4 -4
- data/doc/api/classes/RDoc/AnyMethod.src/M000007.html +22 -0
- data/doc/api/classes/RDoc/TopLevel.html +250 -0
- data/doc/api/classes/RDoc/{DummyOptions.src/M000007.html → TopLevel.src/M000008.html} +4 -4
- data/doc/api/classes/RDoc/TopLevel.src/M000009.html +18 -0
- data/doc/api/classes/RDoc/TopLevel.src/M000010.html +18 -0
- data/doc/api/classes/RDoc/TopLevel.src/M000011.html +29 -0
- data/doc/api/classes/RDoc/TopLevel.src/M000012.html +25 -0
- data/doc/api/classes/RDoc/TopLevel.src/M000013.html +18 -0
- data/doc/api/created.rid +1 -1
- data/doc/api/files/lib/gerbil/rdoc_rb.html +1 -1
- data/doc/api/files/lib/gerbil_rb.html +2 -2
- data/doc/api/fr_class_index.html +2 -3
- data/doc/api/fr_method_index.html +10 -4
- data/doc/guide.erb +5 -11
- data/doc/guide.html +118 -124
- data/fmt/html.yaml +23 -9
- data/lib/gerbil.rb +12 -2
- data/lib/gerbil/rdoc.rb +104 -66
- metadata +16 -12
- data/doc/api/classes/RDoc.src/M000004.html +0 -26
- data/doc/api/classes/RDoc.src/M000005.html +0 -59
- data/doc/api/classes/RDoc/DummyMarkup.html +0 -119
- data/doc/api/classes/RDoc/DummyMixin.html +0 -131
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
|
|
6
6
|
<html>
|
|
7
7
|
<head>
|
|
8
|
-
<title>
|
|
8
|
+
<title>all_classes (RDoc::TopLevel)</title>
|
|
9
9
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
10
|
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
11
|
</head>
|
|
12
12
|
<body class="standalone-code">
|
|
13
|
-
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line
|
|
14
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-
|
|
15
|
-
<span class="ruby-
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 11</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">all_classes</span>
|
|
15
|
+
<span class="ruby-ivar">@@all_classes</span>.<span class="ruby-identifier">values</span>
|
|
16
16
|
<span class="ruby-keyword kw">end</span></pre>
|
|
17
17
|
</body>
|
|
18
18
|
</html>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>all_modules (RDoc::TopLevel)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 16</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">all_modules</span>
|
|
15
|
+
<span class="ruby-ivar">@@all_modules</span>.<span class="ruby-identifier">values</span>
|
|
16
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
17
|
+
</body>
|
|
18
|
+
</html>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>all_methods (RDoc::TopLevel)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 22</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">all_methods</span>
|
|
15
|
+
<span class="ruby-identifier">all_classes_and_modules</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">method_list</span> }.<span class="ruby-identifier">flatten</span>
|
|
16
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
17
|
+
</body>
|
|
18
|
+
</html>
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>refresh_all_classes_and_modules (RDoc::TopLevel)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 28</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">refresh_all_classes_and_modules</span>
|
|
15
|
+
<span class="ruby-identifier">visit</span> = <span class="ruby-identifier">lambda</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
|
|
16
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">NormalClass</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">SingleClass</span>
|
|
17
|
+
<span class="ruby-ivar">@@all_classes</span>[<span class="ruby-identifier">node</span>.<span class="ruby-identifier">full_name</span>] = <span class="ruby-identifier">node</span>
|
|
18
|
+
|
|
19
|
+
<span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">NormalModule</span>
|
|
20
|
+
<span class="ruby-ivar">@@all_modules</span>[<span class="ruby-identifier">node</span>.<span class="ruby-identifier">full_name</span>] = <span class="ruby-identifier">node</span>
|
|
21
|
+
<span class="ruby-keyword kw">end</span>
|
|
22
|
+
|
|
23
|
+
(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">classes</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">modules</span>).<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">visit</span>[<span class="ruby-identifier">n</span>] }
|
|
24
|
+
<span class="ruby-keyword kw">end</span>
|
|
25
|
+
|
|
26
|
+
<span class="ruby-identifier">all_classes_and_modules</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">visit</span>[<span class="ruby-identifier">n</span>] }
|
|
27
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
28
|
+
</body>
|
|
29
|
+
</html>
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>parse (RDoc::TopLevel)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 53</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">aCodeString</span>, <span class="ruby-identifier">aFileName</span> = <span class="ruby-keyword kw">__FILE__</span>
|
|
15
|
+
<span class="ruby-identifier">top</span> = <span class="ruby-constant">ParserFactory</span>.<span class="ruby-identifier">parser_for</span>(
|
|
16
|
+
<span class="ruby-constant">TopLevel</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">aFileName</span>), <span class="ruby-identifier">aFileName</span>,
|
|
17
|
+
<span class="ruby-identifier">aCodeString</span>, <span class="ruby-constant">DummyOptions</span>.<span class="ruby-identifier">new</span>, <span class="ruby-constant">Stats</span>.<span class="ruby-identifier">new</span>
|
|
18
|
+
).<span class="ruby-identifier">scan</span>
|
|
19
|
+
|
|
20
|
+
<span class="ruby-identifier">refresh_all_classes_and_modules</span>
|
|
21
|
+
|
|
22
|
+
<span class="ruby-identifier">top</span>
|
|
23
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
24
|
+
</body>
|
|
25
|
+
</html>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>parse_file (RDoc::TopLevel)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 72</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse_file</span> <span class="ruby-identifier">aFileName</span>
|
|
15
|
+
<span class="ruby-identifier">parse</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">aFileName</span>), <span class="ruby-identifier">aFileName</span>
|
|
16
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
17
|
+
</body>
|
|
18
|
+
</html>
|
data/doc/api/created.rid
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
Sun, 03 Feb 2008 22:52:32 -0800
|
|
@@ -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>Sun Feb 03 22:12:30 -0800 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 => '
|
|
98
|
+
<td class="context-item-value">{ :name => 'Gerbil', :version => '2.0.0', :release => '2008-02-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
|
data/doc/api/fr_class_index.html
CHANGED
|
@@ -21,9 +21,8 @@
|
|
|
21
21
|
<h1 class="section-bar">Classes</h1>
|
|
22
22
|
<div id="index-entries">
|
|
23
23
|
<a href="classes/RDoc.html">RDoc</a><br />
|
|
24
|
-
<a href="classes/RDoc/
|
|
25
|
-
<a href="classes/RDoc/
|
|
26
|
-
<a href="classes/RDoc/DummyOptions.html">RDoc::DummyOptions</a><br />
|
|
24
|
+
<a href="classes/RDoc/AnyMethod.html">RDoc::AnyMethod</a><br />
|
|
25
|
+
<a href="classes/RDoc/TopLevel.html">RDoc::TopLevel</a><br />
|
|
27
26
|
<a href="classes/String.html">String</a><br />
|
|
28
27
|
</div>
|
|
29
28
|
</div>
|
|
@@ -20,13 +20,19 @@
|
|
|
20
20
|
<div id="index">
|
|
21
21
|
<h1 class="section-bar">Methods</h1>
|
|
22
22
|
<div id="index-entries">
|
|
23
|
-
<a href="classes/RDoc.html#
|
|
24
|
-
<a href="classes/RDoc.html#
|
|
25
|
-
<a href="classes/RDoc/
|
|
26
|
-
<a href="classes/RDoc/
|
|
23
|
+
<a href="classes/RDoc/TopLevel.html#M000008">all_classes (RDoc::TopLevel)</a><br />
|
|
24
|
+
<a href="classes/RDoc/TopLevel.html#M000010">all_methods (RDoc::TopLevel)</a><br />
|
|
25
|
+
<a href="classes/RDoc/TopLevel.html#M000009">all_modules (RDoc::TopLevel)</a><br />
|
|
26
|
+
<a href="classes/RDoc/AnyMethod.html#M000006">comment_html (RDoc::AnyMethod)</a><br />
|
|
27
|
+
<a href="classes/RDoc/AnyMethod.html#M000005">decl (RDoc::AnyMethod)</a><br />
|
|
28
|
+
<a href="classes/RDoc/AnyMethod.html#M000004">full_name (RDoc::AnyMethod)</a><br />
|
|
29
|
+
<a href="classes/RDoc/TopLevel.html#M000012">parse (RDoc::TopLevel)</a><br />
|
|
30
|
+
<a href="classes/RDoc/TopLevel.html#M000013">parse_file (RDoc::TopLevel)</a><br />
|
|
31
|
+
<a href="classes/RDoc/TopLevel.html#M000011">refresh_all_classes_and_modules (RDoc::TopLevel)</a><br />
|
|
27
32
|
<a href="classes/String.html#M000003">thru_coderay (String)</a><br />
|
|
28
33
|
<a href="classes/String.html#M000002">thru_redcloth (String)</a><br />
|
|
29
34
|
<a href="classes/String.html#M000001">to_html (String)</a><br />
|
|
35
|
+
<a href="classes/RDoc/AnyMethod.html#M000007">top_level (RDoc::AnyMethod)</a><br />
|
|
30
36
|
</div>
|
|
31
37
|
</div>
|
|
32
38
|
</body>
|
data/doc/guide.erb
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
feed_icon_url = File.join(Gerbil[:website], 'feed-icon-28x28.png')
|
|
9
9
|
|
|
10
10
|
# parameters for the HTML format
|
|
11
|
-
$title = "
|
|
11
|
+
$title = "#{Gerbil} user guide"
|
|
12
12
|
$authors = { 'Suraj N. Kurapati' => 'http://snk.tuxfamily.org' }
|
|
13
13
|
$feeds = { feed_url => :rss }
|
|
14
14
|
$logo = '<img src="gerbil.png" alt="Gerbil logo" title="Gerbil logo"/>'
|
|
@@ -428,18 +428,12 @@
|
|
|
428
428
|
# load library for parsing method documentation
|
|
429
429
|
require 'gerbil/rdoc'
|
|
430
430
|
|
|
431
|
-
|
|
431
|
+
RDoc::TopLevel.parse @spec['code']
|
|
432
|
+
RDoc::TopLevel.parse_file 'lib/gerbil/html.rb'
|
|
432
433
|
|
|
433
|
-
|
|
434
|
-
html_rb_code = File.read(html_rb_path)
|
|
435
|
-
html_rb_tree = RDoc::gen_parse_trees(html_rb_code, html_rb_path)
|
|
436
|
-
|
|
437
|
-
trees = spec_tree + html_rb_tree
|
|
438
|
-
meths = RDoc::gen_method_infos(*trees)
|
|
439
|
-
|
|
440
|
-
meths.each do |m|
|
|
434
|
+
RDoc::TopLevel.all_methods.each do |m|
|
|
441
435
|
%>
|
|
442
|
-
|
|
|
436
|
+
| <code><%= m.decl %></code> | <noformat><%= m.comment_html %></noformat> |
|
|
443
437
|
<% end %>
|
|
444
438
|
<% end %>
|
|
445
439
|
|
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 February 2008"/>
|
|
6
6
|
<meta name="author" content="Suraj N. Kurapati"/>
|
|
7
|
-
<meta name="generator" content="Gerbil
|
|
7
|
+
<meta name="generator" content="Gerbil 2.0.0"/>
|
|
8
8
|
<link rel="alternate" type="application/rss+xml" href="http://gerbil.rubyforge.org/news.xml"/>
|
|
9
|
-
<title>Gerbil
|
|
9
|
+
<title>Gerbil 2.0.0 user guide</title>
|
|
10
10
|
|
|
11
11
|
<style type="text/css" media="screen">
|
|
12
12
|
body
|
|
@@ -95,6 +95,8 @@
|
|
|
95
95
|
table
|
|
96
96
|
{
|
|
97
97
|
border : none;
|
|
98
|
+
margin : auto; /* center horizontally */
|
|
99
|
+
margin-top : 1em;
|
|
98
100
|
}
|
|
99
101
|
|
|
100
102
|
th,
|
|
@@ -111,11 +113,6 @@
|
|
|
111
113
|
background-color : #F5F5F5;
|
|
112
114
|
}
|
|
113
115
|
|
|
114
|
-
table
|
|
115
|
-
{
|
|
116
|
-
margin : auto;
|
|
117
|
-
}
|
|
118
|
-
|
|
119
116
|
/* document structure */
|
|
120
117
|
|
|
121
118
|
#header
|
|
@@ -485,6 +482,8 @@
|
|
|
485
482
|
table
|
|
486
483
|
{
|
|
487
484
|
border : none;
|
|
485
|
+
margin : auto; /* center horizontally */
|
|
486
|
+
margin-top : 1em;
|
|
488
487
|
}
|
|
489
488
|
|
|
490
489
|
th,
|
|
@@ -501,11 +500,6 @@
|
|
|
501
500
|
background-color : #F5F5F5;
|
|
502
501
|
}
|
|
503
502
|
|
|
504
|
-
table
|
|
505
|
-
{
|
|
506
|
-
margin : auto;
|
|
507
|
-
}
|
|
508
|
-
|
|
509
503
|
/* document structure */
|
|
510
504
|
|
|
511
505
|
#header
|
|
@@ -760,23 +754,27 @@
|
|
|
760
754
|
</style>
|
|
761
755
|
</head>
|
|
762
756
|
<body>
|
|
757
|
+
|
|
763
758
|
<div id="header">
|
|
759
|
+
|
|
764
760
|
<img src="gerbil.png" alt="Gerbil logo" title="Gerbil logo"/>
|
|
765
|
-
<h1 class="title">Gerbil
|
|
761
|
+
<h1 class="title">Gerbil 2.0.0 user guide</h1>
|
|
766
762
|
<h2 class="authors"><a href="http://snk.tuxfamily.org">Suraj N. Kurapati</a></h2>
|
|
767
|
-
<h3 class="date">
|
|
763
|
+
<h3 class="date">03 February 2008</h3>
|
|
764
|
+
|
|
768
765
|
</div>
|
|
766
|
+
|
|
769
767
|
|
|
770
768
|
|
|
771
|
-
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-
|
|
769
|
+
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-607066028" href="#Introduction">Introduction</a><ul><li>1.1 <a id="a-606188118" href="#Features">Features</a></li><li>1.2 <a id="a-606218898" href="#License">License</a></li><li>1.3 <a id="a-606223458" href="#Resources">Resources</a></li><li>1.4 <a id="a-606227818" href="#Testimonials">Testimonials</a></li></ul></li><li>2 <a id="a-606235298" href="#Setup">Setup</a><ul><li>2.1 <a id="a-606240388" href="#Requirements">Requirements</a></li><li>2.2 <a id="a-606256788" href="#Installation">Installation</a></li><li>2.3 <a id="a-606265138" href="#Manifest">Manifest</a></li><li>2.4 <a id="a-606302598" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3 <a id="a-606326838" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="a-606377028" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="a-606452568" 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-606468878" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="a-605945888" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="a-605998298" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="a-606051418" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="a-606079608" href="#HelloWorld">Creating your own custom format</a></li></ul></li></ul></li><li>4 <a id="a-606538038" href="#Usage">Usage</a><ul><li>4.1 <a id="a-606549048" href="#include">The <strong>include</strong> directive</a></li><li>4.2 <a id="a-606553118" 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-606560998" href="#Formats">Formats</a><ul><li>5.1 <a id="a-606569718" href="#html">HTML</a><ul><li>5.1.1 <a id="a-606575088" href="#Text-to-HTML-conversion">Text to HTML conversion</a><ul><li>5.1.1.1 <a id="a-606583498" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="a-606587048" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="a-606589878" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="a-606597658" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="a-606603218" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="a-606611678" href="#Methods">Methods</a></li><li>5.1.4 <a id="a-606231738" href="#html.nodes">Nodes</a><ul><li>5.1.4.1 <a id="a-606365818" href="#Structure">Structure</a><ul><li>5.1.4.1.1 <a id="a-606393778" href="#html.nodes.header">header</a></li><li>5.1.4.1.2 <a id="a-606466078" href="#html.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="a-606074408" href="#html.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="a-605862928" href="#html.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="a-607085718" href="#Organization">Organization</a><ul><li>5.1.4.2.1 <a id="a-607091108" href="#html.nodes.part">part</a><ul><li>5.1.4.2.1.1 <a id="a-607098318" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.2 <a id="a-607102708" href="#html.nodes.chapter">chapter</a><ul><li>5.1.4.2.2.1 <a id="a-607105588" href="#An-example-607121038">An example</a></li></ul></li><li>5.1.4.2.3 <a id="a-607110168" href="#html.nodes.section">section</a><ul><li>5.1.4.2.3.1 <a id="a-607112598" href="#An-example-607309848">An example</a></li></ul></li><li>5.1.4.2.4 <a id="a-607115108" href="#html.nodes.paragraph">paragraph</a></li></ul></li><li>5.1.4.3 <a id="a-607119348" href="#Admonitions">Admonitions</a><ul><li>5.1.4.3.1 <a id="a-607126738" href="#html.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="a-607143578" href="#html.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="a-607157038" href="#html.nodes.important">important</a></li><li>5.1.4.3.4 <a id="a-607182008" href="#html.nodes.note">note</a></li><li>5.1.4.3.5 <a id="a-607205138" href="#html.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="a-607226408" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="a-607230568" href="#html.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="a-607246558" href="#html.nodes.table">table</a></li><li>5.1.4.4.3 <a id="a-607264148" href="#html.nodes.example">example</a></li><li>5.1.4.4.4 <a id="a-607273738" href="#html.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="a-607285628" href="#html.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="a-607296508" href="#Bibliography">Bibliography</a><ul><li>5.1.4.5.1 <a id="a-607300308" href="#html.nodes.reference">reference</a></li><li>5.1.4.5.2 <a id="a-607322118" href="#html.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="a-607329858" href="#text">Plain text</a></li><li>5.3 <a id="a-607331928" href="#latex">LaTeX</a></li><li>5.4 <a id="a-607334028" href="#man">UNIX man page</a></li></ul></li></ul></div>
|
|
772
770
|
|
|
773
|
-
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-
|
|
771
|
+
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-607148128" href="#An-example-607521548">An example</a></li></ol><h1>Equations</h1> <ol><li><a id="a-607280668" href="#An-example-607722228">An example</a></li></ol><h1>Examples</h1> <ol><li><a id="a-606516778" href="#HelloWorld.spec">HelloWorld format specification file</a></li><li><a id="a-606523608" href="#HelloWorld.input">Input document for HelloWorld format</a></li><li><a id="a-606531378" href="#HelloWorld.output">Output of HelloWorld format</a></li><li><a id="a-607266528" href="#An-example-607699228">An example</a></li></ol><h1>Figures</h1> <ol><li><a id="a-607239548" href="#An-example-607652708">An example</a></li></ol><h1>Importants</h1> <ol><li><a id="a-607172068" href="#An-example-607552078">An example</a></li></ol><h1>Notes</h1> <ol><li><a id="a-606166528" href="#See-the-source-of-this-guide">See the source of this guide</a></li><li><a id="a-606511168" href="#Author-s-note-about-documentation-quality">Author’s note about documentation quality</a></li><li><a id="a-607195098" href="#An-example-607582508">An example</a></li></ol><h1>Procedures</h1> <ol><li><a id="a-607292028" href="#An-example-607745508">An example</a></li></ol><h1>Tables</h1> <ol><li><a id="a-607256998" href="#An-example-607675888">An example</a></li></ol><h1>Tips</h1> <ol><li><a id="a-607218328" href="#An-example-607617378">An example</a></li></ol><h1>Warnings</h1> <ol><li><a id="a-607136098" href="#An-example-607453788">An example</a></li></ol></div>
|
|
774
772
|
|
|
775
773
|
<div id="content">
|
|
776
774
|
<div class="chapter">
|
|
777
775
|
<h1 class="title">
|
|
778
776
|
Chapter
|
|
779
|
-
<a class="toc" id="Introduction" href="#a-
|
|
777
|
+
<a class="toc" id="Introduction" href="#a-607066028">1</a>
|
|
780
778
|
|
|
781
779
|
<br/>
|
|
782
780
|
|
|
@@ -796,7 +794,7 @@
|
|
|
796
794
|
|
|
797
795
|
|
|
798
796
|
<p><div class="note">
|
|
799
|
-
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-
|
|
797
|
+
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-606166528">Note 1</a>. See the source of this guide</p>
|
|
800
798
|
|
|
801
799
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
802
800
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -861,7 +859,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
861
859
|
</div>
|
|
862
860
|
<div class="section">
|
|
863
861
|
<h2 class="title">
|
|
864
|
-
<a class="toc" id="Features" href="#a-
|
|
862
|
+
<a class="toc" id="Features" href="#a-606188118">1.1</a> Features
|
|
865
863
|
</h2>
|
|
866
864
|
<div class="content"><ul>
|
|
867
865
|
<li>Composed of <strong>less than 200 lines</strong> of code!</li>
|
|
@@ -872,7 +870,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
872
870
|
</div>
|
|
873
871
|
<div class="section">
|
|
874
872
|
<h2 class="title">
|
|
875
|
-
<a class="toc" id="License" href="#a-
|
|
873
|
+
<a class="toc" id="License" href="#a-606218898">1.2</a> License
|
|
876
874
|
</h2>
|
|
877
875
|
<div class="content"><p>Copyright 2006 Suraj N. Kurapati <SNK at GNA dot ORG></p>
|
|
878
876
|
|
|
@@ -908,7 +906,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
908
906
|
</div>
|
|
909
907
|
<div class="section">
|
|
910
908
|
<h2 class="title">
|
|
911
|
-
<a class="toc" id="Resources" href="#a-
|
|
909
|
+
<a class="toc" id="Resources" href="#a-606223458">1.3</a> Resources
|
|
912
910
|
</h2>
|
|
913
911
|
<div class="content"><ul>
|
|
914
912
|
<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" />
|
|
@@ -923,7 +921,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
923
921
|
</div>
|
|
924
922
|
<div class="section">
|
|
925
923
|
<h2 class="title">
|
|
926
|
-
<a class="toc" id="Testimonials" href="#a-
|
|
924
|
+
<a class="toc" id="Testimonials" href="#a-606227818">1.4</a> Testimonials
|
|
927
925
|
</h2>
|
|
928
926
|
<div class="content"><blockquote>
|
|
929
927
|
<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>
|
|
@@ -933,7 +931,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
933
931
|
<div class="chapter">
|
|
934
932
|
<h1 class="title">
|
|
935
933
|
Chapter
|
|
936
|
-
<a class="toc" id="Setup" href="#a-
|
|
934
|
+
<a class="toc" id="Setup" href="#a-606235298">2</a>
|
|
937
935
|
|
|
938
936
|
<br/>
|
|
939
937
|
|
|
@@ -942,7 +940,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
942
940
|
|
|
943
941
|
<div class="content"><div class="section">
|
|
944
942
|
<h2 class="title">
|
|
945
|
-
<a class="toc" id="Requirements" href="#a-
|
|
943
|
+
<a class="toc" id="Requirements" href="#a-606240388">2.1</a> Requirements
|
|
946
944
|
</h2>
|
|
947
945
|
<div class="content"><p>Your system needs the following software to run Gerbil.</p>
|
|
948
946
|
|
|
@@ -976,7 +974,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
976
974
|
</div>
|
|
977
975
|
<div class="section">
|
|
978
976
|
<h2 class="title">
|
|
979
|
-
<a class="toc" id="Installation" href="#a-
|
|
977
|
+
<a class="toc" id="Installation" href="#a-606256788">2.2</a> Installation
|
|
980
978
|
</h2>
|
|
981
979
|
<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>
|
|
982
980
|
|
|
@@ -996,7 +994,7 @@ Otherwise, follow these instructions:
|
|
|
996
994
|
<pre>ruby bin/gerbil -v</pre>
|
|
997
995
|
|
|
998
996
|
|
|
999
|
-
<p>If the installation was successful, then you will see output like this: <pre>Gerbil
|
|
997
|
+
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 2.0.0 (2008-02-03) http://gerbil.rubyforge.org /home/sun/src/gerbil
|
|
1000
998
|
</pre></p>
|
|
1001
999
|
|
|
1002
1000
|
|
|
@@ -1004,7 +1002,7 @@ Otherwise, follow these instructions:
|
|
|
1004
1002
|
</div>
|
|
1005
1003
|
<div class="section">
|
|
1006
1004
|
<h2 class="title">
|
|
1007
|
-
<a class="toc" id="Manifest" href="#a-
|
|
1005
|
+
<a class="toc" id="Manifest" href="#a-606265138">2.3</a> Manifest
|
|
1008
1006
|
</h2>
|
|
1009
1007
|
<div class="content">Now that Gerbil is installed on your system, let us examine its installation directory.
|
|
1010
1008
|
<ul>
|
|
@@ -1051,7 +1049,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1051
1049
|
</div>
|
|
1052
1050
|
<div class="section">
|
|
1053
1051
|
<h2 class="title">
|
|
1054
|
-
<a class="toc" id="Version-numbering-system" href="#a-
|
|
1052
|
+
<a class="toc" id="Version-numbering-system" href="#a-606302598">2.4</a> Version numbering system
|
|
1055
1053
|
</h2>
|
|
1056
1054
|
<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.
|
|
1057
1055
|
|
|
@@ -1087,7 +1085,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1087
1085
|
<div class="chapter">
|
|
1088
1086
|
<h1 class="title">
|
|
1089
1087
|
Chapter
|
|
1090
|
-
<a class="toc" id="Theory-of-operation" href="#a-
|
|
1088
|
+
<a class="toc" id="Theory-of-operation" href="#a-606326838">3</a>
|
|
1091
1089
|
|
|
1092
1090
|
<br/>
|
|
1093
1091
|
|
|
@@ -1119,7 +1117,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1119
1117
|
|
|
1120
1118
|
<p><div class="section">
|
|
1121
1119
|
<h2 class="title">
|
|
1122
|
-
<a class="toc" id="Nodes" href="#a-
|
|
1120
|
+
<a class="toc" id="Nodes" href="#a-606377028">3.1</a> Nodes
|
|
1123
1121
|
</h2>
|
|
1124
1122
|
<div class="content"><p>A node is a block of text that appears like this:</p>
|
|
1125
1123
|
|
|
@@ -1177,7 +1175,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1177
1175
|
|
|
1178
1176
|
<p><div class="section">
|
|
1179
1177
|
<h3 class="title">
|
|
1180
|
-
<a class="toc" id="Node.class" href="#a-
|
|
1178
|
+
<a class="toc" id="Node.class" href="#a-606452568">3.1.1</a> The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class
|
|
1181
1179
|
</h3>
|
|
1182
1180
|
<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>
|
|
1183
1181
|
|
|
@@ -1253,7 +1251,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1253
1251
|
</div>
|
|
1254
1252
|
<div class="section">
|
|
1255
1253
|
<h2 class="title">
|
|
1256
|
-
<a class="toc" id="SpecFile" href="#a-
|
|
1254
|
+
<a class="toc" id="SpecFile" href="#a-606468878">3.2</a> Format specification file
|
|
1257
1255
|
</h2>
|
|
1258
1256
|
<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>
|
|
1259
1257
|
|
|
@@ -1291,7 +1289,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1291
1289
|
|
|
1292
1290
|
<p><div class="section">
|
|
1293
1291
|
<h3 class="title">
|
|
1294
|
-
<a class="toc" id="SpecFile.nodes" href="#a-
|
|
1292
|
+
<a class="toc" id="SpecFile.nodes" href="#a-605945888">3.2.1</a> Node definition
|
|
1295
1293
|
</h3>
|
|
1296
1294
|
<div class="content"><p>A node definition is a mapping from a name (the “node type”) to the following set of parameters:</p>
|
|
1297
1295
|
|
|
@@ -1332,7 +1330,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1332
1330
|
|
|
1333
1331
|
<p><div class="section">
|
|
1334
1332
|
<h4 class="title">
|
|
1335
|
-
<a class="toc" id="SpecFile.nodes.output" href="#a-
|
|
1333
|
+
<a class="toc" id="SpecFile.nodes.output" href="#a-605998298">3.2.1.1</a> Node output template
|
|
1336
1334
|
</h4>
|
|
1337
1335
|
<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>
|
|
1338
1336
|
|
|
@@ -1400,7 +1398,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1400
1398
|
</div>
|
|
1401
1399
|
<div class="section">
|
|
1402
1400
|
<h3 class="title">
|
|
1403
|
-
<a class="toc" id="SpecFile.output" href="#a-
|
|
1401
|
+
<a class="toc" id="SpecFile.output" href="#a-606051418">3.2.2</a> Document output template
|
|
1404
1402
|
</h3>
|
|
1405
1403
|
<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>
|
|
1406
1404
|
|
|
@@ -1467,7 +1465,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1467
1465
|
</div>
|
|
1468
1466
|
<div class="section">
|
|
1469
1467
|
<h3 class="title">
|
|
1470
|
-
<a class="toc" id="HelloWorld" href="#a-
|
|
1468
|
+
<a class="toc" id="HelloWorld" href="#a-606079608">3.2.3</a> Creating your own custom format
|
|
1471
1469
|
</h3>
|
|
1472
1470
|
<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:
|
|
1473
1471
|
<ul>
|
|
@@ -1486,7 +1484,7 @@ To run this example, perform the following steps:
|
|
|
1486
1484
|
|
|
1487
1485
|
|
|
1488
1486
|
<p><div class="note">
|
|
1489
|
-
<p class="title"><a class="toc" id="Author-s-note-about-documentation-quality" href="#a-
|
|
1487
|
+
<p class="title"><a class="toc" id="Author-s-note-about-documentation-quality" href="#a-606511168">Note 2</a>. Author’s note about documentation quality</p>
|
|
1490
1488
|
|
|
1491
1489
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
1492
1490
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -1556,7 +1554,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
1556
1554
|
<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>
|
|
1557
1555
|
</div>
|
|
1558
1556
|
<div class="example">
|
|
1559
|
-
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-
|
|
1557
|
+
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606516778">Example 1</a>. HelloWorld format specification file</p>
|
|
1560
1558
|
<div class="content"><pre class="code" lang="rhtml">
|
|
1561
1559
|
desc: A illustrative format.
|
|
1562
1560
|
|
|
@@ -1628,7 +1626,7 @@ output: |
|
|
|
1628
1626
|
</pre></div>
|
|
1629
1627
|
</div>
|
|
1630
1628
|
<div class="example">
|
|
1631
|
-
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-
|
|
1629
|
+
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-606523608">Example 2</a>. Input document for HelloWorld format</p>
|
|
1632
1630
|
<div class="content"><pre class="code" lang="rhtml">
|
|
1633
1631
|
<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>
|
|
1634
1632
|
<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>
|
|
@@ -1670,10 +1668,10 @@ output: |
|
|
|
1670
1668
|
</pre></div>
|
|
1671
1669
|
</div>
|
|
1672
1670
|
<div class="example">
|
|
1673
|
-
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-
|
|
1671
|
+
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-606531378">Example 3</a>. Output of HelloWorld format</p>
|
|
1674
1672
|
<div class="content">Welcome to the “HelloWorld” format.
|
|
1675
|
-
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “
|
|
1676
|
-
My name is “
|
|
1673
|
+
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “nok”</h1>
|
|
1674
|
+
My name is “nok” and these are my properties:
|
|
1677
1675
|
<table border="1">
|
|
1678
1676
|
<tr>
|
|
1679
1677
|
<th>Property</th>
|
|
@@ -1699,8 +1697,8 @@ My name is “zeh” and these are my properties:
|
|
|
1699
1697
|
<td>content</td>
|
|
1700
1698
|
<td> <big>I’m</big> the very first node, oh <em>yes</em> I am! <strong>sneer</strong>
|
|
1701
1699
|
|
|
1702
|
-
<h1>hello #1.1: “
|
|
1703
|
-
My name is “
|
|
1700
|
+
<h1>hello #1.1: “dibisom”</h1>
|
|
1701
|
+
My name is “dibisom” and these are my properties:
|
|
1704
1702
|
<table border="1">
|
|
1705
1703
|
<tr>
|
|
1706
1704
|
<th>Property</th>
|
|
@@ -1726,8 +1724,8 @@ My name is “posobet” and these are my properties:
|
|
|
1726
1724
|
<td>content</td>
|
|
1727
1725
|
<td> Hi, I… <strong>hide</strong>
|
|
1728
1726
|
|
|
1729
|
-
<h1>hello #1.1.1: “
|
|
1730
|
-
My name is “
|
|
1727
|
+
<h1>hello #1.1.1: “loti”</h1>
|
|
1728
|
+
My name is “loti” and these are my properties:
|
|
1731
1729
|
<table border="1">
|
|
1732
1730
|
<tr>
|
|
1733
1731
|
<th>Property</th>
|
|
@@ -1753,8 +1751,8 @@ My name is “fotaseb” and these are my properties:
|
|
|
1753
1751
|
<td>content</td>
|
|
1754
1752
|
<td> <strong>sigh</strong>
|
|
1755
1753
|
|
|
1756
|
-
<h1>hello #1.1.1.1: “
|
|
1757
|
-
My name is “
|
|
1754
|
+
<h1>hello #1.1.1.1: “bukeyam”</h1>
|
|
1755
|
+
My name is “bukeyam” and these are my properties:
|
|
1758
1756
|
<table border="1">
|
|
1759
1757
|
<tr>
|
|
1760
1758
|
<th>Property</th>
|
|
@@ -1784,8 +1782,8 @@ My name is “juk” and these are my properties:
|
|
|
1784
1782
|
</table></td>
|
|
1785
1783
|
</tr>
|
|
1786
1784
|
</table>
|
|
1787
|
-
<h1>hello #1.1.2: “
|
|
1788
|
-
My name is “
|
|
1785
|
+
<h1>hello #1.1.2: “vukuy”</h1>
|
|
1786
|
+
My name is “vukuy” and these are my properties:
|
|
1789
1787
|
<table border="1">
|
|
1790
1788
|
<tr>
|
|
1791
1789
|
<th>Property</th>
|
|
@@ -1815,8 +1813,8 @@ My name is “noma” and these are my properties:
|
|
|
1815
1813
|
</table></td>
|
|
1816
1814
|
</tr>
|
|
1817
1815
|
</table>
|
|
1818
|
-
<h1>hello #1.2: “
|
|
1819
|
-
My name is “
|
|
1816
|
+
<h1>hello #1.2: “numose”</h1>
|
|
1817
|
+
My name is “numose” and these are my properties:
|
|
1820
1818
|
<table border="1">
|
|
1821
1819
|
<tr>
|
|
1822
1820
|
<th>Property</th>
|
|
@@ -1842,8 +1840,8 @@ My name is “diboha” and these are my properties:
|
|
|
1842
1840
|
<td>content</td>
|
|
1843
1841
|
<td> <strong>yawn</strong> Just five more minutes…
|
|
1844
1842
|
|
|
1845
|
-
<h1>hello #1.2.1: “
|
|
1846
|
-
My name is “
|
|
1843
|
+
<h1>hello #1.2.1: “dazan”</h1>
|
|
1844
|
+
My name is “dazan” and these are my properties:
|
|
1847
1845
|
<table border="1">
|
|
1848
1846
|
<tr>
|
|
1849
1847
|
<th>Property</th>
|
|
@@ -1869,8 +1867,8 @@ My name is “vehokeh” and these are my properties:
|
|
|
1869
1867
|
<td>content</td>
|
|
1870
1868
|
<td> So <em>be</em> happy my friend, <strong>happy</strong>!
|
|
1871
1869
|
|
|
1872
|
-
<h1>hello #1.2.1.1: “
|
|
1873
|
-
My name is “
|
|
1870
|
+
<h1>hello #1.2.1.1: “yed”</h1>
|
|
1871
|
+
My name is “yed” and these are my properties:
|
|
1874
1872
|
<table border="1">
|
|
1875
1873
|
<tr>
|
|
1876
1874
|
<th>Property</th>
|
|
@@ -1904,8 +1902,8 @@ My name is “hif” and these are my properties:
|
|
|
1904
1902
|
</table></td>
|
|
1905
1903
|
</tr>
|
|
1906
1904
|
</table>
|
|
1907
|
-
<h1>hello #2: “
|
|
1908
|
-
My name is “
|
|
1905
|
+
<h1>hello #2: “zehun”</h1>
|
|
1906
|
+
My name is “zehun” and these are my properties:
|
|
1909
1907
|
<table border="1">
|
|
1910
1908
|
<tr>
|
|
1911
1909
|
<th>Property</th>
|
|
@@ -1934,8 +1932,8 @@ My name is “zanugi” and these are my properties:
|
|
|
1934
1932
|
</td>
|
|
1935
1933
|
</tr>
|
|
1936
1934
|
</table>
|
|
1937
|
-
<h1>hello #3: “
|
|
1938
|
-
My name is “
|
|
1935
|
+
<h1>hello #3: “gijoju”</h1>
|
|
1936
|
+
My name is “gijoju” and these are my properties:
|
|
1939
1937
|
<table border="1">
|
|
1940
1938
|
<tr>
|
|
1941
1939
|
<th>Property</th>
|
|
@@ -1970,7 +1968,7 @@ That’s all folks!</div>
|
|
|
1970
1968
|
<div class="chapter">
|
|
1971
1969
|
<h1 class="title">
|
|
1972
1970
|
Chapter
|
|
1973
|
-
<a class="toc" id="Usage" href="#a-
|
|
1971
|
+
<a class="toc" id="Usage" href="#a-606538038">4</a>
|
|
1974
1972
|
|
|
1975
1973
|
<br/>
|
|
1976
1974
|
|
|
@@ -2006,7 +2004,7 @@ Format:
|
|
|
2006
2004
|
|
|
2007
2005
|
<p><div class="section">
|
|
2008
2006
|
<h2 class="title">
|
|
2009
|
-
<a class="toc" id="include" href="#a-
|
|
2007
|
+
<a class="toc" id="include" href="#a-606549048">4.1</a> The <strong>include</strong> directive
|
|
2010
2008
|
</h2>
|
|
2011
2009
|
<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>
|
|
2012
2010
|
|
|
@@ -2021,7 +2019,7 @@ Format:
|
|
|
2021
2019
|
</div>
|
|
2022
2020
|
<div class="section">
|
|
2023
2021
|
<h2 class="title">
|
|
2024
|
-
<a class="toc" id="unindent" href="#a-
|
|
2022
|
+
<a class="toc" id="unindent" href="#a-606553118">4.2</a> The <code class="code"><span style="color:#d70; font-weight:bold">$unindent</span></code> variable
|
|
2025
2023
|
</h2>
|
|
2026
2024
|
<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>
|
|
2027
2025
|
|
|
@@ -2038,7 +2036,7 @@ Format:
|
|
|
2038
2036
|
<div class="part">
|
|
2039
2037
|
<h1 class="title">
|
|
2040
2038
|
Part
|
|
2041
|
-
<a class="toc" id="Formats" href="#a-
|
|
2039
|
+
<a class="toc" id="Formats" href="#a-606560998">5</a>
|
|
2042
2040
|
|
|
2043
2041
|
<br/>
|
|
2044
2042
|
|
|
@@ -2054,7 +2052,7 @@ Format:
|
|
|
2054
2052
|
<p><div class="chapter">
|
|
2055
2053
|
<h1 class="title">
|
|
2056
2054
|
Chapter
|
|
2057
|
-
<a class="toc" id="html" href="#a-
|
|
2055
|
+
<a class="toc" id="html" href="#a-606569718">5.1</a>
|
|
2058
2056
|
|
|
2059
2057
|
<br/>
|
|
2060
2058
|
|
|
@@ -2072,7 +2070,7 @@ Format:
|
|
|
2072
2070
|
|
|
2073
2071
|
<p><div class="section">
|
|
2074
2072
|
<h3 class="title">
|
|
2075
|
-
<a class="toc" id="Text-to-HTML-conversion" href="#a-
|
|
2073
|
+
<a class="toc" id="Text-to-HTML-conversion" href="#a-606575088">5.1.1</a> Text to HTML conversion
|
|
2076
2074
|
</h3>
|
|
2077
2075
|
<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>
|
|
2078
2076
|
|
|
@@ -2097,7 +2095,7 @@ Format:
|
|
|
2097
2095
|
|
|
2098
2096
|
<p><div class="section">
|
|
2099
2097
|
<h4 class="title">
|
|
2100
|
-
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-
|
|
2098
|
+
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-606583498">5.1.1.1</a> Syntax coloring for source code
|
|
2101
2099
|
</h4>
|
|
2102
2100
|
<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>
|
|
2103
2101
|
|
|
@@ -2115,7 +2113,7 @@ The following programming languages are currently supported by <a href="http://c
|
|
|
2115
2113
|
|
|
2116
2114
|
<p><div class="section">
|
|
2117
2115
|
<h5 class="title">
|
|
2118
|
-
<a class="toc" id="Specifying-the-programming-language" href="#a-
|
|
2116
|
+
<a class="toc" id="Specifying-the-programming-language" href="#a-606587048">5.1.1.1.1</a> Specifying the programming language
|
|
2119
2117
|
</h5>
|
|
2120
2118
|
<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>
|
|
2121
2119
|
|
|
@@ -2203,7 +2201,7 @@ int main(int argc, char **argv) {
|
|
|
2203
2201
|
</div>
|
|
2204
2202
|
<div class="section">
|
|
2205
2203
|
<h4 class="title">
|
|
2206
|
-
<a class="toc" id="Smart-sizing-of-source-code" href="#a-
|
|
2204
|
+
<a class="toc" id="Smart-sizing-of-source-code" href="#a-606589878">5.1.1.2</a> Smart sizing of source code
|
|
2207
2205
|
</h4>
|
|
2208
2206
|
<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>
|
|
2209
2207
|
|
|
@@ -2222,14 +2220,14 @@ int main(int argc, char **argv) {
|
|
|
2222
2220
|
</div>
|
|
2223
2221
|
<div class="section">
|
|
2224
2222
|
<h4 class="title">
|
|
2225
|
-
<a class="toc" id="Protecting-verbatim-text" href="#a-
|
|
2223
|
+
<a class="toc" id="Protecting-verbatim-text" href="#a-606597658">5.1.1.3</a> Protecting verbatim text
|
|
2226
2224
|
</h4>
|
|
2227
2225
|
<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>
|
|
2228
2226
|
</div></p></div>
|
|
2229
2227
|
</div>
|
|
2230
2228
|
<div class="section">
|
|
2231
2229
|
<h3 class="title">
|
|
2232
|
-
<a class="toc" id="Parameters" href="#a-
|
|
2230
|
+
<a class="toc" id="Parameters" href="#a-606603218">5.1.2</a> Parameters
|
|
2233
2231
|
</h3>
|
|
2234
2232
|
<div class="content">The HTML format accepts the following document parameters.
|
|
2235
2233
|
|
|
@@ -2281,7 +2279,7 @@ int main(int argc, char **argv) {
|
|
|
2281
2279
|
</div>
|
|
2282
2280
|
<div class="section">
|
|
2283
2281
|
<h3 class="title">
|
|
2284
|
-
<a class="toc" id="Methods" href="#a-
|
|
2282
|
+
<a class="toc" id="Methods" href="#a-606611678">5.1.3</a> Methods
|
|
2285
2283
|
</h3>
|
|
2286
2284
|
<div class="content">The HTML format provides the following methods. In the method declarations shown below,
|
|
2287
2285
|
<ul>
|
|
@@ -2295,14 +2293,6 @@ int main(int argc, char **argv) {
|
|
|
2295
2293
|
<th>Method declaration </th>
|
|
2296
2294
|
<th>Description </th>
|
|
2297
2295
|
</tr>
|
|
2298
|
-
<tr>
|
|
2299
|
-
<td> <code class="code">link(aUrl, aName = aUrl, aTitle = <span style="color:#038; font-weight:bold">nil</span>)</code> </td>
|
|
2300
|
-
<td> <p>
|
|
2301
|
-
Returns a hyperlink to the given URL of the given name and mouse-hover
|
|
2302
|
-
title.
|
|
2303
|
-
</p>
|
|
2304
|
-
</td>
|
|
2305
|
-
</tr>
|
|
2306
2296
|
<tr>
|
|
2307
2297
|
<td> <code class="code"><span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#title()</span></code> </td>
|
|
2308
2298
|
<td> <p>
|
|
@@ -2385,7 +2375,7 @@ ruby.
|
|
|
2385
2375
|
<div class="chapter">
|
|
2386
2376
|
<h1 class="title">
|
|
2387
2377
|
Chapter
|
|
2388
|
-
<a class="toc" id="html.nodes" href="#a-
|
|
2378
|
+
<a class="toc" id="html.nodes" href="#a-606231738">5.1.4</a>
|
|
2389
2379
|
|
|
2390
2380
|
<br/>
|
|
2391
2381
|
|
|
@@ -2428,32 +2418,32 @@ ruby.
|
|
|
2428
2418
|
|
|
2429
2419
|
<p><div class="section">
|
|
2430
2420
|
<h4 class="title">
|
|
2431
|
-
<a class="toc" id="Structure" href="#a-
|
|
2421
|
+
<a class="toc" id="Structure" href="#a-606365818">5.1.4.1</a> Structure
|
|
2432
2422
|
</h4>
|
|
2433
2423
|
<div class="content"><p>The nodes described in this section form the overall structure of the output document.</p>
|
|
2434
2424
|
|
|
2435
2425
|
|
|
2436
2426
|
<p><div class="section">
|
|
2437
2427
|
<h5 class="title">
|
|
2438
|
-
<a class="toc" id="html.nodes.header" href="#a-
|
|
2428
|
+
<a class="toc" id="html.nodes.header" href="#a-606393778">5.1.4.1.1</a> header
|
|
2439
2429
|
</h5>
|
|
2440
2430
|
<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>
|
|
2441
2431
|
</div>
|
|
2442
2432
|
<div class="section">
|
|
2443
2433
|
<h5 class="title">
|
|
2444
|
-
<a class="toc" id="html.nodes.footer" href="#a-
|
|
2434
|
+
<a class="toc" id="html.nodes.footer" href="#a-606466078">5.1.4.1.2</a> footer
|
|
2445
2435
|
</h5>
|
|
2446
2436
|
<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>
|
|
2447
2437
|
</div>
|
|
2448
2438
|
<div class="section">
|
|
2449
2439
|
<h5 class="title">
|
|
2450
|
-
<a class="toc" id="html.nodes.abstract" href="#a-
|
|
2440
|
+
<a class="toc" id="html.nodes.abstract" href="#a-606074408">5.1.4.1.3</a> abstract
|
|
2451
2441
|
</h5>
|
|
2452
2442
|
<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>
|
|
2453
2443
|
</div>
|
|
2454
2444
|
<div class="section">
|
|
2455
2445
|
<h5 class="title">
|
|
2456
|
-
<a class="toc" id="html.nodes.xref" href="#a-
|
|
2446
|
+
<a class="toc" id="html.nodes.xref" href="#a-605862928">5.1.4.1.4</a> xref
|
|
2457
2447
|
</h5>
|
|
2458
2448
|
<div class="content"><p>A cross-reference; a hyperlink that takes you to any node in the document.</p>
|
|
2459
2449
|
|
|
@@ -2484,14 +2474,14 @@ ruby.
|
|
|
2484
2474
|
</div>
|
|
2485
2475
|
<div class="section">
|
|
2486
2476
|
<h4 class="title">
|
|
2487
|
-
<a class="toc" id="Organization" href="#a-
|
|
2477
|
+
<a class="toc" id="Organization" href="#a-607085718">5.1.4.2</a> Organization
|
|
2488
2478
|
</h4>
|
|
2489
2479
|
<div class="content"><p>The nodes described in this section are meant to help organize the document’s content logically.</p>
|
|
2490
2480
|
|
|
2491
2481
|
|
|
2492
2482
|
<p><div class="section">
|
|
2493
2483
|
<h5 class="title">
|
|
2494
|
-
<a class="toc" id="html.nodes.part" href="#a-
|
|
2484
|
+
<a class="toc" id="html.nodes.part" href="#a-607091108">5.1.4.2.1</a> part
|
|
2495
2485
|
</h5>
|
|
2496
2486
|
<div class="content"><p>A collection of chapters.</p>
|
|
2497
2487
|
|
|
@@ -2499,7 +2489,7 @@ ruby.
|
|
|
2499
2489
|
<p><div class="part">
|
|
2500
2490
|
<h1 class="title">
|
|
2501
2491
|
Part
|
|
2502
|
-
<a class="toc" id="An-example" href="#a-
|
|
2492
|
+
<a class="toc" id="An-example" href="#a-607098318">5.1.4.2.1.1</a>
|
|
2503
2493
|
|
|
2504
2494
|
<br/>
|
|
2505
2495
|
|
|
@@ -2511,7 +2501,7 @@ ruby.
|
|
|
2511
2501
|
</div>
|
|
2512
2502
|
<div class="section">
|
|
2513
2503
|
<h5 class="title">
|
|
2514
|
-
<a class="toc" id="html.nodes.chapter" href="#a-
|
|
2504
|
+
<a class="toc" id="html.nodes.chapter" href="#a-607102708">5.1.4.2.2</a> chapter
|
|
2515
2505
|
</h5>
|
|
2516
2506
|
<div class="content"><p>A collection of sections.</p>
|
|
2517
2507
|
|
|
@@ -2519,7 +2509,7 @@ ruby.
|
|
|
2519
2509
|
<p><div class="chapter">
|
|
2520
2510
|
<h1 class="title">
|
|
2521
2511
|
Chapter
|
|
2522
|
-
<a class="toc" id="An-example-
|
|
2512
|
+
<a class="toc" id="An-example-607121038" href="#a-607105588">5.1.4.2.2.1</a>
|
|
2523
2513
|
|
|
2524
2514
|
<br/>
|
|
2525
2515
|
|
|
@@ -2531,21 +2521,21 @@ ruby.
|
|
|
2531
2521
|
</div>
|
|
2532
2522
|
<div class="section">
|
|
2533
2523
|
<h5 class="title">
|
|
2534
|
-
<a class="toc" id="html.nodes.section" href="#a-
|
|
2524
|
+
<a class="toc" id="html.nodes.section" href="#a-607110168">5.1.4.2.3</a> section
|
|
2535
2525
|
</h5>
|
|
2536
2526
|
<div class="content"><p>A collection of paragraphs about a particular topic.</p>
|
|
2537
2527
|
|
|
2538
2528
|
|
|
2539
2529
|
<p><div class="section">
|
|
2540
2530
|
<h6 class="title">
|
|
2541
|
-
<a class="toc" id="An-example-
|
|
2531
|
+
<a class="toc" id="An-example-607309848" href="#a-607112598">5.1.4.2.3.1</a> An example
|
|
2542
2532
|
</h6>
|
|
2543
2533
|
<div class="content">This is what a <strong>section</strong> node appears like.</div>
|
|
2544
2534
|
</div></p></div>
|
|
2545
2535
|
</div>
|
|
2546
2536
|
<div class="section">
|
|
2547
2537
|
<h5 class="title">
|
|
2548
|
-
<a class="toc" id="html.nodes.paragraph" href="#a-
|
|
2538
|
+
<a class="toc" id="html.nodes.paragraph" href="#a-607115108">5.1.4.2.4</a> paragraph
|
|
2549
2539
|
</h5>
|
|
2550
2540
|
<div class="content"><p>A collection of sentences about a particular idea.</p>
|
|
2551
2541
|
|
|
@@ -2558,7 +2548,7 @@ ruby.
|
|
|
2558
2548
|
</div>
|
|
2559
2549
|
<div class="section">
|
|
2560
2550
|
<h4 class="title">
|
|
2561
|
-
<a class="toc" id="Admonitions" href="#a-
|
|
2551
|
+
<a class="toc" id="Admonitions" href="#a-607119348">5.1.4.3</a> Admonitions
|
|
2562
2552
|
</h4>
|
|
2563
2553
|
<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>
|
|
2564
2554
|
|
|
@@ -2569,13 +2559,13 @@ ruby.
|
|
|
2569
2559
|
<p>
|
|
2570
2560
|
<div class="section">
|
|
2571
2561
|
<h5 class="title">
|
|
2572
|
-
<a class="toc" id="html.nodes.warning" href="#a-
|
|
2562
|
+
<a class="toc" id="html.nodes.warning" href="#a-607126738">5.1.4.3.1</a> warning
|
|
2573
2563
|
</h5>
|
|
2574
2564
|
<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>
|
|
2575
2565
|
|
|
2576
2566
|
|
|
2577
2567
|
<p><div class="warning">
|
|
2578
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2568
|
+
<p class="title"><a class="toc" id="An-example-607453788" href="#a-607136098">Warning 1</a>. An example</p>
|
|
2579
2569
|
|
|
2580
2570
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2581
2571
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2640,7 +2630,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2640
2630
|
</div>
|
|
2641
2631
|
<div class="section">
|
|
2642
2632
|
<h5 class="title">
|
|
2643
|
-
<a class="toc" id="html.nodes.caution" href="#a-
|
|
2633
|
+
<a class="toc" id="html.nodes.caution" href="#a-607143578">5.1.4.3.2</a> caution
|
|
2644
2634
|
</h5>
|
|
2645
2635
|
<div class="content"><blockquote>
|
|
2646
2636
|
<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>
|
|
@@ -2648,7 +2638,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2648
2638
|
|
|
2649
2639
|
|
|
2650
2640
|
<p><div class="caution">
|
|
2651
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2641
|
+
<p class="title"><a class="toc" id="An-example-607521548" href="#a-607148128">Caution 1</a>. An example</p>
|
|
2652
2642
|
|
|
2653
2643
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2654
2644
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2709,7 +2699,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2709
2699
|
</div>
|
|
2710
2700
|
<div class="section">
|
|
2711
2701
|
<h5 class="title">
|
|
2712
|
-
<a class="toc" id="html.nodes.important" href="#a-
|
|
2702
|
+
<a class="toc" id="html.nodes.important" href="#a-607157038">5.1.4.3.3</a> important
|
|
2713
2703
|
</h5>
|
|
2714
2704
|
<div class="content"><p>Use an <strong>important</strong> node when:</p>
|
|
2715
2705
|
|
|
@@ -2720,7 +2710,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2720
2710
|
|
|
2721
2711
|
|
|
2722
2712
|
<p><div class="important">
|
|
2723
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2713
|
+
<p class="title"><a class="toc" id="An-example-607552078" href="#a-607172068">Important 1</a>. An example</p>
|
|
2724
2714
|
|
|
2725
2715
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2726
2716
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2785,7 +2775,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2785
2775
|
</div>
|
|
2786
2776
|
<div class="section">
|
|
2787
2777
|
<h5 class="title">
|
|
2788
|
-
<a class="toc" id="html.nodes.note" href="#a-
|
|
2778
|
+
<a class="toc" id="html.nodes.note" href="#a-607182008">5.1.4.3.4</a> note
|
|
2789
2779
|
</h5>
|
|
2790
2780
|
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
|
|
2791
2781
|
|
|
@@ -2796,7 +2786,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2796
2786
|
|
|
2797
2787
|
|
|
2798
2788
|
<p><div class="note">
|
|
2799
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2789
|
+
<p class="title"><a class="toc" id="An-example-607582508" href="#a-607195098">Note 3</a>. An example</p>
|
|
2800
2790
|
|
|
2801
2791
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2802
2792
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2862,7 +2852,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2862
2852
|
</div>
|
|
2863
2853
|
<div class="section">
|
|
2864
2854
|
<h5 class="title">
|
|
2865
|
-
<a class="toc" id="html.nodes.tip" href="#a-
|
|
2855
|
+
<a class="toc" id="html.nodes.tip" href="#a-607205138">5.1.4.3.5</a> tip
|
|
2866
2856
|
</h5>
|
|
2867
2857
|
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
|
|
2868
2858
|
|
|
@@ -2873,7 +2863,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2873
2863
|
|
|
2874
2864
|
|
|
2875
2865
|
<p><div class="tip">
|
|
2876
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2866
|
+
<p class="title"><a class="toc" id="An-example-607617378" href="#a-607218328">Tip 1</a>. An example</p>
|
|
2877
2867
|
|
|
2878
2868
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2879
2869
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2958,79 +2948,79 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
2958
2948
|
</div>
|
|
2959
2949
|
<div class="section">
|
|
2960
2950
|
<h4 class="title">
|
|
2961
|
-
<a class="toc" id="Auxilary-materials" href="#a-
|
|
2951
|
+
<a class="toc" id="Auxilary-materials" href="#a-607226408">5.1.4.4</a> Auxilary materials
|
|
2962
2952
|
</h4>
|
|
2963
2953
|
<div class="content"><div class="section">
|
|
2964
2954
|
<h5 class="title">
|
|
2965
|
-
<a class="toc" id="html.nodes.figure" href="#a-
|
|
2955
|
+
<a class="toc" id="html.nodes.figure" href="#a-607230568">5.1.4.4.1</a> figure
|
|
2966
2956
|
</h5>
|
|
2967
2957
|
<div class="content"><p>A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.</p>
|
|
2968
2958
|
|
|
2969
2959
|
|
|
2970
2960
|
<p><div class="figure">
|
|
2971
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2961
|
+
<p class="title"><a class="toc" id="An-example-607652708" href="#a-607239548">Figure 1</a>. An example</p>
|
|
2972
2962
|
<div class="content">This is what a <strong>figure</strong> node appears like.</div>
|
|
2973
2963
|
</div></p></div>
|
|
2974
2964
|
</div>
|
|
2975
2965
|
<div class="section">
|
|
2976
2966
|
<h5 class="title">
|
|
2977
|
-
<a class="toc" id="html.nodes.table" href="#a-
|
|
2967
|
+
<a class="toc" id="html.nodes.table" href="#a-607246558">5.1.4.4.2</a> table
|
|
2978
2968
|
</h5>
|
|
2979
2969
|
<div class="content"><p>Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.</p>
|
|
2980
2970
|
|
|
2981
2971
|
|
|
2982
2972
|
<p><div class="table">
|
|
2983
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2973
|
+
<p class="title"><a class="toc" id="An-example-607675888" href="#a-607256998">Table 1</a>. An example</p>
|
|
2984
2974
|
<div class="content">This is what a <strong>table</strong> node appears like.</div>
|
|
2985
2975
|
</div></p></div>
|
|
2986
2976
|
</div>
|
|
2987
2977
|
<div class="section">
|
|
2988
2978
|
<h5 class="title">
|
|
2989
|
-
<a class="toc" id="html.nodes.example" href="#a-
|
|
2979
|
+
<a class="toc" id="html.nodes.example" href="#a-607264148">5.1.4.4.3</a> example
|
|
2990
2980
|
</h5>
|
|
2991
2981
|
<div class="content"><p>A sample application of an idea or thought.</p>
|
|
2992
2982
|
|
|
2993
2983
|
|
|
2994
2984
|
<p><div class="example">
|
|
2995
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2985
|
+
<p class="title"><a class="toc" id="An-example-607699228" href="#a-607266528">Example 4</a>. An example</p>
|
|
2996
2986
|
<div class="content">This is what a <strong>example</strong> node appears like.</div>
|
|
2997
2987
|
</div></p></div>
|
|
2998
2988
|
</div>
|
|
2999
2989
|
<div class="section">
|
|
3000
2990
|
<h5 class="title">
|
|
3001
|
-
<a class="toc" id="html.nodes.equation" href="#a-
|
|
2991
|
+
<a class="toc" id="html.nodes.equation" href="#a-607273738">5.1.4.4.4</a> equation
|
|
3002
2992
|
</h5>
|
|
3003
2993
|
<div class="content"><p>A mathematical equation or formula.</p>
|
|
3004
2994
|
|
|
3005
2995
|
|
|
3006
2996
|
<p><div class="equation">
|
|
3007
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2997
|
+
<p class="title"><a class="toc" id="An-example-607722228" href="#a-607280668">Equation 1</a>. An example</p>
|
|
3008
2998
|
<div class="content">This is what a <strong>equation</strong> node appears like.</div>
|
|
3009
2999
|
</div></p></div>
|
|
3010
3000
|
</div>
|
|
3011
3001
|
<div class="section">
|
|
3012
3002
|
<h5 class="title">
|
|
3013
|
-
<a class="toc" id="html.nodes.procedure" href="#a-
|
|
3003
|
+
<a class="toc" id="html.nodes.procedure" href="#a-607285628">5.1.4.4.5</a> procedure
|
|
3014
3004
|
</h5>
|
|
3015
3005
|
<div class="content"><p>An outline; a series of steps outlining some kind of process.</p>
|
|
3016
3006
|
|
|
3017
3007
|
|
|
3018
3008
|
<p><div class="procedure">
|
|
3019
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3009
|
+
<p class="title"><a class="toc" id="An-example-607745508" href="#a-607292028">Procedure 1</a>. An example</p>
|
|
3020
3010
|
<div class="content">This is what a <strong>procedure</strong> node appears like.</div>
|
|
3021
3011
|
</div></p></div>
|
|
3022
3012
|
</div></div>
|
|
3023
3013
|
</div>
|
|
3024
3014
|
<div class="section">
|
|
3025
3015
|
<h4 class="title">
|
|
3026
|
-
<a class="toc" id="Bibliography" href="#a-
|
|
3016
|
+
<a class="toc" id="Bibliography" href="#a-607296508">5.1.4.5</a> Bibliography
|
|
3027
3017
|
</h4>
|
|
3028
3018
|
<div class="content"><p>The nodes in this section deal with attribution of ideas—an important weapon against plagiarism.</p>
|
|
3029
3019
|
|
|
3030
3020
|
|
|
3031
3021
|
<p><div class="section">
|
|
3032
3022
|
<h5 class="title">
|
|
3033
|
-
<a class="toc" id="html.nodes.reference" href="#a-
|
|
3023
|
+
<a class="toc" id="html.nodes.reference" href="#a-607300308">5.1.4.5.1</a> reference
|
|
3034
3024
|
</h5>
|
|
3035
3025
|
<div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
|
|
3036
3026
|
|
|
@@ -3046,7 +3036,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3046
3036
|
</div>
|
|
3047
3037
|
<div class="section">
|
|
3048
3038
|
<h5 class="title">
|
|
3049
|
-
<a class="toc" id="html.nodes.cite" href="#a-
|
|
3039
|
+
<a class="toc" id="html.nodes.cite" href="#a-607322118">5.1.4.5.2</a> cite
|
|
3050
3040
|
</h5>
|
|
3051
3041
|
<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>
|
|
3052
3042
|
|
|
@@ -3077,7 +3067,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3077
3067
|
<div class="chapter">
|
|
3078
3068
|
<h1 class="title">
|
|
3079
3069
|
Chapter
|
|
3080
|
-
<a class="toc" id="text" href="#a-
|
|
3070
|
+
<a class="toc" id="text" href="#a-607329858">5.2</a>
|
|
3081
3071
|
|
|
3082
3072
|
<br/>
|
|
3083
3073
|
|
|
@@ -3092,7 +3082,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3092
3082
|
<div class="chapter">
|
|
3093
3083
|
<h1 class="title">
|
|
3094
3084
|
Chapter
|
|
3095
|
-
<a class="toc" id="latex" href="#a-
|
|
3085
|
+
<a class="toc" id="latex" href="#a-607331928">5.3</a>
|
|
3096
3086
|
|
|
3097
3087
|
<br/>
|
|
3098
3088
|
|
|
@@ -3107,7 +3097,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3107
3097
|
<div class="chapter">
|
|
3108
3098
|
<h1 class="title">
|
|
3109
3099
|
Chapter
|
|
3110
|
-
<a class="toc" id="man" href="#a-
|
|
3100
|
+
<a class="toc" id="man" href="#a-607334028">5.4</a>
|
|
3111
3101
|
|
|
3112
3102
|
<br/>
|
|
3113
3103
|
|
|
@@ -3133,8 +3123,10 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3133
3123
|
<hr style="display: none"/>
|
|
3134
3124
|
<br style="display: none"/>
|
|
3135
3125
|
|
|
3126
|
+
|
|
3136
3127
|
<div id="footer">
|
|
3137
|
-
|
|
3128
|
+
|
|
3129
|
+
Generated on Sun Feb 03 22:52:32 -0800 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 2.0.0.
|
|
3138
3130
|
|
|
3139
3131
|
<p>The admonition icons (<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
3140
3132
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -3433,6 +3425,8 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3433
3425
|
0BYggPpqs9jeBlvqCnTNAP/jIXWgBeNF/YXzBfHxIoC3z5cj+Or2X3r9Ye2F
|
|
3434
3426
|
1izgAAAAAElFTkSuQmCC
|
|
3435
3427
|
" alt="tip"/>) used in this document are Copyright © 2005 <a href="http://tango.freedesktop.org">Tango Desktop Project</a>. They are part of the <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a> set, which is distributed under the <a href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License Agreement</a>.</p>
|
|
3428
|
+
|
|
3436
3429
|
</div>
|
|
3430
|
+
|
|
3437
3431
|
</body>
|
|
3438
3432
|
</html>
|