doc/index.xhtml in erbook-6.0.1 vs doc/index.xhtml in erbook-6.1.0
- old
+ new
@@ -10,17 +10,17 @@
<!ENTITY icon_link "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAMAAAC67D+PAAAAFVBMVEVmmcwzmcyZzP8AZswAZv////////9E6giVAAAAB3RSTlP///////8AGksDRgAAADhJREFUGFcly0ESAEAEA0Ei6/9P3sEcVB8kmrwFyni0bOeyyDpy9JTLEaOhQq7Ongf5FeMhHS/4AVnsAZubxDVmAAAAAElFTkSuQmCC">
]>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
- <meta name="generator" content="ERBook 6.0.1"/>
+ <meta name="generator" content="ERBook 6.1.0"/>
- <title>ERBook 6.0.1</title>
+ <title>ERBook 6.1.0</title>
<meta name="author" content="Suraj N. Kurapati"/>
- <meta name="date" content="19 January 2009"/>
+ <meta name="date" content="14 February 2009"/>
<link rel="alternate" type="application/rss+xml" href="http://snk.tuxfamily.org/lib/erbook/ann.xml"/>
<style type="text/css" media="all">
<![CDATA[/* general */
@@ -47,11 +47,11 @@
hr
{
height : 0;
border : 0;
- border-top : 2px solid #FF0000;
+ border-top : thin dashed #000000;
}
/* source code */
tt,
code,
@@ -483,11 +483,11 @@
}
.nav a:link,
.nav a:visited
{
- color : #D3D3D3;
+ color : #C0C0C0;
}
.nav a:hover,
#nav a:target:after {
color : #9ACD32;
@@ -648,19 +648,19 @@
<br style="display: none"/>
<div id="header">
- <div class="logo"><img src='erbook.png' alt='ERBook logo' /></div>
+ <div class="logo"><a class="xref" href="#Credits" title="Section 1.3. "Credits""><img src='erbook.png' alt='ERBook logo' /></a></div>
- <h1 class="title">ERBook 6.0.1</h1>
+ <h1 class="title">ERBook 6.1.0</h1>
<h2 class="subtitle">Extensible document processor based on eRuby</h2>
<h3 class="authors"><a href="mailto:sunaku@gmail.com">Suraj N. Kurapati</a></h3>
- <h3 class="date">19 January 2009</h3>
+ <h3 class="date">14 February 2009</h3>
</div>
@@ -671,11 +671,11 @@
<div id="toc">
<a name="Contents"/><div class="nav" id="Contents"><a title="Reverse jump to listing" href="#rev:Contents">≡</a>△▽<a title="Jump to this segment" href="#Contents">◎</a></div>
<h1 class="title">Contents</h1>
<ul>
- <li>1 <a id="rev:Introduction" href="#Introduction">Introduction</a><ul><li>1.1 <a id="rev:Logistics" href="#Logistics">Logistics</a><ul><li><a id="rev:Version-numbers" href="#Version-numbers">Version numbers</a></li></ul></li><li>1.2 <a id="rev:License" href="#License">License</a></li><li>1.3 <a id="rev:Credits" href="#Credits">Credits</a></li><li>1.4 <a id="rev:Reviews" href="#Reviews">Reviews</a></li></ul></li><li>2 <a id="rev:Setup" href="#Setup">Setup</a><ul><li>2.1 <a id="rev:Requirements" href="#Requirements">Requirements</a></li><li>2.2 <a id="rev:Installation" href="#Installation">Installation</a></li><li>2.3 <a id="rev:Manifest" href="#Manifest">Manifest</a></li></ul></li><li>3 <a id="rev:Theory-of-operation" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="rev:Nodes" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="rev:Node.class" href="#Node.class">The <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> class</a></li></ul></li><li>3.2 <a id="rev:SpecFile" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="rev:SpecFile.nodes" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="rev:SpecFile.nodes.output" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="rev:SpecFile.output" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="rev:HelloWorld" href="#HelloWorld">Creating your own document format</a></li></ul></li></ul></li><li>4 <a id="rev:Usage" href="#Usage">Usage</a><ul><li>4.1 <a id="rev:Command-line-interface" href="#Command-line-interface">Command-line interface</a><ul><li>4.1.1 <a id="rev:Saving-the-output-to-a-file" href="#Saving-the-output-to-a-file">Saving the output to a file</a></li></ul></li><li>4.2 <a id="rev:include" href="#include">Including external documents</a></li><li>4.3 <a id="rev:Unindenting-nodes-hierarchically" href="#Unindenting-nodes-hierarchically">Unindenting nodes hierarchically</a></li></ul></li><li>5 <a id="rev:Formats" href="#Formats">Formats</a><ul><li>5.1 <a id="rev:xhtml" href="#xhtml">XHTML (web page)</a><ul><li>5.1.1 <a id="rev:Text-to-XHTML-conversion" href="#Text-to-XHTML-conversion">Text to XHTML conversion</a><ul><li>5.1.1.1 <a id="rev:Syntax-coloring-for-source-code" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="rev:Specifying-the-programming-language" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="rev:Smart-sizing-of-source-code" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="rev:Protecting-verbatim-text" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="rev:Parameters" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="rev:Methods" href="#Methods">Methods</a><ul><li><a id="rev:a-ERBook::Document::Node-title" href="#a-ERBook::Document::Node-title"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#title()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-id" href="#a-ERBook::Document::Node-id"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#id()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-title_xhtml" href="#a-ERBook::Document::Node-title_xhtml"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#title_xhtml()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-content_xhtml" href="#a-ERBook::Document::Node-content_xhtml"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#content_xhtml()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-title_link-title-nil" href="#a-ERBook::Document::Node-title_link-title-nil"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#title_link(title = nil)</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-index_link" href="#a-ERBook::Document::Node-index_link"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#index_link()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-number_link" href="#a-ERBook::Document::Node-number_link"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#number_link()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-navigation" href="#a-ERBook::Document::Node-navigation"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#navigation()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node::navigation-here_frag-list_frag-prev_frag-next_frag" href="#a-ERBook::Document::Node::navigation-here_frag-list_frag-prev_frag-next_frag"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span>::navigation(here_frag, list_frag, prev_frag, next_frag)</code></a></li><li><a id="rev:a-ERBook::Document::Node-xref_link-label-nil" href="#a-ERBook::Document::Node-xref_link-label-nil"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#xref_link(label = nil)</span></code></a></li><li><a id="rev:a-Hash-to_xml_atts" href="#a-Hash-to_xml_atts"><code class="code"><span style="color:#036;font-weight:bold">Hash</span><span style="color:#666">#to_xml_atts()</span></code></a></li><li><a id="rev:a-ERBook::Template-verbatim-content" href="#a-ERBook::Template-verbatim-content"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#verbatim(content)</span></code></a></li><li><a id="rev:a-ERBook::Template-hyperlink-url-label-url-title-nil" href="#a-ERBook::Template-hyperlink-url-label-url-title-nil"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#hyperlink(url, label = url, title = nil)</span></code></a></li><li><a id="rev:a-ERBook::Template-embed_image_file-path-format-path-w-atts" href="#a-ERBook::Template-embed_image_file-path-format-path-w-atts"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#embed_image_file(path, format = path[/\w+/], atts = {})</span></code></a></li><li><a id="rev:a-ERBook::Template-embed_image_data-data-format-atts" href="#a-ERBook::Template-embed_image_data-data-format-atts"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#embed_image_data(data, format, atts = {})</span></code></a></li><li><a id="rev:a-String-to_xml_entities" href="#a-String-to_xml_entities"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_xml_entities()</span></code></a></li><li><a id="rev:a-String-to_uri_fragment" href="#a-String-to_uri_fragment"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_uri_fragment()</span></code></a></li><li><a id="rev:a-String-to_inline_xhtml" href="#a-String-to_inline_xhtml"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_inline_xhtml()</span></code></a></li><li><a id="rev:a-String-to_xhtml-inline-false" href="#a-String-to_xhtml-inline-false"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_xhtml(inline = false)</span></code></a></li></ul></li><li>5.1.4 <a id="rev:xhtml.nodes" href="#xhtml.nodes">Nodes</a><ul><li>5.1.4.1 <a id="rev:Structural-nodes" href="#Structural-nodes">Structural nodes</a><ul><li>5.1.4.1.1 <a id="rev:xhtml.nodes.header" href="#xhtml.nodes.header">header</a></li><li>5.1.4.1.2 <a id="rev:xhtml.nodes.footer" href="#xhtml.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="rev:xhtml.nodes.abstract" href="#xhtml.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="rev:xhtml.nodes.xref" href="#xhtml.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="rev:Organizational-nodes" href="#Organizational-nodes">Organizational nodes</a><ul><li>5.1.4.2.1 <a id="rev:xhtml.nodes.node" href="#xhtml.nodes.node">node</a></li><li>5.1.4.2.2 <a id="rev:xhtml.nodes.part" href="#xhtml.nodes.part">part</a><ul><li>5.1.4.2.2.1 <a id="rev:An-example" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.3 <a id="rev:xhtml.nodes.chapter" href="#xhtml.nodes.chapter">chapter</a><ul><li>5.1.4.2.3.1 <a id="rev:An-example-5.1.4.2.3.1" href="#An-example-5.1.4.2.3.1">An example</a></li></ul></li><li>5.1.4.2.4 <a id="rev:xhtml.nodes.section" href="#xhtml.nodes.section">section</a><ul><li>5.1.4.2.4.1 <a id="rev:An-example-5.1.4.2.4.1" href="#An-example-5.1.4.2.4.1">An example</a></li></ul></li><li>5.1.4.2.5 <a id="rev:xhtml.nodes.paragraph" href="#xhtml.nodes.paragraph">paragraph</a><ul><li><a id="rev:An-example-609366268" href="#An-example-609366268">An example</a></li></ul></li></ul></li><li>5.1.4.3 <a id="rev:Admonition-nodes" href="#Admonition-nodes">Admonition nodes</a><ul><li>5.1.4.3.1 <a id="rev:xhtml.nodes.warning" href="#xhtml.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="rev:xhtml.nodes.caution" href="#xhtml.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="rev:xhtml.nodes.important" href="#xhtml.nodes.important">important</a></li><li>5.1.4.3.4 <a id="rev:xhtml.nodes.note" href="#xhtml.nodes.note">note</a></li><li>5.1.4.3.5 <a id="rev:xhtml.nodes.tip" href="#xhtml.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="rev:Auxilary-materials" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="rev:xhtml.nodes.figure" href="#xhtml.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="rev:xhtml.nodes.table" href="#xhtml.nodes.table">table</a></li><li>5.1.4.4.3 <a id="rev:xhtml.nodes.example" href="#xhtml.nodes.example">example</a></li><li>5.1.4.4.4 <a id="rev:xhtml.nodes.equation" href="#xhtml.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="rev:xhtml.nodes.procedure" href="#xhtml.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="rev:Bibliographical-nodes" href="#Bibliographical-nodes">Bibliographical nodes</a><ul><li>5.1.4.5.1 <a id="rev:xhtml.nodes.reference" href="#xhtml.nodes.reference">reference</a><ul><li><a id="rev:An-example-609682968" href="#An-example-609682968">An example</a></li></ul></li><li>5.1.4.5.2 <a id="rev:xhtml.nodes.cite" href="#xhtml.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="rev:text" href="#text">Plain text</a></li><li>5.3 <a id="rev:latex" href="#latex">LaTeX (PDF)</a></li><li>5.4 <a id="rev:man" href="#man">UNIX manual page</a></li></ul></li><li>6 <a id="rev:history" href="#history">Project history</a><ul><li>6.1 <a id="rev:Version-6.0.1-2009-01-19" href="#Version-6.0.1-2009-01-19">Version 6.0.1 (2009-01-19)</a></li><li>6.1 <a id="rev:Version-6.0.0-2009-01-19" href="#Version-6.0.0-2009-01-19">Version 6.0.0 (2009-01-19)</a><ul><li><a id="rev:Incompatible-changes" href="#Incompatible-changes">Incompatible changes</a></li><li><a id="rev:New-features" href="#New-features">New features</a></li><li><a id="rev:Bug-fixes" href="#Bug-fixes">Bug fixes</a></li><li><a id="rev:Housekeeping" href="#Housekeeping">Housekeeping</a></li></ul></li></ul></li>
+ <li>1 <a id="rev:Introduction" href="#Introduction">Introduction</a><ul><li>1.1 <a id="rev:Logistics" href="#Logistics">Logistics</a><ul><li><a id="rev:Version-numbers" href="#Version-numbers">Version numbers</a></li></ul></li><li>1.2 <a id="rev:License" href="#License">License</a></li><li>1.3 <a id="rev:Credits" href="#Credits">Credits</a></li><li>1.4 <a id="rev:Reviews" href="#Reviews">Reviews</a></li></ul></li><li>2 <a id="rev:Setup" href="#Setup">Setup</a><ul><li>2.1 <a id="rev:Requirements" href="#Requirements">Requirements</a></li><li>2.2 <a id="rev:Installation" href="#Installation">Installation</a></li><li>2.3 <a id="rev:Manifest" href="#Manifest">Manifest</a></li></ul></li><li>3 <a id="rev:Theory-of-operation" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1 <a id="rev:Nodes" href="#Nodes">Nodes</a><ul><li>3.1.1 <a id="rev:Node.class" href="#Node.class">The <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> class</a></li></ul></li><li>3.2 <a id="rev:SpecFile" href="#SpecFile">Format specification file</a><ul><li>3.2.1 <a id="rev:SpecFile.nodes" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1 <a id="rev:SpecFile.nodes.output" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2 <a id="rev:SpecFile.output" href="#SpecFile.output">Document output template</a></li><li>3.2.3 <a id="rev:HelloWorld" href="#HelloWorld">Creating your own document format</a></li></ul></li></ul></li><li>4 <a id="rev:Usage" href="#Usage">Usage</a><ul><li>4.1 <a id="rev:Command-line-interface" href="#Command-line-interface">Command-line interface</a><ul><li>4.1.1 <a id="rev:Saving-the-output-to-a-file" href="#Saving-the-output-to-a-file">Saving the output to a file</a></li></ul></li><li>4.2 <a id="rev:include" href="#include">Including external documents</a></li><li>4.3 <a id="rev:Unindenting-nodes-hierarchically" href="#Unindenting-nodes-hierarchically">Unindenting nodes hierarchically</a></li></ul></li><li>5 <a id="rev:Formats" href="#Formats">Formats</a><ul><li>5.1 <a id="rev:xhtml" href="#xhtml">XHTML (web page)</a><ul><li>5.1.1 <a id="rev:Text-to-XHTML-conversion" href="#Text-to-XHTML-conversion">Text to XHTML conversion</a><ul><li>5.1.1.1 <a id="rev:Syntax-coloring-for-source-code" href="#Syntax-coloring-for-source-code">Syntax coloring for source code</a><ul><li>5.1.1.1.1 <a id="rev:Specifying-the-programming-language" href="#Specifying-the-programming-language">Specifying the programming language</a></li></ul></li><li>5.1.1.2 <a id="rev:Smart-sizing-of-source-code" href="#Smart-sizing-of-source-code">Smart sizing of source code</a></li><li>5.1.1.3 <a id="rev:Protecting-verbatim-text" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2 <a id="rev:Parameters" href="#Parameters">Parameters</a></li><li>5.1.3 <a id="rev:Methods" href="#Methods">Methods</a><ul><li><a id="rev:a-ERBook::Document::Node-title" href="#a-ERBook::Document::Node-title"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#title()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-id" href="#a-ERBook::Document::Node-id"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#id()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-title_xhtml" href="#a-ERBook::Document::Node-title_xhtml"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#title_xhtml()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-content_xhtml" href="#a-ERBook::Document::Node-content_xhtml"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#content_xhtml()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-title_link-title-nil" href="#a-ERBook::Document::Node-title_link-title-nil"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#title_link(title = nil)</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-index_link" href="#a-ERBook::Document::Node-index_link"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#index_link()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-number_link" href="#a-ERBook::Document::Node-number_link"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#number_link()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node-navigation" href="#a-ERBook::Document::Node-navigation"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#navigation()</span></code></a></li><li><a id="rev:a-ERBook::Document::Node::navigation-here_frag-list_frag-prev_frag-next_frag" href="#a-ERBook::Document::Node::navigation-here_frag-list_frag-prev_frag-next_frag"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span>::navigation(here_frag, list_frag, prev_frag, next_frag)</code></a></li><li><a id="rev:a-ERBook::Document::Node-xref_link-label-nil" href="#a-ERBook::Document::Node-xref_link-label-nil"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#xref_link(label = nil)</span></code></a></li><li><a id="rev:a-Hash-to_xml_atts" href="#a-Hash-to_xml_atts"><code class="code"><span style="color:#036;font-weight:bold">Hash</span><span style="color:#666">#to_xml_atts()</span></code></a></li><li><a id="rev:a-ERBook::Template-verbatim-content" href="#a-ERBook::Template-verbatim-content"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#verbatim(content)</span></code></a></li><li><a id="rev:a-ERBook::Template-hyperlink-url-label-url-title-nil" href="#a-ERBook::Template-hyperlink-url-label-url-title-nil"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#hyperlink(url, label = url, title = nil)</span></code></a></li><li><a id="rev:a-ERBook::Template-embed_image_file-path-format-path-w-atts" href="#a-ERBook::Template-embed_image_file-path-format-path-w-atts"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#embed_image_file(path, format = path[/\w+/], atts = {})</span></code></a></li><li><a id="rev:a-ERBook::Template-embed_image_data-data-format-atts" href="#a-ERBook::Template-embed_image_data-data-format-atts"><code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Template</span><span style="color:#666">#embed_image_data(data, format, atts = {})</span></code></a></li><li><a id="rev:a-String-to_xml_entities" href="#a-String-to_xml_entities"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_xml_entities()</span></code></a></li><li><a id="rev:a-String-to_uri_fragment" href="#a-String-to_uri_fragment"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_uri_fragment()</span></code></a></li><li><a id="rev:a-String-to_inline_xhtml" href="#a-String-to_inline_xhtml"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_inline_xhtml()</span></code></a></li><li><a id="rev:a-String-to_xhtml-inline-false" href="#a-String-to_xhtml-inline-false"><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_xhtml(inline = false)</span></code></a></li></ul></li><li>5.1.4 <a id="rev:xhtml.nodes" href="#xhtml.nodes">Nodes</a><ul><li>5.1.4.1 <a id="rev:Structural-nodes" href="#Structural-nodes">Structural nodes</a><ul><li>5.1.4.1.1 <a id="rev:xhtml.nodes.header" href="#xhtml.nodes.header">header</a></li><li>5.1.4.1.2 <a id="rev:xhtml.nodes.footer" href="#xhtml.nodes.footer">footer</a></li><li>5.1.4.1.3 <a id="rev:xhtml.nodes.abstract" href="#xhtml.nodes.abstract">abstract</a></li><li>5.1.4.1.4 <a id="rev:xhtml.nodes.xref" href="#xhtml.nodes.xref">xref</a></li></ul></li><li>5.1.4.2 <a id="rev:Organizational-nodes" href="#Organizational-nodes">Organizational nodes</a><ul><li>5.1.4.2.1 <a id="rev:xhtml.nodes.node" href="#xhtml.nodes.node">node</a></li><li>5.1.4.2.2 <a id="rev:xhtml.nodes.part" href="#xhtml.nodes.part">part</a><ul><li>5.1.4.2.2.1 <a id="rev:An-example" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.3 <a id="rev:xhtml.nodes.chapter" href="#xhtml.nodes.chapter">chapter</a><ul><li>5.1.4.2.3.1 <a id="rev:An-example-5.1.4.2.3.1" href="#An-example-5.1.4.2.3.1">An example</a></li></ul></li><li>5.1.4.2.4 <a id="rev:xhtml.nodes.section" href="#xhtml.nodes.section">section</a><ul><li>5.1.4.2.4.1 <a id="rev:An-example-5.1.4.2.4.1" href="#An-example-5.1.4.2.4.1">An example</a></li></ul></li><li>5.1.4.2.5 <a id="rev:xhtml.nodes.paragraph" href="#xhtml.nodes.paragraph">paragraph</a><ul><li><a id="rev:An-example-613122798" href="#An-example-613122798">An example</a></li></ul></li></ul></li><li>5.1.4.3 <a id="rev:Admonition-nodes" href="#Admonition-nodes">Admonition nodes</a><ul><li>5.1.4.3.1 <a id="rev:xhtml.nodes.warning" href="#xhtml.nodes.warning">warning</a></li><li>5.1.4.3.2 <a id="rev:xhtml.nodes.caution" href="#xhtml.nodes.caution">caution</a></li><li>5.1.4.3.3 <a id="rev:xhtml.nodes.important" href="#xhtml.nodes.important">important</a></li><li>5.1.4.3.4 <a id="rev:xhtml.nodes.note" href="#xhtml.nodes.note">note</a></li><li>5.1.4.3.5 <a id="rev:xhtml.nodes.tip" href="#xhtml.nodes.tip">tip</a></li></ul></li><li>5.1.4.4 <a id="rev:Auxilary-materials" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1 <a id="rev:xhtml.nodes.figure" href="#xhtml.nodes.figure">figure</a></li><li>5.1.4.4.2 <a id="rev:xhtml.nodes.table" href="#xhtml.nodes.table">table</a></li><li>5.1.4.4.3 <a id="rev:xhtml.nodes.example" href="#xhtml.nodes.example">example</a></li><li>5.1.4.4.4 <a id="rev:xhtml.nodes.equation" href="#xhtml.nodes.equation">equation</a></li><li>5.1.4.4.5 <a id="rev:xhtml.nodes.procedure" href="#xhtml.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5 <a id="rev:Bibliographical-nodes" href="#Bibliographical-nodes">Bibliographical nodes</a><ul><li>5.1.4.5.1 <a id="rev:xhtml.nodes.reference" href="#xhtml.nodes.reference">reference</a><ul><li><a id="rev:An-example-613425188" href="#An-example-613425188">An example</a></li></ul></li><li>5.1.4.5.2 <a id="rev:xhtml.nodes.cite" href="#xhtml.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2 <a id="rev:text" href="#text">Plain text</a></li><li>5.3 <a id="rev:latex" href="#latex">LaTeX (PDF)</a></li><li>5.4 <a id="rev:man" href="#man">UNIX manual page</a></li></ul></li><li>6 <a id="rev:History" href="#History">History</a><ul><li>6.1 <a id="rev:Version-6.1.0-2009-02-14" href="#Version-6.1.0-2009-02-14">Version 6.1.0 (2009-02-14)</a><ul><li><a id="rev:New-features" href="#New-features">New features</a></li><li><a id="rev:Bug-fixes" href="#Bug-fixes">Bug fixes</a></li><li><a id="rev:Housekeeping" href="#Housekeeping">Housekeeping</a></li></ul></li><li>6.2 <a id="rev:Version-6.0.1-2009-01-19" href="#Version-6.0.1-2009-01-19">Version 6.0.1 (2009-01-19)</a></li><li>6.3 <a id="rev:Version-6.0.0-2009-01-19" href="#Version-6.0.0-2009-01-19">Version 6.0.0 (2009-01-19)</a><ul><li><a id="rev:Incompatible-changes" href="#Incompatible-changes">Incompatible changes</a></li><li><a id="rev:New-features-613455288" href="#New-features-613455288">New features</a></li><li><a id="rev:Bug-fixes-613490318" href="#Bug-fixes-613490318">Bug fixes</a></li><li><a id="rev:Housekeeping-613510338" href="#Housekeeping-613510338">Housekeeping</a></li></ul></li><li>6.4 <a id="rev:Version-5.0.0-2008-11-22" href="#Version-5.0.0-2008-11-22">Version 5.0.0 (2008-11-22)</a><ul><li><a id="rev:Incompatible-changes-613551298" href="#Incompatible-changes-613551298">Incompatible changes</a></li><li><a id="rev:New-features-613563748" href="#New-features-613563748">New features</a></li><li><a id="rev:Bug-fixes-613575558" href="#Bug-fixes-613575558">Bug fixes</a></li><li><a id="rev:Housekeeping-612924428" href="#Housekeeping-612924428">Housekeeping</a></li></ul></li><li>6.5 <a id="rev:Version-4.0.0-2008-11-15" href="#Version-4.0.0-2008-11-15">Version 4.0.0 (2008-11-15)</a><ul><li><a id="rev:Contributor-kudos" href="#Contributor-kudos">Contributor kudos</a></li><li><a id="rev:Incompatible-changes-613060388" href="#Incompatible-changes-613060388">Incompatible changes</a></li><li><a id="rev:New-features-613094628" href="#New-features-613094628">New features</a></li><li><a id="rev:Housekeeping-613184078" href="#Housekeeping-613184078">Housekeeping</a></li></ul></li><li>6.6 <a id="rev:Version-3.1.0-2008-06-22" href="#Version-3.1.0-2008-06-22">Version 3.1.0 (2008-06-22)</a><ul><li><a id="rev:New-features-613336208" href="#New-features-613336208">New features</a></li><li><a id="rev:Bug-fixes-613365218" href="#Bug-fixes-613365218">Bug fixes</a></li><li><a id="rev:Housekeeping-613389138" href="#Housekeeping-613389138">Housekeeping</a></li></ul></li><li>6.7 <a id="rev:Version-3.0.2-2008-06-08" href="#Version-3.0.2-2008-06-08">Version 3.0.2 (2008-06-08)</a></li><li>6.8 <a id="rev:Version-3.0.1-2008-06-03" href="#Version-3.0.1-2008-06-03">Version 3.0.1 (2008-06-03)</a></li><li>6.9 <a id="rev:Version-3.0.0-2008-06-01" href="#Version-3.0.0-2008-06-01">Version 3.0.0 (2008-06-01)</a><ul><li><a id="rev:Incompatible-changes-613457568" href="#Incompatible-changes-613457568">Incompatible changes</a></li><li><a id="rev:Bug-fixes-613478758" href="#Bug-fixes-613478758">Bug fixes</a></li></ul></li><li>6.10 <a id="rev:Version-2.1.0-2008-05-29" href="#Version-2.1.0-2008-05-29">Version 2.1.0 (2008-05-29)</a></li><li>6.11 <a id="rev:Version-2.0.0-2008-02-03" href="#Version-2.0.0-2008-02-03">Version 2.0.0 (2008-02-03)</a><ul><li><a id="rev:Incompatible-changes-613565638" href="#Incompatible-changes-613565638">Incompatible changes</a></li><li><a id="rev:New-features-613589358" href="#New-features-613589358">New features</a></li><li><a id="rev:Bug-fixes-613601568" href="#Bug-fixes-613601568">Bug fixes</a></li><li><a id="rev:Housekeeping-613616318" href="#Housekeeping-613616318">Housekeeping</a></li></ul></li><li>6.12 <a id="rev:Version-1.1.0-2008-01-22" href="#Version-1.1.0-2008-01-22">Version 1.1.0 (2008-01-22)</a><ul><li><a id="rev:New-features-613634948" href="#New-features-613634948">New features</a></li><li><a id="rev:Bug-fixes-613645288" href="#Bug-fixes-613645288">Bug fixes</a></li></ul></li><li>6.13 <a id="rev:Version-1.0.0-2008-01-12" href="#Version-1.0.0-2008-01-12">Version 1.0.0 (2008-01-12)</a><ul><li><a id="rev:Incompatible-changes-612915118" href="#Incompatible-changes-612915118">Incompatible changes</a></li><li><a id="rev:Bug-fixes-612988718" href="#Bug-fixes-612988718">Bug fixes</a></li></ul></li><li>6.14 <a id="rev:Version-0.0.1-2007-12-13" href="#Version-0.0.1-2007-12-13">Version 0.0.1 (2007-12-13)</a></li><li>6.15 <a id="rev:Version-0.0.0-2007-12-09" href="#Version-0.0.0-2007-12-09">Version 0.0.0 (2007-12-09)</a></li></ul></li>
<li><a id="rev:References" href="#References">References</a></li>
</ul>
</div>
@@ -691,18 +691,18 @@
<h1 class="title">
Chapter 1
<br/>
<big>Introduction</big>
</h1>
- <div class="content"><p><p><strong>ERBook</strong> is an extensible document processor that emits <a class="xref" href="#HelloWorld" title="Section 3.2.3. Creating your own document format">any document you can imagine</a> from <a href='http://en.wikipedia.org/wiki/ERuby'>eRuby templates</a> that allow scripting and dynamic content generation.</p>
+ <div class="content"><p><p><strong>ERBook</strong> is an extensible document processor that emits <a class="xref" href="#HelloWorld" title="Section 3.2.3. "Creating your own document format"">any document you can imagine</a> from <a href='http://en.wikipedia.org/wiki/ERuby'>eRuby templates</a> that allow scripting and dynamic content generation.</p>
-<p>A working <a class="xref" href="#xhtml" title="Chapter 5.1. XHTML (web page)">XHTML (web page)</a> format is provided, while <a class="xref" href="#latex" title="Chapter 5.3. LaTeX (PDF)">LaTeX (PDF)</a>, <a class="xref" href="#man" title="Chapter 5.4. UNIX manual page">UNIX manual page</a>, and <a class="xref" href="#text" title="Chapter 5.2. Plain text">plain text</a> formats are planned… <a class="xref" href="#License" title="Section 1.2. License">patches are welcome</a>!</p> <strong>ERBook</strong> is exciting because:</p>
+<p>A working <a class="xref" href="#xhtml" title="Chapter 5.1. "XHTML (web page)"">XHTML (web page)</a> format is provided, while <a class="xref" href="#latex" title="Chapter 5.3. "LaTeX (PDF)"">LaTeX (PDF)</a>, <a class="xref" href="#man" title="Chapter 5.4. "UNIX manual page"">UNIX manual page</a>, and <a class="xref" href="#text" title="Chapter 5.2. "Plain text"">plain text</a> formats are planned… <a class="xref" href="#License" title="Section 1.2. "License"">patches are welcome</a>!</p> <strong>ERBook</strong> is exciting because:</p>
<ul>
<li>Its documents are scriptable <a href='http://en.wikipedia.org/wiki/ERuby'>eRuby templates</a>.</li>
-<li>It lets you <a class="xref" href="#HelloWorld" title="Section 3.2.3. Creating your own document format">define your own document formats</a>.</li>
+<li>It lets you <a class="xref" href="#HelloWorld" title="Section 3.2.3. "Creating your own document format"">define your own document formats</a>.</li>
<li>Its core contains less than 300 lines of code.</li>
</ul>
<p>These features distinguish <strong>ERBook</strong> from the competition, which offers neither scriptable documents nor definable document formats:</p>
@@ -725,18 +725,18 @@
<a name="Logistics"/><div class="nav" id="Logistics"><a title="Reverse jump to listing" href="#rev:Logistics">≡</a><a title="Jump to previous segment" href="#Introduction">△</a><a title="Jump to next segment" href="#Version-numbers">▽</a><a title="Jump to this segment" href="#Logistics">◎</a></div>
<h2 class="title">
1.1 Logistics
</h2>
<div class="content"><ul>
-<li><a class="xref" href="#history" title="Chapter 6. Project history">Release notes</a> — history of project releases.</li>
+<li><a class="xref" href="#History" title="Chapter 6. "History"">Release notes</a> — history of project releases.</li>
<li><a href='http://github.com/sunaku/erbook'>Source code</a> — obtain via <a href='http://git.or.cz'>Git</a> or browse online.</li>
<li><a href='api/index.html'>API reference</a> — documentation for source code.</li>
</ul>
-<p>To get help or provide feedback, simply <a class="xref" href="#License" title="Section 1.2. License">contact the authors</a>.</p>
+<p>To get help or provide feedback, simply <a class="xref" href="#License" title="Section 1.2. "License"">contact the authors</a>.</p>
<p><div class="paragraph">
<a name="Version-numbers"/><div class="nav" id="Version-numbers"><a title="Reverse jump to listing" href="#rev:Version-numbers">≡</a><a title="Jump to previous segment" href="#Logistics">△</a><a title="Jump to next segment" href="#License">▽</a><a title="Jump to this segment" href="#Version-numbers">◎</a></div>
<p class="title">Version numbers</p>
<div class="content"><p><strong>ERBook</strong> releases are numbered in <em>major.minor.patch</em> form according to the <a href='http://www.rubygems.org/read/chapter/7'>RubyGems rational versioning policy</a>, which can be summarized thus:</p>
@@ -777,37 +777,55 @@
</div> <div class="section">
<a name="License"/><div class="nav" id="License"><a title="Reverse jump to listing" href="#rev:License">≡</a><a title="Jump to previous segment" href="#Version-numbers">△</a><a title="Jump to next segment" href="#Credits">▽</a><a title="Jump to this segment" href="#License">◎</a></div>
<h2 class="title">
1.2 License
</h2>
- <div class="content"><p>Copyright 2006 Suraj N. Kurapati <a href='mailto:sunaku@gmail.com'>sunaku@gmail.com</a></p>
+ <div class="content"><p>(the ISC license)</p>
+<p>Copyright 2006 Suraj N. Kurapati <a href='mailto:sunaku@gmail.com'>sunaku@gmail.com</a></p>
+
<p>Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</p></div>
</div> <div class="section">
<a name="Credits"/><div class="nav" id="Credits"><a title="Reverse jump to listing" href="#rev:Credits">≡</a><a title="Jump to previous segment" href="#License">△</a><a title="Jump to next segment" href="#Reviews">▽</a><a title="Jump to this segment" href="#Credits">◎</a></div>
<h2 class="title">
1.3 Credits
</h2>
- <div class="content"><img src='erbook.png' alt='ERBook logo' />
-<p>The “erbook.png” image and its “erbook.svg” source utilize the <a href='http://openclipart.org/media/files/lemmling/9065'>“cartoon owl sitting on a book”</a> graphic, which was created and released into the public domain by <a href='http://openclipart.org/media/people/lemmling'>Jens Vierbuchen</a> on July 7, 2008.</p></div>
+ <div class="content"><a href='#Credits' class='xref' title='Section 1.3. "Credits"'><img src='erbook.png' alt='ERBook logo' /></a>
+<p>The “erbook.png” image and its “erbook.svg” source utilize the <a href='http://openclipart.org/media/files/lemmling/9065'>“cartoon owl sitting on a book”</a> graphic, which was created and released into the public domain by <a href='http://openclipart.org/media/people/lemmling'>Jens Vierbuchen</a> on July 7, 2008.</p>
+
+<p><strong>ERBook</strong> is made possible by <a class="xref" href="#History" title="Chapter 6. "History"">contributions</a> from users like you:</p>
+
+<ul>
+<li>Jens Vierbuchen</li>
+
+<li>Maunika Gosike</li>
+
+<li><a href='http://lifegoo.pluskid.org'>Zhang Chiyuan</a></li>
+</ul></div>
</div> <div class="section">
<a name="Reviews"/><div class="nav" id="Reviews"><a title="Reverse jump to listing" href="#rev:Reviews">≡</a><a title="Jump to previous segment" href="#Credits">△</a><a title="Jump to next segment" href="#Setup">▽</a><a title="Jump to this segment" href="#Reviews">◎</a></div>
<h2 class="title">
1.4 Reviews
</h2>
- <div class="content"><p>Vitor Peres in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052'>ruby-talk</a>:</p>
+ <div class="content"><p>Tom Cloyd in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/327499'>ruby-talk</a>:</p>
<blockquote>
+<p>This documentation is simply gorgeous!</p>
+</blockquote>
+
+<p>Vitor Peres in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052'>ruby-talk</a>:</p>
+
+<blockquote>
<p>I actually felt like printing [this manual], because it’s just so well-thought typographically… Even if [<strong>ERBook</strong>] weren’t great by itself, I’d feel good just looking at the manual.</p>
</blockquote>
<p>Ara T. Howard in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/282949'>ruby-talk</a>:</p>
<blockquote>
-<p>[this manual is] a insanely complete and nice looking bit of documentation [… <strong>ERBook</strong>] looks like a great project</p>
+<p>[This manual is] a insanely complete and nice looking bit of documentation [… <strong>ERBook</strong>] looks like a great project</p>
</blockquote>
<p>Martin DeMello in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283304'>ruby-talk</a>:</p>
<blockquote>
@@ -845,16 +863,16 @@
<pre>erbook -v</pre>
<p>If the installation was successful, you will see output like this:</p>
<p><pre>project: ERBook
-version: 6.0.1
-release: 2009-01-19
+version: 6.1.0
+release: 2009-02-14
website: http://snk.tuxfamily.org/lib/erbook/
install: /home/sun/src/erbook</pre></p>
-<p>Otherwise, you can <a class="xref" href="#License" title="Section 1.2. License">contact the author</a> for help.</p></div>
+<p>Otherwise, you can <a class="xref" href="#License" title="Section 1.2. "License"">contact the author</a> for help.</p></div>
</div> <div class="section">
<a name="Manifest"/><div class="nav" id="Manifest"><a title="Reverse jump to listing" href="#rev:Manifest">≡</a><a title="Jump to previous segment" href="#Installation">△</a><a title="Jump to next segment" href="#Theory-of-operation">▽</a><a title="Jump to this segment" href="#Manifest">◎</a></div>
<h2 class="title">
2.3 Manifest
</h2>
@@ -870,11 +888,11 @@
<li><tt>erbook</tt> — the main <strong>ERBook</strong> executable.</li>
</ul>
</li>
<li>
-<p><tt>fmt/</tt> — contains the predefined set of <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">format specification files</a>. If you ever need to install your custom format specification file globally, then put it inside this directory.</p>
+<p><tt>fmt/</tt> — contains the predefined set of <a class="xref" href="#SpecFile" title="Section 3.2. "Format specification file"">format specification files</a>. If you ever need to install your custom format specification file globally, then put it inside this directory.</p>
</li>
<li>
<p><tt>latex.yaml</tt> — high-quality typesetting</p>
</li>
@@ -902,11 +920,11 @@
<li>
<p><tt>erbook/</tt></p>
<ul>
<li>
-<p><tt>to_xhtml.rb</tt> — provides methods (see <a class="xref" href="#Text-to-XHTML-conversion">Section 5.1.1. Text to XHTML conversion</a>) for the <a class="xref" href="#xhtml">Chapter 5.1. XHTML (web page)</a> format.</p>
+<p><tt>to_xhtml.rb</tt> — provides methods (see <a class="xref" href="#Text-to-XHTML-conversion">Section 5.1.1. “Text to XHTML conversion”</a>) for the <a class="xref" href="#xhtml">Chapter 5.1. “XHTML (web page)”</a> format.</p>
</li>
<li>
<p><tt>rdoc.rb</tt> — provides RDoc parse trees to Ruby code.</p>
</li>
@@ -948,11 +966,11 @@
</h1>
<div class="content"><p>When you run ERBook, it does the following:</p>
<ol>
<li>
-<p>Loads the <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">format specification file</a>.</p>
+<p>Loads the <a class="xref" href="#SpecFile" title="Section 3.2. "Format specification file"">format specification file</a>.</p>
</li>
<li>
<p>Creates an <strong>input document</strong> by:</p>
@@ -960,31 +978,31 @@
<li>
<p>Reading the input (the content of either the input file or the standard input stream) into memory.</p>
</li>
<li>
-<p>Evaluating <a class="xref" href="#include" title="Section 4.2. Including external documents">include directives</a> in the input.</p>
+<p>Evaluating <a class="xref" href="#include" title="Section 4.2. "Including external documents"">include directives</a> in the input.</p>
</li>
</ul>
</li>
<li>
<p>Transforms the input document into a <strong>processed document</strong> by:</p>
<ul>
<li>
-<p>Building a <strong>document tree</strong> data structure from <a class="xref" href="#Nodes" title="Section 3.1. Nodes">nodes</a> present in the input document.</p>
+<p>Building a <strong>document tree</strong> data structure from <a class="xref" href="#Nodes" title="Section 3.1. "Nodes"">nodes</a> present in the input document.</p>
</li>
<li>
-<p>Replacing every node in the input document with the result of its <a class="xref" href="#SpecFile.nodes.output" title="Section 3.2.1.1. Node output template">node output template</a>.</p>
+<p>Replacing every node in the input document with the result of its <a class="xref" href="#SpecFile.nodes.output" title="Section 3.2.1.1. "Node output template"">node output template</a>.</p>
</li>
</ul>
</li>
<li>
-<p>Transforms the processed document into an <strong>output document</strong> according to the <a class="xref" href="#SpecFile.output" title="Section 3.2.2. Document output template">document output template</a>.</p>
+<p>Transforms the processed document into an <strong>output document</strong> according to the <a class="xref" href="#SpecFile.output" title="Section 3.2.2. "Document output template"">document output template</a>.</p>
</li>
<li>
<p>Prints the output document to the standard output stream.</p>
</li>
@@ -1031,13 +1049,13 @@
<p>Technically, nodes are Ruby method invocations composed of the following:</p>
<table border="1"><thead><tr><th>Component</th><th>Description</th></tr></thead><tbody><tr><td style='text-align: left;'><code class="code">node_type</code></td><td style='text-align: left;'>name of the method being invoked</td>
</tr><tr><td style='text-align: left;'><code class="code">node_argument1, node_argument2, ...</code></td><td style='text-align: left;'>arguments for the method invocation</td>
</tr><tr><td style='text-align: left;'><code class="code">node_content</code></td><td style='text-align: left;'>a block argument being passed to the method invocation</td>
-</tr><tr><td style='text-align: left;'><code class="code">node_object</code></td><td style='text-align: left;'>a <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> object (see <a class="xref" href="#Node.class">Section 3.1.1. The <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> class</a>) representing this method invocation</td>
+</tr><tr><td style='text-align: left;'><code class="code">node_object</code></td><td style='text-align: left;'>a <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> object (see <a class="xref" href="#Node.class">Section 3.1.1. “The <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> class”</a>) representing this method invocation</td>
</tr></tbody></table>
-<p>A <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">format specification file</a> defines what types of nodes an input document may use.</p>
+<p>A <a class="xref" href="#SpecFile" title="Section 3.2. "Format specification file"">format specification file</a> defines what types of nodes an input document may use.</p>
<p><div class="section">
<a name="Node.class"/><div class="nav" id="Node.class"><a title="Reverse jump to listing" href="#rev:Node.class">≡</a><a title="Jump to previous segment" href="#Nodes">△</a><a title="Jump to next segment" href="#SpecFile">▽</a><a title="Jump to this segment" href="#Node.class">◎</a></div>
<h3 class="title">
3.1.1 The <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Node</span></code> class
@@ -1063,23 +1081,23 @@
3.2 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"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td style='text-align: left;'>desc</td><td style='text-align: left;'><code class="code"><span style="color:#036;font-weight:bold">String</span></code></td><td style='text-align: left;'>A short description of the output format.</td>
</tr><tr><td style='text-align: left;'>code</td><td style='text-align: left;'><code class="code"><span style="color:#036;font-weight:bold">String</span></code></td><td style='text-align: left;'>Ruby code that will be loaded before the input document is processed. This source code will be evaluated inside the main ERBook executable, so any file-system or path-dependent portions of this source code should take appropriate precautions.</td>
-</tr><tr><td style='text-align: left;'>nodes</td><td style='text-align: left;'>Hash</td><td style='text-align: left;'>A listing of <a class="xref" href="#SpecFile.nodes" title="Section 3.2.1. Node definition">node definitions</a>.</td>
-</tr><tr><td style='text-align: left;'>output</td><td style='text-align: left;'><code class="code"><span style="color:#036;font-weight:bold">String</span></code></td><td style='text-align: left;'>An eRuby template for the final output document. See <a class="xref" href="#SpecFile.output">Section 3.2.2. Document output template</a>.</td>
+</tr><tr><td style='text-align: left;'>nodes</td><td style='text-align: left;'>Hash</td><td style='text-align: left;'>A listing of <a class="xref" href="#SpecFile.nodes" title="Section 3.2.1. "Node definition"">node definitions</a>.</td>
+</tr><tr><td style='text-align: left;'>output</td><td style='text-align: left;'><code class="code"><span style="color:#036;font-weight:bold">String</span></code></td><td style='text-align: left;'>An eRuby template for the final output document. See <a class="xref" href="#SpecFile.output">Section 3.2.2. “Document output template”</a>.</td>
</tr></tbody></table>
<p><div class="section">
<a name="SpecFile.nodes"/><div class="nav" id="SpecFile.nodes"><a title="Reverse jump to listing" href="#rev:SpecFile.nodes">≡</a><a title="Jump to previous segment" href="#SpecFile">△</a><a title="Jump to next segment" href="#SpecFile.nodes.output">▽</a><a title="Jump to this segment" href="#SpecFile.nodes">◎</a></div>
<h3 class="title">
3.2.1 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"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td style='text-align: left;'>index</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Assign a LaTeX-style section number to this node?</td>
</tr><tr><td style='text-align: left;'>number</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Assign an order-of-occurrence number to this node?</td>
</tr><tr><td style='text-align: left;'>silent</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Suppress the output of this node?</td>
-</tr><tr><td style='text-align: left;'>output</td><td style='text-align: left;'><code class="code"><span style="color:#036;font-weight:bold">String</span></code></td><td style='text-align: left;'>An eRuby template for the content of this node. See <a class="xref" href="#SpecFile.nodes.output">Section 3.2.1.1. Node output template</a>.</td>
+</tr><tr><td style='text-align: left;'>output</td><td style='text-align: left;'><code class="code"><span style="color:#036;font-weight:bold">String</span></code></td><td style='text-align: left;'>An eRuby template for the content of this node. See <a class="xref" href="#SpecFile.nodes.output">Section 3.2.1.1. “Node output template”</a>.</td>
</tr><tr><td style='text-align: left;'>inline</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Is node’s output an in-line string of text that can be embedded anywhere in the document?</td>
</tr></tbody></table>
<p>You may define additional parameters in a node definition if you want.</p>
<p><div class="section">
@@ -1126,27 +1144,27 @@
</h3>
<div class="content"><p>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:</p>
<ul>
<li>
-<p>We define a <code class="code">generate_name()</code> method in <a class="xref" href="#HelloWorld.spec">Example 1. HelloWorld format specification file</a> and make use of it in the <a class="xref" href="#HelloWorld.input">Example 2. Input document for HelloWorld format</a>. This shows how to provide format-specific functionality to an input document.</p>
+<p>We define a <code class="code">generate_name()</code> method in <a class="xref" href="#HelloWorld.spec">Example 1. “HelloWorld format specification file”</a> and make use of it in the <a class="xref" href="#HelloWorld.input">Example 2. “Input document for HelloWorld format”</a>. This shows how to provide format-specific functionality to an input document.</p>
</li>
<li>
-<p>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. Input document for HelloWorld format</a> and make use of it in <a class="xref" href="#HelloWorld.spec">Example 1. HelloWorld format specification file</a>. This shows how to pass parameters from an input document to your format specification file.</p>
+<p>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. “Input document for HelloWorld format”</a> and make use of it in <a class="xref" href="#HelloWorld.spec">Example 1. “HelloWorld format specification file”</a>. This shows how to pass parameters from an input document to your format specification file.</p>
</li>
</ul>
<p>To run this example:</p>
<ol>
<li>
-<p>Save the code shown in <a class="xref" href="#HelloWorld.spec">Example 1. HelloWorld format specification file</a> to a file named <tt>HelloWorld.spec</tt></p>
+<p>Save the code shown in <a class="xref" href="#HelloWorld.spec">Example 1. “HelloWorld format specification file”</a> to a file named <tt>HelloWorld.spec</tt></p>
</li>
<li>
-<p>Save the text shown in <a class="xref" href="#HelloWorld.input">Example 2. Input document for HelloWorld format</a> to a file named <tt>HelloWorld.input</tt></p>
+<p>Save the text shown in <a class="xref" href="#HelloWorld.input">Example 2. “Input document for HelloWorld format”</a> to a file named <tt>HelloWorld.input</tt></p>
</li>
<li>
<p>Run this command:</p>
@@ -1313,11 +1331,11 @@
My name is nil and these are my properties:
<dl style='border-left: thick dotted LightGrey; padding-left: 1em;'>
<dt>args</dt>
- <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">Hopeful</span><span style="color:#710">"</span></span>, <span style="color:#60E;font-weight:bold">0.129688166237699</span>]</code></dd>
+ <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">Hopeful</span><span style="color:#710">"</span></span>, <span style="color:#60E;font-weight:bold">0.737155765329912</span>]</code></dd>
<dt>index</dt>
<dd><code class="code"><span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">1.1.1</span><span style="color:#710">"</span></span></code></dd>
<dt>number</dt>
@@ -1335,11 +1353,11 @@
My name is nil and these are my properties:
<dl style='border-left: thick dotted LightGrey; padding-left: 1em;'>
<dt>args</dt>
- <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">Confused</span><span style="color:#710">"</span></span>, <span style="color:#60E;font-weight:bold">0.0535821548187691</span>]</code></dd>
+ <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">Confused</span><span style="color:#710">"</span></span>, <span style="color:#60E;font-weight:bold">0.444444669437529</span>]</code></dd>
<dt>index</dt>
<dd><code class="code"><span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">1.1.1.1</span><span style="color:#710">"</span></span></code></dd>
<dt>number</dt>
@@ -1384,11 +1402,11 @@
My name is nil and these are my properties:
<dl style='border-left: thick dotted LightGrey; padding-left: 1em;'>
<dt>args</dt>
- <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">Sleepy</span><span style="color:#710">"</span></span>, <span style="color:#036;font-weight:bold">Mon</span> <span style="color:#036;font-weight:bold">Jan</span> <span style="color:#00D;font-weight:bold">19</span> <span style="color:#00D;font-weight:bold">12</span>:<span style="color:#00D;font-weight:bold">56</span>:<span style="color:#00D;font-weight:bold">00</span> -<span style="color:#00D;font-weight:bold">0800</span> <span style="color:#00D;font-weight:bold">2009</span>]</code></dd>
+ <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">Sleepy</span><span style="color:#710">"</span></span>, <span style="color:#036;font-weight:bold">Sat</span> <span style="color:#036;font-weight:bold">Feb</span> <span style="color:#00D;font-weight:bold">14</span> <span style="color:#00D;font-weight:bold">16</span>:<span style="color:#00D;font-weight:bold">53</span>:<span style="color:#00D;font-weight:bold">25</span> -<span style="color:#00D;font-weight:bold">0800</span> <span style="color:#00D;font-weight:bold">2009</span>]</code></dd>
<dt>index</dt>
<dd><code class="code"><span style="background-color:#fff0f0;color:#D20"><span style="color:#710">"</span><span style="">1.2</span><span style="color:#710">"</span></span></code></dd>
<dt>number</dt>
@@ -1512,45 +1530,46 @@
* If an error occurs, the input document will be written to the standard
output stream, so that you can investigate line numbers in the error.
Usage:
- erbook [Option...] FormatName [InputFile]
- erbook [Option...] FormatFile [InputFile]
+ erbook [Options] FormatName [InputFile]
+ erbook [Options] FormatFile [InputFile]
FormatName:
- latex: high-quality typesetting
- man: manual page for UNIX
- xhtml: web page for the Internet
- text: plain text, nothing fancy
+ latex: high-quality typesetting
+ man: manual page for UNIX
+ xhtml: web page for the Internet
+ text: plain text, nothing fancy
-Option:
- --unindent, -u: Unindent node content hierarchically
- --manual, -m: Show the user manual
- --version, -v: Print version and exit
- --help, -h: Show this message</pre></p>
+Options:
+ --unindent, -u: Unindent node content hierarchically
+ --manual, -m: Show the user manual
+ --locale, -l <s>: Set preferred language
+ --version, -v: Print version and exit
+ --help, -h: Show this message</pre></p>
-<p>The first command-line argument to erbook is either the name of a predefined format (FormatName) or the path to a <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">format specification file</a> (FormatFile).</p>
+<p>The first command-line argument to <strong>ERBook</strong> is either the name of a predefined format (FormatName) or the path to a <a class="xref" href="#SpecFile" title="Section 3.2. "Format specification file"">format specification file</a> (FormatFile).</p>
-<p>Predefined formats are simply short-hand names of format specification files located in the <tt>fmt/</tt> subdirectory of the erbook installation directory (see <a class="xref" href="#Manifest">Section 2.3. Manifest</a>).</p>
+<p>Predefined formats are simply short-hand names of format specification files located in the <tt>fmt/</tt> subdirectory of the <strong>ERBook</strong> installation directory (see <a class="xref" href="#Manifest">Section 2.3. “Manifest”</a>).</p>
<p><div class="section">
<a name="Saving-the-output-to-a-file"/><div class="nav" id="Saving-the-output-to-a-file"><a title="Reverse jump to listing" href="#rev:Saving-the-output-to-a-file">≡</a><a title="Jump to previous segment" href="#Command-line-interface">△</a><a title="Jump to next segment" href="#Save-XHTML-output-as-.xhtml">▽</a><a title="Jump to this segment" href="#Saving-the-output-to-a-file">◎</a></div>
<h3 class="title">
4.1.1 Saving the output to a file
</h3>
<div class="content"><p>Simply redirect the standard ouput stream (STDOUT) to a file like this:</p>
<pre>erbook > YOUR_PATH_HERE</pre>
-<p>In the above example, <strong>YOUR_PATH_HERE</strong> is the path of the file in which the output should be saved.</p>
+<p>In the above example, <em>YOUR_PATH_HERE</em> is the path of the file in which the output should be saved.</p>
<p><div class="important">
<a name="Save-XHTML-output-as-.xhtml"/><div class="nav" id="Save-XHTML-output-as-.xhtml"><a title="Reverse jump to listing" href="#rev:Save-XHTML-output-as-.xhtml">≡</a><a title="Jump to previous segment" href="#Saving-the-output-to-a-file">△</a><a title="Jump to next segment" href="#include">▽</a><a title="Jump to this segment" href="#Save-XHTML-output-as-.xhtml">◎</a></div>
<p class="title">Important 1. Save XHTML output as <tt>.xhtml</tt></p>
<div class="content">
- <img class="icon" alt="important" src="&icon_important;"/>
+ <img alt="important" class="icon" src="&icon_important;"/>
<p>When you use the XHTML format, ensure that the file extension of your saved output document is either <tt>.xhtml</tt> or <tt>.xml</tt>. Alternatively, ensure that your saved output document is served to web browsers under the <tt>application/xhtml+xml</tt> mime type.</p>
<p>Otherwise, most web browsers <em>will not display</em> the icons and graphics embedded in the saved XHTML output document because they will treat it as HTML instead of as XML. See <a href='http://www.quirksmode.org/bugreports/archives/2005/02/custom_dtds_int_1.html'>this QuirksMode.org bug report</a> for details.</p>
</div>
</div></p></div>
@@ -1562,33 +1581,33 @@
</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><%# include YOUR_PATH_HERE #%></pre>
-<p>In the above example, <strong>YOUR_PATH_HERE</strong> is the path of the file whose content you wish to insert into the input document.</p>
+<p>In the above example, <em>YOUR_PATH_HERE</em> is the path of the file whose content you wish to insert into the input document.</p>
<p>You can divide a large document into separate files for easier editing and stitch them together, dynamically, into a single document using the <strong>include</strong> directive.</p></div>
</div> <div class="section">
<a name="Unindenting-nodes-hierarchically"/><div class="nav" id="Unindenting-nodes-hierarchically"><a title="Reverse jump to listing" href="#rev:Unindenting-nodes-hierarchically">≡</a><a title="Jump to previous segment" href="#include">△</a><a title="Jump to next segment" href="#Formats">▽</a><a title="Jump to this segment" href="#Unindenting-nodes-hierarchically">◎</a></div>
<h2 class="title">
4.3 Unindenting nodes hierarchically
</h2>
- <div class="content"><p>When writing erbook documents, I prefer to indent the content of nodes according to their depth because my <a href='http://jedit.org'>text editor of choice</a> automatically folds blocks of text based on indentation.</p>
+ <div class="content"><p>When writing <strong>ERBook</strong> documents, I prefer to indent the content of nodes according to their depth because my <a href='http://jedit.org'>text editor of choice</a> automatically folds blocks of text based on indentation.</p>
-<p>If you also prefer to write documents in this way, be sure to pass the <tt>--unindent</tt> option to <strong>erbook</strong> so that the indentation will not affect the resulting output.</p></div>
+<p>If you also prefer to write documents in this way, be sure to pass the <tt>--unindent</tt> option to <strong>ERBook</strong> so that the indentation will not affect the resulting output.</p></div>
</div></p></div>
</div>
<div class="part">
<a name="Formats"/><div class="nav" id="Formats"><a title="Reverse jump to listing" href="#rev:Formats">≡</a><a title="Jump to previous segment" href="#Unindenting-nodes-hierarchically">△</a><a title="Jump to next segment" href="#xhtml">▽</a><a title="Jump to this segment" href="#Formats">◎</a></div>
<h1 class="title">
Part 5
<br/>
<big>Formats</big>
</h1>
- <div class="content"><p>This part describes the default formats provided along with ERBook. The <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">format specification files</a> for these formats can be found in the <tt>fmt/</tt> directory of the ERBook installation directory (see <a class="xref" href="#Manifest">Section 2.3. Manifest</a>).</p>
+ <div class="content"><p>This part describes the default formats provided along with ERBook. The <a class="xref" href="#SpecFile" title="Section 3.2. "Format specification file"">format specification files</a> for these formats can be found in the <tt>fmt/</tt> directory of the ERBook installation directory (see <a class="xref" href="#Manifest">Section 2.3. “Manifest”</a>).</p>
-<p>These formats are meant to serve as working examples. If you require more functionality from one of these formats, simply make a copy of the corresponding format specification file and edit the copy to suit your needs. If you would like to contribute or discuss your enhancements to these default formats, you can <a class="xref" href="#License" title="Section 1.2. License">contact the author</a>.</p>
+<p>These formats are meant to serve as working examples. If you require more functionality from one of these formats, simply make a copy of the corresponding format specification file and edit the copy to suit your needs. If you would like to contribute or discuss your enhancements to these default formats, you can <a class="xref" href="#License" title="Section 1.2. "License"">contact the author</a>.</p>
<p><div class="chapter">
<a name="xhtml"/><div class="nav" id="xhtml"><a title="Reverse jump to listing" href="#rev:xhtml">≡</a><a title="Jump to previous segment" href="#Formats">△</a><a title="Jump to next segment" href="#Text-to-XHTML-conversion">▽</a><a title="Jump to this segment" href="#xhtml">◎</a></div>
<h1 class="title">
Chapter 5.1
@@ -1604,11 +1623,11 @@
<p><div class="section">
<a name="Text-to-XHTML-conversion"/><div class="nav" id="Text-to-XHTML-conversion"><a title="Reverse jump to listing" href="#rev:Text-to-XHTML-conversion">≡</a><a title="Jump to previous segment" href="#xhtml">△</a><a title="Jump to next segment" href="#Syntax-coloring-for-source-code">▽</a><a title="Jump to this segment" href="#Text-to-XHTML-conversion">◎</a></div>
<h3 class="title">
5.1.1 Text to XHTML conversion
</h3>
- <div class="content"><p>The <tt>lib/erbook/to_xhtml.rb</tt> file inside ERBook’s installation directory (see <a class="xref" href="#Manifest">Section 2.3. Manifest</a>) defines the following methods:</p>
+ <div class="content"><p>The <tt>lib/erbook/to_xhtml.rb</tt> file inside ERBook’s installation directory (see <a class="xref" href="#Manifest">Section 2.3. “Manifest”</a>) defines the following methods:</p>
<ul>
<li>
<p><code class="code"><span style="color:#036;font-weight:bold">String</span><span style="color:#666">#to_xhtml</span></code> - Transforms this string into XHTML while ensuring that the result contains one or more block-level elements at the root.</p>
</li>
@@ -1946,13 +1965,13 @@
<li>a required <em>title</em> for the node</li>
<li>an optional <em>unique identifier</em> for the node</li>
</ol>
-<p>The second argument is used by the cross-referencing nodes (see <a class="xref" href="#xhtml.nodes.xref">Section 5.1.4.1.4. xref</a> and <a class="xref" href="#xhtml.nodes.cite">Section 5.1.4.5.2. cite</a>), which allow you to refer to another node in the document by its unique identifier.</p>
+<p>The second argument is used by the cross-referencing nodes (see <a class="xref" href="#xhtml.nodes.xref">Section 5.1.4.1.4. “xref”</a> and <a class="xref" href="#xhtml.nodes.cite">Section 5.1.4.5.2. “cite”</a>), which allow you to refer to another node in the document by its unique identifier.</p>
-<p>Furthermore, <a class="xref" href="#SpecFile.nodes" title="Section 3.2.1. Node definition">node definitions</a> in the XHTML format have two additional parameters:</p>
+<p>Furthermore, <a class="xref" href="#SpecFile.nodes" title="Section 3.2.1. "Node definition"">node definitions</a> in the XHTML format have two additional parameters:</p>
<table border="1"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td style='text-align: left;'>toc</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Include this node in the <strong>Table of Contents</strong> (TOC)?</td>
</tr><tr><td style='text-align: left;'>lof</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Include this node in the <strong>List of Figures</strong> (LOF)?</td>
</tr></tbody></table>
<p><div class="section">
<a name="Structural-nodes"/><div class="nav" id="Structural-nodes"><a title="Reverse jump to listing" href="#rev:Structural-nodes">≡</a><a title="Jump to previous segment" href="#xhtml.nodes">△</a><a title="Jump to next segment" href="#xhtml.nodes.header">▽</a><a title="Jump to this segment" href="#Structural-nodes">◎</a></div>
@@ -1992,17 +2011,17 @@
<p>For example, this node in the input document:</p>
<pre><%= xref "SpecFile" %></pre>
-<p>appears in the output document like this: <a class="xref" href="#SpecFile">Section 3.2. Format specification file</a>.</p>
+<p>appears in the output document like this: <a class="xref" href="#SpecFile">Section 3.2. “Format specification file”</a>.</p>
<p>As another example, this node in the input document:</p>
<pre><%= xref "SpecFile", "custom link text" %></pre>
-<p>appears in the output document like this: <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">custom link text</a>.</p></div>
+<p>appears in the output document like this: <a class="xref" href="#SpecFile" title="Section 3.2. "Format specification file"">custom link text</a>.</p></div>
</div></p></div>
</div> <div class="section">
<a name="Organizational-nodes"/><div class="nav" id="Organizational-nodes"><a title="Reverse jump to listing" href="#rev:Organizational-nodes">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.xref">△</a><a title="Jump to next segment" href="#xhtml.nodes.node">▽</a><a title="Jump to this segment" href="#Organizational-nodes">◎</a></div>
<h4 class="title">
5.1.4.2 Organizational nodes
@@ -2064,109 +2083,109 @@
5.1.4.2.4.1 An example
</h6>
<div class="content"><p>This is how a <strong>section</strong> node appears.</p></div>
</div></p></div>
</div> <div class="section">
- <a name="xhtml.nodes.paragraph"/><div class="nav" id="xhtml.nodes.paragraph"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.paragraph">≡</a><a title="Jump to previous segment" href="#An-example-5.1.4.2.4.1">△</a><a title="Jump to next segment" href="#An-example-609366268">▽</a><a title="Jump to this segment" href="#xhtml.nodes.paragraph">◎</a></div>
+ <a name="xhtml.nodes.paragraph"/><div class="nav" id="xhtml.nodes.paragraph"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.paragraph">≡</a><a title="Jump to previous segment" href="#An-example-5.1.4.2.4.1">△</a><a title="Jump to next segment" href="#An-example-613122798">▽</a><a title="Jump to this segment" href="#xhtml.nodes.paragraph">◎</a></div>
<h5 class="title">
5.1.4.2.5 paragraph
</h5>
<div class="content"><p>A collection of sentences about a particular idea.</p>
<p><div class="paragraph">
- <a name="An-example-609366268"/><div class="nav" id="An-example-609366268"><a title="Reverse jump to listing" href="#rev:An-example-609366268">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.paragraph">△</a><a title="Jump to next segment" href="#Admonition-nodes">▽</a><a title="Jump to this segment" href="#An-example-609366268">◎</a></div>
+ <a name="An-example-613122798"/><div class="nav" id="An-example-613122798"><a title="Reverse jump to listing" href="#rev:An-example-613122798">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.paragraph">△</a><a title="Jump to next segment" href="#Admonition-nodes">▽</a><a title="Jump to this segment" href="#An-example-613122798">◎</a></div>
<p class="title">An example</p>
<div class="content"><p>This is how a <strong>paragraph</strong> node appears. Notice that there is no LaTeX-style index number in the heading of this <strong>paragraph</strong> node.</p></div>
</div></p></div>
</div></p></div>
</div> <div class="section">
- <a name="Admonition-nodes"/><div class="nav" id="Admonition-nodes"><a title="Reverse jump to listing" href="#rev:Admonition-nodes">≡</a><a title="Jump to previous segment" href="#An-example-609366268">△</a><a title="Jump to next segment" href="#xhtml.nodes.warning">▽</a><a title="Jump to this segment" href="#Admonition-nodes">◎</a></div>
+ <a name="Admonition-nodes"/><div class="nav" id="Admonition-nodes"><a title="Reverse jump to listing" href="#rev:Admonition-nodes">≡</a><a title="Jump to previous segment" href="#An-example-613122798">△</a><a title="Jump to next segment" href="#xhtml.nodes.warning">▽</a><a title="Jump to this segment" href="#Admonition-nodes">◎</a></div>
<h4 class="title">
5.1.4.3 Admonition nodes
</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>I like to follow the KDE guidelines<sup>[<a class="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup> when determining which admonition to use in my documents.</p>
<p> <div class="section">
<a name="xhtml.nodes.warning"/><div class="nav" id="xhtml.nodes.warning"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.warning">≡</a><a title="Jump to previous segment" href="#Admonition-nodes">△</a><a title="Jump to next segment" href="#An-example-1">▽</a><a title="Jump to this segment" href="#xhtml.nodes.warning">◎</a></div>
<h5 class="title">
5.1.4.3.1 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>
+ <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="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
<p><div class="warning">
<a name="An-example-1"/><div class="nav" id="An-example-1"><a title="Reverse jump to listing" href="#rev:An-example-1">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.warning">△</a><a title="Jump to next segment" href="#xhtml.nodes.caution">▽</a><a title="Jump to this segment" href="#An-example-1">◎</a></div>
<p class="title">Warning 1. An example</p>
<div class="content">
- <img class="icon" alt="warning" src="&icon_warning;"/>
+ <img alt="warning" class="icon" src="&icon_warning;"/>
<p>This is how a <strong>warning</strong> node appears.</p>
</div>
</div></p></div>
</div> <div class="section">
<a name="xhtml.nodes.caution"/><div class="nav" id="xhtml.nodes.caution"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.caution">≡</a><a title="Jump to previous segment" href="#An-example-1">△</a><a title="Jump to next segment" href="#An-example-1-1">▽</a><a title="Jump to this segment" href="#xhtml.nodes.caution">◎</a></div>
<h5 class="title">
5.1.4.3.2 caution
</h5>
- <div class="content"><p>bq. 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>
+ <div class="content"><p>bq. 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="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
<p><div class="caution">
<a name="An-example-1-1"/><div class="nav" id="An-example-1-1"><a title="Reverse jump to listing" href="#rev:An-example-1-1">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.caution">△</a><a title="Jump to next segment" href="#xhtml.nodes.important">▽</a><a title="Jump to this segment" href="#An-example-1-1">◎</a></div>
<p class="title">Caution 1. An example</p>
<div class="content">
- <img class="icon" alt="caution" src="&icon_caution;"/>
+ <img alt="caution" class="icon" src="&icon_caution;"/>
<p>This is how a <strong>caution</strong> node appears.</p>
</div>
</div></p></div>
</div> <div class="section">
<a name="xhtml.nodes.important"/><div class="nav" id="xhtml.nodes.important"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.important">≡</a><a title="Jump to previous segment" href="#An-example-1-1">△</a><a title="Jump to next segment" href="#An-example-2">▽</a><a title="Jump to this segment" href="#xhtml.nodes.important">◎</a></div>
<h5 class="title">
5.1.4.3.3 important
</h5>
<div class="content"><p>Use an <strong>important</strong> node when:</p>
-<p>bq. 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>
+<p>bq. 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="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
<p><div class="important">
<a name="An-example-2"/><div class="nav" id="An-example-2"><a title="Reverse jump to listing" href="#rev:An-example-2">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.important">△</a><a title="Jump to next segment" href="#xhtml.nodes.note">▽</a><a title="Jump to this segment" href="#An-example-2">◎</a></div>
<p class="title">Important 2. An example</p>
<div class="content">
- <img class="icon" alt="important" src="&icon_important;"/>
+ <img alt="important" class="icon" src="&icon_important;"/>
<p>This is how a <strong>important</strong> node appears.</p>
</div>
</div></p></div>
</div> <div class="section">
<a name="xhtml.nodes.note"/><div class="nav" id="xhtml.nodes.note"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.note">≡</a><a title="Jump to previous segment" href="#An-example-2">△</a><a title="Jump to next segment" href="#An-example-1-1-1">▽</a><a title="Jump to this segment" href="#xhtml.nodes.note">◎</a></div>
<h5 class="title">
5.1.4.3.4 note
</h5>
<div class="content"><p>Use a <strong>note</strong> node to convey:</p>
-<p>bq. 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>
+<p>bq. Information the user should be aware of, but is peripheral to the actual task being described. <sup>[<a class="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
<p><div class="note">
<a name="An-example-1-1-1"/><div class="nav" id="An-example-1-1-1"><a title="Reverse jump to listing" href="#rev:An-example-1-1-1">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.note">△</a><a title="Jump to next segment" href="#xhtml.nodes.tip">▽</a><a title="Jump to this segment" href="#An-example-1-1-1">◎</a></div>
<p class="title">Note 1. An example</p>
<div class="content">
- <img class="icon" alt="note" src="&icon_note;"/>
+ <img alt="note" class="icon" src="&icon_note;"/>
<p>This is how a <strong>note</strong> node appears.</p>
</div>
</div></p></div>
</div> <div class="section">
<a name="xhtml.nodes.tip"/><div class="nav" id="xhtml.nodes.tip"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.tip">≡</a><a title="Jump to previous segment" href="#An-example-1-1-1">△</a><a title="Jump to next segment" href="#An-example-1-1-1-1">▽</a><a title="Jump to this segment" href="#xhtml.nodes.tip">◎</a></div>
<h5 class="title">
5.1.4.3.5 tip
</h5>
<div class="content"><p>Use a <strong>tip</strong> node when:</p>
-<p>bq. 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>
+<p>bq. When you’re giving a hint to make things easier or more productive for the reader. <sup>[<a class="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
<p><div class="tip">
<a name="An-example-1-1-1-1"/><div class="nav" id="An-example-1-1-1-1"><a title="Reverse jump to listing" href="#rev:An-example-1-1-1-1">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.tip">△</a><a title="Jump to next segment" href="#Auxilary-materials">▽</a><a title="Jump to this segment" href="#An-example-1-1-1-1">◎</a></div>
<p class="title">Tip 1. An example</p>
<div class="content">
- <img class="icon" alt="tip" src="&icon_tip;"/>
+ <img alt="tip" class="icon" src="&icon_tip;"/>
<p>This is how a <strong>tip</strong> node appears.</p>
</div>
</div></p></div>
</div></p></div>
</div> <div class="section">
@@ -2241,43 +2260,43 @@
5.1.4.5 Bibliographical nodes
</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">
- <a name="xhtml.nodes.reference"/><div class="nav" id="xhtml.nodes.reference"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.reference">≡</a><a title="Jump to previous segment" href="#Bibliographical-nodes">△</a><a title="Jump to next segment" href="#An-example-609682968">▽</a><a title="Jump to this segment" href="#xhtml.nodes.reference">◎</a></div>
+ <a name="xhtml.nodes.reference"/><div class="nav" id="xhtml.nodes.reference"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.reference">≡</a><a title="Jump to previous segment" href="#Bibliographical-nodes">△</a><a title="Jump to next segment" href="#An-example-613425188">▽</a><a title="Jump to this segment" href="#xhtml.nodes.reference">◎</a></div>
<h5 class="title">
5.1.4.5.1 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="#xhtml.nodes.cite">Section 5.1.4.5.2. cite</a>) to perform the citation.</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="#xhtml.nodes.cite">Section 5.1.4.5.2. “cite”</a>) to perform the citation.</p>
<p><div class="paragraph">
- <a name="An-example-609682968"/><div class="nav" id="An-example-609682968"><a title="Reverse jump to listing" href="#rev:An-example-609682968">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.reference">△</a><a title="Jump to next segment" href="#xhtml.nodes.cite">▽</a><a title="Jump to this segment" href="#An-example-609682968">◎</a></div>
+ <a name="An-example-613425188"/><div class="nav" id="An-example-613425188"><a title="Reverse jump to listing" href="#rev:An-example-613425188">≡</a><a title="Jump to previous segment" href="#xhtml.nodes.reference">△</a><a title="Jump to next segment" href="#xhtml.nodes.cite">▽</a><a title="Jump to this segment" href="#An-example-613425188">◎</a></div>
<p class="title">An example</p>
<div class="content"><p>See <a class="xref" href="#xhtml.nodes.reference.example">Reference 2</a> for an example of how a <strong>reference</strong> node appears.</p></div>
</div> </p></div>
</div> <div class="section">
- <a name="xhtml.nodes.cite"/><div class="nav" id="xhtml.nodes.cite"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.cite">≡</a><a title="Jump to previous segment" href="#An-example-609682968">△</a><a title="Jump to next segment" href="#text">▽</a><a title="Jump to this segment" href="#xhtml.nodes.cite">◎</a></div>
+ <a name="xhtml.nodes.cite"/><div class="nav" id="xhtml.nodes.cite"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.cite">≡</a><a title="Jump to previous segment" href="#An-example-613425188">△</a><a title="Jump to next segment" href="#text">▽</a><a title="Jump to this segment" href="#xhtml.nodes.cite">◎</a></div>
<h5 class="title">
5.1.4.5.2 cite
</h5>
- <div class="content"><p>A citation to a <strong>reference</strong> node (see <a class="xref" href="#xhtml.nodes.reference">Section 5.1.4.5.1. reference</a>) in the document’s bibliography.</p>
+ <div class="content"><p>A citation to a <strong>reference</strong> node (see <a class="xref" href="#xhtml.nodes.reference">Section 5.1.4.5.1. “reference”</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>
<p>For example, this node in the input document:</p>
<pre><%= cite "xhtml.nodes.reference.example" %></pre>
-<p>appears in the output document like this: <sup>[<a class="cite" href="#xhtml.nodes.reference.example">2</a>]</sup></p>
+<p>appears in the output document like this: <sup>[<a class="xref" href="#xhtml.nodes.reference.example" title="Reference 2">2</a>]</sup></p>
<p>As another example, this node in the input document:</p>
<pre><%= cite "xhtml.nodes.reference.example", "chapter 10", "page 53", "..." %></pre>
-<p>appears in the output document like this: <sup>[<a class="cite" href="#xhtml.nodes.reference.example">2</a>, chapter 10, page 53, ...]</sup></p></div>
+<p>appears in the output document like this: <sup>[<a class="xref" href="#xhtml.nodes.reference.example" title="Reference 2">2</a>, chapter 10, page 53, ...]</sup></p></div>
</div></p></div>
</div></p></div>
</div></p></div>
</div></p>
@@ -2298,41 +2317,87 @@
<big>LaTeX (PDF)</big>
</h1>
<div class="content"><p>This format is not yet implemented. Patches are welcome! :-)</p>
<a href='http://www.latex-project.org'>http://www.latex-project.org</a></div>
</div> <div class="chapter">
- <a name="man"/><div class="nav" id="man"><a title="Reverse jump to listing" href="#rev:man">≡</a><a title="Jump to previous segment" href="#latex">△</a><a title="Jump to next segment" href="#history">▽</a><a title="Jump to this segment" href="#man">◎</a></div>
+ <a name="man"/><div class="nav" id="man"><a title="Reverse jump to listing" href="#rev:man">≡</a><a title="Jump to previous segment" href="#latex">△</a><a title="Jump to next segment" href="#History">▽</a><a title="Jump to this segment" href="#man">◎</a></div>
<h1 class="title">
Chapter 5.4
<br/>
<big>UNIX manual page</big>
</h1>
<div class="content"><p>This format is not yet implemented. Patches are welcome! :-)</p>
<a href='http://en.wikipedia.org/wiki/Man_page'>http://en.wikipedia.org/wiki/Man_page</a></div>
</div></p></div>
</div><div class="chapter">
- <a name="history"/><div class="nav" id="history"><a title="Reverse jump to listing" href="#rev:history">≡</a><a title="Jump to previous segment" href="#man">△</a><a title="Jump to next segment" href="#Version-6.0.1-2009-01-19">▽</a><a title="Jump to this segment" href="#history">◎</a></div>
+ <a name="History"/><div class="nav" id="History"><a title="Reverse jump to listing" href="#rev:History">≡</a><a title="Jump to previous segment" href="#man">△</a><a title="Jump to next segment" href="#Version-6.1.0-2009-02-14">▽</a><a title="Jump to this segment" href="#History">◎</a></div>
<h1 class="title">
Chapter 6
<br/>
- <big>Project history</big>
+ <big>History</big>
</h1>
<div class="content"><p><p><div class="section">
- <a name="Version-6.0.1-2009-01-19"/><div class="nav" id="Version-6.0.1-2009-01-19"><a title="Reverse jump to listing" href="#rev:Version-6.0.1-2009-01-19">≡</a><a title="Jump to previous segment" href="#history">△</a><a title="Jump to next segment" href="#Version-6.0.0-2009-01-19">▽</a><a title="Jump to this segment" href="#Version-6.0.1-2009-01-19">◎</a></div>
+ <a name="Version-6.1.0-2009-02-14"/><div class="nav" id="Version-6.1.0-2009-02-14"><a title="Reverse jump to listing" href="#rev:Version-6.1.0-2009-02-14">≡</a><a title="Jump to previous segment" href="#History">△</a><a title="Jump to next segment" href="#New-features">▽</a><a title="Jump to this segment" href="#Version-6.1.0-2009-02-14">◎</a></div>
<h2 class="title">
- 6.1 Version 6.0.1 (2009-01-19)
+ 6.1 Version 6.1.0 (2009-02-14)
</h2>
+ <div class="content"><p><div class="paragraph">
+ <a name="New-features"/><div class="nav" id="New-features"><a title="Reverse jump to listing" href="#rev:New-features">≡</a><a title="Jump to previous segment" href="#Version-6.1.0-2009-02-14">△</a><a title="Jump to next segment" href="#Bug-fixes">▽</a><a title="Jump to this segment" href="#New-features">◎</a></div>
+ <p class="title">New features</p>
+ <div class="content"><ul>
+<li>
+<p>Added translations for English phrases used in the XHTML format (see the <tt>lang/</tt> directory).</p>
+
+<p>You can choose which language to translate into by setting your LANG environment variable or by supplying the <tt>--locale</tt> option to the <strong>erbook</strong> executable.</p>
+</li>
+
+<li>
+<p>Reduced brightness of links in local navigation menus; it was distracting from the main text of the document.</p>
+</li>
+
+<li>
+<p>Draw the HTML <hr/> element as a dashed black line, instead of a <em>glaring</em> red line.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes"/><div class="nav" id="Bug-fixes"><a title="Reverse jump to listing" href="#rev:Bug-fixes">≡</a><a title="Jump to previous segment" href="#New-features">△</a><a title="Jump to next segment" href="#Housekeeping">▽</a><a title="Jump to this segment" href="#Bug-fixes">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>LaTeX-style index numbers were calculated incorrectly for descendants of the “node” node.</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Housekeeping"/><div class="nav" id="Housekeeping"><a title="Reverse jump to listing" href="#rev:Housekeeping">≡</a><a title="Jump to previous segment" href="#Bug-fixes">△</a><a title="Jump to next segment" href="#Version-6.0.1-2009-01-19">▽</a><a title="Jump to this segment" href="#Housekeeping">◎</a></div>
+ <p class="title">Housekeeping</p>
+ <div class="content"><ul>
+<li>
+<p>Add release notes for past releases… two years have already passed since I started this project! Where did the time go?</p>
+</li>
+
+<li>
+<p>List all contributors in the <a class="xref" href="#Credits" title="Section 1.3. "Credits"">Credits section</a> and make project logo a hyperlink to that section so interested people can quickly learn the source of the logo.</p>
+</li>
+
+<li>
+<p>Mention that project license is ISC for reader’s convenience.</p>
+</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-6.0.1-2009-01-19"/><div class="nav" id="Version-6.0.1-2009-01-19"><a title="Reverse jump to listing" href="#rev:Version-6.0.1-2009-01-19">≡</a><a title="Jump to previous segment" href="#Housekeeping">△</a><a title="Jump to next segment" href="#Version-6.0.0-2009-01-19">▽</a><a title="Jump to this segment" href="#Version-6.0.1-2009-01-19">◎</a></div>
+ <h2 class="title">
+ 6.2 Version 6.0.1 (2009-01-19)
+ </h2>
<div class="content"><p>This release reattempts to fix the <a href='http://www.ruby-forum.com/topic/176173#771281'>circular dependency problem</a> that occurred when installing either <strong>Inochi</strong> or <strong>ERBook</strong>.</p></div>
</div> <div class="section">
<a name="Version-6.0.0-2009-01-19"/><div class="nav" id="Version-6.0.0-2009-01-19"><a title="Reverse jump to listing" href="#rev:Version-6.0.0-2009-01-19">≡</a><a title="Jump to previous segment" href="#Version-6.0.1-2009-01-19">△</a><a title="Jump to next segment" href="#Incompatible-changes">▽</a><a title="Jump to this segment" href="#Version-6.0.0-2009-01-19">◎</a></div>
<h2 class="title">
- 6.1 Version 6.0.0 (2009-01-19)
+ 6.3 Version 6.0.0 (2009-01-19)
</h2>
<div class="content"><p>This release improves the appearance & usability of the XHTML format, refactors the core logic into reusable libraries, fixes some bugs and improves variable names.</p>
<p><div class="paragraph">
- <a name="Incompatible-changes"/><div class="nav" id="Incompatible-changes"><a title="Reverse jump to listing" href="#rev:Incompatible-changes">≡</a><a title="Jump to previous segment" href="#Version-6.0.0-2009-01-19">△</a><a title="Jump to next segment" href="#New-features">▽</a><a title="Jump to this segment" href="#Incompatible-changes">◎</a></div>
+ <a name="Incompatible-changes"/><div class="nav" id="Incompatible-changes"><a title="Reverse jump to listing" href="#rev:Incompatible-changes">≡</a><a title="Jump to previous segment" href="#Version-6.0.0-2009-01-19">△</a><a title="Jump to next segment" href="#New-features-613455288">▽</a><a title="Jump to this segment" href="#Incompatible-changes">◎</a></div>
<p class="title">Incompatible changes</p>
<div class="content"><ul>
<li>
<p>Renamed <code class="code"><span style="color:#33B">@types</span></code> to <code class="code"><span style="color:#33B">@nodes_by_type</span></code> and <code class="code"><span style="color:#33B">@spec</span></code> to <code class="code"><span style="color:#33B">@format</span></code> in XHTML format.</p>
</li>
@@ -2340,11 +2405,11 @@
<li>
<p>Moved the core logic of the <strong>erbook</strong> executable into the <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span></code> and <code class="code"><span style="color:#036;font-weight:bold">ERBook</span>::<span style="color:#036;font-weight:bold">Document</span>::<span style="color:#036;font-weight:bold">Template</span></code> classes.</p>
</li>
</ul></div>
</div> <div class="paragraph">
- <a name="New-features"/><div class="nav" id="New-features"><a title="Reverse jump to listing" href="#rev:New-features">≡</a><a title="Jump to previous segment" href="#Incompatible-changes">△</a><a title="Jump to next segment" href="#Bug-fixes">▽</a><a title="Jump to this segment" href="#New-features">◎</a></div>
+ <a name="New-features-613455288"/><div class="nav" id="New-features-613455288"><a title="Reverse jump to listing" href="#rev:New-features-613455288">≡</a><a title="Jump to previous segment" href="#Incompatible-changes">△</a><a title="Jump to next segment" href="#Bug-fixes-613490318">▽</a><a title="Jump to this segment" href="#New-features-613455288">◎</a></div>
<p class="title">New features</p>
<div class="content"><ul>
<li>
<p>Addded navigation menus beside every segment in the user manual. These menus allow you to jump to the next/previous segment, whereas previously you always had to go back to the table of contents and select a new segment.</p>
</li>
@@ -2352,11 +2417,11 @@
<li>
<p>A star is drawn beside a reverse jump target in the table of contents, so the user can continue where they left off.</p>
</li>
<li>
-<p>Added “inline” node definition parameter (see <a class="xref" href="#SpecFile.nodes">Section 3.2.1. Node definition</a>).</p>
+<p>Added “inline” node definition parameter (see <a class="xref" href="#SpecFile.nodes">Section 3.2.1. “Node definition”</a>).</p>
</li>
<li>
<p>Added <code class="code"><span style="color:#d70;font-weight:bold">$subtitle</span></code> parameter to XHTML format.</p>
</li>
@@ -2368,11 +2433,11 @@
<li>
<p>Relative file paths can now be specified in <%#include#%> directives.</p>
</li>
<li>
-<p>Added a “node” node (see <a class="xref" href="#xhtml.nodes.node">Section 5.1.4.2.1. node</a>), which serves as a pass-through container, in the XHTML format.</p>
+<p>Added a “node” node (see <a class="xref" href="#xhtml.nodes.node">Section 5.1.4.2.1. “node”</a>), which serves as a pass-through container, in the XHTML format.</p>
</li>
<li>
<p>Allow user to type <code class="code"><pre></code> blocks on single lines without affecting the display of their content.</p>
</li>
@@ -2390,11 +2455,11 @@
<li>
<p>Paragraph nodes are now included in the table of contents.</p>
</li>
</ul></div>
</div> <div class="paragraph">
- <a name="Bug-fixes"/><div class="nav" id="Bug-fixes"><a title="Reverse jump to listing" href="#rev:Bug-fixes">≡</a><a title="Jump to previous segment" href="#New-features">△</a><a title="Jump to next segment" href="#Housekeeping">▽</a><a title="Jump to this segment" href="#Bug-fixes">◎</a></div>
+ <a name="Bug-fixes-613490318"/><div class="nav" id="Bug-fixes-613490318"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613490318">≡</a><a title="Jump to previous segment" href="#New-features-613455288">△</a><a title="Jump to next segment" href="#Housekeeping-613510338">▽</a><a title="Jump to this segment" href="#Bug-fixes-613490318">◎</a></div>
<p class="title">Bug fixes</p>
<div class="content"><ul>
<li>
<p>Input to unindentation algorithm was being partially unindented beforehand by the logic that silences code-only eRuby directives. This corrupted the unindentation algorithm’s output in some cases.</p>
</li>
@@ -2406,11 +2471,11 @@
<li>
<p><code class="code"><a/></code> without href was treated as external hyperlink.</p>
</li>
</ul></div>
</div> <div class="paragraph">
- <a name="Housekeeping"/><div class="nav" id="Housekeeping"><a title="Reverse jump to listing" href="#rev:Housekeeping">≡</a><a title="Jump to previous segment" href="#Bug-fixes">△</a>▽<a title="Jump to this segment" href="#Housekeeping">◎</a></div>
+ <a name="Housekeeping-613510338"/><div class="nav" id="Housekeeping-613510338"><a title="Reverse jump to listing" href="#rev:Housekeeping-613510338">≡</a><a title="Jump to previous segment" href="#Bug-fixes-613490318">△</a><a title="Jump to next segment" href="#Version-5.0.0-2008-11-22">▽</a><a title="Jump to this segment" href="#Housekeeping-613510338">◎</a></div>
<p class="title">Housekeeping</p>
<div class="content"><ul>
<li>
<p>Revised the project logo to emphasize the owl mascot.</p>
</li>
@@ -2422,16 +2487,492 @@
<li>
<p>Wrote more API documentation and use <a href='http://snk.tuxfamily.org/lib/inochi'>Inochi</a> to simplify project maintenance.</p>
</li>
</ul></div>
</div></p></div>
+</div> <div class="section">
+ <a name="Version-5.0.0-2008-11-22"/><div class="nav" id="Version-5.0.0-2008-11-22"><a title="Reverse jump to listing" href="#rev:Version-5.0.0-2008-11-22">≡</a><a title="Jump to previous segment" href="#Housekeeping-613510338">△</a><a title="Jump to next segment" href="#Incompatible-changes-613551298">▽</a><a title="Jump to this segment" href="#Version-5.0.0-2008-11-22">◎</a></div>
+ <h2 class="title">
+ 6.4 Version 5.0.0 (2008-11-22)
+ </h2>
+ <div class="content"><p>This release renames the “html” format to “xhtml”, moves previously global stuff into the <code class="code"><span style="color:#036;font-weight:bold">ERBook</span></code> namespace, improves error reporting and usability, reduces the file size of XHTML output, and fixes some bugs.</p>
+
+<p><div class="paragraph">
+ <a name="Incompatible-changes-613551298"/><div class="nav" id="Incompatible-changes-613551298"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613551298">≡</a><a title="Jump to previous segment" href="#Version-5.0.0-2008-11-22">△</a><a title="Jump to next segment" href="#New-features-613563748">▽</a><a title="Jump to this segment" href="#Incompatible-changes-613551298">◎</a></div>
+ <p class="title">Incompatible changes</p>
+ <div class="content"><ul>
+<li>
+<p>Renamed the “html” format to “xhtml” (and all similarly named methods and files) in order to <a href='http://www.quirksmode.org/bugreports/archives/2005/02/custom_dtds_int_1.html'>support custom DTD extensions</a> which reduce the overall file size of the output. See <a href='http://snk.tuxfamily.org/lib/erbook/#Save-XHTML-output-as-.xhtml'>this note in the user manual</a> for the consequences of this change.</p>
+</li>
+
+<li>
+<p>Removed the <code class="code"><span style="color:#d70;font-weight:bold">$use_icons</span></code> parameter from the XHTML format. Now, icons are always used, whether you like it or not! ;-)</p>
+</li>
+
+<li>
+<p>Replaced the implicit <code class="code"><span style="color:#036;font-weight:bold">ERB</span>::<span style="color:#036;font-weight:bold">Util</span><span style="color:#666">#h</span></code> method with a <code class="code">verbatim()</code> method in the XHTML format.</p>
+</li>
+
+<li>
+<p>The <a href='http://trollop.rubyforge.org'>Trollop library</a> (used for command-line options parsing) is now required to run erbook. See the “Setup” section in the user manual for details.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="New-features-613563748"/><div class="nav" id="New-features-613563748"><a title="Reverse jump to listing" href="#rev:New-features-613563748">≡</a><a title="Jump to previous segment" href="#Incompatible-changes-613551298">△</a><a title="Jump to next segment" href="#Bug-fixes-613575558">▽</a><a title="Jump to this segment" href="#New-features-613563748">◎</a></div>
+ <p class="title">New features</p>
+ <div class="content"><ul>
+<li>
+<p>Added support for single-line eRuby directives (lines which begin with ”%”), both in general and in the <tt>--unindent</tt> option. See <a href='http://snk.tuxfamily.org/lib/erbook/#xhtml.nodes'>this section of the user manual</a> for examples.</p>
+</li>
+
+<li>
+<p>Enhanced stack traces with information about the input file and also <tt><%#include#%></tt>-ed files. This was done at the cost of increasing the number of source lines of code to more than 200 (it is 207 right now). Oh well, tradeoffs. ;-)</p>
+</li>
+
+<li>
+<p>Omitted erbook internals from stack traces (unless in $DEBUG mode). This helps users concentrate on problems in their input document.</p>
+</li>
+
+<li>
+<p>Used colors for hyperlinks and suffix icon for external hyperlinks from <a href='http://www.mediawiki.org'>the MediaWiki software</a>, which powers the famous Wikipedia.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes-613575558"/><div class="nav" id="Bug-fixes-613575558"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613575558">≡</a><a title="Jump to previous segment" href="#New-features-613563748">△</a><a title="Jump to next segment" href="#Housekeeping-612924428">▽</a><a title="Jump to this segment" href="#Bug-fixes-613575558">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>
+<p>Could not jump to examples and admonitions from the list of figures.</p>
+</li>
+
+<li>
+<p>Reorganized icons for the XHTML format to better reflect their origin (the directory layout of the source code of the open-source projects they came from) so that others can easily find them in their original sources.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Housekeeping-612924428"/><div class="nav" id="Housekeeping-612924428"><a title="Reverse jump to listing" href="#rev:Housekeeping-612924428">≡</a><a title="Jump to previous segment" href="#Bug-fixes-613575558">△</a><a title="Jump to next segment" href="#Version-4.0.0-2008-11-15">▽</a><a title="Jump to this segment" href="#Housekeeping-612924428">◎</a></div>
+ <p class="title">Housekeeping</p>
+ <div class="content"><ul>
+<li>Added API documentation for all methods listed in the user manual, while also omitting many irrelevant methods from the list.</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-4.0.0-2008-11-15"/><div class="nav" id="Version-4.0.0-2008-11-15"><a title="Reverse jump to listing" href="#rev:Version-4.0.0-2008-11-15">≡</a><a title="Jump to previous segment" href="#Housekeeping-612924428">△</a><a title="Jump to next segment" href="#Contributor-kudos">▽</a><a title="Jump to this segment" href="#Version-4.0.0-2008-11-15">◎</a></div>
+ <h2 class="title">
+ 6.5 Version 4.0.0 (2008-11-15)
+ </h2>
+ <div class="content"><p>This release renames the project, changes the project license, the source repository, and the default text-to-HTML formatting system, refactors the HTML format, and revises the documentation.</p>
+
+<p><div class="paragraph">
+ <a name="Contributor-kudos"/><div class="nav" id="Contributor-kudos"><a title="Reverse jump to listing" href="#rev:Contributor-kudos">≡</a><a title="Jump to previous segment" href="#Version-4.0.0-2008-11-15">△</a><a title="Jump to next segment" href="#Incompatible-changes-613060388">▽</a><a title="Jump to this segment" href="#Contributor-kudos">◎</a></div>
+ <p class="title">Contributor kudos</p>
+ <div class="content"><ul>
+<li>
+<p>Jens Vierbuchen contributed the the <a href='http://openclipart.org/media/files/lemmling/9065'>cartoon owl sitting on a book</a> drawing that is used in the new project logo:</p>
+<a href='#Credits' class='xref' title='Section 1.3. "Credits"'><img src='erbook.png' alt='ERBook logo' /></a></li>
+
+<li>
+<p>Maunika Gosike provided usability feedback to help improve the HTML format.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Incompatible-changes-613060388"/><div class="nav" id="Incompatible-changes-613060388"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613060388">≡</a><a title="Jump to previous segment" href="#Contributor-kudos">△</a><a title="Jump to next segment" href="#New-features-613094628">▽</a><a title="Jump to this segment" href="#Incompatible-changes-613060388">◎</a></div>
+ <p class="title">Incompatible changes</p>
+ <div class="content"><ul>
+<li>
+<p>The “Gerbil” project has been renamed to “erbook” to better reflect its purpose: it allows you to write books and documents using eRuby.</p>
+</li>
+
+<li>
+<p>The project license has been changed from a <a href='http://snk.tuxfamily.org/web/2007-05-02-copyleft-variation-of-mit-license.html'>custom MIT/copyleft license</a> to the more permissive <a href='https://www.isc.org/software/license'>ISC license</a> to make the world a better place! :-)</p>
+</li>
+
+<li>
+<p>The project source code repository is now <a href='http://github.com/sunaku/erbook/tree'>hosted on GitHub</a> (and therefore we now use Git instead of Darcs) to ease collaboration.</p>
+</li>
+
+<li>
+<p><a href='http://daringfireball.net/projects/markdown/syntax'>Markdown</a> is now the default text-to-HTML formatting system for the HTML format.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="New-features-613094628"/><div class="nav" id="New-features-613094628"><a title="Reverse jump to listing" href="#rev:New-features-613094628">≡</a><a title="Jump to previous segment" href="#Incompatible-changes-613060388">△</a><a title="Jump to next segment" href="#Housekeeping-613184078">▽</a><a title="Jump to this segment" href="#New-features-613094628">◎</a></div>
+ <p class="title">New features</p>
+ <div class="content"><ul>
+<li>
+<p>Added admonition icon for HTML <code class="code"><blockquote></code> element.</p>
+</li>
+
+<li>
+<p>A visual marker is shown on outgoing (external) hyperlinks.</p>
+</li>
+
+<li>
+<p>Tooltips are shown upon mouse hover for section index and title links which instruct new users how to navigate the web page more efficiently.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Housekeeping-613184078"/><div class="nav" id="Housekeeping-613184078"><a title="Reverse jump to listing" href="#rev:Housekeeping-613184078">≡</a><a title="Jump to previous segment" href="#New-features-613094628">△</a><a title="Jump to next segment" href="#Version-3.1.0-2008-06-22">▽</a><a title="Jump to this segment" href="#Housekeeping-613184078">◎</a></div>
+ <p class="title">Housekeeping</p>
+ <div class="content"><ul>
+<li>
+<p>Renamed <code class="code"><span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#url</span></code> to <code class="code"><span style="color:#036;font-weight:bold">Node</span><span style="color:#666">#here_frag</span></code>. Also, speak of “frags” rather than “anchors” or “urls” from now on.</p>
+</li>
+
+<li>
+<p>Refactored common logic from node output templates into Node class.</p>
+</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-3.1.0-2008-06-22"/><div class="nav" id="Version-3.1.0-2008-06-22"><a title="Reverse jump to listing" href="#rev:Version-3.1.0-2008-06-22">≡</a><a title="Jump to previous segment" href="#Housekeeping-613184078">△</a><a title="Jump to next segment" href="#New-features-613336208">▽</a><a title="Jump to this segment" href="#Version-3.1.0-2008-06-22">◎</a></div>
+ <h2 class="title">
+ 6.6 Version 3.1.0 (2008-06-22)
+ </h2>
+ <div class="content"><p>This release improves the HTML format by reducing the output file size, improving on-line usability and document printability (please try the “print preview” function in your browser; the output is simply beautiful!), and repairing some defects.</p>
+
+<p><div class="paragraph">
+ <a name="New-features-613336208"/><div class="nav" id="New-features-613336208"><a title="Reverse jump to listing" href="#rev:New-features-613336208">≡</a><a title="Jump to previous segment" href="#Version-3.1.0-2008-06-22">△</a><a title="Jump to next segment" href="#Bug-fixes-613365218">▽</a><a title="Jump to this segment" href="#New-features-613336208">◎</a></div>
+ <p class="title">New features</p>
+ <div class="content"><ul>
+<li>The file size of the HTML format’s output has been significantly reduced by reusing the data for embedded admonition icons through CSS. So use admonitions generously; they will not bloat the output file size!</li>
+</ul>
+
+<p>Usability</p>
+
+<ul>
+<li>
+<p>All headings are now hyperlinks to themselves. This allows readers to obtain a “permanent link” to any section in your HTML document.</p>
+</li>
+
+<li>
+<p>A meta navigation menu is now emitted at the top of the HTML document. This menu contains hyperlinks to the various structural elements of a document, such as the abstract, table of contents, list of figures, and references.</p>
+</li>
+
+<li>
+<p>The color of visited hyperlinks has been darkened to improve readability.</p>
+</li>
+
+<li>
+<p>The style of <strong>blockquote</strong> now provides better focus on its content.</p>
+</li>
+
+<li>
+<p>Cross-reference (xref) hyperlinks now have a mouse-hover title when you override the default link text.</p>
+</li>
+</ul>
+
+<p>Printing</p>
+
+<ul>
+<li>
+<p>Page breaks are now inserted before major sections in the document. This allows for easier printing (you can print a subset of pages without fear of discontinuity) and improves readability through better organization.</p>
+</li>
+
+<li>
+<p>In browsers that support <a href='http://www.w3.org/TR/css3-selectors/#selectors'>CSS3 pseudo-class selectors</a>, cross-reference hyperlinks now show the name and index of their destination node.</p>
+</li>
+
+<li>
+<p>Internal hyperlinks (which point to internal URI fragments) that are not cross-references are now shown as normal text to reduce distraction.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes-613365218"/><div class="nav" id="Bug-fixes-613365218"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613365218">≡</a><a title="Jump to previous segment" href="#New-features-613336208">△</a><a title="Jump to next segment" href="#Housekeeping-613389138">▽</a><a title="Jump to this segment" href="#Bug-fixes-613365218">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>Cross-reference (xref) hyperlinks to paragraphs were broken due to a missing <strong>id</strong> attribute.</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Housekeeping-613389138"/><div class="nav" id="Housekeeping-613389138"><a title="Reverse jump to listing" href="#rev:Housekeeping-613389138">≡</a><a title="Jump to previous segment" href="#Bug-fixes-613365218">△</a><a title="Jump to next segment" href="#Version-3.0.2-2008-06-08">▽</a><a title="Jump to this segment" href="#Housekeeping-613389138">◎</a></div>
+ <p class="title">Housekeeping</p>
+ <div class="content"><ul>
+<li>Removed useless CSS styles and fixed some XHTML validation issues.</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-3.0.2-2008-06-08"/><div class="nav" id="Version-3.0.2-2008-06-08"><a title="Reverse jump to listing" href="#rev:Version-3.0.2-2008-06-08">≡</a><a title="Jump to previous segment" href="#Housekeeping-613389138">△</a><a title="Jump to next segment" href="#Version-3.0.1-2008-06-03">▽</a><a title="Jump to this segment" href="#Version-3.0.2-2008-06-08">◎</a></div>
+ <h2 class="title">
+ 6.7 Version 3.0.2 (2008-06-08)
+ </h2>
+ <div class="content"><p>This release implements a shorter, faster, better unindentation algorithm which:</p>
+
+<ul>
+<li>Allows block beginnings <code class="code" lang="rhtml"><span style="background:#eee"><span style="font-weight:bold;color:#888"><%</span> <span style="color:#080;font-weight:bold">do</span> <span style="font-weight:bold;color:#888">%></span></span></code> and endings <code class="code" lang="rhtml"><span style="background:#eee"><span style="font-weight:bold;color:#888"><%</span> <span style="color:#080;font-weight:bold">end</span> <span style="font-weight:bold;color:#888">%></span></span></code> to span multiple lines.</li>
+
+<li>Ignores blank lines (which may contain whitespace) after block beginnings.</li>
+
+<li>Processes multiple lines per iteration, instead of one line at a time.</li>
+</ul></div>
+</div> <div class="section">
+ <a name="Version-3.0.1-2008-06-03"/><div class="nav" id="Version-3.0.1-2008-06-03"><a title="Reverse jump to listing" href="#rev:Version-3.0.1-2008-06-03">≡</a><a title="Jump to previous segment" href="#Version-3.0.2-2008-06-08">△</a><a title="Jump to next segment" href="#Version-3.0.0-2008-06-01">▽</a><a title="Jump to this segment" href="#Version-3.0.1-2008-06-03">◎</a></div>
+ <h2 class="title">
+ 6.8 Version 3.0.1 (2008-06-03)
+ </h2>
+ <div class="content"><p>This release repairs the <em>unindent</em> feature (it did not consider block beginnings that had block parameters) and adds an error message when block beginnings and endings are unbalanced.</p></div>
+</div> <div class="section">
+ <a name="Version-3.0.0-2008-06-01"/><div class="nav" id="Version-3.0.0-2008-06-01"><a title="Reverse jump to listing" href="#rev:Version-3.0.0-2008-06-01">≡</a><a title="Jump to previous segment" href="#Version-3.0.1-2008-06-03">△</a><a title="Jump to next segment" href="#Incompatible-changes-613457568">▽</a><a title="Jump to this segment" href="#Version-3.0.0-2008-06-01">◎</a></div>
+ <h2 class="title">
+ 6.9 Version 3.0.0 (2008-06-01)
+ </h2>
+ <div class="content"><p>This release improves the <strong>unindent</strong> feature and changes the <strong>include</strong> directive’s syntax. In related news, the project mailing list has been dismantled in favor of simply contacting the author directly (see e-mail address in LICENSE) to get help or provide feedback.</p>
+
+<p><div class="paragraph">
+ <a name="Incompatible-changes-613457568"/><div class="nav" id="Incompatible-changes-613457568"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613457568">≡</a><a title="Jump to previous segment" href="#Version-3.0.0-2008-06-01">△</a><a title="Jump to next segment" href="#Bug-fixes-613478758">▽</a><a title="Jump to this segment" href="#Incompatible-changes-613457568">◎</a></div>
+ <p class="title">Incompatible changes</p>
+ <div class="content"><ul>
+<li>
+<p>The <code class="code"><span style="color:#d70;font-weight:bold">$unindent</span></code> parameter has been replaced by the <tt>--unindent</tt> command-line option, which automatically unindents each line of input by the inner margin of its containing node.</p>
+</li>
+
+<li>
+<p>The <strong>include</strong> directive now has a symmetric # at the closing end: <pre><%# include ... #%></pre></p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes-613478758"/><div class="nav" id="Bug-fixes-613478758"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613478758">≡</a><a title="Jump to previous segment" href="#Incompatible-changes-613457568">△</a><a title="Jump to next segment" href="#Version-2.1.0-2008-05-29">▽</a><a title="Jump to this segment" href="#Bug-fixes-613478758">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>
+<p>The CSS for the horizontal rule (hr) element should now be consistent in all browsers.</p>
+</li>
+
+<li>
+<p>In the HTML format, whitespace has been added (in CSS) around the following nodes to make them conform more easily with the style of the rest of the document:</p>
+
+<ul>
+<li><code class="code">header_outside_above</code> - above the entire header block</li>
+
+<li><code class="code">header_inside_above </code> - above the default header content</li>
+
+<li><code class="code">header_inside_below </code> - below the default header content</li>
+
+<li><code class="code">header_outside_below</code> - below the entire header block</li>
+
+<li><code class="code">footer_outside_above</code> - above the entire footer block</li>
+
+<li><code class="code">footer_inside_above </code> - above the default footer content</li>
+
+<li><code class="code">footer_inside_below </code> - below the default footer content</li>
+
+<li><code class="code">footer_outside_below</code> - below the entire footer block</li>
+</ul>
+</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-2.1.0-2008-05-29"/><div class="nav" id="Version-2.1.0-2008-05-29"><a title="Reverse jump to listing" href="#rev:Version-2.1.0-2008-05-29">≡</a><a title="Jump to previous segment" href="#Bug-fixes-613478758">△</a><a title="Jump to next segment" href="#Version-2.0.0-2008-02-03">▽</a><a title="Jump to this segment" href="#Version-2.1.0-2008-05-29">◎</a></div>
+ <h2 class="title">
+ 6.10 Version 2.1.0 (2008-05-29)
+ </h2>
+ <div class="content"><p>This release adds image embedding methods for the HTML format and no longer appends (through CSS) an asterisk on outgoing hyperlinks.</p></div>
+</div> <div class="section">
+ <a name="Version-2.0.0-2008-02-03"/><div class="nav" id="Version-2.0.0-2008-02-03"><a title="Reverse jump to listing" href="#rev:Version-2.0.0-2008-02-03">≡</a><a title="Jump to previous segment" href="#Version-2.1.0-2008-05-29">△</a><a title="Jump to next segment" href="#Incompatible-changes-613565638">▽</a><a title="Jump to this segment" href="#Version-2.0.0-2008-02-03">◎</a></div>
+ <h2 class="title">
+ 6.11 Version 2.0.0 (2008-02-03)
+ </h2>
+ <div class="content"><p>This release fixes some bugs, improves the RDoc library, and adds nodes for customization of the default header and footer.</p>
+
+<p><div class="paragraph">
+ <a name="Incompatible-changes-613565638"/><div class="nav" id="Incompatible-changes-613565638"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613565638">≡</a><a title="Jump to previous segment" href="#Version-2.0.0-2008-02-03">△</a><a title="Jump to next segment" href="#New-features-613589358">▽</a><a title="Jump to this segment" href="#Incompatible-changes-613565638">◎</a></div>
+ <p class="title">Incompatible changes</p>
+ <div class="content"><ul>
+<li>The <tt>lib/gerbil/rdoc.rb</tt> library has changed! Read it for details.</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="New-features-613589358"/><div class="nav" id="New-features-613589358"><a title="Reverse jump to listing" href="#rev:New-features-613589358">≡</a><a title="Jump to previous segment" href="#Incompatible-changes-613565638">△</a><a title="Jump to next segment" href="#Bug-fixes-613601568">▽</a><a title="Jump to this segment" href="#New-features-613589358">◎</a></div>
+ <p class="title">New features</p>
+ <div class="content"><ul>
+<li>
+<p>In the <strong>html</strong> format, added the following nodes which allow you customize the default header and footer whilst preserving the default content:</p>
+
+<ul>
+<li><code class="code">header_outside_above</code> - above the entire header block</li>
+
+<li><code class="code">header_inside_above </code> - above the default header content</li>
+
+<li><code class="code">header_inside_below </code> - below the default header content</li>
+
+<li><code class="code">header_outside_below</code> - below the entire header block</li>
+
+<li><code class="code">footer_outside_above</code> - above the entire footer block</li>
+
+<li><code class="code">footer_inside_above </code> - above the default footer content</li>
+
+<li><code class="code">footer_inside_below </code> - below the default footer content</li>
+
+<li><code class="code">footer_outside_below</code> - below the entire footer block</li>
+</ul>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes-613601568"/><div class="nav" id="Bug-fixes-613601568"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613601568">≡</a><a title="Jump to previous segment" href="#New-features-613589358">△</a><a title="Jump to next segment" href="#Housekeeping-613616318">▽</a><a title="Jump to this segment" href="#Bug-fixes-613601568">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>
+<p><a href='http://pluskid.lifegoo.com/?p=263'>Regexp substitution placeholders were being interpreted</a> in node content. In particular, any occurrences of “\0” in a node’s content was replaced by a strange SHA1 digest! (Zhang Chiyuan)</p>
+</li>
+
+<li>
+<p>The <tt>lib/gerbil/rdoc.rb</tt> library did not extract method information recursively.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Housekeeping-613616318"/><div class="nav" id="Housekeeping-613616318"><a title="Reverse jump to listing" href="#rev:Housekeeping-613616318">≡</a><a title="Jump to previous segment" href="#Bug-fixes-613601568">△</a><a title="Jump to next segment" href="#Version-1.1.0-2008-01-22">▽</a><a title="Jump to this segment" href="#Housekeeping-613616318">◎</a></div>
+ <p class="title">Housekeeping</p>
+ <div class="content"><ul>
+<li>
+<p>In the <strong>html</strong> format, added a CSS margin above HTML tables because they were visually colliding with other elements above them.</p>
+</li>
+
+<li>
+<p>Fixed some Ruby code warnings in the <strong>html</strong> format.</p>
+</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-1.1.0-2008-01-22"/><div class="nav" id="Version-1.1.0-2008-01-22"><a title="Reverse jump to listing" href="#rev:Version-1.1.0-2008-01-22">≡</a><a title="Jump to previous segment" href="#Housekeeping-613616318">△</a><a title="Jump to next segment" href="#New-features-613634948">▽</a><a title="Jump to this segment" href="#Version-1.1.0-2008-01-22">◎</a></div>
+ <h2 class="title">
+ 6.12 Version 1.1.0 (2008-01-22)
+ </h2>
+ <div class="content"><p>This release improves usability and fixes some bugs.</p>
+
+<p><div class="paragraph">
+ <a name="New-features-613634948"/><div class="nav" id="New-features-613634948"><a title="Reverse jump to listing" href="#rev:New-features-613634948">≡</a><a title="Jump to previous segment" href="#Version-1.1.0-2008-01-22">△</a><a title="Jump to next segment" href="#Bug-fixes-613645288">▽</a><a title="Jump to this segment" href="#New-features-613634948">◎</a></div>
+ <p class="title">New features</p>
+ <div class="content"><ul>
+<li>External links are now marked with a ∗ symbol to help the user distinguish between internal and external links. This is helpful because a user may not wish to follow a link that takes them outside a document, say, when they are reading the document offline, without an Internet connection.</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes-613645288"/><div class="nav" id="Bug-fixes-613645288"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613645288">≡</a><a title="Jump to previous segment" href="#New-features-613634948">△</a><a title="Jump to next segment" href="#Version-1.0.0-2008-01-12">▽</a><a title="Jump to this segment" href="#Bug-fixes-613645288">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>
+<p>Forgot to update some code when I renamed the <code class="code"><span style="color:#036;font-weight:bold">RDoc</span>.gen_parse_tree</code> method in <tt>format/rdoc.rb</tt> during the last release.</p>
+</li>
+
+<li>
+<p>Module methods were omitted by the <code class="code"><span style="color:#036;font-weight:bold">RDoc</span>.gen_method_infos</code> method in <tt>format/rdoc.rb</tt>.</p>
+</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-1.0.0-2008-01-12"/><div class="nav" id="Version-1.0.0-2008-01-12"><a title="Reverse jump to listing" href="#rev:Version-1.0.0-2008-01-12">≡</a><a title="Jump to previous segment" href="#Bug-fixes-613645288">△</a><a title="Jump to next segment" href="#Incompatible-changes-612915118">▽</a><a title="Jump to this segment" href="#Version-1.0.0-2008-01-12">◎</a></div>
+ <h2 class="title">
+ 6.13 Version 1.0.0 (2008-01-12)
+ </h2>
+ <div class="content"><p>This release makes Gerbil available as a <a href='http://rubygems.org'>RubyGem</a>, fixes some bugs, and updates the user guide.</p>
+
+<p><div class="paragraph">
+ <a name="Incompatible-changes-612915118"/><div class="nav" id="Incompatible-changes-612915118"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-612915118">≡</a><a title="Jump to previous segment" href="#Version-1.0.0-2008-01-12">△</a><a title="Jump to next segment" href="#Bug-fixes-612988718">▽</a><a title="Jump to this segment" href="#Incompatible-changes-612915118">◎</a></div>
+ <p class="title">Incompatible changes</p>
+ <div class="content"><ul>
+<li>
+<p>The <tt>gerbil</tt> file has been moved to <tt>bin/gerbil</tt>.</p>
+</li>
+
+<li>
+<p>The <tt>format/</tt> directory has been renamed to <tt>fmt</tt>.</p>
+</li>
+
+<li>
+<p>The <tt>format/html.rb</tt> file has been moved to <tt>lib/gerbil/html.rb</tt>.</p>
+</li>
+
+<li>
+<p>The <tt>format/rdoc.rb</tt> file has been moved to <tt>lib/gerbil/rdoc.rb</tt>.</p>
+</li>
+
+<li>
+<p>In <tt>format/rdoc.rb</tt>, the name of the <code class="code"><span style="color:#036;font-weight:bold">RDoc</span>.gen_parse_tree</code> method has been pluralized (tree → trees) because it really returns an <em>array</em> of trees rather than a single tree.</p>
+</li>
+
+<li>
+<p>The <tt>CHANGES.yaml</tt> file has been removed, in favor of <a href='http://gerbil.rubyforge.org/news.xml'>this RSS feed</a>.</p>
+</li>
+
+<li>
+<p>The <code class="code"><span style="color:#036;font-weight:bold">GENERATOR</span></code> object has been renamed to <code class="code"><span style="color:#036;font-weight:bold">Gerbil</span></code>.</p>
+</li>
+</ul></div>
+</div> <div class="paragraph">
+ <a name="Bug-fixes-612988718"/><div class="nav" id="Bug-fixes-612988718"><a title="Reverse jump to listing" href="#rev:Bug-fixes-612988718">≡</a><a title="Jump to previous segment" href="#Incompatible-changes-612915118">△</a><a title="Jump to next segment" href="#Version-0.0.1-2007-12-13">▽</a><a title="Jump to this segment" href="#Bug-fixes-612988718">◎</a></div>
+ <p class="title">Bug fixes</p>
+ <div class="content"><ul>
+<li>
+<p>User guide now says “gem install RedCloth” instead of “gem install redcloth”. I don’t see why RubyGems requires the correct capitalization, so I <a href='http://rubyforge.org/tracker/?func=detail&aid=16937&group_id=126&atid=575'>filed a bug report</a> about it.</p>
+</li>
+
+<li>
+<p>In the HTML format, images inside descendant nodes of a <em>figure</em> node were not properly centered.</p>
+</li>
+
+<li>
+<p>In the HTML format, the <code class="code"><span style="color:#d70;font-weight:bold">$title</span></code> parameter was not converted into HTML.</p>
+</li>
+</ul></div>
+</div></p></div>
+</div> <div class="section">
+ <a name="Version-0.0.1-2007-12-13"/><div class="nav" id="Version-0.0.1-2007-12-13"><a title="Reverse jump to listing" href="#rev:Version-0.0.1-2007-12-13">≡</a><a title="Jump to previous segment" href="#Bug-fixes-612988718">△</a><a title="Jump to next segment" href="#Version-0.0.0-2007-12-09">▽</a><a title="Jump to this segment" href="#Version-0.0.1-2007-12-13">◎</a></div>
+ <h2 class="title">
+ 6.14 Version 0.0.1 (2007-12-13)
+ </h2>
+ <div class="content"><ul>
+<li>
+<p>Fixed the generation of unique node URI fragments in the HTML format.</p>
+</li>
+
+<li>
+<p>Added a <code class="code"><span style="color:#d70;font-weight:bold">$feeds</span></code> parameter to the HTML format.</p>
+</li>
+
+<li>
+<p>Added the <tt>format/rdoc.rb</tt> library for accessing RDoc’s parse tree.</p>
+</li>
+
+<li>
+<p>Updated the user guide:</p>
+
+<ul>
+<li>added documentation for methods provided by the HTML format</li>
+
+<li>added RSS feed for project release announcements</li>
+
+<li>improved the ghastly HelloWorld example</li>
+</ul>
+</li>
+
+<li>
+<p>Added a simple change-log (<tt>CHANGES.yaml</tt>) for the project.</p>
+</li>
+</ul></div>
+</div> <div class="section">
+ <a name="Version-0.0.0-2007-12-09"/><div class="nav" id="Version-0.0.0-2007-12-09"><a title="Reverse jump to listing" href="#rev:Version-0.0.0-2007-12-09">≡</a><a title="Jump to previous segment" href="#Version-0.0.1-2007-12-13">△</a>▽<a title="Jump to this segment" href="#Version-0.0.0-2007-12-09">◎</a></div>
+ <h2 class="title">
+ 6.15 Version 0.0.0 (2007-12-09)
+ </h2>
+ <div class="content"><p>Dear developers, technical writers, and documentation gurus,</p>
+
+<p>I am proud to announce a new project of mine named “Gerbil” which is beautifully short (176 lines of code) and powerful!</p>
+
+<p>Personally, I am baffled at the amount of documentation I wrote (and felt was necessary) to explain the plethora of things this tiny little utility does. About 70% of the development time was consumed by documentation alone! I’m glad that’s over. :-)</p>
+
+<p>The release notes are shown at the bottom of this message.</p>
+
+<p>Cheers!</p>
+<hr />
+<p>This is the <em>first</em> release of <a href='http://gerbil.rubyforge.org.'>the Gerbil project</a> Happy birthday!</p>
+
+<p>Please note that although the <a href='http://gerbil.rubyforge.org/guide.html'>user guide</a> says you can install Gerbil via RubyGems, currently there is <a href='http://rubyforge.org/tracker/index.php?func=detail&aid=16202&group_id=126&atid=575'>a bug in RubyGems version 0.9.5</a> that prevents me from creating an installable gem without strictly adhering to RubyGems convention of putting executable programs inside a <tt>bin/</tt> directory.</p>
+
+<p>Until this issue is resolved, please download the tarball/zip packages instead.</p></div>
</div></p></p></div>
</div></div>
<div id="bib">
<a name="References"/><div class="nav" id="References"><a title="Reverse jump to listing" href="#rev:References">≡</a>△▽<a title="Jump to this segment" href="#References">◎</a></div>
- <h1 class="title" >References</h1>
+ <h1 class="title">References</h1>
<ol>
<li id="KDE.admonitions"><p>L. Watts, “Admonitions: Tips, hints, and Warnings”, in <em>The KDE DocBook Authors guide</em>, Chapter 13, [Online document], 22 September 2004 (Revision 1.00.00), [cited 8 December 2007], Available at <a href='http://l10n.kde.org/docs/markup/tips-hints-etc.html'>http://l10n.kde.org/docs/markup/tips-hints-etc.html</a></p></li>
<li id="xhtml.nodes.reference.example"><p>This is how a <strong>reference</strong> node appears.</p></li>
</ol>
</div>
@@ -2441,31 +2982,30 @@
<br style="display: none"/>
<div id="footer">
- Generated by <a href="http://snk.tuxfamily.org/lib/erbook/">ERBook 6.0.1</a> on Mon Jan 19 12:56:04 -0800 2009.
<div id="footer-credits">
<p>
- <img class="icon" alt="caution" src="&icon_caution;"/>
- <img class="icon" alt="tip" src="&icon_tip;"/>
- <img class="icon" alt="important" src="&icon_important;"/>
- <img class="icon" alt="note" src="&icon_note;"/>
- <img class="icon" alt="warning" src="&icon_warning;"/>
- <img class="icon" alt="quote" src="&icon_quote;"/>
+ <img alt="caution" class="icon" src="&icon_caution;"/>
+ <img alt="tip" class="icon" src="&icon_tip;"/>
+ <img alt="important" class="icon" src="&icon_important;"/>
+ <img alt="note" class="icon" src="&icon_note;"/>
+ <img alt="warning" class="icon" src="&icon_warning;"/>
+ <img alt="quote" class="icon" src="&icon_quote;"/>
<br/>
- The icons shown above are © 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>.
+ The icons shown above are part of <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a>, which is copyright © 2005 <a href="http://tango.freedesktop.org">Tango Desktop Project</a> and is distributed under <a href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License Agreement</a>.
</p>
<p>
- <img class="icon" alt="link" src="&icon_link;"/>
+ <img alt="link" class="icon" src="&icon_link;"/>
<br/>
- The icons shown above are © 2007 <a href="https://www.ohloh.net/projects/mediawiki/contributors">MediaWiki contributors</a>. They are part of the <a href="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a> software, which is distributed under the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License, version 2</a>.
+ The icons shown above are part of <a href="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a>, which is copyright © 2007 <a href="https://www.ohloh.net/projects/mediawiki/contributors">MediaWiki contributors</a> and is distributed under <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License, version 2</a>.
</p>
</div>
</div>