gerbil 3.0.1 → 3.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/bin/gerbil +20 -27
- data/doc/api/created.rid +1 -1
- data/doc/api/files/lib/gerbil_rb.html +2 -2
- data/doc/guide.erb +1 -2
- data/doc/guide.html +150 -138
- data/lib/gerbil.rb +2 -2
- metadata +2 -2
data/bin/gerbil
CHANGED
|
@@ -7,10 +7,6 @@
|
|
|
7
7
|
# * If an error occurs, the input document will be printed to STDOUT
|
|
8
8
|
# so you can investigate line numbers in the error's stack trace.
|
|
9
9
|
# Otherwise, the final output document will be printed to STDOUT.
|
|
10
|
-
#
|
|
11
|
-
# * The --unindent option assumes that all beginning (<% ... do %>)
|
|
12
|
-
# and ending (<% end %>) eRuby directives are written one per line
|
|
13
|
-
# (with nothing else on the line, except whitespace) in the input.
|
|
14
10
|
|
|
15
11
|
# Copyright 2007 Suraj N. Kurapati
|
|
16
12
|
# See the file named LICENSE for details.
|
|
@@ -165,32 +161,29 @@ if __FILE__ == $0 or File.basename(__FILE__) == File.basename($0)
|
|
|
165
161
|
|
|
166
162
|
# unindent node content
|
|
167
163
|
if unindent
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
else
|
|
187
|
-
if margin = stack.last and line.include? margin
|
|
188
|
-
line[margin] = ''
|
|
189
|
-
end
|
|
164
|
+
tags = input.scan(/<%(?:.(?!<%))*?%>/m)
|
|
165
|
+
margins = []
|
|
166
|
+
result = ''
|
|
167
|
+
|
|
168
|
+
buffer = input
|
|
169
|
+
tags.each do |tag|
|
|
170
|
+
chunk, buffer = buffer.split(tag, 2)
|
|
171
|
+
chunk << tag
|
|
172
|
+
|
|
173
|
+
# perform unindentation
|
|
174
|
+
result << chunk.gsub( /^#{margins.last}/, '' )
|
|
175
|
+
|
|
176
|
+
case tag
|
|
177
|
+
when /<%[^%=].*?\bdo\b.*?%>/m
|
|
178
|
+
margins.push buffer[/^[ \t]*(?=\S)/]
|
|
179
|
+
|
|
180
|
+
when /<%\s*end\s*%>/m
|
|
181
|
+
margins.pop
|
|
190
182
|
end
|
|
191
183
|
end
|
|
184
|
+
result << buffer
|
|
192
185
|
|
|
193
|
-
input =
|
|
186
|
+
input = result
|
|
194
187
|
end
|
|
195
188
|
|
|
196
189
|
# create sandbox for input evaluation
|
data/doc/api/created.rid
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
Sun, 08 Jun 2008 12:56:41 -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>Sun Jun 08 12:37:23 -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.2', :release => '2008-06-08', :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/guide.erb
CHANGED
|
@@ -424,9 +424,8 @@
|
|
|
424
424
|
|
|
425
425
|
RDoc::TopLevel.parse @spec['code']
|
|
426
426
|
RDoc::TopLevel.parse_file 'lib/gerbil/html.rb'
|
|
427
|
-
|
|
427
|
+
RDoc::TopLevel.all_methods.each do |m|
|
|
428
428
|
%>
|
|
429
|
-
<% methods.each do |m| %>
|
|
430
429
|
| <code><%= m.decl %></code> | <noformat><%= m.comment_html %></noformat> |
|
|
431
430
|
<% end %>
|
|
432
431
|
<% 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="08 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.2"/>
|
|
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.2 user guide</title>
|
|
10
10
|
|
|
11
11
|
<style type="text/css" media="screen">
|
|
12
12
|
body
|
|
@@ -818,9 +818,9 @@
|
|
|
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.2 user guide</h1>
|
|
822
822
|
<h2 class="authors"><a href="http://snk.rubyforge.org">Suraj N. Kurapati</a></h2>
|
|
823
|
-
<h3 class="date">
|
|
823
|
+
<h3 class="date">08 June 2008</h3>
|
|
824
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>
|
|
825
825
|
|
|
826
826
|
|
|
@@ -839,15 +839,16 @@
|
|
|
839
839
|
|
|
840
840
|
|
|
841
841
|
|
|
842
|
-
<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-605690458" href="#Introduction">Introduction</a><ul><li>1.1 <a id="a-606176228" href="#Features">Features</a></li><li>1.2 <a id="a-606182908" href="#License">License</a></li><li>1.3 <a id="a-606189058" href="#Reviews">Reviews</a></li></ul></li><li>2 <a id="a-606195148" href="#Setup">Setup</a><ul><li>2.1 <a id="a-606198708" href="#Requirements">Requirements</a></li><li>2.2 <a id="a-606210498" href="#Installation">Installation</a></li><li>2.3 <a id="a-606220358" href="#Manifest">Manifest</a></li><li>2.4 <a id="a-606241838" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3 <a id="a-606248408" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="a-606267838" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="a-606279598" 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-606286778" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="a-606296088" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="a-606300858" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="a-606305578" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="a-606308268" href="#HelloWorld">Creating your own custom format</a></li></ul></li></ul></li><li>4 <a id="a-606339698" href="#Usage">Usage</a><ul><li>4.1 <a id="a-606347418" href="#include">The <strong>include</strong> directive</a></li></ul></li><li>5 <a id="a-606352338" href="#Formats">Formats</a><ul><li>5.1 <a id="a-606365408" href="#html">HTML</a><ul><li>5.1.1 <a id="a-606368788" href="#Text-to-HTML-conversion">Text to HTML conversion</a><ul><li>5.1.1.1 <a id="a-606376608" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="a-606380538" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="a-606385258" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="a-606389488" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="a-606394628" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="a-606399218" href="#Methods">Methods</a></li><li>5.1.4 <a id="a-607016588" href="#html.nodes">Nodes</a><ul><li>5.1.4.1 <a id="a-607033098" href="#Structure">Structure</a><ul><li>5.1.4.1.1 <a id="a-607036378" href="#html.nodes.header">header</a></li><li>5.1.4.1.2 <a id="a-607038448" href="#html.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="a-607040548" href="#html.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="a-607042678" href="#html.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="a-607048578" href="#Organization">Organization</a><ul><li>5.1.4.2.1 <a id="a-607050288" href="#html.nodes.part">part</a><ul><li>5.1.4.2.1.1 <a id="a-607051948" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.2 <a id="a-607054458" href="#html.nodes.chapter">chapter</a><ul><li>5.1.4.2.2.1 <a id="a-607056148" href="#An-example-607136108">An example</a></li></ul></li><li>5.1.4.2.3 <a id="a-607058658" href="#html.nodes.section">section</a><ul><li>5.1.4.2.3.1 <a id="a-607060378" href="#An-example-607242568">An example</a></li></ul></li><li>5.1.4.2.4 <a id="a-607062888" href="#html.nodes.paragraph">paragraph</a></li></ul></li><li>5.1.4.3 <a id="a-607067128" href="#Admonitions">Admonitions</a><ul><li>5.1.4.3.1 <a id="a-607072748" href="#html.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="a-607085348" href="#html.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="a-607102958" href="#html.nodes.important">important</a></li><li>5.1.4.3.4 <a id="a-607121388" href="#html.nodes.note">note</a></li><li>5.1.4.3.5 <a id="a-607139008" href="#html.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="a-607152728" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="a-607155488" href="#html.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="a-607165808" href="#html.nodes.table">table</a></li><li>5.1.4.4.3 <a id="a-607172808" href="#html.nodes.example">example</a></li><li>5.1.4.4.4 <a id="a-607182908" href="#html.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="a-607192058" href="#html.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="a-607206348" href="#Bibliography">Bibliography</a><ul><li>5.1.4.5.1 <a id="a-607212128" href="#html.nodes.reference">reference</a></li><li>5.1.4.5.2 <a id="a-607239408" href="#html.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="a-607247898" href="#text">Plain text</a></li><li>5.3 <a id="a-607250098" href="#latex">LaTeX</a></li><li>5.4 <a id="a-607252408" href="#man">UNIX man page</a></li></ul></li></ul></div>
|
|
843
843
|
|
|
844
|
-
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-
|
|
844
|
+
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-607096198" href="#An-example-607346048">An example</a></li></ol><h1>Equations</h1> <ol><li><a id="a-607186458" href="#An-example-607544658">An example</a></li></ol><h1>Examples</h1> <ol><li><a id="a-606323768" href="#HelloWorld.spec">HelloWorld format specification file</a></li><li><a id="a-606328598" href="#HelloWorld.input">Input document for HelloWorld format</a></li><li><a id="a-606336548" href="#HelloWorld.output">Output of HelloWorld format</a></li><li><a id="a-607176778" href="#An-example-607522818">An example</a></li></ol><h1>Figures</h1> <ol><li><a id="a-607157598" href="#An-example-607477718">An example</a></li></ol><h1>Importants</h1> <ol><li><a id="a-607116008" href="#An-example-607377118">An example</a></li></ol><h1>Notes</h1> <ol><li><a id="a-606170928" href="#See-the-source-of-this-guide">See the source of this guide</a></li><li><a id="a-607132188" href="#An-example-607412768">An example</a></li></ol><h1>Procedures</h1> <ol><li><a id="a-607198148" href="#An-example-607566718">An example</a></li></ol><h1>Tables</h1> <ol><li><a id="a-607169488" href="#An-example-607500258">An example</a></li></ol><h1>Tips</h1> <ol><li><a id="a-607146098" href="#An-example-607442918">An example</a></li></ol><h1>Warnings</h1> <ol><li><a id="a-607078588" href="#An-example-607316558">An example</a></li></ol></div>
|
|
845
845
|
|
|
846
846
|
<div id="content">
|
|
847
|
+
|
|
847
848
|
<div class="chapter">
|
|
848
849
|
<h1 class="title">
|
|
849
850
|
Chapter
|
|
850
|
-
<a class="toc" id="Introduction" href="#a-
|
|
851
|
+
<a class="toc" id="Introduction" href="#a-605690458">1</a>
|
|
851
852
|
|
|
852
853
|
<br/>
|
|
853
854
|
|
|
@@ -870,7 +871,7 @@
|
|
|
870
871
|
|
|
871
872
|
|
|
872
873
|
<p><div class="note">
|
|
873
|
-
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-
|
|
874
|
+
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-606170928">Note 1</a>. See the source of this guide</p>
|
|
874
875
|
|
|
875
876
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
876
877
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -932,9 +933,10 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
932
933
|
" class="icon"/>
|
|
933
934
|
|
|
934
935
|
<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>
|
|
935
|
-
</div
|
|
936
|
+
</div>
|
|
937
|
+
<div class="section">
|
|
936
938
|
<h2 class="title">
|
|
937
|
-
<a class="toc" id="Features" href="#a-
|
|
939
|
+
<a class="toc" id="Features" href="#a-606176228">1.1</a> Features
|
|
938
940
|
</h2>
|
|
939
941
|
<div class="content"><ul>
|
|
940
942
|
<li>Composed of <strong>less than 200 lines</strong> of code!</li>
|
|
@@ -942,9 +944,10 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
942
944
|
<li>Supports <strong>any text-based output</strong> format.</li>
|
|
943
945
|
<li>Generates a <strong>table of contents</strong> automatically.</li>
|
|
944
946
|
</ul></div>
|
|
945
|
-
</div
|
|
947
|
+
</div>
|
|
948
|
+
<div class="section">
|
|
946
949
|
<h2 class="title">
|
|
947
|
-
<a class="toc" id="License" href="#a-
|
|
950
|
+
<a class="toc" id="License" href="#a-606182908">1.2</a> License
|
|
948
951
|
</h2>
|
|
949
952
|
<div class="content"><p>Copyright 2006 Suraj N. Kurapati <SNK at GNA dot ORG></p>
|
|
950
953
|
|
|
@@ -977,9 +980,10 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
977
980
|
<span class="caps">COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM</span>, DAMAGES <span class="caps">OR OTHER LIABILITY</span>, WHETHER
|
|
978
981
|
<span class="caps">IN AN ACTION OF CONTRACT</span>, TORT <span class="caps">OR OTHERWISE</span>, ARISING FROM, OUT <span class="caps">OF OR IN</span>
|
|
979
982
|
<span class="caps">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE</span>.</p></div>
|
|
980
|
-
</div
|
|
983
|
+
</div>
|
|
984
|
+
<div class="section">
|
|
981
985
|
<h2 class="title">
|
|
982
|
-
<a class="toc" id="Reviews" href="#a-
|
|
986
|
+
<a class="toc" id="Reviews" href="#a-606189058">1.3</a> Reviews
|
|
983
987
|
</h2>
|
|
984
988
|
<div class="content"><blockquote>
|
|
985
989
|
<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>
|
|
@@ -1008,7 +1012,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
1008
1012
|
<div class="chapter">
|
|
1009
1013
|
<h1 class="title">
|
|
1010
1014
|
Chapter
|
|
1011
|
-
<a class="toc" id="Setup" href="#a-
|
|
1015
|
+
<a class="toc" id="Setup" href="#a-606195148">2</a>
|
|
1012
1016
|
|
|
1013
1017
|
<br/>
|
|
1014
1018
|
|
|
@@ -1017,7 +1021,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
1017
1021
|
|
|
1018
1022
|
<div class="content"><div class="section">
|
|
1019
1023
|
<h2 class="title">
|
|
1020
|
-
<a class="toc" id="Requirements" href="#a-
|
|
1024
|
+
<a class="toc" id="Requirements" href="#a-606198708">2.1</a> Requirements
|
|
1021
1025
|
</h2>
|
|
1022
1026
|
<div class="content"><p>Your system needs the following software to run Gerbil.</p>
|
|
1023
1027
|
|
|
@@ -1048,9 +1052,10 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
|
1048
1052
|
|
|
1049
1053
|
|
|
1050
1054
|
<pre>gem install RedCloth coderay</pre></div>
|
|
1051
|
-
</div
|
|
1055
|
+
</div>
|
|
1056
|
+
<div class="section">
|
|
1052
1057
|
<h2 class="title">
|
|
1053
|
-
<a class="toc" id="Installation" href="#a-
|
|
1058
|
+
<a class="toc" id="Installation" href="#a-606210498">2.2</a> Installation
|
|
1054
1059
|
</h2>
|
|
1055
1060
|
<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>
|
|
1056
1061
|
|
|
@@ -1070,14 +1075,15 @@ Otherwise, follow these instructions:
|
|
|
1070
1075
|
<pre>ruby bin/gerbil -v</pre>
|
|
1071
1076
|
|
|
1072
1077
|
|
|
1073
|
-
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 3.0.
|
|
1078
|
+
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 3.0.2 (2008-06-08) http://gerbil.rubyforge.org /home/sun/src/gerbil
|
|
1074
1079
|
</pre></p>
|
|
1075
1080
|
|
|
1076
1081
|
|
|
1077
1082
|
<p>Otherwise, you can <a class="xref" href="#License">contact the author</a> for help.</p></div>
|
|
1078
|
-
</div
|
|
1083
|
+
</div>
|
|
1084
|
+
<div class="section">
|
|
1079
1085
|
<h2 class="title">
|
|
1080
|
-
<a class="toc" id="Manifest" href="#a-
|
|
1086
|
+
<a class="toc" id="Manifest" href="#a-606220358">2.3</a> Manifest
|
|
1081
1087
|
</h2>
|
|
1082
1088
|
<div class="content">Now that Gerbil is installed on your system, let us examine its installation directory.
|
|
1083
1089
|
<ul>
|
|
@@ -1121,9 +1127,10 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1121
1127
|
</li>
|
|
1122
1128
|
<li><tt>LICENSE</tt> – the project license and copyright notice.</li>
|
|
1123
1129
|
</ul></div>
|
|
1124
|
-
</div
|
|
1130
|
+
</div>
|
|
1131
|
+
<div class="section">
|
|
1125
1132
|
<h2 class="title">
|
|
1126
|
-
<a class="toc" id="Version-numbering-system" href="#a-
|
|
1133
|
+
<a class="toc" id="Version-numbering-system" href="#a-606241838">2.4</a> Version numbering system
|
|
1127
1134
|
</h2>
|
|
1128
1135
|
<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.
|
|
1129
1136
|
|
|
@@ -1159,7 +1166,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1159
1166
|
<div class="chapter">
|
|
1160
1167
|
<h1 class="title">
|
|
1161
1168
|
Chapter
|
|
1162
|
-
<a class="toc" id="Theory-of-operation" href="#a-
|
|
1169
|
+
<a class="toc" id="Theory-of-operation" href="#a-606248408">3</a>
|
|
1163
1170
|
|
|
1164
1171
|
<br/>
|
|
1165
1172
|
|
|
@@ -1191,7 +1198,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1191
1198
|
|
|
1192
1199
|
<p><div class="section">
|
|
1193
1200
|
<h2 class="title">
|
|
1194
|
-
<a class="toc" id="Nodes" href="#a-
|
|
1201
|
+
<a class="toc" id="Nodes" href="#a-606267838">3.1</a> Nodes
|
|
1195
1202
|
</h2>
|
|
1196
1203
|
<div class="content"><p>A node is a block of text that appears like this:</p>
|
|
1197
1204
|
|
|
@@ -1249,7 +1256,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1249
1256
|
|
|
1250
1257
|
<p><div class="section">
|
|
1251
1258
|
<h3 class="title">
|
|
1252
|
-
<a class="toc" id="Node.class" href="#a-
|
|
1259
|
+
<a class="toc" id="Node.class" href="#a-606279598">3.1.1</a> The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class
|
|
1253
1260
|
</h3>
|
|
1254
1261
|
<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>
|
|
1255
1262
|
|
|
@@ -1325,7 +1332,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1325
1332
|
</div>
|
|
1326
1333
|
<div class="section">
|
|
1327
1334
|
<h2 class="title">
|
|
1328
|
-
<a class="toc" id="SpecFile" href="#a-
|
|
1335
|
+
<a class="toc" id="SpecFile" href="#a-606286778">3.2</a> Format specification file
|
|
1329
1336
|
</h2>
|
|
1330
1337
|
<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>
|
|
1331
1338
|
|
|
@@ -1363,7 +1370,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1363
1370
|
|
|
1364
1371
|
<p><div class="section">
|
|
1365
1372
|
<h3 class="title">
|
|
1366
|
-
<a class="toc" id="SpecFile.nodes" href="#a-
|
|
1373
|
+
<a class="toc" id="SpecFile.nodes" href="#a-606296088">3.2.1</a> Node definition
|
|
1367
1374
|
</h3>
|
|
1368
1375
|
<div class="content"><p>A node definition is a mapping from a name (the “node type”) to the following set of parameters:</p>
|
|
1369
1376
|
|
|
@@ -1404,7 +1411,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1404
1411
|
|
|
1405
1412
|
<p><div class="section">
|
|
1406
1413
|
<h4 class="title">
|
|
1407
|
-
<a class="toc" id="SpecFile.nodes.output" href="#a-
|
|
1414
|
+
<a class="toc" id="SpecFile.nodes.output" href="#a-606300858">3.2.1.1</a> Node output template
|
|
1408
1415
|
</h4>
|
|
1409
1416
|
<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>
|
|
1410
1417
|
|
|
@@ -1472,7 +1479,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1472
1479
|
</div>
|
|
1473
1480
|
<div class="section">
|
|
1474
1481
|
<h3 class="title">
|
|
1475
|
-
<a class="toc" id="SpecFile.output" href="#a-
|
|
1482
|
+
<a class="toc" id="SpecFile.output" href="#a-606305578">3.2.2</a> Document output template
|
|
1476
1483
|
</h3>
|
|
1477
1484
|
<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>
|
|
1478
1485
|
|
|
@@ -1536,9 +1543,10 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
|
1536
1543
|
<td> Path of the current format specification file. </td>
|
|
1537
1544
|
</tr>
|
|
1538
1545
|
</table></div>
|
|
1539
|
-
</div
|
|
1546
|
+
</div>
|
|
1547
|
+
<div class="section">
|
|
1540
1548
|
<h3 class="title">
|
|
1541
|
-
<a class="toc" id="HelloWorld" href="#a-
|
|
1549
|
+
<a class="toc" id="HelloWorld" href="#a-606308268">3.2.3</a> Creating your own custom format
|
|
1542
1550
|
</h3>
|
|
1543
1551
|
<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:
|
|
1544
1552
|
<ul>
|
|
@@ -1557,7 +1565,7 @@ To run this example, perform the following steps:
|
|
|
1557
1565
|
|
|
1558
1566
|
|
|
1559
1567
|
<p><div class="example">
|
|
1560
|
-
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-
|
|
1568
|
+
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606323768">Example 1</a>. HelloWorld format specification file</p>
|
|
1561
1569
|
<div class="content"><pre class="code" lang="rhtml">desc: A illustrative format.
|
|
1562
1570
|
|
|
1563
1571
|
code: |
|
|
@@ -1625,8 +1633,9 @@ output: |
|
|
|
1625
1633
|
<span style="color:#070"><div</span> <span style="color:#007">style</span>=<span style="background-color:#fff0f0"><span style="color:#710">"</span><span style="background: #eee"><span style="color:black"><%=</span> <span style="color:#d70; font-weight:bold">$style</span> <span style="color:black">%></span></span><span style="color:#710">"</span></span><span style="color:#070">></span><span style="background: #eee"><span style="color:black"><%=</span> <span style="color:#33B">@content</span> <span style="color:black">%></span></span><span style="color:#070"></div></span>
|
|
1626
1634
|
That's all folks!
|
|
1627
1635
|
</pre></div>
|
|
1628
|
-
</div
|
|
1629
|
-
|
|
1636
|
+
</div>
|
|
1637
|
+
<div class="example">
|
|
1638
|
+
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-606328598">Example 2</a>. Input document for HelloWorld format</p>
|
|
1630
1639
|
<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>
|
|
1631
1640
|
<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>
|
|
1632
1641
|
<span style="color:#070"><big></span>I'm<span style="color:#070"></big></span> the very first node, oh _yes_ I am! *sneer*
|
|
@@ -1664,11 +1673,12 @@ output: |
|
|
|
1664
1673
|
<span style="background: #eee"><span style="color:black"><%</span> <span style="color:#080; font-weight:bold">end</span> <span style="color:black">%></span></span>
|
|
1665
1674
|
|
|
1666
1675
|
<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>
|
|
1667
|
-
</div
|
|
1668
|
-
|
|
1676
|
+
</div>
|
|
1677
|
+
<div class="example">
|
|
1678
|
+
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-606336548">Example 3</a>. Output of HelloWorld format</p>
|
|
1669
1679
|
<div class="content">Welcome to the “HelloWorld” format.
|
|
1670
|
-
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “
|
|
1671
|
-
My name is “
|
|
1680
|
+
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “kuzide”</h1>
|
|
1681
|
+
My name is “kuzide” and these are my properties:
|
|
1672
1682
|
<table border="1">
|
|
1673
1683
|
<tr>
|
|
1674
1684
|
<th>Property</th>
|
|
@@ -1688,14 +1698,14 @@ My name is “hojes” and these are my properties:
|
|
|
1688
1698
|
</tr>
|
|
1689
1699
|
<tr>
|
|
1690
1700
|
<td>trace</td>
|
|
1691
|
-
<td><ul><li>INPUT:1</li><li>bin/gerbil:
|
|
1701
|
+
<td><ul><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1692
1702
|
</tr>
|
|
1693
1703
|
<tr>
|
|
1694
1704
|
<td>content</td>
|
|
1695
1705
|
<td> <big>I’m</big> the very first node, oh <em>yes</em> I am! <strong>sneer</strong>
|
|
1696
1706
|
|
|
1697
|
-
<h1>hello #1.1: “
|
|
1698
|
-
My name is “
|
|
1707
|
+
<h1>hello #1.1: “hunedi”</h1>
|
|
1708
|
+
My name is “hunedi” and these are my properties:
|
|
1699
1709
|
<table border="1">
|
|
1700
1710
|
<tr>
|
|
1701
1711
|
<th>Property</th>
|
|
@@ -1715,14 +1725,14 @@ My name is “pevu” and these are my properties:
|
|
|
1715
1725
|
</tr>
|
|
1716
1726
|
<tr>
|
|
1717
1727
|
<td>trace</td>
|
|
1718
|
-
<td><ul><li>INPUT:3</li><li>bin/gerbil:
|
|
1728
|
+
<td><ul><li>INPUT:3</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1719
1729
|
</tr>
|
|
1720
1730
|
<tr>
|
|
1721
1731
|
<td>content</td>
|
|
1722
1732
|
<td> Hi, I… <strong>hide</strong>
|
|
1723
1733
|
|
|
1724
|
-
<h1>hello #1.1.1: “
|
|
1725
|
-
My name is “
|
|
1734
|
+
<h1>hello #1.1.1: “tefikos”</h1>
|
|
1735
|
+
My name is “tefikos” and these are my properties:
|
|
1726
1736
|
<table border="1">
|
|
1727
1737
|
<tr>
|
|
1728
1738
|
<th>Property</th>
|
|
@@ -1742,14 +1752,14 @@ My name is “bepole” and these are my properties:
|
|
|
1742
1752
|
</tr>
|
|
1743
1753
|
<tr>
|
|
1744
1754
|
<td>trace</td>
|
|
1745
|
-
<td><ul><li>INPUT:5</li><li>bin/gerbil:
|
|
1755
|
+
<td><ul><li>INPUT:5</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1746
1756
|
</tr>
|
|
1747
1757
|
<tr>
|
|
1748
1758
|
<td>content</td>
|
|
1749
1759
|
<td> <strong>sigh</strong>
|
|
1750
1760
|
|
|
1751
|
-
<h1>hello #1.1.1.1: “
|
|
1752
|
-
My name is “
|
|
1761
|
+
<h1>hello #1.1.1.1: “giki”</h1>
|
|
1762
|
+
My name is “giki” and these are my properties:
|
|
1753
1763
|
<table border="1">
|
|
1754
1764
|
<tr>
|
|
1755
1765
|
<th>Property</th>
|
|
@@ -1769,7 +1779,7 @@ My name is “sehobak” and these are my properties:
|
|
|
1769
1779
|
</tr>
|
|
1770
1780
|
<tr>
|
|
1771
1781
|
<td>trace</td>
|
|
1772
|
-
<td><ul><li>INPUT:7</li><li>bin/gerbil:
|
|
1782
|
+
<td><ul><li>INPUT:7</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:5</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1773
1783
|
</tr>
|
|
1774
1784
|
<tr>
|
|
1775
1785
|
<td>content</td>
|
|
@@ -1779,8 +1789,8 @@ My name is “sehobak” and these are my properties:
|
|
|
1779
1789
|
</table></td>
|
|
1780
1790
|
</tr>
|
|
1781
1791
|
</table>
|
|
1782
|
-
<h1>hello #1.1.2: “
|
|
1783
|
-
My name is “
|
|
1792
|
+
<h1>hello #1.1.2: “kojukuj”</h1>
|
|
1793
|
+
My name is “kojukuj” and these are my properties:
|
|
1784
1794
|
<table border="1">
|
|
1785
1795
|
<tr>
|
|
1786
1796
|
<th>Property</th>
|
|
@@ -1800,7 +1810,7 @@ My name is “bozobe” and these are my properties:
|
|
|
1800
1810
|
</tr>
|
|
1801
1811
|
<tr>
|
|
1802
1812
|
<td>trace</td>
|
|
1803
|
-
<td><ul><li>INPUT:9</li><li>bin/gerbil:
|
|
1813
|
+
<td><ul><li>INPUT:9</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1804
1814
|
</tr>
|
|
1805
1815
|
<tr>
|
|
1806
1816
|
<td>content</td>
|
|
@@ -1810,8 +1820,8 @@ My name is “bozobe” and these are my properties:
|
|
|
1810
1820
|
</table></td>
|
|
1811
1821
|
</tr>
|
|
1812
1822
|
</table>
|
|
1813
|
-
<h1>hello #1.2: “
|
|
1814
|
-
My name is “
|
|
1823
|
+
<h1>hello #1.2: “kikefo”</h1>
|
|
1824
|
+
My name is “kikefo” and these are my properties:
|
|
1815
1825
|
<table border="1">
|
|
1816
1826
|
<tr>
|
|
1817
1827
|
<th>Property</th>
|
|
@@ -1831,14 +1841,14 @@ My name is “bolajo” and these are my properties:
|
|
|
1831
1841
|
</tr>
|
|
1832
1842
|
<tr>
|
|
1833
1843
|
<td>trace</td>
|
|
1834
|
-
<td><ul><li>INPUT:11</li><li>bin/gerbil:
|
|
1844
|
+
<td><ul><li>INPUT:11</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1835
1845
|
</tr>
|
|
1836
1846
|
<tr>
|
|
1837
1847
|
<td>content</td>
|
|
1838
1848
|
<td> <strong>yawn</strong> Just five more minutes…
|
|
1839
1849
|
|
|
1840
|
-
<h1>hello #1.2.1: “
|
|
1841
|
-
My name is “
|
|
1850
|
+
<h1>hello #1.2.1: “rilom”</h1>
|
|
1851
|
+
My name is “rilom” and these are my properties:
|
|
1842
1852
|
<table border="1">
|
|
1843
1853
|
<tr>
|
|
1844
1854
|
<th>Property</th>
|
|
@@ -1858,14 +1868,14 @@ My name is “zumuyuh” and these are my properties:
|
|
|
1858
1868
|
</tr>
|
|
1859
1869
|
<tr>
|
|
1860
1870
|
<td>trace</td>
|
|
1861
|
-
<td><ul><li>INPUT:13</li><li>bin/gerbil:
|
|
1871
|
+
<td><ul><li>INPUT:13</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1862
1872
|
</tr>
|
|
1863
1873
|
<tr>
|
|
1864
1874
|
<td>content</td>
|
|
1865
1875
|
<td> So <em>be</em> happy my friend, <strong>happy</strong>!
|
|
1866
1876
|
|
|
1867
|
-
<h1>hello #1.2.1.1: “
|
|
1868
|
-
My name is “
|
|
1877
|
+
<h1>hello #1.2.1.1: “pelo”</h1>
|
|
1878
|
+
My name is “pelo” and these are my properties:
|
|
1869
1879
|
<table border="1">
|
|
1870
1880
|
<tr>
|
|
1871
1881
|
<th>Property</th>
|
|
@@ -1885,7 +1895,7 @@ My name is “jane” and these are my properties:
|
|
|
1885
1895
|
</tr>
|
|
1886
1896
|
<tr>
|
|
1887
1897
|
<td>trace</td>
|
|
1888
|
-
<td><ul><li>INPUT:15</li><li>bin/gerbil:
|
|
1898
|
+
<td><ul><li>INPUT:15</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:13</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:79:in `content_from_block’</li><li>bin/gerbil:249:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1889
1899
|
</tr>
|
|
1890
1900
|
<tr>
|
|
1891
1901
|
<td>content</td>
|
|
@@ -1899,8 +1909,8 @@ My name is “jane” and these are my properties:
|
|
|
1899
1909
|
</table></td>
|
|
1900
1910
|
</tr>
|
|
1901
1911
|
</table>
|
|
1902
|
-
<h1>hello #2: “
|
|
1903
|
-
My name is “
|
|
1912
|
+
<h1>hello #2: “duz”</h1>
|
|
1913
|
+
My name is “duz” and these are my properties:
|
|
1904
1914
|
<table border="1">
|
|
1905
1915
|
<tr>
|
|
1906
1916
|
<th>Property</th>
|
|
@@ -1920,7 +1930,7 @@ My name is “lukopu” and these are my properties:
|
|
|
1920
1930
|
</tr>
|
|
1921
1931
|
<tr>
|
|
1922
1932
|
<td>trace</td>
|
|
1923
|
-
<td><ul><li>INPUT:17</li><li>bin/gerbil:
|
|
1933
|
+
<td><ul><li>INPUT:17</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1924
1934
|
</tr>
|
|
1925
1935
|
<tr>
|
|
1926
1936
|
<td>content</td>
|
|
@@ -1929,8 +1939,8 @@ My name is “lukopu” and these are my properties:
|
|
|
1929
1939
|
</td>
|
|
1930
1940
|
</tr>
|
|
1931
1941
|
</table>
|
|
1932
|
-
<h1>hello #3: “
|
|
1933
|
-
My name is “
|
|
1942
|
+
<h1>hello #3: “berifu”</h1>
|
|
1943
|
+
My name is “berifu” and these are my properties:
|
|
1934
1944
|
<table border="1">
|
|
1935
1945
|
<tr>
|
|
1936
1946
|
<th>Property</th>
|
|
@@ -1950,7 +1960,7 @@ My name is “lipa” and these are my properties:
|
|
|
1950
1960
|
</tr>
|
|
1951
1961
|
<tr>
|
|
1952
1962
|
<td>trace</td>
|
|
1953
|
-
<td><ul><li>INPUT:20</li><li>bin/gerbil:
|
|
1963
|
+
<td><ul><li>INPUT:20</li><li>bin/gerbil:268</li><li>bin/gerbil:268:in `instance_eval’</li><li>bin/gerbil:268</li></ul></td>
|
|
1954
1964
|
</tr>
|
|
1955
1965
|
<tr>
|
|
1956
1966
|
<td>content</td>
|
|
@@ -1965,7 +1975,7 @@ That’s all folks!</div>
|
|
|
1965
1975
|
<div class="chapter">
|
|
1966
1976
|
<h1 class="title">
|
|
1967
1977
|
Chapter
|
|
1968
|
-
<a class="toc" id="Usage" href="#a-
|
|
1978
|
+
<a class="toc" id="Usage" href="#a-606339698">4</a>
|
|
1969
1979
|
|
|
1970
1980
|
<br/>
|
|
1971
1981
|
|
|
@@ -1987,13 +1997,6 @@ That’s all folks!</div>
|
|
|
1987
1997
|
</ul>
|
|
1988
1998
|
|
|
1989
1999
|
|
|
1990
|
-
<ul>
|
|
1991
|
-
<li>The <tt>--unindent</tt> option assumes that all beginning (<% ... do %>)
|
|
1992
|
-
and ending (<% end %>) eRuby directives are written one per line
|
|
1993
|
-
(with nothing else on the line, except whitespace) in the input.</li>
|
|
1994
|
-
</ul>
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
2000
|
<p><b>Usage:</b> gerbil [Option…] Format|SpecFile [InputFile…]</p>
|
|
1998
2001
|
|
|
1999
2002
|
|
|
@@ -2044,7 +2047,7 @@ That’s all folks!</div>
|
|
|
2044
2047
|
|
|
2045
2048
|
<p><div class="section">
|
|
2046
2049
|
<h2 class="title">
|
|
2047
|
-
<a class="toc" id="include" href="#a-
|
|
2050
|
+
<a class="toc" id="include" href="#a-606347418">4.1</a> The <strong>include</strong> directive
|
|
2048
2051
|
</h2>
|
|
2049
2052
|
<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>
|
|
2050
2053
|
|
|
@@ -2061,7 +2064,7 @@ That’s all folks!</div>
|
|
|
2061
2064
|
<div class="part">
|
|
2062
2065
|
<h1 class="title">
|
|
2063
2066
|
Part
|
|
2064
|
-
<a class="toc" id="Formats" href="#a-
|
|
2067
|
+
<a class="toc" id="Formats" href="#a-606352338">5</a>
|
|
2065
2068
|
|
|
2066
2069
|
<br/>
|
|
2067
2070
|
|
|
@@ -2077,7 +2080,7 @@ That’s all folks!</div>
|
|
|
2077
2080
|
<p><div class="chapter">
|
|
2078
2081
|
<h1 class="title">
|
|
2079
2082
|
Chapter
|
|
2080
|
-
<a class="toc" id="html" href="#a-
|
|
2083
|
+
<a class="toc" id="html" href="#a-606365408">5.1</a>
|
|
2081
2084
|
|
|
2082
2085
|
<br/>
|
|
2083
2086
|
|
|
@@ -2095,7 +2098,7 @@ That’s all folks!</div>
|
|
|
2095
2098
|
|
|
2096
2099
|
<p><div class="section">
|
|
2097
2100
|
<h3 class="title">
|
|
2098
|
-
<a class="toc" id="Text-to-HTML-conversion" href="#a-
|
|
2101
|
+
<a class="toc" id="Text-to-HTML-conversion" href="#a-606368788">5.1.1</a> Text to HTML conversion
|
|
2099
2102
|
</h3>
|
|
2100
2103
|
<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>
|
|
2101
2104
|
|
|
@@ -2120,7 +2123,7 @@ That’s all folks!</div>
|
|
|
2120
2123
|
|
|
2121
2124
|
<p><div class="section">
|
|
2122
2125
|
<h4 class="title">
|
|
2123
|
-
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-
|
|
2126
|
+
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-606376608">5.1.1.1</a> Syntax coloring for source code
|
|
2124
2127
|
</h4>
|
|
2125
2128
|
<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>
|
|
2126
2129
|
|
|
@@ -2138,7 +2141,7 @@ The following programming languages are currently supported by <a href="http://c
|
|
|
2138
2141
|
|
|
2139
2142
|
<p><div class="section">
|
|
2140
2143
|
<h5 class="title">
|
|
2141
|
-
<a class="toc" id="Specifying-the-programming-language" href="#a-
|
|
2144
|
+
<a class="toc" id="Specifying-the-programming-language" href="#a-606380538">5.1.1.1.1</a> Specifying the programming language
|
|
2142
2145
|
</h5>
|
|
2143
2146
|
<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>
|
|
2144
2147
|
|
|
@@ -2226,7 +2229,7 @@ int main(int argc, char **argv) {
|
|
|
2226
2229
|
</div>
|
|
2227
2230
|
<div class="section">
|
|
2228
2231
|
<h4 class="title">
|
|
2229
|
-
<a class="toc" id="Smart-sizing-of-source-code" href="#a-
|
|
2232
|
+
<a class="toc" id="Smart-sizing-of-source-code" href="#a-606385258">5.1.1.2</a> Smart sizing of source code
|
|
2230
2233
|
</h4>
|
|
2231
2234
|
<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>
|
|
2232
2235
|
|
|
@@ -2242,16 +2245,17 @@ int main(int argc, char **argv) {
|
|
|
2242
2245
|
|
|
2243
2246
|
<pre class="code">life =
|
|
2244
2247
|
<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>
|
|
2245
|
-
</div
|
|
2248
|
+
</div>
|
|
2249
|
+
<div class="section">
|
|
2246
2250
|
<h4 class="title">
|
|
2247
|
-
<a class="toc" id="Protecting-verbatim-text" href="#a-
|
|
2251
|
+
<a class="toc" id="Protecting-verbatim-text" href="#a-606389488">5.1.1.3</a> Protecting verbatim text
|
|
2248
2252
|
</h4>
|
|
2249
2253
|
<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>
|
|
2250
2254
|
</div></p></div>
|
|
2251
2255
|
</div>
|
|
2252
2256
|
<div class="section">
|
|
2253
2257
|
<h3 class="title">
|
|
2254
|
-
<a class="toc" id="Parameters" href="#a-
|
|
2258
|
+
<a class="toc" id="Parameters" href="#a-606394628">5.1.2</a> Parameters
|
|
2255
2259
|
</h3>
|
|
2256
2260
|
<div class="content">The HTML format accepts the following document parameters.
|
|
2257
2261
|
|
|
@@ -2300,9 +2304,10 @@ int main(int argc, char **argv) {
|
|
|
2300
2304
|
<td> Use <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango icons</a> in admonitions (see <a class="xref" href="#Admonitions">Section 5.1.4.3: <em>Admonitions</em></a>)? </td>
|
|
2301
2305
|
</tr>
|
|
2302
2306
|
</table></div>
|
|
2303
|
-
</div
|
|
2307
|
+
</div>
|
|
2308
|
+
<div class="section">
|
|
2304
2309
|
<h3 class="title">
|
|
2305
|
-
<a class="toc" id="Methods" href="#a-
|
|
2310
|
+
<a class="toc" id="Methods" href="#a-606399218">5.1.3</a> Methods
|
|
2306
2311
|
</h3>
|
|
2307
2312
|
<div class="content">The HTML format provides the following methods. In the method declarations shown below,
|
|
2308
2313
|
<ul>
|
|
@@ -2398,7 +2403,7 @@ ruby.
|
|
|
2398
2403
|
<div class="chapter">
|
|
2399
2404
|
<h1 class="title">
|
|
2400
2405
|
Chapter
|
|
2401
|
-
<a class="toc" id="html.nodes" href="#a-
|
|
2406
|
+
<a class="toc" id="html.nodes" href="#a-607016588">5.1.4</a>
|
|
2402
2407
|
|
|
2403
2408
|
<br/>
|
|
2404
2409
|
|
|
@@ -2441,29 +2446,32 @@ ruby.
|
|
|
2441
2446
|
|
|
2442
2447
|
<p><div class="section">
|
|
2443
2448
|
<h4 class="title">
|
|
2444
|
-
<a class="toc" id="Structure" href="#a-
|
|
2449
|
+
<a class="toc" id="Structure" href="#a-607033098">5.1.4.1</a> Structure
|
|
2445
2450
|
</h4>
|
|
2446
2451
|
<div class="content"><p>The nodes described in this section form the overall structure of the output document.</p>
|
|
2447
2452
|
|
|
2448
2453
|
|
|
2449
2454
|
<p><div class="section">
|
|
2450
2455
|
<h5 class="title">
|
|
2451
|
-
<a class="toc" id="html.nodes.header" href="#a-
|
|
2456
|
+
<a class="toc" id="html.nodes.header" href="#a-607036378">5.1.4.1.1</a> header
|
|
2452
2457
|
</h5>
|
|
2453
2458
|
<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>
|
|
2454
|
-
</div
|
|
2459
|
+
</div>
|
|
2460
|
+
<div class="section">
|
|
2455
2461
|
<h5 class="title">
|
|
2456
|
-
<a class="toc" id="html.nodes.footer" href="#a-
|
|
2462
|
+
<a class="toc" id="html.nodes.footer" href="#a-607038448">5.1.4.1.2</a> footer
|
|
2457
2463
|
</h5>
|
|
2458
2464
|
<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>
|
|
2459
|
-
</div
|
|
2465
|
+
</div>
|
|
2466
|
+
<div class="section">
|
|
2460
2467
|
<h5 class="title">
|
|
2461
|
-
<a class="toc" id="html.nodes.abstract" href="#a-
|
|
2468
|
+
<a class="toc" id="html.nodes.abstract" href="#a-607040548">5.1.4.1.3</a> abstract
|
|
2462
2469
|
</h5>
|
|
2463
2470
|
<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>
|
|
2464
|
-
</div
|
|
2471
|
+
</div>
|
|
2472
|
+
<div class="section">
|
|
2465
2473
|
<h5 class="title">
|
|
2466
|
-
<a class="toc" id="html.nodes.xref" href="#a-
|
|
2474
|
+
<a class="toc" id="html.nodes.xref" href="#a-607042678">5.1.4.1.4</a> xref
|
|
2467
2475
|
</h5>
|
|
2468
2476
|
<div class="content"><p>A cross-reference; a hyperlink that takes you to any node in the document.</p>
|
|
2469
2477
|
|
|
@@ -2494,14 +2502,14 @@ ruby.
|
|
|
2494
2502
|
</div>
|
|
2495
2503
|
<div class="section">
|
|
2496
2504
|
<h4 class="title">
|
|
2497
|
-
<a class="toc" id="Organization" href="#a-
|
|
2505
|
+
<a class="toc" id="Organization" href="#a-607048578">5.1.4.2</a> Organization
|
|
2498
2506
|
</h4>
|
|
2499
2507
|
<div class="content"><p>The nodes described in this section are meant to help organize the document’s content logically.</p>
|
|
2500
2508
|
|
|
2501
2509
|
|
|
2502
2510
|
<p><div class="section">
|
|
2503
2511
|
<h5 class="title">
|
|
2504
|
-
<a class="toc" id="html.nodes.part" href="#a-
|
|
2512
|
+
<a class="toc" id="html.nodes.part" href="#a-607050288">5.1.4.2.1</a> part
|
|
2505
2513
|
</h5>
|
|
2506
2514
|
<div class="content"><p>A collection of chapters.</p>
|
|
2507
2515
|
|
|
@@ -2509,7 +2517,7 @@ ruby.
|
|
|
2509
2517
|
<p><div class="part">
|
|
2510
2518
|
<h1 class="title">
|
|
2511
2519
|
Part
|
|
2512
|
-
<a class="toc" id="An-example" href="#a-
|
|
2520
|
+
<a class="toc" id="An-example" href="#a-607051948">5.1.4.2.1.1</a>
|
|
2513
2521
|
|
|
2514
2522
|
<br/>
|
|
2515
2523
|
|
|
@@ -2521,7 +2529,7 @@ ruby.
|
|
|
2521
2529
|
</div>
|
|
2522
2530
|
<div class="section">
|
|
2523
2531
|
<h5 class="title">
|
|
2524
|
-
<a class="toc" id="html.nodes.chapter" href="#a-
|
|
2532
|
+
<a class="toc" id="html.nodes.chapter" href="#a-607054458">5.1.4.2.2</a> chapter
|
|
2525
2533
|
</h5>
|
|
2526
2534
|
<div class="content"><p>A collection of sections.</p>
|
|
2527
2535
|
|
|
@@ -2529,7 +2537,7 @@ ruby.
|
|
|
2529
2537
|
<p><div class="chapter">
|
|
2530
2538
|
<h1 class="title">
|
|
2531
2539
|
Chapter
|
|
2532
|
-
<a class="toc" id="An-example-
|
|
2540
|
+
<a class="toc" id="An-example-607136108" href="#a-607056148">5.1.4.2.2.1</a>
|
|
2533
2541
|
|
|
2534
2542
|
<br/>
|
|
2535
2543
|
|
|
@@ -2541,21 +2549,21 @@ ruby.
|
|
|
2541
2549
|
</div>
|
|
2542
2550
|
<div class="section">
|
|
2543
2551
|
<h5 class="title">
|
|
2544
|
-
<a class="toc" id="html.nodes.section" href="#a-
|
|
2552
|
+
<a class="toc" id="html.nodes.section" href="#a-607058658">5.1.4.2.3</a> section
|
|
2545
2553
|
</h5>
|
|
2546
2554
|
<div class="content"><p>A collection of paragraphs about a particular topic.</p>
|
|
2547
2555
|
|
|
2548
2556
|
|
|
2549
2557
|
<p><div class="section">
|
|
2550
2558
|
<h6 class="title">
|
|
2551
|
-
<a class="toc" id="An-example-
|
|
2559
|
+
<a class="toc" id="An-example-607242568" href="#a-607060378">5.1.4.2.3.1</a> An example
|
|
2552
2560
|
</h6>
|
|
2553
2561
|
<div class="content">This is what a <strong>section</strong> node appears like.</div>
|
|
2554
2562
|
</div></p></div>
|
|
2555
2563
|
</div>
|
|
2556
2564
|
<div class="section">
|
|
2557
2565
|
<h5 class="title">
|
|
2558
|
-
<a class="toc" id="html.nodes.paragraph" href="#a-
|
|
2566
|
+
<a class="toc" id="html.nodes.paragraph" href="#a-607062888">5.1.4.2.4</a> paragraph
|
|
2559
2567
|
</h5>
|
|
2560
2568
|
<div class="content"><p>A collection of sentences about a particular idea.</p>
|
|
2561
2569
|
|
|
@@ -2568,7 +2576,7 @@ ruby.
|
|
|
2568
2576
|
</div>
|
|
2569
2577
|
<div class="section">
|
|
2570
2578
|
<h4 class="title">
|
|
2571
|
-
<a class="toc" id="Admonitions" href="#a-
|
|
2579
|
+
<a class="toc" id="Admonitions" href="#a-607067128">5.1.4.3</a> Admonitions
|
|
2572
2580
|
</h4>
|
|
2573
2581
|
<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>
|
|
2574
2582
|
|
|
@@ -2576,15 +2584,16 @@ ruby.
|
|
|
2576
2584
|
<p>I like to follow the KDE guidelines<sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup> when determining which admonition to use in my documents.</p>
|
|
2577
2585
|
|
|
2578
2586
|
|
|
2579
|
-
<p
|
|
2587
|
+
<p>
|
|
2588
|
+
<div class="section">
|
|
2580
2589
|
<h5 class="title">
|
|
2581
|
-
<a class="toc" id="html.nodes.warning" href="#a-
|
|
2590
|
+
<a class="toc" id="html.nodes.warning" href="#a-607072748">5.1.4.3.1</a> warning
|
|
2582
2591
|
</h5>
|
|
2583
2592
|
<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>
|
|
2584
2593
|
|
|
2585
2594
|
|
|
2586
2595
|
<p><div class="warning">
|
|
2587
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2596
|
+
<p class="title"><a class="toc" id="An-example-607316558" href="#a-607078588">Warning 1</a>. An example</p>
|
|
2588
2597
|
|
|
2589
2598
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2590
2599
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2649,7 +2658,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2649
2658
|
</div>
|
|
2650
2659
|
<div class="section">
|
|
2651
2660
|
<h5 class="title">
|
|
2652
|
-
<a class="toc" id="html.nodes.caution" href="#a-
|
|
2661
|
+
<a class="toc" id="html.nodes.caution" href="#a-607085348">5.1.4.3.2</a> caution
|
|
2653
2662
|
</h5>
|
|
2654
2663
|
<div class="content"><blockquote>
|
|
2655
2664
|
<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>
|
|
@@ -2657,7 +2666,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
|
2657
2666
|
|
|
2658
2667
|
|
|
2659
2668
|
<p><div class="caution">
|
|
2660
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2669
|
+
<p class="title"><a class="toc" id="An-example-607346048" href="#a-607096198">Caution 1</a>. An example</p>
|
|
2661
2670
|
|
|
2662
2671
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2663
2672
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2718,7 +2727,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2718
2727
|
</div>
|
|
2719
2728
|
<div class="section">
|
|
2720
2729
|
<h5 class="title">
|
|
2721
|
-
<a class="toc" id="html.nodes.important" href="#a-
|
|
2730
|
+
<a class="toc" id="html.nodes.important" href="#a-607102958">5.1.4.3.3</a> important
|
|
2722
2731
|
</h5>
|
|
2723
2732
|
<div class="content"><p>Use an <strong>important</strong> node when:</p>
|
|
2724
2733
|
|
|
@@ -2729,7 +2738,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
|
2729
2738
|
|
|
2730
2739
|
|
|
2731
2740
|
<p><div class="important">
|
|
2732
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2741
|
+
<p class="title"><a class="toc" id="An-example-607377118" href="#a-607116008">Important 1</a>. An example</p>
|
|
2733
2742
|
|
|
2734
2743
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2735
2744
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2794,7 +2803,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2794
2803
|
</div>
|
|
2795
2804
|
<div class="section">
|
|
2796
2805
|
<h5 class="title">
|
|
2797
|
-
<a class="toc" id="html.nodes.note" href="#a-
|
|
2806
|
+
<a class="toc" id="html.nodes.note" href="#a-607121388">5.1.4.3.4</a> note
|
|
2798
2807
|
</h5>
|
|
2799
2808
|
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
|
|
2800
2809
|
|
|
@@ -2805,7 +2814,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
|
2805
2814
|
|
|
2806
2815
|
|
|
2807
2816
|
<p><div class="note">
|
|
2808
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2817
|
+
<p class="title"><a class="toc" id="An-example-607412768" href="#a-607132188">Note 2</a>. An example</p>
|
|
2809
2818
|
|
|
2810
2819
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2811
2820
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2871,7 +2880,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2871
2880
|
</div>
|
|
2872
2881
|
<div class="section">
|
|
2873
2882
|
<h5 class="title">
|
|
2874
|
-
<a class="toc" id="html.nodes.tip" href="#a-
|
|
2883
|
+
<a class="toc" id="html.nodes.tip" href="#a-607139008">5.1.4.3.5</a> tip
|
|
2875
2884
|
</h5>
|
|
2876
2885
|
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
|
|
2877
2886
|
|
|
@@ -2882,7 +2891,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
|
2882
2891
|
|
|
2883
2892
|
|
|
2884
2893
|
<p><div class="tip">
|
|
2885
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2894
|
+
<p class="title"><a class="toc" id="An-example-607442918" href="#a-607146098">Tip 1</a>. An example</p>
|
|
2886
2895
|
|
|
2887
2896
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
2888
2897
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
|
@@ -2967,79 +2976,79 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
2967
2976
|
</div>
|
|
2968
2977
|
<div class="section">
|
|
2969
2978
|
<h4 class="title">
|
|
2970
|
-
<a class="toc" id="Auxilary-materials" href="#a-
|
|
2979
|
+
<a class="toc" id="Auxilary-materials" href="#a-607152728">5.1.4.4</a> Auxilary materials
|
|
2971
2980
|
</h4>
|
|
2972
2981
|
<div class="content"><div class="section">
|
|
2973
2982
|
<h5 class="title">
|
|
2974
|
-
<a class="toc" id="html.nodes.figure" href="#a-
|
|
2983
|
+
<a class="toc" id="html.nodes.figure" href="#a-607155488">5.1.4.4.1</a> figure
|
|
2975
2984
|
</h5>
|
|
2976
2985
|
<div class="content"><p>A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.</p>
|
|
2977
2986
|
|
|
2978
2987
|
|
|
2979
2988
|
<p><div class="figure">
|
|
2980
|
-
<p class="title"><a class="toc" id="An-example-
|
|
2989
|
+
<p class="title"><a class="toc" id="An-example-607477718" href="#a-607157598">Figure 1</a>. An example</p>
|
|
2981
2990
|
<div class="content">This is what a <strong>figure</strong> node appears like.</div>
|
|
2982
2991
|
</div></p></div>
|
|
2983
2992
|
</div>
|
|
2984
2993
|
<div class="section">
|
|
2985
2994
|
<h5 class="title">
|
|
2986
|
-
<a class="toc" id="html.nodes.table" href="#a-
|
|
2995
|
+
<a class="toc" id="html.nodes.table" href="#a-607165808">5.1.4.4.2</a> table
|
|
2987
2996
|
</h5>
|
|
2988
2997
|
<div class="content"><p>Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.</p>
|
|
2989
2998
|
|
|
2990
2999
|
|
|
2991
3000
|
<p><div class="table">
|
|
2992
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3001
|
+
<p class="title"><a class="toc" id="An-example-607500258" href="#a-607169488">Table 1</a>. An example</p>
|
|
2993
3002
|
<div class="content">This is what a <strong>table</strong> node appears like.</div>
|
|
2994
3003
|
</div></p></div>
|
|
2995
3004
|
</div>
|
|
2996
3005
|
<div class="section">
|
|
2997
3006
|
<h5 class="title">
|
|
2998
|
-
<a class="toc" id="html.nodes.example" href="#a-
|
|
3007
|
+
<a class="toc" id="html.nodes.example" href="#a-607172808">5.1.4.4.3</a> example
|
|
2999
3008
|
</h5>
|
|
3000
3009
|
<div class="content"><p>A sample application of an idea or thought.</p>
|
|
3001
3010
|
|
|
3002
3011
|
|
|
3003
3012
|
<p><div class="example">
|
|
3004
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3013
|
+
<p class="title"><a class="toc" id="An-example-607522818" href="#a-607176778">Example 4</a>. An example</p>
|
|
3005
3014
|
<div class="content">This is what a <strong>example</strong> node appears like.</div>
|
|
3006
3015
|
</div></p></div>
|
|
3007
3016
|
</div>
|
|
3008
3017
|
<div class="section">
|
|
3009
3018
|
<h5 class="title">
|
|
3010
|
-
<a class="toc" id="html.nodes.equation" href="#a-
|
|
3019
|
+
<a class="toc" id="html.nodes.equation" href="#a-607182908">5.1.4.4.4</a> equation
|
|
3011
3020
|
</h5>
|
|
3012
3021
|
<div class="content"><p>A mathematical equation or formula.</p>
|
|
3013
3022
|
|
|
3014
3023
|
|
|
3015
3024
|
<p><div class="equation">
|
|
3016
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3025
|
+
<p class="title"><a class="toc" id="An-example-607544658" href="#a-607186458">Equation 1</a>. An example</p>
|
|
3017
3026
|
<div class="content">This is what a <strong>equation</strong> node appears like.</div>
|
|
3018
3027
|
</div></p></div>
|
|
3019
3028
|
</div>
|
|
3020
3029
|
<div class="section">
|
|
3021
3030
|
<h5 class="title">
|
|
3022
|
-
<a class="toc" id="html.nodes.procedure" href="#a-
|
|
3031
|
+
<a class="toc" id="html.nodes.procedure" href="#a-607192058">5.1.4.4.5</a> procedure
|
|
3023
3032
|
</h5>
|
|
3024
3033
|
<div class="content"><p>An outline; a series of steps outlining some kind of process.</p>
|
|
3025
3034
|
|
|
3026
3035
|
|
|
3027
3036
|
<p><div class="procedure">
|
|
3028
|
-
<p class="title"><a class="toc" id="An-example-
|
|
3037
|
+
<p class="title"><a class="toc" id="An-example-607566718" href="#a-607198148">Procedure 1</a>. An example</p>
|
|
3029
3038
|
<div class="content">This is what a <strong>procedure</strong> node appears like.</div>
|
|
3030
3039
|
</div></p></div>
|
|
3031
3040
|
</div></div>
|
|
3032
3041
|
</div>
|
|
3033
3042
|
<div class="section">
|
|
3034
3043
|
<h4 class="title">
|
|
3035
|
-
<a class="toc" id="Bibliography" href="#a-
|
|
3044
|
+
<a class="toc" id="Bibliography" href="#a-607206348">5.1.4.5</a> Bibliography
|
|
3036
3045
|
</h4>
|
|
3037
3046
|
<div class="content"><p>The nodes in this section deal with attribution of ideas—an important weapon against plagiarism.</p>
|
|
3038
3047
|
|
|
3039
3048
|
|
|
3040
3049
|
<p><div class="section">
|
|
3041
3050
|
<h5 class="title">
|
|
3042
|
-
<a class="toc" id="html.nodes.reference" href="#a-
|
|
3051
|
+
<a class="toc" id="html.nodes.reference" href="#a-607212128">5.1.4.5.1</a> reference
|
|
3043
3052
|
</h5>
|
|
3044
3053
|
<div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
|
|
3045
3054
|
|
|
@@ -3050,11 +3059,12 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3050
3059
|
<p><div class="paragraph">
|
|
3051
3060
|
<p class="title">An example</p>
|
|
3052
3061
|
<div class="content">See <a class="xref" href="#html.nodes.reference.example">Reference 2</a> for an example of what a <strong>reference</strong> node appears like.</div>
|
|
3053
|
-
</div
|
|
3062
|
+
</div>
|
|
3063
|
+
</p></div>
|
|
3054
3064
|
</div>
|
|
3055
3065
|
<div class="section">
|
|
3056
3066
|
<h5 class="title">
|
|
3057
|
-
<a class="toc" id="html.nodes.cite" href="#a-
|
|
3067
|
+
<a class="toc" id="html.nodes.cite" href="#a-607239408">5.1.4.5.2</a> cite
|
|
3058
3068
|
</h5>
|
|
3059
3069
|
<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>
|
|
3060
3070
|
|
|
@@ -3085,7 +3095,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3085
3095
|
<div class="chapter">
|
|
3086
3096
|
<h1 class="title">
|
|
3087
3097
|
Chapter
|
|
3088
|
-
<a class="toc" id="text" href="#a-
|
|
3098
|
+
<a class="toc" id="text" href="#a-607247898">5.2</a>
|
|
3089
3099
|
|
|
3090
3100
|
<br/>
|
|
3091
3101
|
|
|
@@ -3096,10 +3106,11 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3096
3106
|
|
|
3097
3107
|
|
|
3098
3108
|
<p>http://en.wikipedia.org/wiki/Plain_text</p></div>
|
|
3099
|
-
</div
|
|
3109
|
+
</div>
|
|
3110
|
+
<div class="chapter">
|
|
3100
3111
|
<h1 class="title">
|
|
3101
3112
|
Chapter
|
|
3102
|
-
<a class="toc" id="latex" href="#a-
|
|
3113
|
+
<a class="toc" id="latex" href="#a-607250098">5.3</a>
|
|
3103
3114
|
|
|
3104
3115
|
<br/>
|
|
3105
3116
|
|
|
@@ -3110,10 +3121,11 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3110
3121
|
|
|
3111
3122
|
|
|
3112
3123
|
<p>http://www.latex-project.org</p></div>
|
|
3113
|
-
</div
|
|
3124
|
+
</div>
|
|
3125
|
+
<div class="chapter">
|
|
3114
3126
|
<h1 class="title">
|
|
3115
3127
|
Chapter
|
|
3116
|
-
<a class="toc" id="man" href="#a-
|
|
3128
|
+
<a class="toc" id="man" href="#a-607252408">5.4</a>
|
|
3117
3129
|
|
|
3118
3130
|
<br/>
|
|
3119
3131
|
|
|
@@ -3142,7 +3154,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
|
3142
3154
|
|
|
3143
3155
|
<div id="footer">
|
|
3144
3156
|
|
|
3145
|
-
Generated on
|
|
3157
|
+
Generated on Sun Jun 08 12:56:41 -0700 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 3.0.2.
|
|
3146
3158
|
|
|
3147
3159
|
<p>The admonition icons (<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
|
3148
3160
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
data/lib/gerbil.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: gerbil
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0.
|
|
4
|
+
version: 3.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors: []
|
|
7
7
|
|
|
@@ -9,7 +9,7 @@ autorequire:
|
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
11
|
|
|
12
|
-
date: 2008-06-
|
|
12
|
+
date: 2008-06-08 00:00:00 -07:00
|
|
13
13
|
default_executable:
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|