gerbil 2.0.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +2 -2
- data/bin/gerbil +2 -1
- data/doc/api/created.rid +1 -1
- data/doc/api/files/lib/gerbil/html_rb.html +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/guide.html +218 -207
- data/fmt/html.yaml +125 -96
- data/lib/gerbil.rb +2 -2
- metadata +2 -2
data/LICENSE
CHANGED
@@ -11,9 +11,9 @@ Software is furnished to do so, subject to the following conditions:
|
|
11
11
|
and their corresponding machine-readable source code (the "Code") must
|
12
12
|
include the above copyright notice and this permission notice.
|
13
13
|
|
14
|
-
* Upon distribution, the Derivatives must be accompanied either
|
14
|
+
* Upon distribution, the Derivatives must be accompanied by either the Code
|
15
15
|
or--provided that the Code is obtainable for no more than the cost of
|
16
|
-
distribution plus a nominal fee--
|
16
|
+
distribution plus a nominal fee--information on how to obtain the Code.
|
17
17
|
|
18
18
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
19
19
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
data/bin/gerbil
CHANGED
@@ -89,7 +89,8 @@ class Template < ERB
|
|
89
89
|
end
|
90
90
|
|
91
91
|
class Node < OpenStruct
|
92
|
-
undef id
|
92
|
+
undef id if respond_to? :id # deprecated in Ruby 1.8; removed in Ruby 1.9
|
93
|
+
undef type if respond_to? :type # deprecated in Ruby 1.8; removed in Ruby 1.9
|
93
94
|
end
|
94
95
|
|
95
96
|
# the basename() is for being launched by a RubyGems executable
|
data/doc/api/created.rid
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
Thu, 29 May 2008 22:03:51 -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>Thu May 29 21:42:29 -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 => '2.
|
98
|
+
<td class="context-item-value">{ :name => 'Gerbil', :version => '2.1.0', :release => '2008-05-29', :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.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="29 May 2008"/>
|
6
6
|
<meta name="author" content="Suraj N. Kurapati"/>
|
7
|
-
<meta name="generator" content="Gerbil 2.
|
7
|
+
<meta name="generator" content="Gerbil 2.1.0"/>
|
8
8
|
<link rel="alternate" type="application/rss+xml" href="http://gerbil.rubyforge.org/news.xml"/>
|
9
|
-
<title>Gerbil 2.
|
9
|
+
<title>Gerbil 2.1.0 user guide</title>
|
10
10
|
|
11
11
|
<style type="text/css" media="screen">
|
12
12
|
body
|
@@ -25,6 +25,18 @@
|
|
25
25
|
font-family : Cambria, Georgia, serif;
|
26
26
|
}
|
27
27
|
|
28
|
+
/* lists */
|
29
|
+
|
30
|
+
#content li:first-child
|
31
|
+
{
|
32
|
+
margin-top : 1em;
|
33
|
+
}
|
34
|
+
|
35
|
+
#content li
|
36
|
+
{
|
37
|
+
margin-bottom : 1em;
|
38
|
+
}
|
39
|
+
|
28
40
|
/* headings */
|
29
41
|
|
30
42
|
h1,
|
@@ -105,7 +117,7 @@
|
|
105
117
|
padding : 1em;
|
106
118
|
border : 1px solid #C0C0C0;
|
107
119
|
vertical-align : top;
|
108
|
-
background-color :
|
120
|
+
background-color : inherit;
|
109
121
|
}
|
110
122
|
|
111
123
|
th
|
@@ -279,55 +291,20 @@
|
|
279
291
|
max-width : 36em;
|
280
292
|
}
|
281
293
|
|
282
|
-
/*
|
283
|
-
|
284
|
-
a
|
285
|
-
{
|
286
|
-
color : #0000FF;
|
287
|
-
text-decoration : none;
|
288
|
-
}
|
289
|
-
|
290
|
-
a:visited
|
291
|
-
{
|
292
|
-
color : #800080;
|
293
|
-
}
|
294
|
-
|
295
|
-
a:hover
|
296
|
-
{
|
297
|
-
color : #FF0000;
|
298
|
-
text-decoration : underline;
|
299
|
-
}
|
300
|
-
|
301
|
-
a:target
|
302
|
-
{
|
303
|
-
color : #FF0000;
|
304
|
-
text-decoration : underline;
|
305
|
-
}
|
306
|
-
|
307
|
-
a.toc:link,
|
308
|
-
a.toc:visited
|
309
|
-
{
|
310
|
-
text-decoration : none;
|
311
|
-
z-index : 1;
|
312
|
-
}
|
313
|
-
|
314
|
-
a img
|
315
|
-
{
|
316
|
-
border : none;
|
317
|
-
}
|
294
|
+
/* emphasis */
|
318
295
|
|
319
|
-
|
320
|
-
mark external links with a symbol to help the user
|
321
|
-
distinguish between internal and external links
|
322
|
-
*/
|
323
|
-
a:after
|
296
|
+
blockquote
|
324
297
|
{
|
325
|
-
|
298
|
+
margin : 1em;
|
299
|
+
border : 5px dotted #C0C0C0;
|
300
|
+
padding : 1em;
|
301
|
+
color : #444;
|
326
302
|
}
|
327
303
|
|
328
|
-
|
304
|
+
hr
|
329
305
|
{
|
330
|
-
|
306
|
+
color : #FF0000; /* for IE6 */
|
307
|
+
background-color : #FF0000; /* for Firefox */
|
331
308
|
}
|
332
309
|
|
333
310
|
/* source code */
|
@@ -346,7 +323,7 @@
|
|
346
323
|
background-color : #FFFAF0;
|
347
324
|
}
|
348
325
|
|
349
|
-
/* output of syntax
|
326
|
+
/* output of the syntax coloring library */
|
350
327
|
.code
|
351
328
|
{
|
352
329
|
background-color : #FFFFF0;
|
@@ -354,12 +331,12 @@
|
|
354
331
|
|
355
332
|
pre
|
356
333
|
{
|
334
|
+
cursor : text;
|
357
335
|
line-height : normal;
|
358
336
|
border : 1px dashed #C0C0C0;
|
359
337
|
background-color : #F5FFDF;
|
360
338
|
padding : 1em;
|
361
339
|
overflow : auto;
|
362
|
-
cursor : text;
|
363
340
|
}
|
364
341
|
|
365
342
|
/*
|
@@ -378,20 +355,42 @@
|
|
378
355
|
}
|
379
356
|
*/
|
380
357
|
|
381
|
-
/*
|
358
|
+
/* hyperlinks */
|
382
359
|
|
383
|
-
|
360
|
+
a > img
|
384
361
|
{
|
385
|
-
|
386
|
-
border : 5px dotted #C0C0C0;
|
387
|
-
padding : 1em;
|
388
|
-
color : #444;
|
362
|
+
border : none;
|
389
363
|
}
|
390
364
|
|
391
|
-
|
365
|
+
a:link
|
392
366
|
{
|
393
|
-
color : #
|
394
|
-
|
367
|
+
color : #0000FF;
|
368
|
+
text-decoration : none;
|
369
|
+
}
|
370
|
+
|
371
|
+
a:visited
|
372
|
+
{
|
373
|
+
color : #9400D3;
|
374
|
+
text-decoration : none;
|
375
|
+
}
|
376
|
+
|
377
|
+
a:hover
|
378
|
+
{
|
379
|
+
color : #FF0000;
|
380
|
+
text-decoration : underline;
|
381
|
+
}
|
382
|
+
|
383
|
+
a:target
|
384
|
+
{
|
385
|
+
color : #FF0000;
|
386
|
+
font-weight : bold;
|
387
|
+
}
|
388
|
+
|
389
|
+
a.toc:link,
|
390
|
+
a.toc:visited
|
391
|
+
{
|
392
|
+
text-decoration : none;
|
393
|
+
z-index : 1;
|
395
394
|
}
|
396
395
|
|
397
396
|
</style>
|
@@ -412,6 +411,18 @@
|
|
412
411
|
font-family : Cambria, Georgia, serif;
|
413
412
|
}
|
414
413
|
|
414
|
+
/* lists */
|
415
|
+
|
416
|
+
#content li:first-child
|
417
|
+
{
|
418
|
+
margin-top : 1em;
|
419
|
+
}
|
420
|
+
|
421
|
+
#content li
|
422
|
+
{
|
423
|
+
margin-bottom : 1em;
|
424
|
+
}
|
425
|
+
|
415
426
|
/* headings */
|
416
427
|
|
417
428
|
h1,
|
@@ -492,7 +503,7 @@
|
|
492
503
|
padding : 1em;
|
493
504
|
border : 1px solid #C0C0C0;
|
494
505
|
vertical-align : top;
|
495
|
-
background-color :
|
506
|
+
background-color : inherit;
|
496
507
|
}
|
497
508
|
|
498
509
|
th
|
@@ -659,7 +670,24 @@
|
|
659
670
|
_margin : auto; /* for IE6 */
|
660
671
|
}
|
661
672
|
|
662
|
-
/*
|
673
|
+
/* source code */
|
674
|
+
|
675
|
+
tt
|
676
|
+
{
|
677
|
+
color : inherit;
|
678
|
+
background-color : inherit;
|
679
|
+
font-weight : normal;
|
680
|
+
}
|
681
|
+
|
682
|
+
pre,
|
683
|
+
.code
|
684
|
+
{
|
685
|
+
border : none;
|
686
|
+
overflow : visible;
|
687
|
+
background-color : inherit;
|
688
|
+
}
|
689
|
+
|
690
|
+
/* headings */
|
663
691
|
|
664
692
|
h1,
|
665
693
|
h2,
|
@@ -684,8 +712,8 @@
|
|
684
712
|
|
685
713
|
a:after
|
686
714
|
{
|
687
|
-
content : "
|
688
|
-
font-family :
|
715
|
+
content : " " attr(href);
|
716
|
+
font-family : Consolas, "Lucida Console", monospace;
|
689
717
|
font-weight : normal;
|
690
718
|
font-size : 90%;
|
691
719
|
}
|
@@ -713,23 +741,6 @@
|
|
713
741
|
font-style : normal;
|
714
742
|
}
|
715
743
|
|
716
|
-
/* source code */
|
717
|
-
|
718
|
-
tt
|
719
|
-
{
|
720
|
-
color : inherit;
|
721
|
-
background-color : inherit;
|
722
|
-
font-weight : normal;
|
723
|
-
}
|
724
|
-
|
725
|
-
pre,
|
726
|
-
.code
|
727
|
-
{
|
728
|
-
border : none;
|
729
|
-
overflow : visible;
|
730
|
-
background-color : inherit;
|
731
|
-
}
|
732
|
-
|
733
744
|
/* document structure */
|
734
745
|
|
735
746
|
#lof
|
@@ -758,23 +769,23 @@
|
|
758
769
|
<div id="header">
|
759
770
|
|
760
771
|
<img src="gerbil.png" alt="Gerbil logo" title="Gerbil logo"/>
|
761
|
-
<h1 class="title">Gerbil 2.
|
772
|
+
<h1 class="title">Gerbil 2.1.0 user guide</h1>
|
762
773
|
<h2 class="authors"><a href="http://snk.tuxfamily.org">Suraj N. Kurapati</a></h2>
|
763
|
-
<h3 class="date">
|
774
|
+
<h3 class="date">29 May 2008</h3>
|
764
775
|
|
765
776
|
</div>
|
766
777
|
|
767
778
|
|
768
779
|
|
769
|
-
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-
|
780
|
+
<div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-606113298" href="#Introduction">Introduction</a><ul><li>1.1 <a id="a-606173248" href="#Features">Features</a></li><li>1.2 <a id="a-606200668" href="#License">License</a></li><li>1.3 <a id="a-606213458" href="#Resources">Resources</a></li><li>1.4 <a id="a-606229308" href="#Testimonials">Testimonials</a></li></ul></li><li>2 <a id="a-606247748" href="#Setup">Setup</a><ul><li>2.1 <a id="a-606272278" href="#Requirements">Requirements</a></li><li>2.2 <a id="a-606328118" href="#Installation">Installation</a></li><li>2.3 <a id="a-606336328" href="#Manifest">Manifest</a></li><li>2.4 <a id="a-605911468" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3 <a id="a-605941648" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="a-606370728" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="a-606382188" 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-606386758" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="a-606397338" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="a-606404558" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="a-606409628" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="a-606414978" href="#HelloWorld">Creating your own custom format</a></li></ul></li></ul></li><li>4 <a id="a-606467668" href="#Usage">Usage</a><ul><li>4.1 <a id="a-606478528" href="#include">The <strong>include</strong> directive</a></li><li>4.2 <a id="a-606484228" 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-606490418" href="#Formats">Formats</a><ul><li>5.1 <a id="a-606498318" href="#html">HTML</a><ul><li>5.1.1 <a id="a-606500248" href="#Text-to-HTML-conversion">Text to HTML conversion</a><ul><li>5.1.1.1 <a id="a-606505958" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="a-606507978" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="a-606511328" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="a-606514368" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="a-606518168" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="a-606523158" href="#Methods">Methods</a></li><li>5.1.4 <a id="a-607127418" href="#html.nodes">Nodes</a><ul><li>5.1.4.1 <a id="a-607147088" href="#Structure">Structure</a><ul><li>5.1.4.1.1 <a id="a-607152838" href="#html.nodes.header">header</a></li><li>5.1.4.1.2 <a id="a-607155708" href="#html.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="a-607162228" href="#html.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="a-607170078" href="#html.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="a-607184508" href="#Organization">Organization</a><ul><li>5.1.4.2.1 <a id="a-607186558" href="#html.nodes.part">part</a><ul><li>5.1.4.2.1.1 <a id="a-607193048" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.2 <a id="a-607201388" href="#html.nodes.chapter">chapter</a><ul><li>5.1.4.2.2.1 <a id="a-607205928" href="#An-example-607251148">An example</a></li></ul></li><li>5.1.4.2.3 <a id="a-607210158" href="#html.nodes.section">section</a><ul><li>5.1.4.2.3.1 <a id="a-607211878" href="#An-example-607390208">An example</a></li></ul></li><li>5.1.4.2.4 <a id="a-607214388" href="#html.nodes.paragraph">paragraph</a></li></ul></li><li>5.1.4.3 <a id="a-607218628" href="#Admonitions">Admonitions</a><ul><li>5.1.4.3.1 <a id="a-607223748" href="#html.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="a-607229148" href="#html.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="a-607234578" href="#html.nodes.important">important</a></li><li>5.1.4.3.4 <a id="a-607240058" href="#html.nodes.note">note</a></li><li>5.1.4.3.5 <a id="a-607245848" href="#html.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="a-607259048" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="a-607264088" href="#html.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="a-607277488" href="#html.nodes.table">table</a></li><li>5.1.4.4.3 <a id="a-607291368" href="#html.nodes.example">example</a></li><li>5.1.4.4.4 <a id="a-607303798" href="#html.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="a-607314598" href="#html.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="a-607323548" href="#Bibliography">Bibliography</a><ul><li>5.1.4.5.1 <a id="a-607328178" href="#html.nodes.reference">reference</a></li><li>5.1.4.5.2 <a id="a-607346008" href="#html.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="a-607364918" href="#text">Plain text</a></li><li>5.3 <a id="a-607370978" href="#latex">LaTeX</a></li><li>5.4 <a id="a-607378428" href="#man">UNIX man page</a></li></ul></li></ul></div>
|
770
781
|
|
771
|
-
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-
|
782
|
+
<div id="lof"><h1>Cautions</h1> <ol><li><a id="a-607232288" href="#An-example-607498638">An example</a></li></ol><h1>Equations</h1> <ol><li><a id="a-607308068" href="#An-example-607700438">An example</a></li></ol><h1>Examples</h1> <ol><li><a id="a-606445138" href="#HelloWorld.spec">HelloWorld format specification file</a></li><li><a id="a-606452538" href="#HelloWorld.input">Input document for HelloWorld format</a></li><li><a id="a-606461008" href="#HelloWorld.output">Output of HelloWorld format</a></li><li><a id="a-607295988" href="#An-example-607677748">An example</a></li></ol><h1>Figures</h1> <ol><li><a id="a-607270948" href="#An-example-607631908">An example</a></li></ol><h1>Importants</h1> <ol><li><a id="a-607237768" href="#An-example-607529738">An example</a></li></ol><h1>Notes</h1> <ol><li><a id="a-606163978" href="#See-the-source-of-this-guide">See the source of this guide</a></li><li><a id="a-606440698" href="#Author-s-note-about-documentation-quality">Author’s note about documentation quality</a></li><li><a id="a-607243278" href="#An-example-607566278">An example</a></li></ol><h1>Procedures</h1> <ol><li><a id="a-607318728" href="#An-example-607722628">An example</a></li></ol><h1>Tables</h1> <ol><li><a id="a-607284158" href="#An-example-607655068">An example</a></li></ol><h1>Tips</h1> <ol><li><a id="a-607251388" href="#An-example-607596848">An example</a></li></ol><h1>Warnings</h1> <ol><li><a id="a-607226858" href="#An-example-607468538">An example</a></li></ol></div>
|
772
783
|
|
773
784
|
<div id="content">
|
774
785
|
<div class="chapter">
|
775
786
|
<h1 class="title">
|
776
787
|
Chapter
|
777
|
-
<a class="toc" id="Introduction" href="#a-
|
788
|
+
<a class="toc" id="Introduction" href="#a-606113298">1</a>
|
778
789
|
|
779
790
|
<br/>
|
780
791
|
|
@@ -794,7 +805,7 @@
|
|
794
805
|
|
795
806
|
|
796
807
|
<p><div class="note">
|
797
|
-
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-
|
808
|
+
<p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-606163978">Note 1</a>. See the source of this guide</p>
|
798
809
|
|
799
810
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
800
811
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -853,13 +864,13 @@ bj2VSjFnzpxrKjafSSm5cOEC/f39KUAnrVsTgAkUAYU1NTUPx2KxjUEQTLmW
|
|
853
864
|
YvOZpmnxjo6O3x48eHA76S4UB3qEUgohRBQoGLoyKTJJp+nyR97kmA1IwANS
|
854
865
|
wODQ1auUSmYP9UNjoQBwAIv0DBUMFb6WZpNuRB9wSYsfUEr5kOdfSiGETrr1
|
855
866
|
DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
856
|
-
"
|
867
|
+
" class="icon"/>
|
857
868
|
|
858
869
|
<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>
|
859
870
|
</div>
|
860
871
|
<div class="section">
|
861
872
|
<h2 class="title">
|
862
|
-
<a class="toc" id="Features" href="#a-
|
873
|
+
<a class="toc" id="Features" href="#a-606173248">1.1</a> Features
|
863
874
|
</h2>
|
864
875
|
<div class="content"><ul>
|
865
876
|
<li>Composed of <strong>less than 200 lines</strong> of code!</li>
|
@@ -870,7 +881,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
870
881
|
</div>
|
871
882
|
<div class="section">
|
872
883
|
<h2 class="title">
|
873
|
-
<a class="toc" id="License" href="#a-
|
884
|
+
<a class="toc" id="License" href="#a-606200668">1.2</a> License
|
874
885
|
</h2>
|
875
886
|
<div class="content"><p>Copyright 2006 Suraj N. Kurapati <SNK at GNA dot ORG></p>
|
876
887
|
|
@@ -891,9 +902,9 @@ include the above copyright notice and this permission notice.</li>
|
|
891
902
|
|
892
903
|
|
893
904
|
<ul>
|
894
|
-
<li>Upon distribution, the Derivatives must be accompanied either
|
905
|
+
<li>Upon distribution, the Derivatives must be accompanied by either the Code
|
895
906
|
or—provided that the Code is obtainable for no more than the cost of
|
896
|
-
distribution plus a nominal fee—
|
907
|
+
distribution plus a nominal fee—information on how to obtain the Code.</li>
|
897
908
|
</ul>
|
898
909
|
|
899
910
|
|
@@ -906,7 +917,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
906
917
|
</div>
|
907
918
|
<div class="section">
|
908
919
|
<h2 class="title">
|
909
|
-
<a class="toc" id="Resources" href="#a-
|
920
|
+
<a class="toc" id="Resources" href="#a-606213458">1.3</a> Resources
|
910
921
|
</h2>
|
911
922
|
<div class="content"><ul>
|
912
923
|
<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" />
|
@@ -921,7 +932,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
921
932
|
</div>
|
922
933
|
<div class="section">
|
923
934
|
<h2 class="title">
|
924
|
-
<a class="toc" id="Testimonials" href="#a-
|
935
|
+
<a class="toc" id="Testimonials" href="#a-606229308">1.4</a> Testimonials
|
925
936
|
</h2>
|
926
937
|
<div class="content"><blockquote>
|
927
938
|
<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>
|
@@ -931,7 +942,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
931
942
|
<div class="chapter">
|
932
943
|
<h1 class="title">
|
933
944
|
Chapter
|
934
|
-
<a class="toc" id="Setup" href="#a-
|
945
|
+
<a class="toc" id="Setup" href="#a-606247748">2</a>
|
935
946
|
|
936
947
|
<br/>
|
937
948
|
|
@@ -940,7 +951,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
940
951
|
|
941
952
|
<div class="content"><div class="section">
|
942
953
|
<h2 class="title">
|
943
|
-
<a class="toc" id="Requirements" href="#a-
|
954
|
+
<a class="toc" id="Requirements" href="#a-606272278">2.1</a> Requirements
|
944
955
|
</h2>
|
945
956
|
<div class="content"><p>Your system needs the following software to run Gerbil.</p>
|
946
957
|
|
@@ -974,7 +985,7 @@ IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCH
|
|
974
985
|
</div>
|
975
986
|
<div class="section">
|
976
987
|
<h2 class="title">
|
977
|
-
<a class="toc" id="Installation" href="#a-
|
988
|
+
<a class="toc" id="Installation" href="#a-606328118">2.2</a> Installation
|
978
989
|
</h2>
|
979
990
|
<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>
|
980
991
|
|
@@ -994,7 +1005,7 @@ Otherwise, follow these instructions:
|
|
994
1005
|
<pre>ruby bin/gerbil -v</pre>
|
995
1006
|
|
996
1007
|
|
997
|
-
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 2.
|
1008
|
+
<p>If the installation was successful, then you will see output like this: <pre>Gerbil 2.1.0 (2008-05-29) http://gerbil.rubyforge.org /home/sun/src/gerbil
|
998
1009
|
</pre></p>
|
999
1010
|
|
1000
1011
|
|
@@ -1002,7 +1013,7 @@ Otherwise, follow these instructions:
|
|
1002
1013
|
</div>
|
1003
1014
|
<div class="section">
|
1004
1015
|
<h2 class="title">
|
1005
|
-
<a class="toc" id="Manifest" href="#a-
|
1016
|
+
<a class="toc" id="Manifest" href="#a-606336328">2.3</a> Manifest
|
1006
1017
|
</h2>
|
1007
1018
|
<div class="content">Now that Gerbil is installed on your system, let us examine its installation directory.
|
1008
1019
|
<ul>
|
@@ -1049,7 +1060,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1049
1060
|
</div>
|
1050
1061
|
<div class="section">
|
1051
1062
|
<h2 class="title">
|
1052
|
-
<a class="toc" id="Version-numbering-system" href="#a-
|
1063
|
+
<a class="toc" id="Version-numbering-system" href="#a-605911468">2.4</a> Version numbering system
|
1053
1064
|
</h2>
|
1054
1065
|
<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.
|
1055
1066
|
|
@@ -1085,7 +1096,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1085
1096
|
<div class="chapter">
|
1086
1097
|
<h1 class="title">
|
1087
1098
|
Chapter
|
1088
|
-
<a class="toc" id="Theory-of-operation" href="#a-
|
1099
|
+
<a class="toc" id="Theory-of-operation" href="#a-605941648">3</a>
|
1089
1100
|
|
1090
1101
|
<br/>
|
1091
1102
|
|
@@ -1117,7 +1128,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1117
1128
|
|
1118
1129
|
<p><div class="section">
|
1119
1130
|
<h2 class="title">
|
1120
|
-
<a class="toc" id="Nodes" href="#a-
|
1131
|
+
<a class="toc" id="Nodes" href="#a-606370728">3.1</a> Nodes
|
1121
1132
|
</h2>
|
1122
1133
|
<div class="content"><p>A node is a block of text that appears like this:</p>
|
1123
1134
|
|
@@ -1175,7 +1186,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1175
1186
|
|
1176
1187
|
<p><div class="section">
|
1177
1188
|
<h3 class="title">
|
1178
|
-
<a class="toc" id="Node.class" href="#a-
|
1189
|
+
<a class="toc" id="Node.class" href="#a-606382188">3.1.1</a> The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class
|
1179
1190
|
</h3>
|
1180
1191
|
<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>
|
1181
1192
|
|
@@ -1251,7 +1262,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1251
1262
|
</div>
|
1252
1263
|
<div class="section">
|
1253
1264
|
<h2 class="title">
|
1254
|
-
<a class="toc" id="SpecFile" href="#a-
|
1265
|
+
<a class="toc" id="SpecFile" href="#a-606386758">3.2</a> Format specification file
|
1255
1266
|
</h2>
|
1256
1267
|
<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>
|
1257
1268
|
|
@@ -1289,7 +1300,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1289
1300
|
|
1290
1301
|
<p><div class="section">
|
1291
1302
|
<h3 class="title">
|
1292
|
-
<a class="toc" id="SpecFile.nodes" href="#a-
|
1303
|
+
<a class="toc" id="SpecFile.nodes" href="#a-606397338">3.2.1</a> Node definition
|
1293
1304
|
</h3>
|
1294
1305
|
<div class="content"><p>A node definition is a mapping from a name (the “node type”) to the following set of parameters:</p>
|
1295
1306
|
|
@@ -1330,7 +1341,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1330
1341
|
|
1331
1342
|
<p><div class="section">
|
1332
1343
|
<h4 class="title">
|
1333
|
-
<a class="toc" id="SpecFile.nodes.output" href="#a-
|
1344
|
+
<a class="toc" id="SpecFile.nodes.output" href="#a-606404558">3.2.1.1</a> Node output template
|
1334
1345
|
</h4>
|
1335
1346
|
<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>
|
1336
1347
|
|
@@ -1398,7 +1409,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1398
1409
|
</div>
|
1399
1410
|
<div class="section">
|
1400
1411
|
<h3 class="title">
|
1401
|
-
<a class="toc" id="SpecFile.output" href="#a-
|
1412
|
+
<a class="toc" id="SpecFile.output" href="#a-606409628">3.2.2</a> Document output template
|
1402
1413
|
</h3>
|
1403
1414
|
<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>
|
1404
1415
|
|
@@ -1465,7 +1476,7 @@ Inside Gerbil’s installation directory, you will see (among other things)
|
|
1465
1476
|
</div>
|
1466
1477
|
<div class="section">
|
1467
1478
|
<h3 class="title">
|
1468
|
-
<a class="toc" id="HelloWorld" href="#a-
|
1479
|
+
<a class="toc" id="HelloWorld" href="#a-606414978">3.2.3</a> Creating your own custom format
|
1469
1480
|
</h3>
|
1470
1481
|
<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:
|
1471
1482
|
<ul>
|
@@ -1484,7 +1495,7 @@ To run this example, perform the following steps:
|
|
1484
1495
|
|
1485
1496
|
|
1486
1497
|
<p><div class="note">
|
1487
|
-
<p class="title"><a class="toc" id="Author-s-note-about-documentation-quality" href="#a-
|
1498
|
+
<p class="title"><a class="toc" id="Author-s-note-about-documentation-quality" href="#a-606440698">Note 2</a>. Author’s note about documentation quality</p>
|
1488
1499
|
|
1489
1500
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
1490
1501
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -1543,7 +1554,7 @@ bj2VSjFnzpxrKjafSSm5cOEC/f39KUAnrVsTgAkUAYU1NTUPx2KxjUEQTLmW
|
|
1543
1554
|
YvOZpmnxjo6O3x48eHA76S4UB3qEUgohRBQoGLoyKTJJp+nyR97kmA1IwANS
|
1544
1555
|
wODQ1auUSmYP9UNjoQBwAIv0DBUMFb6WZpNuRB9wSYsfUEr5kOdfSiGETrr1
|
1545
1556
|
DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
1546
|
-
"
|
1557
|
+
" class="icon"/>
|
1547
1558
|
|
1548
1559
|
<div class="content"><p>Please excuse my lack of creativity for this example. I tried different ideas but scrapped most of them because writing documentation is hard and mostly boring. (Although I did have fun reading the wacky names produced by the <code class="code">generate_name()</code> method!)</p>
|
1549
1560
|
|
@@ -1554,7 +1565,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
1554
1565
|
<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>
|
1555
1566
|
</div>
|
1556
1567
|
<div class="example">
|
1557
|
-
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-
|
1568
|
+
<p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606445138">Example 1</a>. HelloWorld format specification file</p>
|
1558
1569
|
<div class="content"><pre class="code" lang="rhtml">
|
1559
1570
|
desc: A illustrative format.
|
1560
1571
|
|
@@ -1626,7 +1637,7 @@ output: |
|
|
1626
1637
|
</pre></div>
|
1627
1638
|
</div>
|
1628
1639
|
<div class="example">
|
1629
|
-
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-
|
1640
|
+
<p class="title"><a class="toc" id="HelloWorld.input" href="#a-606452538">Example 2</a>. Input document for HelloWorld format</p>
|
1630
1641
|
<div class="content"><pre class="code" lang="rhtml">
|
1631
1642
|
<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>
|
1632
1643
|
<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>
|
@@ -1668,10 +1679,10 @@ output: |
|
|
1668
1679
|
</pre></div>
|
1669
1680
|
</div>
|
1670
1681
|
<div class="example">
|
1671
|
-
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-
|
1682
|
+
<p class="title"><a class="toc" id="HelloWorld.output" href="#a-606461008">Example 3</a>. Output of HelloWorld format</p>
|
1672
1683
|
<div class="content">Welcome to the “HelloWorld” format.
|
1673
|
-
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “
|
1674
|
-
My name is “
|
1684
|
+
<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “dopijod”</h1>
|
1685
|
+
My name is “dopijod” and these are my properties:
|
1675
1686
|
<table border="1">
|
1676
1687
|
<tr>
|
1677
1688
|
<th>Property</th>
|
@@ -1691,14 +1702,14 @@ My name is “nok” and these are my properties:
|
|
1691
1702
|
</tr>
|
1692
1703
|
<tr>
|
1693
1704
|
<td>trace</td>
|
1694
|
-
<td><ul><li>INPUT:1</li><li>bin/gerbil:
|
1705
|
+
<td><ul><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1695
1706
|
</tr>
|
1696
1707
|
<tr>
|
1697
1708
|
<td>content</td>
|
1698
1709
|
<td> <big>I’m</big> the very first node, oh <em>yes</em> I am! <strong>sneer</strong>
|
1699
1710
|
|
1700
|
-
<h1>hello #1.1: “
|
1701
|
-
My name is “
|
1711
|
+
<h1>hello #1.1: “misonat”</h1>
|
1712
|
+
My name is “misonat” and these are my properties:
|
1702
1713
|
<table border="1">
|
1703
1714
|
<tr>
|
1704
1715
|
<th>Property</th>
|
@@ -1718,14 +1729,14 @@ My name is “dibisom” and these are my properties:
|
|
1718
1729
|
</tr>
|
1719
1730
|
<tr>
|
1720
1731
|
<td>trace</td>
|
1721
|
-
<td><ul><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1732
|
+
<td><ul><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1722
1733
|
</tr>
|
1723
1734
|
<tr>
|
1724
1735
|
<td>content</td>
|
1725
1736
|
<td> Hi, I… <strong>hide</strong>
|
1726
1737
|
|
1727
|
-
<h1>hello #1.1.1: “
|
1728
|
-
My name is “
|
1738
|
+
<h1>hello #1.1.1: “baza”</h1>
|
1739
|
+
My name is “baza” and these are my properties:
|
1729
1740
|
<table border="1">
|
1730
1741
|
<tr>
|
1731
1742
|
<th>Property</th>
|
@@ -1745,14 +1756,14 @@ My name is “loti” and these are my properties:
|
|
1745
1756
|
</tr>
|
1746
1757
|
<tr>
|
1747
1758
|
<td>trace</td>
|
1748
|
-
<td><ul><li>INPUT:5</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1759
|
+
<td><ul><li>INPUT:5</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1749
1760
|
</tr>
|
1750
1761
|
<tr>
|
1751
1762
|
<td>content</td>
|
1752
1763
|
<td> <strong>sigh</strong>
|
1753
1764
|
|
1754
|
-
<h1>hello #1.1.1.1: “
|
1755
|
-
My name is “
|
1765
|
+
<h1>hello #1.1.1.1: “yos”</h1>
|
1766
|
+
My name is “yos” and these are my properties:
|
1756
1767
|
<table border="1">
|
1757
1768
|
<tr>
|
1758
1769
|
<th>Property</th>
|
@@ -1772,7 +1783,7 @@ My name is “bukeyam” and these are my properties:
|
|
1772
1783
|
</tr>
|
1773
1784
|
<tr>
|
1774
1785
|
<td>trace</td>
|
1775
|
-
<td><ul><li>INPUT:7</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1786
|
+
<td><ul><li>INPUT:7</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:5</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1776
1787
|
</tr>
|
1777
1788
|
<tr>
|
1778
1789
|
<td>content</td>
|
@@ -1782,8 +1793,8 @@ My name is “bukeyam” and these are my properties:
|
|
1782
1793
|
</table></td>
|
1783
1794
|
</tr>
|
1784
1795
|
</table>
|
1785
|
-
<h1>hello #1.1.2: “
|
1786
|
-
My name is “
|
1796
|
+
<h1>hello #1.1.2: “pisoh”</h1>
|
1797
|
+
My name is “pisoh” and these are my properties:
|
1787
1798
|
<table border="1">
|
1788
1799
|
<tr>
|
1789
1800
|
<th>Property</th>
|
@@ -1803,7 +1814,7 @@ My name is “vukuy” and these are my properties:
|
|
1803
1814
|
</tr>
|
1804
1815
|
<tr>
|
1805
1816
|
<td>trace</td>
|
1806
|
-
<td><ul><li>INPUT:9</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1817
|
+
<td><ul><li>INPUT:9</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1807
1818
|
</tr>
|
1808
1819
|
<tr>
|
1809
1820
|
<td>content</td>
|
@@ -1813,8 +1824,8 @@ My name is “vukuy” and these are my properties:
|
|
1813
1824
|
</table></td>
|
1814
1825
|
</tr>
|
1815
1826
|
</table>
|
1816
|
-
<h1>hello #1.2: “
|
1817
|
-
My name is “
|
1827
|
+
<h1>hello #1.2: “zek”</h1>
|
1828
|
+
My name is “zek” and these are my properties:
|
1818
1829
|
<table border="1">
|
1819
1830
|
<tr>
|
1820
1831
|
<th>Property</th>
|
@@ -1834,14 +1845,14 @@ My name is “numose” and these are my properties:
|
|
1834
1845
|
</tr>
|
1835
1846
|
<tr>
|
1836
1847
|
<td>trace</td>
|
1837
|
-
<td><ul><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1848
|
+
<td><ul><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1838
1849
|
</tr>
|
1839
1850
|
<tr>
|
1840
1851
|
<td>content</td>
|
1841
1852
|
<td> <strong>yawn</strong> Just five more minutes…
|
1842
1853
|
|
1843
|
-
<h1>hello #1.2.1: “
|
1844
|
-
My name is “
|
1854
|
+
<h1>hello #1.2.1: “juri”</h1>
|
1855
|
+
My name is “juri” and these are my properties:
|
1845
1856
|
<table border="1">
|
1846
1857
|
<tr>
|
1847
1858
|
<th>Property</th>
|
@@ -1861,14 +1872,14 @@ My name is “dazan” and these are my properties:
|
|
1861
1872
|
</tr>
|
1862
1873
|
<tr>
|
1863
1874
|
<td>trace</td>
|
1864
|
-
<td><ul><li>INPUT:13</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1875
|
+
<td><ul><li>INPUT:13</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1865
1876
|
</tr>
|
1866
1877
|
<tr>
|
1867
1878
|
<td>content</td>
|
1868
1879
|
<td> So <em>be</em> happy my friend, <strong>happy</strong>!
|
1869
1880
|
|
1870
|
-
<h1>hello #1.2.1.1: “
|
1871
|
-
My name is “
|
1881
|
+
<h1>hello #1.2.1.1: “yaman”</h1>
|
1882
|
+
My name is “yaman” and these are my properties:
|
1872
1883
|
<table border="1">
|
1873
1884
|
<tr>
|
1874
1885
|
<th>Property</th>
|
@@ -1888,7 +1899,7 @@ My name is “yed” and these are my properties:
|
|
1888
1899
|
</tr>
|
1889
1900
|
<tr>
|
1890
1901
|
<td>trace</td>
|
1891
|
-
<td><ul><li>INPUT:15</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:
|
1902
|
+
<td><ul><li>INPUT:15</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:13</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:80:in `content_from_block’</li><li>bin/gerbil:218:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1892
1903
|
</tr>
|
1893
1904
|
<tr>
|
1894
1905
|
<td>content</td>
|
@@ -1902,8 +1913,8 @@ My name is “yed” and these are my properties:
|
|
1902
1913
|
</table></td>
|
1903
1914
|
</tr>
|
1904
1915
|
</table>
|
1905
|
-
<h1>hello #2: “
|
1906
|
-
My name is “
|
1916
|
+
<h1>hello #2: “ruzat”</h1>
|
1917
|
+
My name is “ruzat” and these are my properties:
|
1907
1918
|
<table border="1">
|
1908
1919
|
<tr>
|
1909
1920
|
<th>Property</th>
|
@@ -1923,7 +1934,7 @@ My name is “zehun” and these are my properties:
|
|
1923
1934
|
</tr>
|
1924
1935
|
<tr>
|
1925
1936
|
<td>trace</td>
|
1926
|
-
<td><ul><li>INPUT:17</li><li>bin/gerbil:
|
1937
|
+
<td><ul><li>INPUT:17</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1927
1938
|
</tr>
|
1928
1939
|
<tr>
|
1929
1940
|
<td>content</td>
|
@@ -1932,8 +1943,8 @@ My name is “zehun” and these are my properties:
|
|
1932
1943
|
</td>
|
1933
1944
|
</tr>
|
1934
1945
|
</table>
|
1935
|
-
<h1>hello #3: “
|
1936
|
-
My name is “
|
1946
|
+
<h1>hello #3: “vapezib”</h1>
|
1947
|
+
My name is “vapezib” and these are my properties:
|
1937
1948
|
<table border="1">
|
1938
1949
|
<tr>
|
1939
1950
|
<th>Property</th>
|
@@ -1953,7 +1964,7 @@ My name is “gijoju” and these are my properties:
|
|
1953
1964
|
</tr>
|
1954
1965
|
<tr>
|
1955
1966
|
<td>trace</td>
|
1956
|
-
<td><ul><li>INPUT:20</li><li>bin/gerbil:
|
1967
|
+
<td><ul><li>INPUT:20</li><li>bin/gerbil:239</li><li>bin/gerbil:239:in `instance_eval’</li><li>bin/gerbil:239</li></ul></td>
|
1957
1968
|
</tr>
|
1958
1969
|
<tr>
|
1959
1970
|
<td>content</td>
|
@@ -1968,7 +1979,7 @@ That’s all folks!</div>
|
|
1968
1979
|
<div class="chapter">
|
1969
1980
|
<h1 class="title">
|
1970
1981
|
Chapter
|
1971
|
-
<a class="toc" id="Usage" href="#a-
|
1982
|
+
<a class="toc" id="Usage" href="#a-606467668">4</a>
|
1972
1983
|
|
1973
1984
|
<br/>
|
1974
1985
|
|
@@ -2004,7 +2015,7 @@ Format:
|
|
2004
2015
|
|
2005
2016
|
<p><div class="section">
|
2006
2017
|
<h2 class="title">
|
2007
|
-
<a class="toc" id="include" href="#a-
|
2018
|
+
<a class="toc" id="include" href="#a-606478528">4.1</a> The <strong>include</strong> directive
|
2008
2019
|
</h2>
|
2009
2020
|
<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>
|
2010
2021
|
|
@@ -2019,7 +2030,7 @@ Format:
|
|
2019
2030
|
</div>
|
2020
2031
|
<div class="section">
|
2021
2032
|
<h2 class="title">
|
2022
|
-
<a class="toc" id="unindent" href="#a-
|
2033
|
+
<a class="toc" id="unindent" href="#a-606484228">4.2</a> The <code class="code"><span style="color:#d70; font-weight:bold">$unindent</span></code> variable
|
2023
2034
|
</h2>
|
2024
2035
|
<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>
|
2025
2036
|
|
@@ -2036,7 +2047,7 @@ Format:
|
|
2036
2047
|
<div class="part">
|
2037
2048
|
<h1 class="title">
|
2038
2049
|
Part
|
2039
|
-
<a class="toc" id="Formats" href="#a-
|
2050
|
+
<a class="toc" id="Formats" href="#a-606490418">5</a>
|
2040
2051
|
|
2041
2052
|
<br/>
|
2042
2053
|
|
@@ -2052,7 +2063,7 @@ Format:
|
|
2052
2063
|
<p><div class="chapter">
|
2053
2064
|
<h1 class="title">
|
2054
2065
|
Chapter
|
2055
|
-
<a class="toc" id="html" href="#a-
|
2066
|
+
<a class="toc" id="html" href="#a-606498318">5.1</a>
|
2056
2067
|
|
2057
2068
|
<br/>
|
2058
2069
|
|
@@ -2070,7 +2081,7 @@ Format:
|
|
2070
2081
|
|
2071
2082
|
<p><div class="section">
|
2072
2083
|
<h3 class="title">
|
2073
|
-
<a class="toc" id="Text-to-HTML-conversion" href="#a-
|
2084
|
+
<a class="toc" id="Text-to-HTML-conversion" href="#a-606500248">5.1.1</a> Text to HTML conversion
|
2074
2085
|
</h3>
|
2075
2086
|
<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>
|
2076
2087
|
|
@@ -2095,7 +2106,7 @@ Format:
|
|
2095
2106
|
|
2096
2107
|
<p><div class="section">
|
2097
2108
|
<h4 class="title">
|
2098
|
-
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-
|
2109
|
+
<a class="toc" id="Syntax-coloring-for-source-code" href="#a-606505958">5.1.1.1</a> Syntax coloring for source code
|
2099
2110
|
</h4>
|
2100
2111
|
<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>
|
2101
2112
|
|
@@ -2113,7 +2124,7 @@ The following programming languages are currently supported by <a href="http://c
|
|
2113
2124
|
|
2114
2125
|
<p><div class="section">
|
2115
2126
|
<h5 class="title">
|
2116
|
-
<a class="toc" id="Specifying-the-programming-language" href="#a-
|
2127
|
+
<a class="toc" id="Specifying-the-programming-language" href="#a-606507978">5.1.1.1.1</a> Specifying the programming language
|
2117
2128
|
</h5>
|
2118
2129
|
<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>
|
2119
2130
|
|
@@ -2201,7 +2212,7 @@ int main(int argc, char **argv) {
|
|
2201
2212
|
</div>
|
2202
2213
|
<div class="section">
|
2203
2214
|
<h4 class="title">
|
2204
|
-
<a class="toc" id="Smart-sizing-of-source-code" href="#a-
|
2215
|
+
<a class="toc" id="Smart-sizing-of-source-code" href="#a-606511328">5.1.1.2</a> Smart sizing of source code
|
2205
2216
|
</h4>
|
2206
2217
|
<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>
|
2207
2218
|
|
@@ -2220,14 +2231,14 @@ int main(int argc, char **argv) {
|
|
2220
2231
|
</div>
|
2221
2232
|
<div class="section">
|
2222
2233
|
<h4 class="title">
|
2223
|
-
<a class="toc" id="Protecting-verbatim-text" href="#a-
|
2234
|
+
<a class="toc" id="Protecting-verbatim-text" href="#a-606514368">5.1.1.3</a> Protecting verbatim text
|
2224
2235
|
</h4>
|
2225
2236
|
<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>
|
2226
2237
|
</div></p></div>
|
2227
2238
|
</div>
|
2228
2239
|
<div class="section">
|
2229
2240
|
<h3 class="title">
|
2230
|
-
<a class="toc" id="Parameters" href="#a-
|
2241
|
+
<a class="toc" id="Parameters" href="#a-606518168">5.1.2</a> Parameters
|
2231
2242
|
</h3>
|
2232
2243
|
<div class="content">The HTML format accepts the following document parameters.
|
2233
2244
|
|
@@ -2279,7 +2290,7 @@ int main(int argc, char **argv) {
|
|
2279
2290
|
</div>
|
2280
2291
|
<div class="section">
|
2281
2292
|
<h3 class="title">
|
2282
|
-
<a class="toc" id="Methods" href="#a-
|
2293
|
+
<a class="toc" id="Methods" href="#a-606523158">5.1.3</a> Methods
|
2283
2294
|
</h3>
|
2284
2295
|
<div class="content">The HTML format provides the following methods. In the method declarations shown below,
|
2285
2296
|
<ul>
|
@@ -2375,7 +2386,7 @@ ruby.
|
|
2375
2386
|
<div class="chapter">
|
2376
2387
|
<h1 class="title">
|
2377
2388
|
Chapter
|
2378
|
-
<a class="toc" id="html.nodes" href="#a-
|
2389
|
+
<a class="toc" id="html.nodes" href="#a-607127418">5.1.4</a>
|
2379
2390
|
|
2380
2391
|
<br/>
|
2381
2392
|
|
@@ -2418,32 +2429,32 @@ ruby.
|
|
2418
2429
|
|
2419
2430
|
<p><div class="section">
|
2420
2431
|
<h4 class="title">
|
2421
|
-
<a class="toc" id="Structure" href="#a-
|
2432
|
+
<a class="toc" id="Structure" href="#a-607147088">5.1.4.1</a> Structure
|
2422
2433
|
</h4>
|
2423
2434
|
<div class="content"><p>The nodes described in this section form the overall structure of the output document.</p>
|
2424
2435
|
|
2425
2436
|
|
2426
2437
|
<p><div class="section">
|
2427
2438
|
<h5 class="title">
|
2428
|
-
<a class="toc" id="html.nodes.header" href="#a-
|
2439
|
+
<a class="toc" id="html.nodes.header" href="#a-607152838">5.1.4.1.1</a> header
|
2429
2440
|
</h5>
|
2430
2441
|
<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>
|
2431
2442
|
</div>
|
2432
2443
|
<div class="section">
|
2433
2444
|
<h5 class="title">
|
2434
|
-
<a class="toc" id="html.nodes.footer" href="#a-
|
2445
|
+
<a class="toc" id="html.nodes.footer" href="#a-607155708">5.1.4.1.2</a> footer
|
2435
2446
|
</h5>
|
2436
2447
|
<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>
|
2437
2448
|
</div>
|
2438
2449
|
<div class="section">
|
2439
2450
|
<h5 class="title">
|
2440
|
-
<a class="toc" id="html.nodes.abstract" href="#a-
|
2451
|
+
<a class="toc" id="html.nodes.abstract" href="#a-607162228">5.1.4.1.3</a> abstract
|
2441
2452
|
</h5>
|
2442
2453
|
<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>
|
2443
2454
|
</div>
|
2444
2455
|
<div class="section">
|
2445
2456
|
<h5 class="title">
|
2446
|
-
<a class="toc" id="html.nodes.xref" href="#a-
|
2457
|
+
<a class="toc" id="html.nodes.xref" href="#a-607170078">5.1.4.1.4</a> xref
|
2447
2458
|
</h5>
|
2448
2459
|
<div class="content"><p>A cross-reference; a hyperlink that takes you to any node in the document.</p>
|
2449
2460
|
|
@@ -2474,14 +2485,14 @@ ruby.
|
|
2474
2485
|
</div>
|
2475
2486
|
<div class="section">
|
2476
2487
|
<h4 class="title">
|
2477
|
-
<a class="toc" id="Organization" href="#a-
|
2488
|
+
<a class="toc" id="Organization" href="#a-607184508">5.1.4.2</a> Organization
|
2478
2489
|
</h4>
|
2479
2490
|
<div class="content"><p>The nodes described in this section are meant to help organize the document’s content logically.</p>
|
2480
2491
|
|
2481
2492
|
|
2482
2493
|
<p><div class="section">
|
2483
2494
|
<h5 class="title">
|
2484
|
-
<a class="toc" id="html.nodes.part" href="#a-
|
2495
|
+
<a class="toc" id="html.nodes.part" href="#a-607186558">5.1.4.2.1</a> part
|
2485
2496
|
</h5>
|
2486
2497
|
<div class="content"><p>A collection of chapters.</p>
|
2487
2498
|
|
@@ -2489,7 +2500,7 @@ ruby.
|
|
2489
2500
|
<p><div class="part">
|
2490
2501
|
<h1 class="title">
|
2491
2502
|
Part
|
2492
|
-
<a class="toc" id="An-example" href="#a-
|
2503
|
+
<a class="toc" id="An-example" href="#a-607193048">5.1.4.2.1.1</a>
|
2493
2504
|
|
2494
2505
|
<br/>
|
2495
2506
|
|
@@ -2501,7 +2512,7 @@ ruby.
|
|
2501
2512
|
</div>
|
2502
2513
|
<div class="section">
|
2503
2514
|
<h5 class="title">
|
2504
|
-
<a class="toc" id="html.nodes.chapter" href="#a-
|
2515
|
+
<a class="toc" id="html.nodes.chapter" href="#a-607201388">5.1.4.2.2</a> chapter
|
2505
2516
|
</h5>
|
2506
2517
|
<div class="content"><p>A collection of sections.</p>
|
2507
2518
|
|
@@ -2509,7 +2520,7 @@ ruby.
|
|
2509
2520
|
<p><div class="chapter">
|
2510
2521
|
<h1 class="title">
|
2511
2522
|
Chapter
|
2512
|
-
<a class="toc" id="An-example-
|
2523
|
+
<a class="toc" id="An-example-607251148" href="#a-607205928">5.1.4.2.2.1</a>
|
2513
2524
|
|
2514
2525
|
<br/>
|
2515
2526
|
|
@@ -2521,21 +2532,21 @@ ruby.
|
|
2521
2532
|
</div>
|
2522
2533
|
<div class="section">
|
2523
2534
|
<h5 class="title">
|
2524
|
-
<a class="toc" id="html.nodes.section" href="#a-
|
2535
|
+
<a class="toc" id="html.nodes.section" href="#a-607210158">5.1.4.2.3</a> section
|
2525
2536
|
</h5>
|
2526
2537
|
<div class="content"><p>A collection of paragraphs about a particular topic.</p>
|
2527
2538
|
|
2528
2539
|
|
2529
2540
|
<p><div class="section">
|
2530
2541
|
<h6 class="title">
|
2531
|
-
<a class="toc" id="An-example-
|
2542
|
+
<a class="toc" id="An-example-607390208" href="#a-607211878">5.1.4.2.3.1</a> An example
|
2532
2543
|
</h6>
|
2533
2544
|
<div class="content">This is what a <strong>section</strong> node appears like.</div>
|
2534
2545
|
</div></p></div>
|
2535
2546
|
</div>
|
2536
2547
|
<div class="section">
|
2537
2548
|
<h5 class="title">
|
2538
|
-
<a class="toc" id="html.nodes.paragraph" href="#a-
|
2549
|
+
<a class="toc" id="html.nodes.paragraph" href="#a-607214388">5.1.4.2.4</a> paragraph
|
2539
2550
|
</h5>
|
2540
2551
|
<div class="content"><p>A collection of sentences about a particular idea.</p>
|
2541
2552
|
|
@@ -2548,7 +2559,7 @@ ruby.
|
|
2548
2559
|
</div>
|
2549
2560
|
<div class="section">
|
2550
2561
|
<h4 class="title">
|
2551
|
-
<a class="toc" id="Admonitions" href="#a-
|
2562
|
+
<a class="toc" id="Admonitions" href="#a-607218628">5.1.4.3</a> Admonitions
|
2552
2563
|
</h4>
|
2553
2564
|
<div class="content"><p>An admonition is basically a box that is indented more deeply than the text surrounding it. It is typically used to convey extraneous or pertinent information about the application of ideas discussed in the surrounding text.</p>
|
2554
2565
|
|
@@ -2559,13 +2570,13 @@ ruby.
|
|
2559
2570
|
<p>
|
2560
2571
|
<div class="section">
|
2561
2572
|
<h5 class="title">
|
2562
|
-
<a class="toc" id="html.nodes.warning" href="#a-
|
2573
|
+
<a class="toc" id="html.nodes.warning" href="#a-607223748">5.1.4.3.1</a> warning
|
2563
2574
|
</h5>
|
2564
2575
|
<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>
|
2565
2576
|
|
2566
2577
|
|
2567
2578
|
<p><div class="warning">
|
2568
|
-
<p class="title"><a class="toc" id="An-example-
|
2579
|
+
<p class="title"><a class="toc" id="An-example-607468538" href="#a-607226858">Warning 1</a>. An example</p>
|
2569
2580
|
|
2570
2581
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
2571
2582
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -2623,14 +2634,14 @@ ViWglmdD/Em451F4eD1sTkB/DLojFTxFKOQhl4WZKRj/F3z6D7hoQuSWISCr
|
|
2623
2634
|
qk371eW4kFUlXiMfbUgj1edIKLqAXY1SjQoE1ViuxlIoFkLpgusAWSrWb7lf
|
2624
2635
|
XckglhDZeDV1Q4RdKvsLJ0S+9qGsCaitOgLAbyGmDHhUra6q5SV53emfPaqC
|
2625
2636
|
rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
2626
|
-
"
|
2637
|
+
" class="icon"/>
|
2627
2638
|
|
2628
2639
|
<div class="content">This is what a <strong>warning</strong> node appears like.</div>
|
2629
2640
|
</div></p></div>
|
2630
2641
|
</div>
|
2631
2642
|
<div class="section">
|
2632
2643
|
<h5 class="title">
|
2633
|
-
<a class="toc" id="html.nodes.caution" href="#a-
|
2644
|
+
<a class="toc" id="html.nodes.caution" href="#a-607229148">5.1.4.3.2</a> caution
|
2634
2645
|
</h5>
|
2635
2646
|
<div class="content"><blockquote>
|
2636
2647
|
<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>
|
@@ -2638,7 +2649,7 @@ rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
|
2638
2649
|
|
2639
2650
|
|
2640
2651
|
<p><div class="caution">
|
2641
|
-
<p class="title"><a class="toc" id="An-example-
|
2652
|
+
<p class="title"><a class="toc" id="An-example-607498638" href="#a-607232288">Caution 1</a>. An example</p>
|
2642
2653
|
|
2643
2654
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
2644
2655
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -2692,14 +2703,14 @@ lQP3aeBFBNHmWbBT/aV/Wn8qvh+F0Uuw73noCsEocEkpFUwKABARJ+CKFwex
|
|
2692
2703
|
MFmBqURf37Fpcf9hIAgEgHFgDBhLzIHkJFZKjYuIAiJACJiIH79ZAhKXdSTO
|
2693
2704
|
ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
2694
2705
|
4xicOQAAAABJRU5ErkJggg==
|
2695
|
-
"
|
2706
|
+
" class="icon"/>
|
2696
2707
|
|
2697
2708
|
<div class="content">This is what a <strong>caution</strong> node appears like.</div>
|
2698
2709
|
</div></p></div>
|
2699
2710
|
</div>
|
2700
2711
|
<div class="section">
|
2701
2712
|
<h5 class="title">
|
2702
|
-
<a class="toc" id="html.nodes.important" href="#a-
|
2713
|
+
<a class="toc" id="html.nodes.important" href="#a-607234578">5.1.4.3.3</a> important
|
2703
2714
|
</h5>
|
2704
2715
|
<div class="content"><p>Use an <strong>important</strong> node when:</p>
|
2705
2716
|
|
@@ -2710,7 +2721,7 @@ ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
|
2710
2721
|
|
2711
2722
|
|
2712
2723
|
<p><div class="important">
|
2713
|
-
<p class="title"><a class="toc" id="An-example-
|
2724
|
+
<p class="title"><a class="toc" id="An-example-607529738" href="#a-607237768">Important 1</a>. An example</p>
|
2714
2725
|
|
2715
2726
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
2716
2727
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -2768,14 +2779,14 @@ qTvNEuCzBFICdBNpEcn1RUD6N6m5vGG6p0SknjVYzD5W5IEF1oHZ2UgxETVf
|
|
2768
2779
|
KbKpZ8GCfObhDrfohGxeMUzk40RkeVy4qB/dqcUMyVDJDJNM4mbymQIyvWgW
|
2769
2780
|
YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
2770
2781
|
2wAAAABJRU5ErkJggg==
|
2771
|
-
"
|
2782
|
+
" class="icon"/>
|
2772
2783
|
|
2773
2784
|
<div class="content">This is what a <strong>important</strong> node appears like.</div>
|
2774
2785
|
</div></p></div>
|
2775
2786
|
</div>
|
2776
2787
|
<div class="section">
|
2777
2788
|
<h5 class="title">
|
2778
|
-
<a class="toc" id="html.nodes.note" href="#a-
|
2789
|
+
<a class="toc" id="html.nodes.note" href="#a-607240058">5.1.4.3.4</a> note
|
2779
2790
|
</h5>
|
2780
2791
|
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
|
2781
2792
|
|
@@ -2786,7 +2797,7 @@ YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
|
2786
2797
|
|
2787
2798
|
|
2788
2799
|
<p><div class="note">
|
2789
|
-
<p class="title"><a class="toc" id="An-example-
|
2800
|
+
<p class="title"><a class="toc" id="An-example-607566278" href="#a-607243278">Note 3</a>. An example</p>
|
2790
2801
|
|
2791
2802
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
2792
2803
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -2845,14 +2856,14 @@ bj2VSjFnzpxrKjafSSm5cOEC/f39KUAnrVsTgAkUAYU1NTUPx2KxjUEQTLmW
|
|
2845
2856
|
YvOZpmnxjo6O3x48eHA76S4UB3qEUgohRBQoGLoyKTJJp+nyR97kmA1IwANS
|
2846
2857
|
wODQ1auUSmYP9UNjoQBwAIv0DBUMFb6WZpNuRB9wSYsfUEr5kOdfSiGETrr1
|
2847
2858
|
DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
2848
|
-
"
|
2859
|
+
" class="icon"/>
|
2849
2860
|
|
2850
2861
|
<div class="content">This is what a <strong>note</strong> node appears like.</div>
|
2851
2862
|
</div></p></div>
|
2852
2863
|
</div>
|
2853
2864
|
<div class="section">
|
2854
2865
|
<h5 class="title">
|
2855
|
-
<a class="toc" id="html.nodes.tip" href="#a-
|
2866
|
+
<a class="toc" id="html.nodes.tip" href="#a-607245848">5.1.4.3.5</a> tip
|
2856
2867
|
</h5>
|
2857
2868
|
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
|
2858
2869
|
|
@@ -2863,7 +2874,7 @@ DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
|
2863
2874
|
|
2864
2875
|
|
2865
2876
|
<p><div class="tip">
|
2866
|
-
<p class="title"><a class="toc" id="An-example-
|
2877
|
+
<p class="title"><a class="toc" id="An-example-607596848" href="#a-607251388">Tip 1</a>. An example</p>
|
2867
2878
|
|
2868
2879
|
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
2869
2880
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -2940,7 +2951,7 @@ ta22BwC4nZ2dXdu2bfujlpaWe4wxNDMz84OzZ88em5qamkZ9ppfjAflu+bDc
|
|
2940
2951
|
HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
2941
2952
|
0BYggPpqs9jeBlvqCnTNAP/jIXWgBeNF/YXzBfHxIoC3z5cj+Or2X3r9Ye2F
|
2942
2953
|
1izgAAAAAElFTkSuQmCC
|
2943
|
-
"
|
2954
|
+
" class="icon"/>
|
2944
2955
|
|
2945
2956
|
<div class="content">This is what a <strong>tip</strong> node appears like.</div>
|
2946
2957
|
</div></p></div>
|
@@ -2948,79 +2959,79 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
2948
2959
|
</div>
|
2949
2960
|
<div class="section">
|
2950
2961
|
<h4 class="title">
|
2951
|
-
<a class="toc" id="Auxilary-materials" href="#a-
|
2962
|
+
<a class="toc" id="Auxilary-materials" href="#a-607259048">5.1.4.4</a> Auxilary materials
|
2952
2963
|
</h4>
|
2953
2964
|
<div class="content"><div class="section">
|
2954
2965
|
<h5 class="title">
|
2955
|
-
<a class="toc" id="html.nodes.figure" href="#a-
|
2966
|
+
<a class="toc" id="html.nodes.figure" href="#a-607264088">5.1.4.4.1</a> figure
|
2956
2967
|
</h5>
|
2957
2968
|
<div class="content"><p>A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.</p>
|
2958
2969
|
|
2959
2970
|
|
2960
2971
|
<p><div class="figure">
|
2961
|
-
<p class="title"><a class="toc" id="An-example-
|
2972
|
+
<p class="title"><a class="toc" id="An-example-607631908" href="#a-607270948">Figure 1</a>. An example</p>
|
2962
2973
|
<div class="content">This is what a <strong>figure</strong> node appears like.</div>
|
2963
2974
|
</div></p></div>
|
2964
2975
|
</div>
|
2965
2976
|
<div class="section">
|
2966
2977
|
<h5 class="title">
|
2967
|
-
<a class="toc" id="html.nodes.table" href="#a-
|
2978
|
+
<a class="toc" id="html.nodes.table" href="#a-607277488">5.1.4.4.2</a> table
|
2968
2979
|
</h5>
|
2969
2980
|
<div class="content"><p>Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.</p>
|
2970
2981
|
|
2971
2982
|
|
2972
2983
|
<p><div class="table">
|
2973
|
-
<p class="title"><a class="toc" id="An-example-
|
2984
|
+
<p class="title"><a class="toc" id="An-example-607655068" href="#a-607284158">Table 1</a>. An example</p>
|
2974
2985
|
<div class="content">This is what a <strong>table</strong> node appears like.</div>
|
2975
2986
|
</div></p></div>
|
2976
2987
|
</div>
|
2977
2988
|
<div class="section">
|
2978
2989
|
<h5 class="title">
|
2979
|
-
<a class="toc" id="html.nodes.example" href="#a-
|
2990
|
+
<a class="toc" id="html.nodes.example" href="#a-607291368">5.1.4.4.3</a> example
|
2980
2991
|
</h5>
|
2981
2992
|
<div class="content"><p>A sample application of an idea or thought.</p>
|
2982
2993
|
|
2983
2994
|
|
2984
2995
|
<p><div class="example">
|
2985
|
-
<p class="title"><a class="toc" id="An-example-
|
2996
|
+
<p class="title"><a class="toc" id="An-example-607677748" href="#a-607295988">Example 4</a>. An example</p>
|
2986
2997
|
<div class="content">This is what a <strong>example</strong> node appears like.</div>
|
2987
2998
|
</div></p></div>
|
2988
2999
|
</div>
|
2989
3000
|
<div class="section">
|
2990
3001
|
<h5 class="title">
|
2991
|
-
<a class="toc" id="html.nodes.equation" href="#a-
|
3002
|
+
<a class="toc" id="html.nodes.equation" href="#a-607303798">5.1.4.4.4</a> equation
|
2992
3003
|
</h5>
|
2993
3004
|
<div class="content"><p>A mathematical equation or formula.</p>
|
2994
3005
|
|
2995
3006
|
|
2996
3007
|
<p><div class="equation">
|
2997
|
-
<p class="title"><a class="toc" id="An-example-
|
3008
|
+
<p class="title"><a class="toc" id="An-example-607700438" href="#a-607308068">Equation 1</a>. An example</p>
|
2998
3009
|
<div class="content">This is what a <strong>equation</strong> node appears like.</div>
|
2999
3010
|
</div></p></div>
|
3000
3011
|
</div>
|
3001
3012
|
<div class="section">
|
3002
3013
|
<h5 class="title">
|
3003
|
-
<a class="toc" id="html.nodes.procedure" href="#a-
|
3014
|
+
<a class="toc" id="html.nodes.procedure" href="#a-607314598">5.1.4.4.5</a> procedure
|
3004
3015
|
</h5>
|
3005
3016
|
<div class="content"><p>An outline; a series of steps outlining some kind of process.</p>
|
3006
3017
|
|
3007
3018
|
|
3008
3019
|
<p><div class="procedure">
|
3009
|
-
<p class="title"><a class="toc" id="An-example-
|
3020
|
+
<p class="title"><a class="toc" id="An-example-607722628" href="#a-607318728">Procedure 1</a>. An example</p>
|
3010
3021
|
<div class="content">This is what a <strong>procedure</strong> node appears like.</div>
|
3011
3022
|
</div></p></div>
|
3012
3023
|
</div></div>
|
3013
3024
|
</div>
|
3014
3025
|
<div class="section">
|
3015
3026
|
<h4 class="title">
|
3016
|
-
<a class="toc" id="Bibliography" href="#a-
|
3027
|
+
<a class="toc" id="Bibliography" href="#a-607323548">5.1.4.5</a> Bibliography
|
3017
3028
|
</h4>
|
3018
3029
|
<div class="content"><p>The nodes in this section deal with attribution of ideas—an important weapon against plagiarism.</p>
|
3019
3030
|
|
3020
3031
|
|
3021
3032
|
<p><div class="section">
|
3022
3033
|
<h5 class="title">
|
3023
|
-
<a class="toc" id="html.nodes.reference" href="#a-
|
3034
|
+
<a class="toc" id="html.nodes.reference" href="#a-607328178">5.1.4.5.1</a> reference
|
3024
3035
|
</h5>
|
3025
3036
|
<div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
|
3026
3037
|
|
@@ -3036,7 +3047,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
3036
3047
|
</div>
|
3037
3048
|
<div class="section">
|
3038
3049
|
<h5 class="title">
|
3039
|
-
<a class="toc" id="html.nodes.cite" href="#a-
|
3050
|
+
<a class="toc" id="html.nodes.cite" href="#a-607346008">5.1.4.5.2</a> cite
|
3040
3051
|
</h5>
|
3041
3052
|
<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>
|
3042
3053
|
|
@@ -3067,7 +3078,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
3067
3078
|
<div class="chapter">
|
3068
3079
|
<h1 class="title">
|
3069
3080
|
Chapter
|
3070
|
-
<a class="toc" id="text" href="#a-
|
3081
|
+
<a class="toc" id="text" href="#a-607364918">5.2</a>
|
3071
3082
|
|
3072
3083
|
<br/>
|
3073
3084
|
|
@@ -3082,7 +3093,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
3082
3093
|
<div class="chapter">
|
3083
3094
|
<h1 class="title">
|
3084
3095
|
Chapter
|
3085
|
-
<a class="toc" id="latex" href="#a-
|
3096
|
+
<a class="toc" id="latex" href="#a-607370978">5.3</a>
|
3086
3097
|
|
3087
3098
|
<br/>
|
3088
3099
|
|
@@ -3097,7 +3108,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
3097
3108
|
<div class="chapter">
|
3098
3109
|
<h1 class="title">
|
3099
3110
|
Chapter
|
3100
|
-
<a class="toc" id="man" href="#a-
|
3111
|
+
<a class="toc" id="man" href="#a-607378428">5.4</a>
|
3101
3112
|
|
3102
3113
|
<br/>
|
3103
3114
|
|
@@ -3126,7 +3137,7 @@ HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
|
3126
3137
|
|
3127
3138
|
<div id="footer">
|
3128
3139
|
|
3129
|
-
Generated on
|
3140
|
+
Generated on Thu May 29 22:03:51 -0700 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 2.1.0.
|
3130
3141
|
|
3131
3142
|
<p>The admonition icons (<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
3132
3143
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
@@ -3185,7 +3196,7 @@ bj2VSjFnzpxrKjafSSm5cOEC/f39KUAnrVsTgAkUAYU1NTUPx2KxjUEQTLmW
|
|
3185
3196
|
YvOZpmnxjo6O3x48eHA76S4UB3qEUgohRBQoGLoyKTJJp+nyR97kmA1IwANS
|
3186
3197
|
wODQ1auUSmYP9UNjoQBwAIv0DBUMFb6WZpNuRB9wSYsfUEr5kOdfSiGETrr1
|
3187
3198
|
DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
|
3188
|
-
"
|
3199
|
+
"/> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
3189
3200
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
3190
3201
|
Lmlua3NjYXBlLm9yZ5vuPBoAAAlSSURBVGiB1ZpJjFzFGcd/31t6ncWzeHrG
|
3191
3202
|
G15JwBAcjAGDkwtJDPIgnAgh+UAkDlzgFHHIzQeOUXKJAheUE1IQEoqMMiZB
|
@@ -3241,7 +3252,7 @@ ViWglmdD/Em451F4eD1sTkB/DLojFTxFKOQhl4WZKRj/F3z6D7hoQuSWISCr
|
|
3241
3252
|
qk371eW4kFUlXiMfbUgj1edIKLqAXY1SjQoE1ViuxlIoFkLpgusAWSrWb7lf
|
3242
3253
|
XckglhDZeDV1Q4RdKvsLJ0S+9qGsCaitOgLAbyGmDHhUra6q5SV53emfPaqC
|
3243
3254
|
rBDpMPlaalVjI/la9EMCgnZW7hT+A5SLlrQmK/qkAAAAAElFTkSuQmCC
|
3244
|
-
"
|
3255
|
+
"/> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
3245
3256
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
3246
3257
|
Lmlua3NjYXBlLm9yZ5vuPBoAAAiESURBVGiB7ZpdbBzVFcd/Z2Znd2d3vbtm
|
3247
3258
|
/RWvsbEdfyauSWzq2MZWEFVD5AqBaBpRVyaKoaakEBMEBRRVBaukKiqhQF+i
|
@@ -3293,7 +3304,7 @@ lQP3aeBFBNHmWbBT/aV/Wn8qvh+F0Uuw73noCsEocEkpFUwKABARJ+CKFwex
|
|
3293
3304
|
MFmBqURf37Fpcf9hIAgEgHFgDBhLzIHkJFZKjYuIAiJACJiIH79ZAhKXdSTO
|
3294
3305
|
ECQGPj690VUrcfw2ZYuXhICbYRZiUUhEYFLNkjYs6s3c/5J97/9q8F/RUcwR
|
3295
3306
|
4xicOQAAAABJRU5ErkJggg==
|
3296
|
-
"
|
3307
|
+
"/> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
3297
3308
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
3298
3309
|
Lmlua3NjYXBlLm9yZ5vuPBoAAAk1SURBVGiBvVlpbBxnGX6+uda76/uO10fs
|
3299
3310
|
xs5BjNOLtE3S5iAp2bSoiIqCFBSQoEgV3R8IQUUjfiAFCfhRugKqCohaobZA
|
@@ -3349,7 +3360,7 @@ qTvNEuCzBFICdBNpEcn1RUD6N6m5vGG6p0SknjVYzD5W5IEF1oHZ2UgxETVf
|
|
3349
3360
|
KbKpZ8GCfObhDrfohGxeMUzk40RkeVy4qB/dqcUMyVDJDJNM4mbymQIyvWgW
|
3350
3361
|
YhZhYHbQZiOelwCTEJhIpuI+JYCZyKe2KNkEWIlIxTrPDJNc+B/DI2njy1uQ
|
3351
3362
|
2wAAAABJRU5ErkJggg==
|
3352
|
-
"
|
3363
|
+
"/> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
|
3353
3364
|
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
|
3354
3365
|
Lmlua3NjYXBlLm9yZ5vuPBoAAAyOSURBVGiB1ZlrkB3Fdcf/5/Q87r1z7z7u
|
3355
3366
|
vrSrXa3QC7EIyUFCSWwnJIANFiGJXdQSICRllGDni4LjqviDnQ+ufHEKx2BX
|
@@ -3424,7 +3435,7 @@ ta22BwC4nZ2dXdu2bfujlpaWe4wxNDMz84OzZ88em5qamkZ9ppfjAflu+bDc
|
|
3424
3435
|
HGAANv6XHFhk9iI4CwDNm5m3aJG9Ww4o1MPnXQVe09fovEsXBC+AXO16LBK/
|
3425
3436
|
0BYggPpqs9jeBlvqCnTNAP/jIXWgBeNF/YXzBfHxIoC3z5cj+Or2X3r9Ye2F
|
3426
3437
|
1izgAAAAAElFTkSuQmCC
|
3427
|
-
"
|
3438
|
+
"/>) 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
3439
|
|
3429
3440
|
</div>
|
3430
3441
|
|