doc/guide.html in gerbil-3.0.1 vs doc/guide.html in gerbil-3.0.2
- old
+ new
@@ -1,14 +1,14 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
- <meta name="date" content="03 June 2008"/>
+ <meta name="date" content="08 June 2008"/>
<meta name="author" content="Suraj N. Kurapati"/>
- <meta name="generator" content="Gerbil 3.0.1"/>
+ <meta name="generator" content="Gerbil 3.0.2"/>
<link rel="alternate" type="application/rss+xml" href="http://gerbil.rubyforge.org/ann"/>
- <title>Gerbil 3.0.1 user guide</title>
+ <title>Gerbil 3.0.2 user guide</title>
<style type="text/css" media="screen">
body
{
color : #000000;
@@ -816,13 +816,13 @@
<body>
<div id="header">
<img src="gerbil.png" alt="Gerbil logo" title="Gerbil logo"/>
- <h1 class="title">Gerbil 3.0.1 user guide</h1>
+ <h1 class="title">Gerbil 3.0.2 user guide</h1>
<h2 class="authors"><a href="http://snk.rubyforge.org">Suraj N. Kurapati</a></h2>
- <h3 class="date">03 June 2008</h3>
+ <h3 class="date">08 June 2008</h3>
<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>
<p><a href="http://gerbil.rubyforge.org/pkg">Downloads</a> – obtain the newest release package.</p>
@@ -837,19 +837,20 @@
</div>
- <div id="toc"><h1>Contents</h1> <ul><li>1 <a id="a-606118218" href="#Introduction">Introduction</a><ul><li>1.1 <a id="a-605758468" href="#Features">Features</a></li><li>1.2 <a id="a-605808488" href="#License">License</a></li><li>1.3 <a id="a-605632198" href="#Reviews">Reviews</a></li></ul></li><li>2 <a id="a-606224088" href="#Setup">Setup</a><ul><li>2.1 <a id="a-606230308" href="#Requirements">Requirements</a></li><li>2.2 <a id="a-606242938" href="#Installation">Installation</a></li><li>2.3 <a id="a-606249628" href="#Manifest">Manifest</a></li><li>2.4 <a id="a-606270528" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3 <a id="a-606275468" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="a-606297318" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="a-606311398" href="#Node.class">The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class</a></li></ul></li><li>3.2 <a id="a-606316358" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="a-606327518" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="a-606334598" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="a-606341178" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="a-606345928" href="#HelloWorld">Creating your own custom format</a></li></ul></li></ul></li><li>4 <a id="a-606380128" href="#Usage">Usage</a><ul><li>4.1 <a id="a-606387368" href="#include">The <strong>include</strong> directive</a></li></ul></li><li>5 <a id="a-606391088" href="#Formats">Formats</a><ul><li>5.1 <a id="a-606403658" href="#html">HTML</a><ul><li>5.1.1 <a id="a-606405368" href="#Text-to-HTML-conversion">Text to HTML conversion</a><ul><li>5.1.1.1 <a id="a-606410468" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="a-606413238" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="a-606418908" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="a-606424048" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="a-606428098" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="a-606435758" href="#Methods">Methods</a></li><li>5.1.4 <a id="a-607086158" href="#html.nodes">Nodes</a><ul><li>5.1.4.1 <a id="a-607097148" href="#Structure">Structure</a><ul><li>5.1.4.1.1 <a id="a-607098828" href="#html.nodes.header">header</a></li><li>5.1.4.1.2 <a id="a-607100888" href="#html.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="a-607102978" href="#html.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="a-607105098" href="#html.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="a-607110998" href="#Organization">Organization</a><ul><li>5.1.4.2.1 <a id="a-607112708" href="#html.nodes.part">part</a><ul><li>5.1.4.2.1.1 <a id="a-607114368" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.2 <a id="a-607116878" href="#html.nodes.chapter">chapter</a><ul><li>5.1.4.2.2.1 <a id="a-607118568" href="#An-example-607233838">An example</a></li></ul></li><li>5.1.4.2.3 <a id="a-607121078" href="#html.nodes.section">section</a><ul><li>5.1.4.2.3.1 <a id="a-607122798" href="#An-example-607318508">An example</a></li></ul></li><li>5.1.4.2.4 <a id="a-607125308" href="#html.nodes.paragraph">paragraph</a></li></ul></li><li>5.1.4.3 <a id="a-607129548" href="#Admonitions">Admonitions</a><ul><li>5.1.4.3.1 <a id="a-607137108" href="#html.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="a-607150658" href="#html.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="a-607171128" href="#html.nodes.important">important</a></li><li>5.1.4.3.4 <a id="a-607188888" href="#html.nodes.note">note</a></li><li>5.1.4.3.5 <a id="a-607204238" href="#html.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="a-607216148" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="a-607218348" href="#html.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="a-607230208" href="#html.nodes.table">table</a></li><li>5.1.4.4.3 <a id="a-607237168" href="#html.nodes.example">example</a></li><li>5.1.4.4.4 <a id="a-607247028" href="#html.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="a-607258168" href="#html.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="a-607272348" href="#Bibliography">Bibliography</a><ul><li>5.1.4.5.1 <a id="a-607282008" href="#html.nodes.reference">reference</a></li><li>5.1.4.5.2 <a id="a-607301808" href="#html.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="a-607310378" href="#text">Plain text</a></li><li>5.3 <a id="a-607312648" href="#latex">LaTeX</a></li><li>5.4 <a id="a-607314888" href="#man">UNIX man page</a></li></ul></li></ul></div>
+ <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>
- <div id="lof"><h1>Cautions</h1> <ol><li><a id="a-607162048" href="#An-example-607415138">An example</a></li></ol><h1>Equations</h1> <ol><li><a id="a-607252048" href="#An-example-607613748">An example</a></li></ol><h1>Examples</h1> <ol><li><a id="a-606367378" href="#HelloWorld.spec">HelloWorld format specification file</a></li><li><a id="a-606372658" href="#HelloWorld.input">Input document for HelloWorld format</a></li><li><a id="a-606375948" href="#HelloWorld.output">Output of HelloWorld format</a></li><li><a id="a-607243068" href="#An-example-607591898">An example</a></li></ol><h1>Figures</h1> <ol><li><a id="a-607223838" href="#An-example-607547218">An example</a></li></ol><h1>Importants</h1> <ol><li><a id="a-607180908" href="#An-example-607446208">An example</a></li></ol><h1>Notes</h1> <ol><li><a id="a-605709568" href="#See-the-source-of-this-guide">See the source of this guide</a></li><li><a id="a-607197468" href="#An-example-607482008">An example</a></li></ol><h1>Procedures</h1> <ol><li><a id="a-607264288" href="#An-example-607635968">An example</a></li></ol><h1>Tables</h1> <ol><li><a id="a-607232528" href="#An-example-607569478">An example</a></li></ol><h1>Tips</h1> <ol><li><a id="a-607210208" href="#An-example-607512348">An example</a></li></ol><h1>Warnings</h1> <ol><li><a id="a-607144268" href="#An-example-607385828">An example</a></li></ol></div>
+ <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>
<div id="content">
+
<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="Introduction" href="#a-606118218">1</a>
+ <a class="toc" id="Introduction" href="#a-605690458">1</a>
<br/>
<big>Introduction</big>
</h1>
@@ -868,11 +869,11 @@
<p>In addition, you can monitor for changes to the above repository by subscribing to <a href="http://gerbil.rubyforge.org/dev">this news feed</a>.</p>
<p><div class="note">
- <p class="title"><a class="toc" id="See-the-source-of-this-guide" href="#a-605709568">Note 1</a>. See the source of this guide</p>
+ <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>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAmCSURBVGiB1ZltbJXlGcd/9/N+Tlssh1Ja
hNEJaK2UFxFptqC2wGCSTWdM3DSQzWVDEzVxy4xfjNkHQ8xMnEEXviwZ62Rj
@@ -930,23 +931,25 @@
wODQ1auUSmYP9UNjoQBwAIv0DBUMFb6WZpNuRB9wSYsfUEr5kOdfSiGETrr1
DUCQhrhWJkj394A0gKeUCjVo3r9Zv0r2P3yyQqPd16MPAAAAAElFTkSuQmCC
" class="icon"/>
<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>
-</div><div class="section">
+</div>
+<div class="section">
<h2 class="title">
- <a class="toc" id="Features" href="#a-605758468">1.1</a> Features
+ <a class="toc" id="Features" href="#a-606176228">1.1</a> Features
</h2>
<div class="content"><ul>
<li>Composed of <strong>less than 200 lines</strong> of code!</li>
<li>Lets you <a class="xref" href="#HelloWorld"><strong>define your own</strong> document format</a>.</li>
<li>Supports <strong>any text-based output</strong> format.</li>
<li>Generates a <strong>table of contents</strong> automatically.</li>
</ul></div>
-</div><div class="section">
+</div>
+<div class="section">
<h2 class="title">
- <a class="toc" id="License" href="#a-605808488">1.2</a> License
+ <a class="toc" id="License" href="#a-606182908">1.2</a> License
</h2>
<div class="content"><p>Copyright 2006 Suraj N. Kurapati <SNK at GNA dot ORG></p>
<p>Permission is hereby granted, free of charge, to any person obtaining a
@@ -975,13 +978,14 @@
IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY</span>, FITNESS
<span class="caps">FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT</span>. IN <span class="caps">NO EVENT SHALL THE AUTHORS OR</span>
<span class="caps">COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM</span>, DAMAGES <span class="caps">OR OTHER LIABILITY</span>, WHETHER
<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>
<span class="caps">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE</span>.</p></div>
-</div><div class="section">
+</div>
+<div class="section">
<h2 class="title">
- <a class="toc" id="Reviews" href="#a-605632198">1.3</a> Reviews
+ <a class="toc" id="Reviews" href="#a-606189058">1.3</a> Reviews
</h2>
<div class="content"><blockquote>
<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>
</blockquote>
@@ -1006,20 +1010,20 @@
</div></p></div>
</div>
<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="Setup" href="#a-606224088">2</a>
+ <a class="toc" id="Setup" href="#a-606195148">2</a>
<br/>
<big>Setup</big>
</h1>
<div class="content"><div class="section">
<h2 class="title">
- <a class="toc" id="Requirements" href="#a-606230308">2.1</a> Requirements
+ <a class="toc" id="Requirements" href="#a-606198708">2.1</a> Requirements
</h2>
<div class="content"><p>Your system needs the following software to run Gerbil.</p>
<table border="1">
@@ -1046,13 +1050,14 @@
<p>If your system has <a href="http://rubygems.org/">RubyGems</a>, then you can install RedCloth and CodeRay by running the following command:</p>
<pre>gem install RedCloth coderay</pre></div>
-</div><div class="section">
+</div>
+<div class="section">
<h2 class="title">
- <a class="toc" id="Installation" href="#a-606242938">2.2</a> Installation
+ <a class="toc" id="Installation" href="#a-606210498">2.2</a> Installation
</h2>
<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>
<pre>gem install gerbil
@@ -1068,18 +1073,19 @@
<pre>ruby bin/gerbil -v</pre>
- <p>If the installation was successful, then you will see output like this: <pre>Gerbil 3.0.1 (2008-06-03) http://gerbil.rubyforge.org /home/sun/src/gerbil
+ <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
</pre></p>
<p>Otherwise, you can <a class="xref" href="#License">contact the author</a> for help.</p></div>
-</div><div class="section">
+</div>
+<div class="section">
<h2 class="title">
- <a class="toc" id="Manifest" href="#a-606249628">2.3</a> Manifest
+ <a class="toc" id="Manifest" href="#a-606220358">2.3</a> Manifest
</h2>
<div class="content">Now that Gerbil is installed on your system, let us examine its installation directory.
<ul>
<li>If you installed Gerbil manually, then you already know the location of its installation directory.</li>
<li>If you installed Gerbil using RubyGems, then run <pre>gerbil -v</pre> and select the right-most item in the output—that is the path of Gerbil’s installation directory.</li>
@@ -1119,13 +1125,14 @@
<li><tt>api/</tt> – contains API reference documentation for the provided Ruby code.</li>
</ul>
</li>
<li><tt>LICENSE</tt> – the project license and copyright notice.</li>
</ul></div>
-</div><div class="section">
+</div>
+<div class="section">
<h2 class="title">
- <a class="toc" id="Version-numbering-system" href="#a-606270528">2.4</a> Version numbering system
+ <a class="toc" id="Version-numbering-system" href="#a-606241838">2.4</a> Version numbering system
</h2>
<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.
<table border="1">
@@ -1157,11 +1164,11 @@
</div></div>
</div>
<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="Theory-of-operation" href="#a-606275468">3</a>
+ <a class="toc" id="Theory-of-operation" href="#a-606248408">3</a>
<br/>
<big>Theory of operation</big>
</h1>
@@ -1189,11 +1196,11 @@
<p>Although there is only one document being processed here, we refer to it using three distinct terms (<strong>input</strong>, <strong>processed</strong>, and <strong>output</strong>). This distinction helps us talk about the document in a particular state because the content of the document changes radically with every transformation—thus it would be ambiguous to say “the input document” all the time.</p>
<p><div class="section">
<h2 class="title">
- <a class="toc" id="Nodes" href="#a-606297318">3.1</a> Nodes
+ <a class="toc" id="Nodes" href="#a-606267838">3.1</a> Nodes
</h2>
<div class="content"><p>A node is a block of text that appears like this:</p>
<pre><% node_type node_argument1, node_argument2, ... do |node_object| %>
@@ -1247,11 +1254,11 @@
<p>A <a class="xref" href="#SpecFile">format specification file</a> defines what types of nodes an input document may use.</p>
<p><div class="section">
<h3 class="title">
- <a class="toc" id="Node.class" href="#a-606311398">3.1.1</a> The <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class
+ <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
</h3>
<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>
<table border="1">
@@ -1323,11 +1330,11 @@
<p>Furthermore, the <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> class is derived from <a href="http://www.ruby-doc.org/stdlib/libdoc/ostruct/rdoc/classes/OpenStruct.html">Ruby’s <code class="code"><span style="color:#036; font-weight:bold">OpenStruct</span></code> class</a>, so you can define new properties for <code class="code"><span style="color:#036; font-weight:bold">Node</span></code> objects dynamically.</p></div>
</div></p></div>
</div>
<div class="section">
<h2 class="title">
- <a class="toc" id="SpecFile" href="#a-606316358">3.2</a> Format specification file
+ <a class="toc" id="SpecFile" href="#a-606286778">3.2</a> Format specification file
</h2>
<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>
<table border="1">
@@ -1361,11 +1368,11 @@
<p><div class="section">
<h3 class="title">
- <a class="toc" id="SpecFile.nodes" href="#a-606327518">3.2.1</a> Node definition
+ <a class="toc" id="SpecFile.nodes" href="#a-606296088">3.2.1</a> Node definition
</h3>
<div class="content"><p>A node definition is a mapping from a name (the “node type”) to the following set of parameters:</p>
<table border="1">
@@ -1402,11 +1409,11 @@
<p>You may define additional parameters in a node definition if you want.</p>
<p><div class="section">
<h4 class="title">
- <a class="toc" id="SpecFile.nodes.output" href="#a-606334598">3.2.1.1</a> Node output template
+ <a class="toc" id="SpecFile.nodes.output" href="#a-606300858">3.2.1.1</a> Node output template
</h4>
<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>
<p>The following variables are available for use in this template:</p>
@@ -1470,11 +1477,11 @@
</table></div>
</div></p></div>
</div>
<div class="section">
<h3 class="title">
- <a class="toc" id="SpecFile.output" href="#a-606341178">3.2.2</a> Document output template
+ <a class="toc" id="SpecFile.output" href="#a-606305578">3.2.2</a> Document output template
</h3>
<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>
<p>The following variables are available for use in this template:</p>
@@ -1534,13 +1541,14 @@
<td> <code class="code"><span style="color:#33B">@spec</span>[<span style="color:#A60">:file</span>]</code> </td>
<td> String </td>
<td> Path of the current format specification file. </td>
</tr>
</table></div>
-</div><div class="section">
+</div>
+<div class="section">
<h3 class="title">
- <a class="toc" id="HelloWorld" href="#a-606345928">3.2.3</a> Creating your own custom format
+ <a class="toc" id="HelloWorld" href="#a-606308268">3.2.3</a> Creating your own custom format
</h3>
<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:
<ul>
<li>We define a <code class="code">generate_name()</code> method in <a class="xref" href="#HelloWorld.spec">Example 1: <em>HelloWorld format specification file</em></a> and make use of it in the <a class="xref" href="#HelloWorld.input">Example 2: <em>Input document for HelloWorld format</em></a>. This shows how to provide format-specific functionality to an input document.</li>
<li>We define a <code class="code"><span style="color:#d70; font-weight:bold">$style</span></code> variable in <a class="xref" href="#HelloWorld.input">Example 2: <em>Input document for HelloWorld format</em></a> and make use of it in <a class="xref" href="#HelloWorld.spec">Example 1: <em>HelloWorld format specification file</em></a>. This shows how to make your format accept parameters from an input document.</li>
@@ -1555,11 +1563,11 @@
<li>Examine the <tt>HelloWorld.output</tt> file until you are satisfied!</li>
</ol>
<p><div class="example">
- <p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606367378">Example 1</a>. HelloWorld format specification file</p>
+ <p class="title"><a class="toc" id="HelloWorld.spec" href="#a-606323768">Example 1</a>. HelloWorld format specification file</p>
<div class="content"><pre class="code" lang="rhtml">desc: A illustrative format.
code: |
# Returns a random, but pronounceable, name.
def generate_name
@@ -1623,12 +1631,13 @@
output: |
Welcome to the "<span style="background: #eee"><span style="color:black"><%=</span> <span style="color:#33B">@spec</span>[<span style="color:#A60">:name</span>] <span style="color:black">%></span></span>" format.
<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>
That's all folks!
</pre></div>
-</div><div class="example">
- <p class="title"><a class="toc" id="HelloWorld.input" href="#a-606372658">Example 2</a>. Input document for HelloWorld format</p>
+</div>
+<div class="example">
+ <p class="title"><a class="toc" id="HelloWorld.input" href="#a-606328598">Example 2</a>. Input document for HelloWorld format</p>
<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>
<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>
<span style="color:#070"><big></span>I'm<span style="color:#070"></big></span> the very first node, oh _yes_ I am! *sneer*
<span style="background: #eee"><span style="color:black"><%</span> hello <span style="background-color:#fff0f0"><span style="color:#710">"</span><span style="color:#D20">Bashful</span><span style="color:#710">"</span></span> <span style="color:#080; font-weight:bold">do</span> <span style="color:black">%></span></span>
@@ -1662,15 +1671,16 @@
Zip! Zap! Wake up, you sap!
_Whoo I'm wild!_ ;-)
<span style="background: #eee"><span style="color:black"><%</span> <span style="color:#080; font-weight:bold">end</span> <span style="color:black">%></span></span>
<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>
-</div><div class="example">
- <p class="title"><a class="toc" id="HelloWorld.output" href="#a-606375948">Example 3</a>. Output of HelloWorld format</p>
+</div>
+<div class="example">
+ <p class="title"><a class="toc" id="HelloWorld.output" href="#a-606336548">Example 3</a>. Output of HelloWorld format</p>
<div class="content">Welcome to the “HelloWorld” format.
-<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “hojes”</h1>
-My name is “hojes” and these are my properties:
+<div style="border-left: thick solid salmon; padding-left: 1em;"><h1>hello #1: “kuzide”</h1>
+My name is “kuzide” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1686,18 +1696,18 @@
<td>number</td>
<td>1</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> <big>I’m</big> the very first node, oh <em>yes</em> I am! <strong>sneer</strong>
-<h1>hello #1.1: “pevu”</h1>
-My name is “pevu” and these are my properties:
+<h1>hello #1.1: “hunedi”</h1>
+My name is “hunedi” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1713,18 +1723,18 @@
<td>number</td>
<td>2</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> Hi, I… <strong>hide</strong>
-<h1>hello #1.1.1: “bepole”</h1>
-My name is “bepole” and these are my properties:
+<h1>hello #1.1.1: “tefikos”</h1>
+My name is “tefikos” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1740,18 +1750,18 @@
<td>number</td>
<td>3</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:5</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> <strong>sigh</strong>
-<h1>hello #1.1.1.1: “sehobak”</h1>
-My name is “sehobak” and these are my properties:
+<h1>hello #1.1.1.1: “giki”</h1>
+My name is “giki” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1767,22 +1777,22 @@
<td>number</td>
<td>4</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:7</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:5</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> Huh?
</td>
</tr>
</table></td>
</tr>
</table>
-<h1>hello #1.1.2: “bozobe”</h1>
-My name is “bozobe” and these are my properties:
+<h1>hello #1.1.2: “kojukuj”</h1>
+My name is “kojukuj” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1798,22 +1808,22 @@
<td>number</td>
<td>5</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:9</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:3</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> Oh it’s <strong>on</strong> now! You’re going <strong>down</strong>!
</td>
</tr>
</table></td>
</tr>
</table>
-<h1>hello #1.2: “bolajo”</h1>
-My name is “bolajo” and these are my properties:
+<h1>hello #1.2: “kikefo”</h1>
+My name is “kikefo” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1829,18 +1839,18 @@
<td>number</td>
<td>6</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> <strong>yawn</strong> Just five more minutes…
-<h1>hello #1.2.1: “zumuyuh”</h1>
-My name is “zumuyuh” and these are my properties:
+<h1>hello #1.2.1: “rilom”</h1>
+My name is “rilom” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1856,18 +1866,18 @@
<td>number</td>
<td>7</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:13</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> So <em>be</em> happy my friend, <strong>happy</strong>!
- <h1>hello #1.2.1.1: “jane”</h1>
-My name is “jane” and these are my properties:
+ <h1>hello #1.2.1.1: “pelo”</h1>
+My name is “pelo” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1883,11 +1893,11 @@
<td>number</td>
<td>8</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:15</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:13</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:11</li><li>bin/gerbil:83:in `content_from_block’</li><li>bin/gerbil:256:in `hello’</li><li>INPUT:1</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td></td>
</tr>
@@ -1897,12 +1907,12 @@
</table></td>
</tr>
</table></td>
</tr>
</table>
-<h1>hello #2: “lukopu”</h1>
-My name is “lukopu” and these are my properties:
+<h1>hello #2: “duz”</h1>
+My name is “duz” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1918,21 +1928,21 @@
<td>number</td>
<td>9</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:17</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td> Zip! Zap! Wake up, you sap!
<em>Whoo I’m wild!</em> ;-)
</td>
</tr>
</table>
-<h1>hello #3: “lipa”</h1>
-My name is “lipa” and these are my properties:
+<h1>hello #3: “berifu”</h1>
+My name is “berifu” and these are my properties:
<table border="1">
<tr>
<th>Property</th>
<th>Value</th>
</tr>
@@ -1948,11 +1958,11 @@
<td>number</td>
<td>10</td>
</tr>
<tr>
<td>trace</td>
- <td><ul><li>INPUT:20</li><li>bin/gerbil:275</li><li>bin/gerbil:275:in `instance_eval’</li><li>bin/gerbil:275</li></ul></td>
+ <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>
</tr>
<tr>
<td>content</td>
<td></td>
</tr>
@@ -1963,11 +1973,11 @@
</div></p></div>
</div>
<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="Usage" href="#a-606380128">4</a>
+ <a class="toc" id="Usage" href="#a-606339698">4</a>
<br/>
<big>Usage</big>
</h1>
@@ -1985,17 +1995,10 @@
so you can investigate line numbers in the error’s stack trace.
Otherwise, the final output document will be printed to STDOUT.</li>
</ul>
- <ul>
- <li>The <tt>--unindent</tt> option assumes that all beginning (<% ... do %>)
- and ending (<% end %>) eRuby directives are written one per line
- (with nothing else on the line, except whitespace) in the input.</li>
- </ul>
-
-
<p><b>Usage:</b> gerbil [Option…] Format|SpecFile [InputFile…]</p>
<b>Option:</b>
<table border="1">
@@ -2042,11 +2045,11 @@
<p>Gerbil requires its <em>first</em> command-line argument to be either (1) the name of a predefined format or (2) the path to a <a class="xref" href="#SpecFile">format specification file</a>. Predefined formats are simply short-hand names of format specification files located in the <tt>fmt/</tt> subdirectory of the Gerbil installation directory (see <a class="xref" href="#Manifest">Section 2.3: <em>Manifest</em></a>).</p>
<p><div class="section">
<h2 class="title">
- <a class="toc" id="include" href="#a-606387368">4.1</a> The <strong>include</strong> directive
+ <a class="toc" id="include" href="#a-606347418">4.1</a> The <strong>include</strong> directive
</h2>
<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>
<pre><<span># include <em>path</em> #</span>></pre>
@@ -2059,11 +2062,11 @@
</div></p></div>
</div>
<div class="part">
<h1 class="title">
Part
- <a class="toc" id="Formats" href="#a-606391088">5</a>
+ <a class="toc" id="Formats" href="#a-606352338">5</a>
<br/>
<big>Formats</big>
</h1>
@@ -2075,11 +2078,11 @@
<p><div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="html" href="#a-606403658">5.1</a>
+ <a class="toc" id="html" href="#a-606365408">5.1</a>
<br/>
<big>HTML</big>
</h1>
@@ -2093,11 +2096,11 @@
<p>Furthermore, the HTML document comes equipped with a stylesheet that makes it suitable for printing. In particular, users of the <a href="http://mozilla.org">Mozilla</a> and <a href="http://www.opera.com/">Opera</a> family of web browsers will be pleasantly surprised to notice that all hyperlinks have been expanded to include their target URL next to the link text. So try using the “print preview” function of a graphical web browser to see how the HTML document will appear when printed.</p>
<p><div class="section">
<h3 class="title">
- <a class="toc" id="Text-to-HTML-conversion" href="#a-606405368">5.1.1</a> Text to HTML conversion
+ <a class="toc" id="Text-to-HTML-conversion" href="#a-606368788">5.1.1</a> Text to HTML conversion
</h3>
<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>
<p>The default implementation of the <code class="code"><span style="color:#036; font-weight:bold">String</span>.to_html</code> method is based on the <a href="http://whytheluckystiff.net/ruby/redcloth/">Textile</a> markup system. If you do not like Textile or wish to use a different markup system for text in your documents, then simply edit the <tt>html.rb</tt> file and adjust the source code of the default <code class="code"><span style="color:#036; font-weight:bold">String</span>.to_html</code> method accordingly.</p>
@@ -2118,11 +2121,11 @@
<p>In addition to supporting Textile markup, the default implementation has some additional features which are described in the following subsections.</p>
<p><div class="section">
<h4 class="title">
- <a class="toc" id="Syntax-coloring-for-source-code" href="#a-606410468">5.1.1.1</a> Syntax coloring for source code
+ <a class="toc" id="Syntax-coloring-for-source-code" href="#a-606376608">5.1.1.1</a> Syntax coloring for source code
</h4>
<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>
The following programming languages are currently supported by <a href="http://coderay.rubychan.de">CodeRay</a>:
@@ -2136,11 +2139,11 @@
</ul>
<p><div class="section">
<h5 class="title">
- <a class="toc" id="Specifying-the-programming-language" href="#a-606413238">5.1.1.1.1</a> Specifying the programming language
+ <a class="toc" id="Specifying-the-programming-language" href="#a-606380538">5.1.1.1.1</a> Specifying the programming language
</h5>
<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>
<p>For example, here is some source code <em>without</em> the <code class="code">lang</code> attribute:</p>
@@ -2224,11 +2227,11 @@
</pre></div>
</div></p></div>
</div>
<div class="section">
<h4 class="title">
- <a class="toc" id="Smart-sizing-of-source-code" href="#a-606418908">5.1.1.2</a> Smart sizing of source code
+ <a class="toc" id="Smart-sizing-of-source-code" href="#a-606385258">5.1.1.2</a> Smart sizing of source code
</h4>
<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>
<p>For example, here is a single line of code:</p>
@@ -2240,20 +2243,21 @@
<p>And here is a paragraph of code:</p>
<pre class="code">life =
<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>
-</div><div class="section">
+</div>
+<div class="section">
<h4 class="title">
- <a class="toc" id="Protecting-verbatim-text" href="#a-606424048">5.1.1.3</a> Protecting verbatim text
+ <a class="toc" id="Protecting-verbatim-text" href="#a-606389488">5.1.1.3</a> Protecting verbatim text
</h4>
<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>
</div></p></div>
</div>
<div class="section">
<h3 class="title">
- <a class="toc" id="Parameters" href="#a-606428098">5.1.2</a> Parameters
+ <a class="toc" id="Parameters" href="#a-606394628">5.1.2</a> Parameters
</h3>
<div class="content">The HTML format accepts the following document parameters.
<table border="1">
@@ -2298,13 +2302,14 @@
<td> Boolean </td>
<td> <code class="code"><span style="color:#038; font-weight:bold">true</span></code> </td>
<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>
</tr>
</table></div>
-</div><div class="section">
+</div>
+<div class="section">
<h3 class="title">
- <a class="toc" id="Methods" href="#a-606435758">5.1.3</a> Methods
+ <a class="toc" id="Methods" href="#a-606399218">5.1.3</a> Methods
</h3>
<div class="content">The HTML format provides the following methods. In the method declarations shown below,
<ul>
<li>a pound sign (#) indicates that the method is an <strong>instance method</strong>, meaning that it can only be invoked on instances of a class, not on the classes themselves.</li>
<li>a double colon sign (::) indicates that the method is a <strong>class method</strong>, meaning that it can only be invoked on a class.</li>
@@ -2396,11 +2401,11 @@
</table></div>
</div>
<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="html.nodes" href="#a-607086158">5.1.4</a>
+ <a class="toc" id="html.nodes" href="#a-607016588">5.1.4</a>
<br/>
<big>Nodes</big>
</h1>
@@ -2439,33 +2444,36 @@
<p><div class="section">
<h4 class="title">
- <a class="toc" id="Structure" href="#a-607097148">5.1.4.1</a> Structure
+ <a class="toc" id="Structure" href="#a-607033098">5.1.4.1</a> Structure
</h4>
<div class="content"><p>The nodes described in this section form the overall structure of the output document.</p>
<p><div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.header" href="#a-607098828">5.1.4.1.1</a> header
+ <a class="toc" id="html.nodes.header" href="#a-607036378">5.1.4.1.1</a> header
</h5>
<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>
-</div><div class="section">
+</div>
+<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.footer" href="#a-607100888">5.1.4.1.2</a> footer
+ <a class="toc" id="html.nodes.footer" href="#a-607038448">5.1.4.1.2</a> footer
</h5>
<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>
-</div><div class="section">
+</div>
+<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.abstract" href="#a-607102978">5.1.4.1.3</a> abstract
+ <a class="toc" id="html.nodes.abstract" href="#a-607040548">5.1.4.1.3</a> abstract
</h5>
<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>
-</div><div class="section">
+</div>
+<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.xref" href="#a-607105098">5.1.4.1.4</a> xref
+ <a class="toc" id="html.nodes.xref" href="#a-607042678">5.1.4.1.4</a> xref
</h5>
<div class="content"><p>A cross-reference; a hyperlink that takes you to any node in the document.</p>
<p>The first argument of this node is either the unique identifier of the node you wish to cross-reference. If no nodes in the document have the given identifier, then the titles of all nodes in the document are searched. If even that fails, then an error will be raised.</p>
@@ -2492,26 +2500,26 @@
<p>appears in the output document like this: <a class="xref" href="#SpecFile">custom link text</a>.</p></div>
</div></p></div>
</div>
<div class="section">
<h4 class="title">
- <a class="toc" id="Organization" href="#a-607110998">5.1.4.2</a> Organization
+ <a class="toc" id="Organization" href="#a-607048578">5.1.4.2</a> Organization
</h4>
<div class="content"><p>The nodes described in this section are meant to help organize the document’s content logically.</p>
<p><div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.part" href="#a-607112708">5.1.4.2.1</a> part
+ <a class="toc" id="html.nodes.part" href="#a-607050288">5.1.4.2.1</a> part
</h5>
<div class="content"><p>A collection of chapters.</p>
<p><div class="part">
<h1 class="title">
Part
- <a class="toc" id="An-example" href="#a-607114368">5.1.4.2.1.1</a>
+ <a class="toc" id="An-example" href="#a-607051948">5.1.4.2.1.1</a>
<br/>
<big>An example</big>
</h1>
@@ -2519,19 +2527,19 @@
<div class="content">This is what a <strong>part</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.chapter" href="#a-607116878">5.1.4.2.2</a> chapter
+ <a class="toc" id="html.nodes.chapter" href="#a-607054458">5.1.4.2.2</a> chapter
</h5>
<div class="content"><p>A collection of sections.</p>
<p><div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="An-example-607233838" href="#a-607118568">5.1.4.2.2.1</a>
+ <a class="toc" id="An-example-607136108" href="#a-607056148">5.1.4.2.2.1</a>
<br/>
<big>An example</big>
</h1>
@@ -2539,25 +2547,25 @@
<div class="content">This is what a <strong>chapter</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.section" href="#a-607121078">5.1.4.2.3</a> section
+ <a class="toc" id="html.nodes.section" href="#a-607058658">5.1.4.2.3</a> section
</h5>
<div class="content"><p>A collection of paragraphs about a particular topic.</p>
<p><div class="section">
<h6 class="title">
- <a class="toc" id="An-example-607318508" href="#a-607122798">5.1.4.2.3.1</a> An example
+ <a class="toc" id="An-example-607242568" href="#a-607060378">5.1.4.2.3.1</a> An example
</h6>
<div class="content">This is what a <strong>section</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.paragraph" href="#a-607125308">5.1.4.2.4</a> paragraph
+ <a class="toc" id="html.nodes.paragraph" href="#a-607062888">5.1.4.2.4</a> paragraph
</h5>
<div class="content"><p>A collection of sentences about a particular idea.</p>
<p><div class="paragraph">
@@ -2566,27 +2574,28 @@
</div></p></div>
</div></p></div>
</div>
<div class="section">
<h4 class="title">
- <a class="toc" id="Admonitions" href="#a-607129548">5.1.4.3</a> Admonitions
+ <a class="toc" id="Admonitions" href="#a-607067128">5.1.4.3</a> Admonitions
</h4>
<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>
<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>
- <p><div class="section">
+ <p>
+<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.warning" href="#a-607137108">5.1.4.3.1</a> warning
+ <a class="toc" id="html.nodes.warning" href="#a-607072748">5.1.4.3.1</a> warning
</h5>
<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>
<p><div class="warning">
- <p class="title"><a class="toc" id="An-example-607385828" href="#a-607144268">Warning 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607316558" href="#a-607078588">Warning 1</a>. An example</p>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAlSSURBVGiB1ZpJjFzFGcd/31t6ncWzeHrG
G15JwBAcjAGDkwtJDPIgnAgh+UAkDlzgFHHIzQeOUXKJAheUE1IQEoqMMiZB
@@ -2647,19 +2656,19 @@
<div class="content">This is what a <strong>warning</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.caution" href="#a-607150658">5.1.4.3.2</a> caution
+ <a class="toc" id="html.nodes.caution" href="#a-607085348">5.1.4.3.2</a> caution
</h5>
<div class="content"><blockquote>
<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>
</blockquote>
<p><div class="caution">
- <p class="title"><a class="toc" id="An-example-607415138" href="#a-607162048">Caution 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607346048" href="#a-607096198">Caution 1</a>. An example</p>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAiESURBVGiB7ZpdbBzVFcd/Z2Znd2d3vbtm
/RWvsbEdfyauSWzq2MZWEFVD5AqBaBpRVyaKoaakEBMEBRRVBaukKiqhQF+i
@@ -2716,22 +2725,22 @@
<div class="content">This is what a <strong>caution</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.important" href="#a-607171128">5.1.4.3.3</a> important
+ <a class="toc" id="html.nodes.important" href="#a-607102958">5.1.4.3.3</a> important
</h5>
<div class="content"><p>Use an <strong>important</strong> node when:</p>
<blockquote>
<p>When there is no danger of data loss, but you wish to make clear to the reader a consequence that isn’t immediately obvious (e.g. when changing the font for one instance of a program also changes the default setting, and this isn’t clear from the GUI.) <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
</blockquote>
<p><div class="important">
- <p class="title"><a class="toc" id="An-example-607446208" href="#a-607180908">Important 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607377118" href="#a-607116008">Important 1</a>. An example</p>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAk1SURBVGiBvVlpbBxnGX6+uda76/uO10fs
xs5BjNOLtE3S5iAp2bSoiIqCFBSQoEgV3R8IQUUjfiAFCfhRugKqCohaobZA
@@ -2792,22 +2801,22 @@
<div class="content">This is what a <strong>important</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.note" href="#a-607188888">5.1.4.3.4</a> note
+ <a class="toc" id="html.nodes.note" href="#a-607121388">5.1.4.3.4</a> note
</h5>
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
<blockquote>
<p>Information the user should be aware of, but is peripheral to the actual task being described. <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
</blockquote>
<p><div class="note">
- <p class="title"><a class="toc" id="An-example-607482008" href="#a-607197468">Note 2</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607412768" href="#a-607132188">Note 2</a>. An example</p>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAmCSURBVGiB1ZltbJXlGcd/9/N+Tlssh1Ja
hNEJaK2UFxFptqC2wGCSTWdM3DSQzWVDEzVxy4xfjNkHQ8xMnEEXviwZ62Rj
@@ -2869,22 +2878,22 @@
<div class="content">This is what a <strong>note</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.tip" href="#a-607204238">5.1.4.3.5</a> tip
+ <a class="toc" id="html.nodes.tip" href="#a-607139008">5.1.4.3.5</a> tip
</h5>
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
<blockquote>
<p>When you’re giving a hint to make things easier or more productive for the reader. <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
</blockquote>
<p><div class="tip">
- <p class="title"><a class="toc" id="An-example-607512348" href="#a-607210208">Tip 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607442918" href="#a-607146098">Tip 1</a>. An example</p>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAyOSURBVGiB1ZlrkB3Fdcf/5/Q87r1z7z7u
vrSrXa3QC7EIyUFCSWwnJIANFiGJXdQSICRllGDni4LjqviDnQ+ufHEKx2BX
@@ -2965,98 +2974,99 @@
</div></p></div>
</div></p></div>
</div>
<div class="section">
<h4 class="title">
- <a class="toc" id="Auxilary-materials" href="#a-607216148">5.1.4.4</a> Auxilary materials
+ <a class="toc" id="Auxilary-materials" href="#a-607152728">5.1.4.4</a> Auxilary materials
</h4>
<div class="content"><div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.figure" href="#a-607218348">5.1.4.4.1</a> figure
+ <a class="toc" id="html.nodes.figure" href="#a-607155488">5.1.4.4.1</a> figure
</h5>
<div class="content"><p>A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.</p>
<p><div class="figure">
- <p class="title"><a class="toc" id="An-example-607547218" href="#a-607223838">Figure 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607477718" href="#a-607157598">Figure 1</a>. An example</p>
<div class="content">This is what a <strong>figure</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.table" href="#a-607230208">5.1.4.4.2</a> table
+ <a class="toc" id="html.nodes.table" href="#a-607165808">5.1.4.4.2</a> table
</h5>
<div class="content"><p>Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.</p>
<p><div class="table">
- <p class="title"><a class="toc" id="An-example-607569478" href="#a-607232528">Table 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607500258" href="#a-607169488">Table 1</a>. An example</p>
<div class="content">This is what a <strong>table</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.example" href="#a-607237168">5.1.4.4.3</a> example
+ <a class="toc" id="html.nodes.example" href="#a-607172808">5.1.4.4.3</a> example
</h5>
<div class="content"><p>A sample application of an idea or thought.</p>
<p><div class="example">
- <p class="title"><a class="toc" id="An-example-607591898" href="#a-607243068">Example 4</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607522818" href="#a-607176778">Example 4</a>. An example</p>
<div class="content">This is what a <strong>example</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.equation" href="#a-607247028">5.1.4.4.4</a> equation
+ <a class="toc" id="html.nodes.equation" href="#a-607182908">5.1.4.4.4</a> equation
</h5>
<div class="content"><p>A mathematical equation or formula.</p>
<p><div class="equation">
- <p class="title"><a class="toc" id="An-example-607613748" href="#a-607252048">Equation 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607544658" href="#a-607186458">Equation 1</a>. An example</p>
<div class="content">This is what a <strong>equation</strong> node appears like.</div>
</div></p></div>
</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.procedure" href="#a-607258168">5.1.4.4.5</a> procedure
+ <a class="toc" id="html.nodes.procedure" href="#a-607192058">5.1.4.4.5</a> procedure
</h5>
<div class="content"><p>An outline; a series of steps outlining some kind of process.</p>
<p><div class="procedure">
- <p class="title"><a class="toc" id="An-example-607635968" href="#a-607264288">Procedure 1</a>. An example</p>
+ <p class="title"><a class="toc" id="An-example-607566718" href="#a-607198148">Procedure 1</a>. An example</p>
<div class="content">This is what a <strong>procedure</strong> node appears like.</div>
</div></p></div>
</div></div>
</div>
<div class="section">
<h4 class="title">
- <a class="toc" id="Bibliography" href="#a-607272348">5.1.4.5</a> Bibliography
+ <a class="toc" id="Bibliography" href="#a-607206348">5.1.4.5</a> Bibliography
</h4>
<div class="content"><p>The nodes in this section deal with attribution of ideas—an important weapon against plagiarism.</p>
<p><div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.reference" href="#a-607282008">5.1.4.5.1</a> reference
+ <a class="toc" id="html.nodes.reference" href="#a-607212128">5.1.4.5.1</a> reference
</h5>
<div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
<p>If you wish to cite a certain source in several places in your document, start by creating a <strong>reference</strong> node first and then use a <strong>cite</strong> node (see <a class="xref" href="#html.nodes.cite">Section 5.1.4.5.2: <em>cite</em></a>) to perform the citation.</p>
<p><div class="paragraph">
<p class="title">An example</p>
<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>
-</div></p></div>
</div>
+</p></div>
+</div>
<div class="section">
<h5 class="title">
- <a class="toc" id="html.nodes.cite" href="#a-607301808">5.1.4.5.2</a> cite
+ <a class="toc" id="html.nodes.cite" href="#a-607239408">5.1.4.5.2</a> cite
</h5>
<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>
<p>The first argument of this node is the unique identifier of the reference node you wish to cite. You can specify additional arguments to give more detail about the citation.</p>
@@ -3083,39 +3093,41 @@
</div></p></div>
</div>
<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="text" href="#a-607310378">5.2</a>
+ <a class="toc" id="text" href="#a-607247898">5.2</a>
<br/>
<big>Plain text</big>
</h1>
<div class="content"><p>This format is not yet implemented.</p>
<p>http://en.wikipedia.org/wiki/Plain_text</p></div>
-</div><div class="chapter">
+</div>
+<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="latex" href="#a-607312648">5.3</a>
+ <a class="toc" id="latex" href="#a-607250098">5.3</a>
<br/>
<big>LaTeX</big>
</h1>
<div class="content"><p>This format is not yet implemented.</p>
<p>http://www.latex-project.org</p></div>
-</div><div class="chapter">
+</div>
+<div class="chapter">
<h1 class="title">
Chapter
- <a class="toc" id="man" href="#a-607314888">5.4</a>
+ <a class="toc" id="man" href="#a-607252408">5.4</a>
<br/>
<big>UNIX man page</big>
</h1>
@@ -3140,10 +3152,10 @@
<br style="display: none"/>
<div id="footer">
- Generated on Tue Jun 03 21:04:07 -0700 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 3.0.1.
+ Generated on Sun Jun 08 12:56:41 -0700 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 3.0.2.
<p>The admonition icons (<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABHNCSVQICAgI
fAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3
Lmlua3NjYXBlLm9yZ5vuPBoAAAmCSURBVGiB1ZltbJXlGcd/9/N+Tlssh1Ja
hNEJaK2UFxFptqC2wGCSTWdM3DSQzWVDEzVxy4xfjNkHQ8xMnEEXviwZ62Rj