erbook 6.0.1 → 6.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -14,27 +14,27 @@
14
14
  <h1>All Modules / Classes</h1>
15
15
  <ul>
16
16
 
17
- <li><a href="ERBook.html" title="ERBook">ERBook</a> <em>(module)</em></li>
17
+ <li><a title="ERBook" href="ERBook.html">ERBook</a> <em>(module)</em></li>
18
18
 
19
- <li><a href="ERBook/Document.html" title="ERBook::Document">ERBook::Document</a> <em>(class)</em></li>
19
+ <li><a title="ERBook::Document" href="ERBook/Document.html">ERBook::Document</a> <em>(class)</em></li>
20
20
 
21
- <li><a href="ERBook/Document/Node.html" title="ERBook::Document::Node">ERBook::Document::Node</a> <em>(class)</em></li>
21
+ <li><a title="ERBook::Document::Node" href="ERBook/Document/Node.html">ERBook::Document::Node</a> <em>(class)</em></li>
22
22
 
23
- <li><a href="ERBook/Template.html" title="ERBook::Template">ERBook::Template</a> <em>(class)</em></li>
23
+ <li><a title="ERBook::Template" href="ERBook/Template.html">ERBook::Template</a> <em>(class)</em></li>
24
24
 
25
- <li><a href="RDoc.html" title="RDoc">RDoc</a> <em>(module)</em></li>
25
+ <li><a title="RDoc" href="RDoc.html">RDoc</a> <em>(module)</em></li>
26
26
 
27
- <li><a href="RDoc/AnyMethod.html" title="RDoc::AnyMethod">RDoc::AnyMethod</a> <em>(class)</em></li>
27
+ <li><a title="RDoc::AnyMethod" href="RDoc/AnyMethod.html">RDoc::AnyMethod</a> <em>(class)</em></li>
28
28
 
29
- <li><a href="RDoc/DummyMarkup.html" title="RDoc::DummyMarkup">RDoc::DummyMarkup</a> <em>(class)</em></li>
29
+ <li><a title="RDoc::DummyMarkup" href="RDoc/DummyMarkup.html">RDoc::DummyMarkup</a> <em>(class)</em></li>
30
30
 
31
- <li><a href="RDoc/DummyMixin.html" title="RDoc::DummyMixin">RDoc::DummyMixin</a> <em>(module)</em></li>
31
+ <li><a title="RDoc::DummyMixin" href="RDoc/DummyMixin.html">RDoc::DummyMixin</a> <em>(module)</em></li>
32
32
 
33
- <li><a href="RDoc/DummyOptions.html" title="RDoc::DummyOptions">RDoc::DummyOptions</a> <em>(class)</em></li>
33
+ <li><a title="RDoc::DummyOptions" href="RDoc/DummyOptions.html">RDoc::DummyOptions</a> <em>(class)</em></li>
34
34
 
35
- <li><a href="RDoc/TopLevel.html" title="RDoc::TopLevel">RDoc::TopLevel</a> <em>(class)</em></li>
35
+ <li><a title="RDoc::TopLevel" href="RDoc/TopLevel.html">RDoc::TopLevel</a> <em>(class)</em></li>
36
36
 
37
- <li><a href="String.html" title="String">String</a> <em>(class)</em></li>
37
+ <li><a title="String" href="String.html">String</a> <em>(class)</em></li>
38
38
 
39
39
  </ul>
40
40
  </div>
data/doc/api/readme.html CHANGED
@@ -12,6 +12,9 @@
12
12
  <div id="content">
13
13
  <div class="section docstring readme">
14
14
  <p>
15
+ (the ISC license)
16
+ </p>
17
+ <p>
15
18
  Copyright 2006 Suraj N. Kurapati &lt;sunaku@gmail.com&gt;
16
19
  </p>
17
20
  <p>
data/doc/history.erb CHANGED
@@ -1,5 +1,29 @@
1
- <% chapter "Project history", "history" do %>
1
+ <% chapter "History" do %>
2
2
  <% project_history do %>
3
+ <% section "Version 6.1.0 (2009-02-14)" do %>
4
+ <% paragraph "New features" do %>
5
+ * Added translations for English phrases used in the XHTML format (see the <tt>lang/</tt> directory).
6
+
7
+ You can choose which language to translate into by setting your LANG environment variable or by supplying the <tt>--locale</tt> option to the **<%= $program %>** executable.
8
+
9
+ * Reduced brightness of links in local navigation menus; it was distracting from the main text of the document.
10
+
11
+ * Draw the HTML &lt;hr/&gt; element as a dashed black line, instead of a *glaring* red line.
12
+ <% end %>
13
+
14
+ <% paragraph "Bug fixes" do %>
15
+ * LaTeX-style index numbers were calculated incorrectly for descendants of the "node" node.
16
+ <% end %>
17
+
18
+ <% paragraph "Housekeeping" do %>
19
+ * Add release notes for past releases... two years have already passed since I started this project! Where did the time go?
20
+
21
+ * List all contributors in the <%= xref "Credits", "Credits section" %> and make project logo a hyperlink to that section so interested people can quickly learn the source of the logo.
22
+
23
+ * Mention that project license is ISC for reader's convenience.
24
+ <% end %>
25
+ <% end %>
26
+
3
27
  <% section "Version 6.0.1 (2009-01-19)" do %>
4
28
  This release reattempts to fix the [circular dependency problem](http://www.ruby-forum.com/topic/176173#771281) that occurred when installing either **<%= Inochi::PROJECT %>** or **<%= $project %>**.
5
29
  <% end %>
@@ -62,5 +86,263 @@
62
86
  * Wrote more API documentation and use [<%= Inochi::PROJECT %>](<%= Inochi::WEBSITE %>) to simplify project maintenance.
63
87
  <% end %>
64
88
  <% end %>
89
+
90
+ <% section "Version 5.0.0 (2008-11-22)" do %>
91
+ This release renames the "html" format to "xhtml", moves previously global stuff into the `ERBook` namespace, improves error reporting and usability, reduces the file size of XHTML output, and fixes some bugs.
92
+
93
+
94
+ <% paragraph "Incompatible changes" do %>
95
+ * Renamed the "html" format to "xhtml" (and all similarly named methods and files) in order to [support custom DTD extensions](http://www.quirksmode.org/bugreports/archives/2005/02/custom_dtds_int_1.html) which reduce the overall file size of the output. See [this note in the user manual](http://snk.tuxfamily.org/lib/erbook/#Save-XHTML-output-as-.xhtml) for the consequences of this change.
96
+
97
+ * Removed the `$use_icons` parameter from the XHTML format. Now, icons are always used, whether you like it or not! ;-)
98
+
99
+ * Replaced the implicit `ERB::Util#h` method with a `verbatim()` method in the XHTML format.
100
+
101
+ * The [Trollop library](http://trollop.rubyforge.org) (used for command-line options parsing) is now required to run erbook. See the "Setup" section in the user manual for details.
102
+ <% end %>
103
+
104
+ <% paragraph "New features" do %>
105
+ * Added support for single-line eRuby directives (lines which begin with "%"), both in general and in the <tt>--unindent</tt> option. See [this section of the user manual](http://snk.tuxfamily.org/lib/erbook/#xhtml.nodes) for examples.
106
+
107
+ * 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. ;-)
108
+
109
+ * Omitted erbook internals from stack traces (unless in $DEBUG mode). This helps users concentrate on problems in their input document.
110
+
111
+ * Used colors for hyperlinks and suffix icon for external hyperlinks from [the MediaWiki software](http://www.mediawiki.org), which powers the famous Wikipedia.
112
+ <% end %>
113
+
114
+ <% paragraph "Bug fixes" do %>
115
+ * Could not jump to examples and admonitions from the list of figures.
116
+
117
+ * 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.
118
+ <% end %>
119
+
120
+ <% paragraph "Housekeeping" do %>
121
+ * Added API documentation for all methods listed in the user manual, while also omitting many irrelevant methods from the list.
122
+ <% end %>
123
+ <% end %>
124
+
125
+ <% section "Version 4.0.0 (2008-11-15)" do %>
126
+ 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.
127
+
128
+ <% paragraph "Contributor kudos" do %>
129
+ * Jens Vierbuchen contributed the the [cartoon owl sitting on a book](http://openclipart.org/media/files/lemmling/9065) drawing that is used in the new project logo:
130
+
131
+ <%= $logo %>
132
+
133
+ * Maunika Gosike provided usability feedback to help improve the HTML format.
134
+ <% end %>
135
+
136
+ <% paragraph "Incompatible changes" do %>
137
+ * The "Gerbil" project has been renamed to "erbook" to better reflect its purpose: it allows you to write books and documents using eRuby.
138
+
139
+ * The project license has been changed from a [custom MIT/copyleft license](http://snk.tuxfamily.org/web/2007-05-02-copyleft-variation-of-mit-license.html) to the more permissive [ISC license](https://www.isc.org/software/license) to make the world a better place! :-)
140
+
141
+ * The project source code repository is now [hosted on GitHub](http://github.com/sunaku/erbook/tree) (and therefore we now use Git instead of Darcs) to ease collaboration.
142
+
143
+ * [Markdown](http://daringfireball.net/projects/markdown/syntax) is now the default text-to-HTML formatting system for the HTML format.
144
+ <% end %>
145
+
146
+ <% paragraph "New features" do %>
147
+ * Added admonition icon for HTML <code><blockquote></code> element.
148
+
149
+ * A visual marker is shown on outgoing (external) hyperlinks.
150
+
151
+ * Tooltips are shown upon mouse hover for section index and title links which instruct new users how to navigate the web page more efficiently.
152
+ <% end %>
153
+
154
+ <% paragraph "Housekeeping" do %>
155
+ * Renamed `Node#url` to `Node#here_frag`. Also, speak of "frags" rather than "anchors" or "urls" from now on.
156
+
157
+ * Refactored common logic from node output templates into Node class.
158
+ <% end %>
159
+ <% end %>
160
+
161
+ <% section "Version 3.1.0 (2008-06-22)" do %>
162
+ 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.
163
+
164
+ <% paragraph "New features" do %>
165
+ * 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!
166
+
167
+
168
+ Usability
169
+
170
+ * All headings are now hyperlinks to themselves. This allows readers to obtain a "permanent link" to any section in your HTML document.
171
+
172
+ * 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.
173
+
174
+ * The color of visited hyperlinks has been darkened to improve readability.
175
+
176
+ * The style of **blockquote** now provides better focus on its content.
177
+
178
+ * Cross-reference (xref) hyperlinks now have a mouse-hover title when you override the default link text.
179
+
180
+
181
+ Printing
182
+
183
+ * 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.
184
+
185
+ * In browsers that support [CSS3 pseudo-class selectors](http://www.w3.org/TR/css3-selectors/#selectors), cross-reference hyperlinks now show the name and index of their destination node.
186
+
187
+ * Internal hyperlinks (which point to internal URI fragments) that are not cross-references are now shown as normal text to reduce distraction.
188
+ <% end %>
189
+
190
+ <% paragraph "Bug fixes" do %>
191
+ * Cross-reference (xref) hyperlinks to paragraphs were broken due to a missing **id** attribute.
192
+ <% end %>
193
+
194
+ <% paragraph "Housekeeping" do %>
195
+ * Removed useless CSS styles and fixed some XHTML validation issues.
196
+ <% end %>
197
+ <% end %>
198
+
199
+ <% section "Version 3.0.2 (2008-06-08)" do %>
200
+ This release implements a shorter, faster, better unindentation algorithm which:
201
+ * Allows block beginnings <code lang="rhtml"><%% do %></code> and endings <code lang="rhtml"><%% end %></code> to span multiple lines.
202
+ * Ignores blank lines (which may contain whitespace) after block beginnings.
203
+ * Processes multiple lines per iteration, instead of one line at a time.
204
+ <% end %>
205
+
206
+ <% section "Version 3.0.1 (2008-06-03)" do %>
207
+ This release repairs the *unindent* feature (it did not consider block beginnings that had block parameters) and adds an error message when block beginnings and endings are unbalanced.
208
+ <% end %>
209
+
210
+ <% section "Version 3.0.0 (2008-06-01)" do %>
211
+ This release improves the **unindent** feature and changes the **include** 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.
212
+
213
+ <% paragraph "Incompatible changes" do %>
214
+ * The `$unindent` 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.
215
+
216
+ * The **include** directive now has a symmetric # at the closing end:
217
+ <pre><%%# include ... #%></pre>
218
+ <% end %>
219
+
220
+ <% paragraph "Bug fixes" do %>
221
+ * The CSS for the horizontal rule (hr) element should now be consistent in all browsers.
222
+
223
+ * 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:
224
+ * `header_outside_above` - above the entire header block
225
+ * `header_inside_above ` - above the default header content
226
+ * `header_inside_below ` - below the default header content
227
+ * `header_outside_below` - below the entire header block
228
+ * `footer_outside_above` - above the entire footer block
229
+ * `footer_inside_above ` - above the default footer content
230
+ * `footer_inside_below ` - below the default footer content
231
+ * `footer_outside_below` - below the entire footer block
232
+ <% end %>
233
+ <% end %>
234
+
235
+ <% section "Version 2.1.0 (2008-05-29)" do %>
236
+ This release adds image embedding methods for the HTML format and no longer appends (through CSS) an asterisk on outgoing hyperlinks.
237
+ <% end %>
238
+
239
+ <% section "Version 2.0.0 (2008-02-03)" do %>
240
+ This release fixes some bugs, improves the RDoc library, and adds nodes for customization of the default header and footer.
241
+
242
+ <% paragraph "Incompatible changes" do %>
243
+ * The <tt>lib/gerbil/rdoc.rb</tt> library has changed! Read it for details.
244
+ <% end %>
245
+
246
+ <% paragraph "New features" do %>
247
+ * In the **html** format, added the following nodes which allow you customize the default header and footer whilst preserving the default content:
248
+ * `header_outside_above` - above the entire header block
249
+ * `header_inside_above ` - above the default header content
250
+ * `header_inside_below ` - below the default header content
251
+ * `header_outside_below` - below the entire header block
252
+ * `footer_outside_above` - above the entire footer block
253
+ * `footer_inside_above ` - above the default footer content
254
+ * `footer_inside_below ` - below the default footer content
255
+ * `footer_outside_below` - below the entire footer block
256
+ <% end %>
257
+
258
+ <% paragraph "Bug fixes" do %>
259
+ * [Regexp substitution placeholders were being interpreted](http://pluskid.lifegoo.com/?p=263) in node content. In particular, any occurrences of "\0" in a node's content was replaced by a strange SHA1 digest! (Zhang Chiyuan)
260
+
261
+ * The <tt>lib/gerbil/rdoc.rb</tt> library did not extract method information recursively.
262
+ <% end %>
263
+
264
+ <% paragraph "Housekeeping" do %>
265
+ * In the **html** format, added a CSS margin above HTML tables because they were visually colliding with other elements above them.
266
+
267
+ * Fixed some Ruby code warnings in the **html** format.
268
+ <% end %>
269
+ <% end %>
270
+
271
+ <% section "Version 1.1.0 (2008-01-22)" do %>
272
+ This release improves usability and fixes some bugs.
273
+
274
+ <% paragraph "New features" do %>
275
+ * External links are now marked with a &lowast; 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.
276
+ <% end %>
277
+
278
+ <% paragraph "Bug fixes" do %>
279
+ * Forgot to update some code when I renamed the `RDoc.gen_parse_tree` method in <tt>format/rdoc.rb</tt> during the last release.
280
+
281
+ * Module methods were omitted by the `RDoc.gen_method_infos` method in <tt>format/rdoc.rb</tt>.
282
+ <% end %>
283
+ <% end %>
284
+
285
+ <% section "Version 1.0.0 (2008-01-12)" do %>
286
+ This release makes Gerbil available as a [RubyGem](http://rubygems.org), fixes some bugs, and updates the user guide.
287
+
288
+ <% paragraph "Incompatible changes" do %>
289
+ * The <tt>gerbil</tt> file has been moved to <tt>bin/gerbil</tt>.
290
+
291
+ * The <tt>format/</tt> directory has been renamed to <tt>fmt</tt>.
292
+
293
+ * The <tt>format/html.rb</tt> file has been moved to <tt>lib/gerbil/html.rb</tt>.
294
+
295
+ * The <tt>format/rdoc.rb</tt> file has been moved to <tt>lib/gerbil/rdoc.rb</tt>.
296
+
297
+ * In <tt>format/rdoc.rb</tt>, the name of the `RDoc.gen_parse_tree` method has been pluralized (tree &rarr; trees) because it really returns an _array_ of trees rather than a single tree.
298
+
299
+ * The <tt>CHANGES.yaml</tt> file has been removed, in favor of [this RSS feed](http://gerbil.rubyforge.org/news.xml).
300
+
301
+ * The `GENERATOR` object has been renamed to `Gerbil`.
302
+ <% end %>
303
+
304
+ <% paragraph "Bug fixes" do %>
305
+ * User guide now says "gem install RedCloth" instead of "gem install redcloth". I don't see why RubyGems requires the correct capitalization, so I [filed a bug report](http://rubyforge.org/tracker/?func=detail&aid=16937&group_id=126&atid=575) about it.
306
+
307
+ * In the HTML format, images inside descendant nodes of a *figure* node were not properly centered.
308
+
309
+ * In the HTML format, the `$title` parameter was not converted into HTML.
310
+ <% end %>
311
+ <% end %>
312
+
313
+ <% section "Version 0.0.1 (2007-12-13)" do %>
314
+ * Fixed the generation of unique node URI fragments in the HTML format.
315
+ * Added a `$feeds` parameter to the HTML format.
316
+ * Added the <tt>format/rdoc.rb</tt> library for accessing RDoc's parse tree.
317
+ * Updated the user guide:
318
+ * added documentation for methods provided by the HTML format
319
+ * added RSS feed for project release announcements
320
+ * improved the ghastly HelloWorld example
321
+ * Added a simple change-log (<tt>CHANGES.yaml</tt>) for the project.
322
+ <% end %>
323
+
324
+ <% section "Version 0.0.0 (2007-12-09)" do %>
325
+ Dear developers, technical writers, and documentation gurus,
326
+
327
+ I am proud to announce a new project of mine named "Gerbil"
328
+ which is beautifully short (176 lines of code) and powerful!
329
+
330
+ Personally, I am baffled at the amount of documentation I wrote
331
+ (and felt was necessary) to explain the plethora of things this
332
+ tiny little utility does. About 70% of the development time
333
+ was consumed by documentation alone! I'm glad that's over. :-)
334
+
335
+ The release notes are shown at the bottom of this message.
336
+
337
+ Cheers!
338
+
339
+ * * *
340
+
341
+ This is the _first_ release of [the Gerbil project](http://gerbil.rubyforge.org.) Happy birthday!
342
+
343
+ Please note that although the [user guide](http://gerbil.rubyforge.org/guide.html) says you can install Gerbil via RubyGems, currently there is [a bug in RubyGems version 0.9.5](http://rubyforge.org/tracker/index.php?func=detail&aid=16202&group_id=126&atid=575) that prevents me from creating an installable gem without strictly adhering to RubyGems convention of putting executable programs inside a <tt>bin/</tt> directory.
344
+
345
+ Until this issue is resolved, please download the tarball/zip packages instead.
346
+ <% end %>
65
347
  <% end %>
66
348
  <% end %>
data/doc/index.xhtml CHANGED
@@ -12,13 +12,13 @@
12
12
  <html xmlns="http://www.w3.org/1999/xhtml">
13
13
  <head>
14
14
  <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
15
- <meta name="generator" content="ERBook 6.0.1"/>
15
+ <meta name="generator" content="ERBook 6.1.0"/>
16
16
 
17
- <title>ERBook 6.0.1</title>
17
+ <title>ERBook 6.1.0</title>
18
18
 
19
19
  <meta name="author" content="Suraj N. Kurapati"/>
20
20
 
21
- <meta name="date" content="19 January 2009"/>
21
+ <meta name="date" content="14 February 2009"/>
22
22
 
23
23
  <link rel="alternate" type="application/rss+xml" href="http://snk.tuxfamily.org/lib/erbook/ann.xml"/>
24
24
 
@@ -49,7 +49,7 @@
49
49
  {
50
50
  height : 0;
51
51
  border : 0;
52
- border-top : 2px solid #FF0000;
52
+ border-top : thin dashed #000000;
53
53
  }
54
54
 
55
55
  /* source code */
@@ -485,7 +485,7 @@
485
485
  .nav a:link,
486
486
  .nav a:visited
487
487
  {
488
- color : #D3D3D3;
488
+ color : #C0C0C0;
489
489
  }
490
490
 
491
491
  .nav a:hover,
@@ -650,15 +650,15 @@
650
650
 
651
651
  <div id="header">
652
652
 
653
- <div class="logo"><img src='erbook.png' alt='ERBook logo' /></div>
653
+ <div class="logo"><a class="xref" href="#Credits" title="Section 1.3. &quot;Credits&quot;"><img src='erbook.png' alt='ERBook logo' /></a></div>
654
654
 
655
- <h1 class="title">ERBook 6.0.1</h1>
655
+ <h1 class="title">ERBook 6.1.0</h1>
656
656
 
657
657
  <h2 class="subtitle">Extensible document processor based on eRuby</h2>
658
658
 
659
659
  <h3 class="authors"><a href="mailto:sunaku@gmail.com">Suraj N. Kurapati</a></h3>
660
660
 
661
- <h3 class="date">19 January 2009</h3>
661
+ <h3 class="date">14 February 2009</h3>
662
662
 
663
663
  </div>
664
664
 
@@ -673,7 +673,7 @@
673
673
  <a name="Contents"/><div class="nav" id="Contents"><a title="Reverse jump to listing" href="#rev:Contents">&equiv;</a>&#x25B3;&#x25BD;<a title="Jump to this segment" href="#Contents">&#x25CE;</a></div>
674
674
  <h1 class="title">Contents</h1>
675
675
  <ul>
676
- <li>1&nbsp;&nbsp;<a id="rev:Introduction" href="#Introduction">Introduction</a><ul><li>1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:License" href="#License">License</a></li><li>1.3&nbsp;&nbsp;<a id="rev:Credits" href="#Credits">Credits</a></li><li>1.4&nbsp;&nbsp;<a id="rev:Reviews" href="#Reviews">Reviews</a></li></ul></li><li>2&nbsp;&nbsp;<a id="rev:Setup" href="#Setup">Setup</a><ul><li>2.1&nbsp;&nbsp;<a id="rev:Requirements" href="#Requirements">Requirements</a></li><li>2.2&nbsp;&nbsp;<a id="rev:Installation" href="#Installation">Installation</a></li><li>2.3&nbsp;&nbsp;<a id="rev:Manifest" href="#Manifest">Manifest</a></li></ul></li><li>3&nbsp;&nbsp;<a id="rev:Theory-of-operation" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1&nbsp;&nbsp;<a id="rev:Nodes" href="#Nodes">Nodes</a><ul><li>3.1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:SpecFile" href="#SpecFile">Format specification file</a><ul><li>3.2.1&nbsp;&nbsp;<a id="rev:SpecFile.nodes" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1&nbsp;&nbsp;<a id="rev:SpecFile.nodes.output" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2&nbsp;&nbsp;<a id="rev:SpecFile.output" href="#SpecFile.output">Document output template</a></li><li>3.2.3&nbsp;&nbsp;<a id="rev:HelloWorld" href="#HelloWorld">Creating your own document format</a></li></ul></li></ul></li><li>4&nbsp;&nbsp;<a id="rev:Usage" href="#Usage">Usage</a><ul><li>4.1&nbsp;&nbsp;<a id="rev:Command-line-interface" href="#Command-line-interface">Command-line interface</a><ul><li>4.1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:include" href="#include">Including external documents</a></li><li>4.3&nbsp;&nbsp;<a id="rev:Unindenting-nodes-hierarchically" href="#Unindenting-nodes-hierarchically">Unindenting nodes hierarchically</a></li></ul></li><li>5&nbsp;&nbsp;<a id="rev:Formats" href="#Formats">Formats</a><ul><li>5.1&nbsp;&nbsp;<a id="rev:xhtml" href="#xhtml">XHTML (web page)</a><ul><li>5.1.1&nbsp;&nbsp;<a id="rev:Text-to-XHTML-conversion" href="#Text-to-XHTML-conversion">Text to XHTML conversion</a><ul><li>5.1.1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:Protecting-verbatim-text" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2&nbsp;&nbsp;<a id="rev:Parameters" href="#Parameters">Parameters</a></li><li>5.1.3&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:xhtml.nodes" href="#xhtml.nodes">Nodes</a><ul><li>5.1.4.1&nbsp;&nbsp;<a id="rev:Structural-nodes" href="#Structural-nodes">Structural nodes</a><ul><li>5.1.4.1.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.header" href="#xhtml.nodes.header">header</a></li><li>5.1.4.1.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.footer" href="#xhtml.nodes.footer">footer</a></li><li>5.1.4.1.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.abstract" href="#xhtml.nodes.abstract">abstract</a></li><li>5.1.4.1.4&nbsp;&nbsp;<a id="rev:xhtml.nodes.xref" href="#xhtml.nodes.xref">xref</a></li></ul></li><li>5.1.4.2&nbsp;&nbsp;<a id="rev:Organizational-nodes" href="#Organizational-nodes">Organizational nodes</a><ul><li>5.1.4.2.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.node" href="#xhtml.nodes.node">node</a></li><li>5.1.4.2.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.part" href="#xhtml.nodes.part">part</a><ul><li>5.1.4.2.2.1&nbsp;&nbsp;<a id="rev:An-example" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.chapter" href="#xhtml.nodes.chapter">chapter</a><ul><li>5.1.4.2.3.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:xhtml.nodes.section" href="#xhtml.nodes.section">section</a><ul><li>5.1.4.2.4.1&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:Admonition-nodes" href="#Admonition-nodes">Admonition nodes</a><ul><li>5.1.4.3.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.warning" href="#xhtml.nodes.warning">warning</a></li><li>5.1.4.3.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.caution" href="#xhtml.nodes.caution">caution</a></li><li>5.1.4.3.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.important" href="#xhtml.nodes.important">important</a></li><li>5.1.4.3.4&nbsp;&nbsp;<a id="rev:xhtml.nodes.note" href="#xhtml.nodes.note">note</a></li><li>5.1.4.3.5&nbsp;&nbsp;<a id="rev:xhtml.nodes.tip" href="#xhtml.nodes.tip">tip</a></li></ul></li><li>5.1.4.4&nbsp;&nbsp;<a id="rev:Auxilary-materials" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.figure" href="#xhtml.nodes.figure">figure</a></li><li>5.1.4.4.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.table" href="#xhtml.nodes.table">table</a></li><li>5.1.4.4.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.example" href="#xhtml.nodes.example">example</a></li><li>5.1.4.4.4&nbsp;&nbsp;<a id="rev:xhtml.nodes.equation" href="#xhtml.nodes.equation">equation</a></li><li>5.1.4.4.5&nbsp;&nbsp;<a id="rev:xhtml.nodes.procedure" href="#xhtml.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5&nbsp;&nbsp;<a id="rev:Bibliographical-nodes" href="#Bibliographical-nodes">Bibliographical nodes</a><ul><li>5.1.4.5.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:xhtml.nodes.cite" href="#xhtml.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2&nbsp;&nbsp;<a id="rev:text" href="#text">Plain text</a></li><li>5.3&nbsp;&nbsp;<a id="rev:latex" href="#latex">LaTeX (PDF)</a></li><li>5.4&nbsp;&nbsp;<a id="rev:man" href="#man">UNIX manual page</a></li></ul></li><li>6&nbsp;&nbsp;<a id="rev:history" href="#history">Project history</a><ul><li>6.1&nbsp;&nbsp;<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&nbsp;&nbsp;<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>
676
+ <li>1&nbsp;&nbsp;<a id="rev:Introduction" href="#Introduction">Introduction</a><ul><li>1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:License" href="#License">License</a></li><li>1.3&nbsp;&nbsp;<a id="rev:Credits" href="#Credits">Credits</a></li><li>1.4&nbsp;&nbsp;<a id="rev:Reviews" href="#Reviews">Reviews</a></li></ul></li><li>2&nbsp;&nbsp;<a id="rev:Setup" href="#Setup">Setup</a><ul><li>2.1&nbsp;&nbsp;<a id="rev:Requirements" href="#Requirements">Requirements</a></li><li>2.2&nbsp;&nbsp;<a id="rev:Installation" href="#Installation">Installation</a></li><li>2.3&nbsp;&nbsp;<a id="rev:Manifest" href="#Manifest">Manifest</a></li></ul></li><li>3&nbsp;&nbsp;<a id="rev:Theory-of-operation" href="#Theory-of-operation">Theory of operation</a><ul><li>3.1&nbsp;&nbsp;<a id="rev:Nodes" href="#Nodes">Nodes</a><ul><li>3.1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:SpecFile" href="#SpecFile">Format specification file</a><ul><li>3.2.1&nbsp;&nbsp;<a id="rev:SpecFile.nodes" href="#SpecFile.nodes">Node definition</a><ul><li>3.2.1.1&nbsp;&nbsp;<a id="rev:SpecFile.nodes.output" href="#SpecFile.nodes.output">Node output template</a></li></ul></li><li>3.2.2&nbsp;&nbsp;<a id="rev:SpecFile.output" href="#SpecFile.output">Document output template</a></li><li>3.2.3&nbsp;&nbsp;<a id="rev:HelloWorld" href="#HelloWorld">Creating your own document format</a></li></ul></li></ul></li><li>4&nbsp;&nbsp;<a id="rev:Usage" href="#Usage">Usage</a><ul><li>4.1&nbsp;&nbsp;<a id="rev:Command-line-interface" href="#Command-line-interface">Command-line interface</a><ul><li>4.1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:include" href="#include">Including external documents</a></li><li>4.3&nbsp;&nbsp;<a id="rev:Unindenting-nodes-hierarchically" href="#Unindenting-nodes-hierarchically">Unindenting nodes hierarchically</a></li></ul></li><li>5&nbsp;&nbsp;<a id="rev:Formats" href="#Formats">Formats</a><ul><li>5.1&nbsp;&nbsp;<a id="rev:xhtml" href="#xhtml">XHTML (web page)</a><ul><li>5.1.1&nbsp;&nbsp;<a id="rev:Text-to-XHTML-conversion" href="#Text-to-XHTML-conversion">Text to XHTML conversion</a><ul><li>5.1.1.1&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:Protecting-verbatim-text" href="#Protecting-verbatim-text">Protecting verbatim text</a></li></ul></li><li>5.1.2&nbsp;&nbsp;<a id="rev:Parameters" href="#Parameters">Parameters</a></li><li>5.1.3&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:xhtml.nodes" href="#xhtml.nodes">Nodes</a><ul><li>5.1.4.1&nbsp;&nbsp;<a id="rev:Structural-nodes" href="#Structural-nodes">Structural nodes</a><ul><li>5.1.4.1.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.header" href="#xhtml.nodes.header">header</a></li><li>5.1.4.1.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.footer" href="#xhtml.nodes.footer">footer</a></li><li>5.1.4.1.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.abstract" href="#xhtml.nodes.abstract">abstract</a></li><li>5.1.4.1.4&nbsp;&nbsp;<a id="rev:xhtml.nodes.xref" href="#xhtml.nodes.xref">xref</a></li></ul></li><li>5.1.4.2&nbsp;&nbsp;<a id="rev:Organizational-nodes" href="#Organizational-nodes">Organizational nodes</a><ul><li>5.1.4.2.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.node" href="#xhtml.nodes.node">node</a></li><li>5.1.4.2.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.part" href="#xhtml.nodes.part">part</a><ul><li>5.1.4.2.2.1&nbsp;&nbsp;<a id="rev:An-example" href="#An-example">An example</a></li></ul></li><li>5.1.4.2.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.chapter" href="#xhtml.nodes.chapter">chapter</a><ul><li>5.1.4.2.3.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:xhtml.nodes.section" href="#xhtml.nodes.section">section</a><ul><li>5.1.4.2.4.1&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:Admonition-nodes" href="#Admonition-nodes">Admonition nodes</a><ul><li>5.1.4.3.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.warning" href="#xhtml.nodes.warning">warning</a></li><li>5.1.4.3.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.caution" href="#xhtml.nodes.caution">caution</a></li><li>5.1.4.3.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.important" href="#xhtml.nodes.important">important</a></li><li>5.1.4.3.4&nbsp;&nbsp;<a id="rev:xhtml.nodes.note" href="#xhtml.nodes.note">note</a></li><li>5.1.4.3.5&nbsp;&nbsp;<a id="rev:xhtml.nodes.tip" href="#xhtml.nodes.tip">tip</a></li></ul></li><li>5.1.4.4&nbsp;&nbsp;<a id="rev:Auxilary-materials" href="#Auxilary-materials">Auxilary materials</a><ul><li>5.1.4.4.1&nbsp;&nbsp;<a id="rev:xhtml.nodes.figure" href="#xhtml.nodes.figure">figure</a></li><li>5.1.4.4.2&nbsp;&nbsp;<a id="rev:xhtml.nodes.table" href="#xhtml.nodes.table">table</a></li><li>5.1.4.4.3&nbsp;&nbsp;<a id="rev:xhtml.nodes.example" href="#xhtml.nodes.example">example</a></li><li>5.1.4.4.4&nbsp;&nbsp;<a id="rev:xhtml.nodes.equation" href="#xhtml.nodes.equation">equation</a></li><li>5.1.4.4.5&nbsp;&nbsp;<a id="rev:xhtml.nodes.procedure" href="#xhtml.nodes.procedure">procedure</a></li></ul></li><li>5.1.4.5&nbsp;&nbsp;<a id="rev:Bibliographical-nodes" href="#Bibliographical-nodes">Bibliographical nodes</a><ul><li>5.1.4.5.1&nbsp;&nbsp;<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&nbsp;&nbsp;<a id="rev:xhtml.nodes.cite" href="#xhtml.nodes.cite">cite</a></li></ul></li></ul></li></ul></li><li>5.2&nbsp;&nbsp;<a id="rev:text" href="#text">Plain text</a></li><li>5.3&nbsp;&nbsp;<a id="rev:latex" href="#latex">LaTeX (PDF)</a></li><li>5.4&nbsp;&nbsp;<a id="rev:man" href="#man">UNIX manual page</a></li></ul></li><li>6&nbsp;&nbsp;<a id="rev:History" href="#History">History</a><ul><li>6.1&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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&nbsp;&nbsp;<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>
677
677
 
678
678
  <li><a id="rev:References" href="#References">References</a></li>
679
679
  </ul>
@@ -693,14 +693,14 @@
693
693
  <br/>
694
694
  <big>Introduction</big>
695
695
  </h1>
696
- <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>
696
+ <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. &quot;Creating your own document format&quot;">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>
697
697
 
698
- <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&#8230; <a class="xref" href="#License" title="Section 1.2. License">patches are welcome</a>!</p> <strong>ERBook</strong> is exciting because:</p>
698
+ <p>A working <a class="xref" href="#xhtml" title="Chapter 5.1. &quot;XHTML (web page)&quot;">XHTML (web page)</a> format is provided, while <a class="xref" href="#latex" title="Chapter 5.3. &quot;LaTeX (PDF)&quot;">LaTeX (PDF)</a>, <a class="xref" href="#man" title="Chapter 5.4. &quot;UNIX manual page&quot;">UNIX manual page</a>, and <a class="xref" href="#text" title="Chapter 5.2. &quot;Plain text&quot;">plain text</a> formats are planned&#8230; <a class="xref" href="#License" title="Section 1.2. &quot;License&quot;">patches are welcome</a>!</p> <strong>ERBook</strong> is exciting because:</p>
699
699
 
700
700
  <ul>
701
701
  <li>Its documents are scriptable <a href='http://en.wikipedia.org/wiki/ERuby'>eRuby templates</a>.</li>
702
702
 
703
- <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>
703
+ <li>It lets you <a class="xref" href="#HelloWorld" title="Section 3.2.3. &quot;Creating your own document format&quot;">define your own document formats</a>.</li>
704
704
 
705
705
  <li>Its core contains less than 300 lines of code.</li>
706
706
  </ul>
@@ -727,14 +727,14 @@
727
727
  1.1&nbsp;&nbsp;Logistics
728
728
  </h2>
729
729
  <div class="content"><ul>
730
- <li><a class="xref" href="#history" title="Chapter 6. Project history">Release notes</a> &#8212; history of project releases.</li>
730
+ <li><a class="xref" href="#History" title="Chapter 6. &quot;History&quot;">Release notes</a> &#8212; history of project releases.</li>
731
731
 
732
732
  <li><a href='http://github.com/sunaku/erbook'>Source code</a> &#8212; obtain via <a href='http://git.or.cz'>Git</a> or browse online.</li>
733
733
 
734
734
  <li><a href='api/index.html'>API reference</a> &#8212; documentation for source code.</li>
735
735
  </ul>
736
736
 
737
- <p>To get help or provide feedback, simply <a class="xref" href="#License" title="Section 1.2. License">contact the authors</a>.</p>
737
+ <p>To get help or provide feedback, simply <a class="xref" href="#License" title="Section 1.2. &quot;License&quot;">contact the authors</a>.</p>
738
738
 
739
739
  <p><div class="paragraph">
740
740
  <a name="Version-numbers"/><div class="nav" id="Version-numbers"><a title="Reverse jump to listing" href="#rev:Version-numbers">&equiv;</a><a title="Jump to previous segment" href="#Logistics">&#x25B3;</a><a title="Jump to next segment" href="#License">&#x25BD;</a><a title="Jump to this segment" href="#Version-numbers">&#x25CE;</a></div>
@@ -779,7 +779,9 @@
779
779
  <h2 class="title">
780
780
  1.2&nbsp;&nbsp;License
781
781
  </h2>
782
- <div class="content"><p>Copyright 2006 Suraj N. Kurapati <a href='mailto:sunaku@gmail.com'>&#115;&#117;&#110;&#097;&#107;&#117;&#064;&#103;&#109;&#097;&#105;&#108;&#046;&#099;&#111;&#109;</a></p>
782
+ <div class="content"><p>(the ISC license)</p>
783
+
784
+ <p>Copyright 2006 Suraj N. Kurapati <a href='mailto:sunaku@gmail.com'>&#115;&#117;&#110;&#097;&#107;&#117;&#064;&#103;&#109;&#097;&#105;&#108;&#046;&#099;&#111;&#109;</a></p>
783
785
 
784
786
  <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>
785
787
 
@@ -789,14 +791,30 @@
789
791
  <h2 class="title">
790
792
  1.3&nbsp;&nbsp;Credits
791
793
  </h2>
792
- <div class="content"><img src='erbook.png' alt='ERBook logo' />
793
- <p>The &#8220;erbook.png&#8221; image and its &#8220;erbook.svg&#8221; source utilize the <a href='http://openclipart.org/media/files/lemmling/9065'>&#8220;cartoon owl sitting on a book&#8221;</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>
794
+ <div class="content"><a href='#Credits' class='xref' title='Section 1.3. &quot;Credits&quot;'><img src='erbook.png' alt='ERBook logo' /></a>
795
+ <p>The &#8220;erbook.png&#8221; image and its &#8220;erbook.svg&#8221; source utilize the <a href='http://openclipart.org/media/files/lemmling/9065'>&#8220;cartoon owl sitting on a book&#8221;</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>
796
+
797
+ <p><strong>ERBook</strong> is made possible by <a class="xref" href="#History" title="Chapter 6. &quot;History&quot;">contributions</a> from users like you:</p>
798
+
799
+ <ul>
800
+ <li>Jens Vierbuchen</li>
801
+
802
+ <li>Maunika Gosike</li>
803
+
804
+ <li><a href='http://lifegoo.pluskid.org'>Zhang Chiyuan</a></li>
805
+ </ul></div>
794
806
  </div> <div class="section">
795
807
  <a name="Reviews"/><div class="nav" id="Reviews"><a title="Reverse jump to listing" href="#rev:Reviews">&equiv;</a><a title="Jump to previous segment" href="#Credits">&#x25B3;</a><a title="Jump to next segment" href="#Setup">&#x25BD;</a><a title="Jump to this segment" href="#Reviews">&#x25CE;</a></div>
796
808
  <h2 class="title">
797
809
  1.4&nbsp;&nbsp;Reviews
798
810
  </h2>
799
- <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>
811
+ <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>
812
+
813
+ <blockquote>
814
+ <p>This documentation is simply gorgeous!</p>
815
+ </blockquote>
816
+
817
+ <p>Vitor Peres in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052'>ruby-talk</a>:</p>
800
818
 
801
819
  <blockquote>
802
820
  <p>I actually felt like printing [this manual], because it&#8217;s just so well-thought typographically&#8230; Even if [<strong>ERBook</strong>] weren&#8217;t great by itself, I&#8217;d feel good just looking at the manual.</p>
@@ -805,7 +823,7 @@
805
823
  <p>Ara T. Howard in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/282949'>ruby-talk</a>:</p>
806
824
 
807
825
  <blockquote>
808
- <p>[this manual is] a insanely complete and nice looking bit of documentation [&#8230; <strong>ERBook</strong>] looks like a great project</p>
826
+ <p>[This manual is] a insanely complete and nice looking bit of documentation [&#8230; <strong>ERBook</strong>] looks like a great project</p>
809
827
  </blockquote>
810
828
 
811
829
  <p>Martin DeMello in <a href='http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283304'>ruby-talk</a>:</p>
@@ -847,12 +865,12 @@
847
865
  <p>If the installation was successful, you will see output like this:</p>
848
866
 
849
867
  <p><pre>project: ERBook
850
- version: 6.0.1
851
- release: 2009-01-19
868
+ version: 6.1.0
869
+ release: 2009-02-14
852
870
  website: http://snk.tuxfamily.org/lib/erbook/
853
871
  install: /home/sun/src/erbook</pre></p>
854
872
 
855
- <p>Otherwise, you can <a class="xref" href="#License" title="Section 1.2. License">contact the author</a> for help.</p></div>
873
+ <p>Otherwise, you can <a class="xref" href="#License" title="Section 1.2. &quot;License&quot;">contact the author</a> for help.</p></div>
856
874
  </div> <div class="section">
857
875
  <a name="Manifest"/><div class="nav" id="Manifest"><a title="Reverse jump to listing" href="#rev:Manifest">&equiv;</a><a title="Jump to previous segment" href="#Installation">&#x25B3;</a><a title="Jump to next segment" href="#Theory-of-operation">&#x25BD;</a><a title="Jump to this segment" href="#Manifest">&#x25CE;</a></div>
858
876
  <h2 class="title">
@@ -872,7 +890,7 @@ install: /home/sun/src/erbook</pre></p>
872
890
  </li>
873
891
 
874
892
  <li>
875
- <p><tt>fmt/</tt> &#8212; 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>
893
+ <p><tt>fmt/</tt> &#8212; contains the predefined set of <a class="xref" href="#SpecFile" title="Section 3.2. &quot;Format specification file&quot;">format specification files</a>. If you ever need to install your custom format specification file globally, then put it inside this directory.</p>
876
894
  </li>
877
895
 
878
896
  <li>
@@ -904,7 +922,7 @@ install: /home/sun/src/erbook</pre></p>
904
922
 
905
923
  <ul>
906
924
  <li>
907
- <p><tt>to_xhtml.rb</tt> &#8212; 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>
925
+ <p><tt>to_xhtml.rb</tt> &#8212; provides methods (see <a class="xref" href="#Text-to-XHTML-conversion">Section 5.1.1. &#8220;Text to XHTML conversion&#8221;</a>) for the <a class="xref" href="#xhtml">Chapter 5.1. &#8220;XHTML (web page)&#8221;</a> format.</p>
908
926
  </li>
909
927
 
910
928
  <li>
@@ -950,7 +968,7 @@ install: /home/sun/src/erbook</pre></p>
950
968
 
951
969
  <ol>
952
970
  <li>
953
- <p>Loads the <a class="xref" href="#SpecFile" title="Section 3.2. Format specification file">format specification file</a>.</p>
971
+ <p>Loads the <a class="xref" href="#SpecFile" title="Section 3.2. &quot;Format specification file&quot;">format specification file</a>.</p>
954
972
  </li>
955
973
 
956
974
  <li>
@@ -962,7 +980,7 @@ install: /home/sun/src/erbook</pre></p>
962
980
  </li>
963
981
 
964
982
  <li>
965
- <p>Evaluating <a class="xref" href="#include" title="Section 4.2. Including external documents">include directives</a> in the input.</p>
983
+ <p>Evaluating <a class="xref" href="#include" title="Section 4.2. &quot;Including external documents&quot;">include directives</a> in the input.</p>
966
984
  </li>
967
985
  </ul>
968
986
  </li>
@@ -972,17 +990,17 @@ install: /home/sun/src/erbook</pre></p>
972
990
 
973
991
  <ul>
974
992
  <li>
975
- <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>
993
+ <p>Building a <strong>document tree</strong> data structure from <a class="xref" href="#Nodes" title="Section 3.1. &quot;Nodes&quot;">nodes</a> present in the input document.</p>
976
994
  </li>
977
995
 
978
996
  <li>
979
- <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>
997
+ <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. &quot;Node output template&quot;">node output template</a>.</p>
980
998
  </li>
981
999
  </ul>
982
1000
  </li>
983
1001
 
984
1002
  <li>
985
- <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>
1003
+ <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. &quot;Document output template&quot;">document output template</a>.</p>
986
1004
  </li>
987
1005
 
988
1006
  <li>
@@ -1033,9 +1051,9 @@ install: /home/sun/src/erbook</pre></p>
1033
1051
  <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>
1034
1052
  </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>
1035
1053
  </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>
1036
- </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>
1054
+ </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. &#8220;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&#8221;</a>) representing this method invocation</td>
1037
1055
  </tr></tbody></table>
1038
- <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>
1056
+ <p>A <a class="xref" href="#SpecFile" title="Section 3.2. &quot;Format specification file&quot;">format specification file</a> defines what types of nodes an input document may use.</p>
1039
1057
 
1040
1058
  <p><div class="section">
1041
1059
  <a name="Node.class"/><div class="nav" id="Node.class"><a title="Reverse jump to listing" href="#rev:Node.class">&equiv;</a><a title="Jump to previous segment" href="#Nodes">&#x25B3;</a><a title="Jump to next segment" href="#SpecFile">&#x25BD;</a><a title="Jump to this segment" href="#Node.class">&#x25CE;</a></div>
@@ -1065,8 +1083,8 @@ install: /home/sun/src/erbook</pre></p>
1065
1083
  <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>
1066
1084
  <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>
1067
1085
  </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>
1068
- </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>
1069
- </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>
1086
+ </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. &quot;Node definition&quot;">node definitions</a>.</td>
1087
+ </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. &#8220;Document output template&#8221;</a>.</td>
1070
1088
  </tr></tbody></table>
1071
1089
  <p><div class="section">
1072
1090
  <a name="SpecFile.nodes"/><div class="nav" id="SpecFile.nodes"><a title="Reverse jump to listing" href="#rev:SpecFile.nodes">&equiv;</a><a title="Jump to previous segment" href="#SpecFile">&#x25B3;</a><a title="Jump to next segment" href="#SpecFile.nodes.output">&#x25BD;</a><a title="Jump to this segment" href="#SpecFile.nodes">&#x25CE;</a></div>
@@ -1077,7 +1095,7 @@ install: /home/sun/src/erbook</pre></p>
1077
1095
  <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>
1078
1096
  </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>
1079
1097
  </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>
1080
- </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>
1098
+ </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. &#8220;Node output template&#8221;</a>.</td>
1081
1099
  </tr><tr><td style='text-align: left;'>inline</td><td style='text-align: left;'>Boolean</td><td style='text-align: left;'>Is node&#8217;s output an in-line string of text that can be embedded anywhere in the document?</td>
1082
1100
  </tr></tbody></table>
1083
1101
  <p>You may define additional parameters in a node definition if you want.</p>
@@ -1128,11 +1146,11 @@ install: /home/sun/src/erbook</pre></p>
1128
1146
 
1129
1147
  <ul>
1130
1148
  <li>
1131
- <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>
1149
+ <p>We define a <code class="code">generate_name()</code> method in <a class="xref" href="#HelloWorld.spec">Example 1. &#8220;HelloWorld format specification file&#8221;</a> and make use of it in the <a class="xref" href="#HelloWorld.input">Example 2. &#8220;Input document for HelloWorld format&#8221;</a>. This shows how to provide format-specific functionality to an input document.</p>
1132
1150
  </li>
1133
1151
 
1134
1152
  <li>
1135
- <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>
1153
+ <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. &#8220;Input document for HelloWorld format&#8221;</a> and make use of it in <a class="xref" href="#HelloWorld.spec">Example 1. &#8220;HelloWorld format specification file&#8221;</a>. This shows how to pass parameters from an input document to your format specification file.</p>
1136
1154
  </li>
1137
1155
  </ul>
1138
1156
 
@@ -1140,11 +1158,11 @@ install: /home/sun/src/erbook</pre></p>
1140
1158
 
1141
1159
  <ol>
1142
1160
  <li>
1143
- <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>
1161
+ <p>Save the code shown in <a class="xref" href="#HelloWorld.spec">Example 1. &#8220;HelloWorld format specification file&#8221;</a> to a file named <tt>HelloWorld.spec</tt></p>
1144
1162
  </li>
1145
1163
 
1146
1164
  <li>
1147
- <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>
1165
+ <p>Save the text shown in <a class="xref" href="#HelloWorld.input">Example 2. &#8220;Input document for HelloWorld format&#8221;</a> to a file named <tt>HelloWorld.input</tt></p>
1148
1166
  </li>
1149
1167
 
1150
1168
  <li>
@@ -1315,7 +1333,7 @@ My name is nil and these are my properties:
1315
1333
 
1316
1334
  <dl style='border-left: thick dotted LightGrey; padding-left: 1em;'>
1317
1335
  <dt>args</dt>
1318
- <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Hopeful</span><span style="color:#710">&quot;</span></span>, <span style="color:#60E;font-weight:bold">0.129688166237699</span>]</code></dd>
1336
+ <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Hopeful</span><span style="color:#710">&quot;</span></span>, <span style="color:#60E;font-weight:bold">0.737155765329912</span>]</code></dd>
1319
1337
 
1320
1338
  <dt>index</dt>
1321
1339
  <dd><code class="code"><span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">1.1.1</span><span style="color:#710">&quot;</span></span></code></dd>
@@ -1337,7 +1355,7 @@ My name is nil and these are my properties:
1337
1355
 
1338
1356
  <dl style='border-left: thick dotted LightGrey; padding-left: 1em;'>
1339
1357
  <dt>args</dt>
1340
- <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Confused</span><span style="color:#710">&quot;</span></span>, <span style="color:#60E;font-weight:bold">0.0535821548187691</span>]</code></dd>
1358
+ <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Confused</span><span style="color:#710">&quot;</span></span>, <span style="color:#60E;font-weight:bold">0.444444669437529</span>]</code></dd>
1341
1359
 
1342
1360
  <dt>index</dt>
1343
1361
  <dd><code class="code"><span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">1.1.1.1</span><span style="color:#710">&quot;</span></span></code></dd>
@@ -1386,7 +1404,7 @@ My name is nil and these are my properties:
1386
1404
 
1387
1405
  <dl style='border-left: thick dotted LightGrey; padding-left: 1em;'>
1388
1406
  <dt>args</dt>
1389
- <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Sleepy</span><span style="color:#710">&quot;</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>
1407
+ <dd><code class="code">[<span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">Sleepy</span><span style="color:#710">&quot;</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>
1390
1408
 
1391
1409
  <dt>index</dt>
1392
1410
  <dd><code class="code"><span style="background-color:#fff0f0;color:#D20"><span style="color:#710">&quot;</span><span style="">1.2</span><span style="color:#710">&quot;</span></span></code></dd>
@@ -1514,24 +1532,25 @@ _Whoo I'm wild!_ ;-)
1514
1532
 
1515
1533
  Usage:
1516
1534
 
1517
- erbook [Option...] FormatName [InputFile]
1518
- erbook [Option...] FormatFile [InputFile]
1535
+ erbook [Options] FormatName [InputFile]
1536
+ erbook [Options] FormatFile [InputFile]
1519
1537
 
1520
1538
  FormatName:
1521
- latex: high-quality typesetting
1522
- man: manual page for UNIX
1523
- xhtml: web page for the Internet
1524
- text: plain text, nothing fancy
1539
+ latex: high-quality typesetting
1540
+ man: manual page for UNIX
1541
+ xhtml: web page for the Internet
1542
+ text: plain text, nothing fancy
1525
1543
 
1526
- Option:
1527
- --unindent, -u: Unindent node content hierarchically
1528
- --manual, -m: Show the user manual
1529
- --version, -v: Print version and exit
1530
- --help, -h: Show this message</pre></p>
1544
+ Options:
1545
+ --unindent, -u: Unindent node content hierarchically
1546
+ --manual, -m: Show the user manual
1547
+ --locale, -l &lt;s&gt;: Set preferred language
1548
+ --version, -v: Print version and exit
1549
+ --help, -h: Show this message</pre></p>
1531
1550
 
1532
- <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>
1551
+ <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. &quot;Format specification file&quot;">format specification file</a> (FormatFile).</p>
1533
1552
 
1534
- <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>
1553
+ <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. &#8220;Manifest&#8221;</a>).</p>
1535
1554
 
1536
1555
  <p><div class="section">
1537
1556
  <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">&equiv;</a><a title="Jump to previous segment" href="#Command-line-interface">&#x25B3;</a><a title="Jump to next segment" href="#Save-XHTML-output-as-.xhtml">&#x25BD;</a><a title="Jump to this segment" href="#Saving-the-output-to-a-file">&#x25CE;</a></div>
@@ -1542,13 +1561,13 @@ Option:
1542
1561
 
1543
1562
  <pre>erbook &gt; YOUR_PATH_HERE</pre>
1544
1563
 
1545
- <p>In the above example, <strong>YOUR_PATH_HERE</strong> is the path of the file in which the output should be saved.</p>
1564
+ <p>In the above example, <em>YOUR_PATH_HERE</em> is the path of the file in which the output should be saved.</p>
1546
1565
 
1547
1566
  <p><div class="important">
1548
1567
  <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">&equiv;</a><a title="Jump to previous segment" href="#Saving-the-output-to-a-file">&#x25B3;</a><a title="Jump to next segment" href="#include">&#x25BD;</a><a title="Jump to this segment" href="#Save-XHTML-output-as-.xhtml">&#x25CE;</a></div>
1549
1568
  <p class="title">Important 1.&nbsp;&nbsp;Save XHTML output as <tt>.xhtml</tt></p>
1550
1569
  <div class="content">
1551
- <img class="icon" alt="important" src="&icon_important;"/>
1570
+ <img alt="important" class="icon" src="&icon_important;"/>
1552
1571
  <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>
1553
1572
 
1554
1573
  <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>
@@ -1564,7 +1583,7 @@ Option:
1564
1583
 
1565
1584
  <pre>&lt;%# include YOUR_PATH_HERE #%&gt;</pre>
1566
1585
 
1567
- <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>
1586
+ <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>
1568
1587
 
1569
1588
  <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>
1570
1589
  </div> <div class="section">
@@ -1572,9 +1591,9 @@ Option:
1572
1591
  <h2 class="title">
1573
1592
  4.3&nbsp;&nbsp;Unindenting nodes hierarchically
1574
1593
  </h2>
1575
- <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>
1594
+ <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>
1576
1595
 
1577
- <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>
1596
+ <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>
1578
1597
  </div></p></div>
1579
1598
  </div>
1580
1599
  <div class="part">
@@ -1584,9 +1603,9 @@ Option:
1584
1603
  <br/>
1585
1604
  <big>Formats</big>
1586
1605
  </h1>
1587
- <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>
1606
+ <div class="content"><p>This part describes the default formats provided along with ERBook. The <a class="xref" href="#SpecFile" title="Section 3.2. &quot;Format specification file&quot;">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. &#8220;Manifest&#8221;</a>).</p>
1588
1607
 
1589
- <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>
1608
+ <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. &quot;License&quot;">contact the author</a>.</p>
1590
1609
 
1591
1610
  <p><div class="chapter">
1592
1611
  <a name="xhtml"/><div class="nav" id="xhtml"><a title="Reverse jump to listing" href="#rev:xhtml">&equiv;</a><a title="Jump to previous segment" href="#Formats">&#x25B3;</a><a title="Jump to next segment" href="#Text-to-XHTML-conversion">&#x25BD;</a><a title="Jump to this segment" href="#xhtml">&#x25CE;</a></div>
@@ -1606,7 +1625,7 @@ Option:
1606
1625
  <h3 class="title">
1607
1626
  5.1.1&nbsp;&nbsp;Text to XHTML conversion
1608
1627
  </h3>
1609
- <div class="content"><p>The <tt>lib/erbook/to_xhtml.rb</tt> file inside ERBook&#8217;s installation directory (see <a class="xref" href="#Manifest">Section 2.3. Manifest</a>) defines the following methods:</p>
1628
+ <div class="content"><p>The <tt>lib/erbook/to_xhtml.rb</tt> file inside ERBook&#8217;s installation directory (see <a class="xref" href="#Manifest">Section 2.3. &#8220;Manifest&#8221;</a>) defines the following methods:</p>
1610
1629
 
1611
1630
  <ul>
1612
1631
  <li>
@@ -1948,9 +1967,9 @@ at the root.
1948
1967
  <li>an optional <em>unique identifier</em> for the node</li>
1949
1968
  </ol>
1950
1969
 
1951
- <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>
1970
+ <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. &#8220;xref&#8221;</a> and <a class="xref" href="#xhtml.nodes.cite">Section 5.1.4.5.2. &#8220;cite&#8221;</a>), which allow you to refer to another node in the document by its unique identifier.</p>
1952
1971
 
1953
- <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>
1972
+ <p>Furthermore, <a class="xref" href="#SpecFile.nodes" title="Section 3.2.1. &quot;Node definition&quot;">node definitions</a> in the XHTML format have two additional parameters:</p>
1954
1973
  <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>
1955
1974
  </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>
1956
1975
  </tr></tbody></table>
@@ -1994,13 +2013,13 @@ at the root.
1994
2013
 
1995
2014
  <pre>&lt;%= xref &quot;SpecFile&quot; %&gt;</pre>
1996
2015
 
1997
- <p>appears in the output document like this: <a class="xref" href="#SpecFile">Section 3.2. Format specification file</a>.</p>
2016
+ <p>appears in the output document like this: <a class="xref" href="#SpecFile">Section 3.2. &#8220;Format specification file&#8221;</a>.</p>
1998
2017
 
1999
2018
  <p>As another example, this node in the input document:</p>
2000
2019
 
2001
2020
  <pre>&lt;%= xref &quot;SpecFile&quot;, &quot;custom link text&quot; %&gt;</pre>
2002
2021
 
2003
- <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>
2022
+ <p>appears in the output document like this: <a class="xref" href="#SpecFile" title="Section 3.2. &quot;Format specification file&quot;">custom link text</a>.</p></div>
2004
2023
  </div></p></div>
2005
2024
  </div> <div class="section">
2006
2025
  <a name="Organizational-nodes"/><div class="nav" id="Organizational-nodes"><a title="Reverse jump to listing" href="#rev:Organizational-nodes">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.xref">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.node">&#x25BD;</a><a title="Jump to this segment" href="#Organizational-nodes">&#x25CE;</a></div>
@@ -2066,39 +2085,39 @@ at the root.
2066
2085
  <div class="content"><p>This is how a <strong>section</strong> node appears.</p></div>
2067
2086
  </div></p></div>
2068
2087
  </div> <div class="section">
2069
- <a name="xhtml.nodes.paragraph"/><div class="nav" id="xhtml.nodes.paragraph"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.paragraph">&equiv;</a><a title="Jump to previous segment" href="#An-example-5.1.4.2.4.1">&#x25B3;</a><a title="Jump to next segment" href="#An-example-609366268">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.paragraph">&#x25CE;</a></div>
2088
+ <a name="xhtml.nodes.paragraph"/><div class="nav" id="xhtml.nodes.paragraph"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.paragraph">&equiv;</a><a title="Jump to previous segment" href="#An-example-5.1.4.2.4.1">&#x25B3;</a><a title="Jump to next segment" href="#An-example-613122798">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.paragraph">&#x25CE;</a></div>
2070
2089
  <h5 class="title">
2071
2090
  5.1.4.2.5&nbsp;&nbsp;paragraph
2072
2091
  </h5>
2073
2092
  <div class="content"><p>A collection of sentences about a particular idea.</p>
2074
2093
 
2075
2094
  <p><div class="paragraph">
2076
- <a name="An-example-609366268"/><div class="nav" id="An-example-609366268"><a title="Reverse jump to listing" href="#rev:An-example-609366268">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.paragraph">&#x25B3;</a><a title="Jump to next segment" href="#Admonition-nodes">&#x25BD;</a><a title="Jump to this segment" href="#An-example-609366268">&#x25CE;</a></div>
2095
+ <a name="An-example-613122798"/><div class="nav" id="An-example-613122798"><a title="Reverse jump to listing" href="#rev:An-example-613122798">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.paragraph">&#x25B3;</a><a title="Jump to next segment" href="#Admonition-nodes">&#x25BD;</a><a title="Jump to this segment" href="#An-example-613122798">&#x25CE;</a></div>
2077
2096
  <p class="title">An example</p>
2078
2097
  <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>
2079
2098
  </div></p></div>
2080
2099
  </div></p></div>
2081
2100
  </div> <div class="section">
2082
- <a name="Admonition-nodes"/><div class="nav" id="Admonition-nodes"><a title="Reverse jump to listing" href="#rev:Admonition-nodes">&equiv;</a><a title="Jump to previous segment" href="#An-example-609366268">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.warning">&#x25BD;</a><a title="Jump to this segment" href="#Admonition-nodes">&#x25CE;</a></div>
2101
+ <a name="Admonition-nodes"/><div class="nav" id="Admonition-nodes"><a title="Reverse jump to listing" href="#rev:Admonition-nodes">&equiv;</a><a title="Jump to previous segment" href="#An-example-613122798">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.warning">&#x25BD;</a><a title="Jump to this segment" href="#Admonition-nodes">&#x25CE;</a></div>
2083
2102
  <h4 class="title">
2084
2103
  5.1.4.3&nbsp;&nbsp;Admonition nodes
2085
2104
  </h4>
2086
2105
  <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>
2087
2106
 
2088
- <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>
2107
+ <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>
2089
2108
 
2090
2109
  <p> <div class="section">
2091
2110
  <a name="xhtml.nodes.warning"/><div class="nav" id="xhtml.nodes.warning"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.warning">&equiv;</a><a title="Jump to previous segment" href="#Admonition-nodes">&#x25B3;</a><a title="Jump to next segment" href="#An-example-1">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.warning">&#x25CE;</a></div>
2092
2111
  <h5 class="title">
2093
2112
  5.1.4.3.1&nbsp;&nbsp;warning
2094
2113
  </h5>
2095
- <div class="content"><p>Use a <strong>warning</strong> node when &#8220;data loss could occur if you follow the procedure being described.&#8221; <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
2114
+ <div class="content"><p>Use a <strong>warning</strong> node when &#8220;data loss could occur if you follow the procedure being described.&#8221; <sup>[<a class="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
2096
2115
 
2097
2116
  <p><div class="warning">
2098
2117
  <a name="An-example-1"/><div class="nav" id="An-example-1"><a title="Reverse jump to listing" href="#rev:An-example-1">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.warning">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.caution">&#x25BD;</a><a title="Jump to this segment" href="#An-example-1">&#x25CE;</a></div>
2099
2118
  <p class="title">Warning 1.&nbsp;&nbsp;An example</p>
2100
2119
  <div class="content">
2101
- <img class="icon" alt="warning" src="&icon_warning;"/>
2120
+ <img alt="warning" class="icon" src="&icon_warning;"/>
2102
2121
  <p>This is how a <strong>warning</strong> node appears.</p>
2103
2122
  </div>
2104
2123
  </div></p></div>
@@ -2107,13 +2126,13 @@ at the root.
2107
2126
  <h5 class="title">
2108
2127
  5.1.4.3.2&nbsp;&nbsp;caution
2109
2128
  </h5>
2110
- <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&#8217;t correctly follow the procedure being outlined. <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
2129
+ <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&#8217;t correctly follow the procedure being outlined. <sup>[<a class="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
2111
2130
 
2112
2131
  <p><div class="caution">
2113
2132
  <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">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.caution">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.important">&#x25BD;</a><a title="Jump to this segment" href="#An-example-1-1">&#x25CE;</a></div>
2114
2133
  <p class="title">Caution 1.&nbsp;&nbsp;An example</p>
2115
2134
  <div class="content">
2116
- <img class="icon" alt="caution" src="&icon_caution;"/>
2135
+ <img alt="caution" class="icon" src="&icon_caution;"/>
2117
2136
  <p>This is how a <strong>caution</strong> node appears.</p>
2118
2137
  </div>
2119
2138
  </div></p></div>
@@ -2124,13 +2143,13 @@ at the root.
2124
2143
  </h5>
2125
2144
  <div class="content"><p>Use an <strong>important</strong> node when:</p>
2126
2145
 
2127
- <p>bq. When there is no danger of data loss, but you wish to make clear to the reader a consequence that isn&#8217;t immediately obvious (e.g. when changing the font for one instance of a program also changes the default setting, and this isn&#8217;t clear from the GUI.) <sup>[<a class="cite" href="#KDE.admonitions">1</a>]</sup></p>
2146
+ <p>bq. When there is no danger of data loss, but you wish to make clear to the reader a consequence that isn&#8217;t immediately obvious (e.g. when changing the font for one instance of a program also changes the default setting, and this isn&#8217;t clear from the GUI.) <sup>[<a class="xref" href="#KDE.admonitions" title="Reference 1">1</a>]</sup></p>
2128
2147
 
2129
2148
  <p><div class="important">
2130
2149
  <a name="An-example-2"/><div class="nav" id="An-example-2"><a title="Reverse jump to listing" href="#rev:An-example-2">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.important">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.note">&#x25BD;</a><a title="Jump to this segment" href="#An-example-2">&#x25CE;</a></div>
2131
2150
  <p class="title">Important 2.&nbsp;&nbsp;An example</p>
2132
2151
  <div class="content">
2133
- <img class="icon" alt="important" src="&icon_important;"/>
2152
+ <img alt="important" class="icon" src="&icon_important;"/>
2134
2153
  <p>This is how a <strong>important</strong> node appears.</p>
2135
2154
  </div>
2136
2155
  </div></p></div>
@@ -2141,13 +2160,13 @@ at the root.
2141
2160
  </h5>
2142
2161
  <div class="content"><p>Use a <strong>note</strong> node to convey:</p>
2143
2162
 
2144
- <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>
2163
+ <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>
2145
2164
 
2146
2165
  <p><div class="note">
2147
2166
  <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">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.note">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.tip">&#x25BD;</a><a title="Jump to this segment" href="#An-example-1-1-1">&#x25CE;</a></div>
2148
2167
  <p class="title">Note 1.&nbsp;&nbsp;An example</p>
2149
2168
  <div class="content">
2150
- <img class="icon" alt="note" src="&icon_note;"/>
2169
+ <img alt="note" class="icon" src="&icon_note;"/>
2151
2170
  <p>This is how a <strong>note</strong> node appears.</p>
2152
2171
  </div>
2153
2172
  </div></p></div>
@@ -2158,13 +2177,13 @@ at the root.
2158
2177
  </h5>
2159
2178
  <div class="content"><p>Use a <strong>tip</strong> node when:</p>
2160
2179
 
2161
- <p>bq. When you&#8217;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>
2180
+ <p>bq. When you&#8217;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>
2162
2181
 
2163
2182
  <p><div class="tip">
2164
2183
  <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">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.tip">&#x25B3;</a><a title="Jump to next segment" href="#Auxilary-materials">&#x25BD;</a><a title="Jump to this segment" href="#An-example-1-1-1-1">&#x25CE;</a></div>
2165
2184
  <p class="title">Tip 1.&nbsp;&nbsp;An example</p>
2166
2185
  <div class="content">
2167
- <img class="icon" alt="tip" src="&icon_tip;"/>
2186
+ <img alt="tip" class="icon" src="&icon_tip;"/>
2168
2187
  <p>This is how a <strong>tip</strong> node appears.</p>
2169
2188
  </div>
2170
2189
  </div></p></div>
@@ -2243,25 +2262,25 @@ at the root.
2243
2262
  <div class="content"><p>The nodes in this section deal with attribution of ideas&#8212;an important weapon against plagiarism.</p>
2244
2263
 
2245
2264
  <p><div class="section">
2246
- <a name="xhtml.nodes.reference"/><div class="nav" id="xhtml.nodes.reference"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.reference">&equiv;</a><a title="Jump to previous segment" href="#Bibliographical-nodes">&#x25B3;</a><a title="Jump to next segment" href="#An-example-609682968">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.reference">&#x25CE;</a></div>
2265
+ <a name="xhtml.nodes.reference"/><div class="nav" id="xhtml.nodes.reference"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.reference">&equiv;</a><a title="Jump to previous segment" href="#Bibliographical-nodes">&#x25B3;</a><a title="Jump to next segment" href="#An-example-613425188">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.reference">&#x25CE;</a></div>
2247
2266
  <h5 class="title">
2248
2267
  5.1.4.5.1&nbsp;&nbsp;reference
2249
2268
  </h5>
2250
2269
  <div class="content"><p>This node stores bibliography information about an information source that is relevant to your document.</p>
2251
2270
 
2252
- <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>
2271
+ <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. &#8220;cite&#8221;</a>) to perform the citation.</p>
2253
2272
 
2254
2273
  <p><div class="paragraph">
2255
- <a name="An-example-609682968"/><div class="nav" id="An-example-609682968"><a title="Reverse jump to listing" href="#rev:An-example-609682968">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.reference">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.cite">&#x25BD;</a><a title="Jump to this segment" href="#An-example-609682968">&#x25CE;</a></div>
2274
+ <a name="An-example-613425188"/><div class="nav" id="An-example-613425188"><a title="Reverse jump to listing" href="#rev:An-example-613425188">&equiv;</a><a title="Jump to previous segment" href="#xhtml.nodes.reference">&#x25B3;</a><a title="Jump to next segment" href="#xhtml.nodes.cite">&#x25BD;</a><a title="Jump to this segment" href="#An-example-613425188">&#x25CE;</a></div>
2256
2275
  <p class="title">An example</p>
2257
2276
  <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>
2258
2277
  </div> </p></div>
2259
2278
  </div> <div class="section">
2260
- <a name="xhtml.nodes.cite"/><div class="nav" id="xhtml.nodes.cite"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.cite">&equiv;</a><a title="Jump to previous segment" href="#An-example-609682968">&#x25B3;</a><a title="Jump to next segment" href="#text">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.cite">&#x25CE;</a></div>
2279
+ <a name="xhtml.nodes.cite"/><div class="nav" id="xhtml.nodes.cite"><a title="Reverse jump to listing" href="#rev:xhtml.nodes.cite">&equiv;</a><a title="Jump to previous segment" href="#An-example-613425188">&#x25B3;</a><a title="Jump to next segment" href="#text">&#x25BD;</a><a title="Jump to this segment" href="#xhtml.nodes.cite">&#x25CE;</a></div>
2261
2280
  <h5 class="title">
2262
2281
  5.1.4.5.2&nbsp;&nbsp;cite
2263
2282
  </h5>
2264
- <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&#8217;s bibliography.</p>
2283
+ <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. &#8220;reference&#8221;</a>) in the document&#8217;s bibliography.</p>
2265
2284
 
2266
2285
  <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>
2267
2286
 
@@ -2269,13 +2288,13 @@ at the root.
2269
2288
 
2270
2289
  <pre>&lt;%= cite &quot;xhtml.nodes.reference.example&quot; %&gt;</pre>
2271
2290
 
2272
- <p>appears in the output document like this: <sup>[<a class="cite" href="#xhtml.nodes.reference.example">2</a>]</sup></p>
2291
+ <p>appears in the output document like this: <sup>[<a class="xref" href="#xhtml.nodes.reference.example" title="Reference 2">2</a>]</sup></p>
2273
2292
 
2274
2293
  <p>As another example, this node in the input document:</p>
2275
2294
 
2276
2295
  <pre>&lt;%= cite &quot;xhtml.nodes.reference.example&quot;, &quot;chapter 10&quot;, &quot;page 53&quot;, &quot;...&quot; %&gt;</pre>
2277
2296
 
2278
- <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>
2297
+ <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>
2279
2298
  </div></p></div>
2280
2299
  </div></p></div>
2281
2300
  </div></p></div>
@@ -2300,7 +2319,7 @@ at the root.
2300
2319
  <div class="content"><p>This format is not yet implemented. Patches are welcome! :-)</p>
2301
2320
  <a href='http://www.latex-project.org'>http://www.latex-project.org</a></div>
2302
2321
  </div> <div class="chapter">
2303
- <a name="man"/><div class="nav" id="man"><a title="Reverse jump to listing" href="#rev:man">&equiv;</a><a title="Jump to previous segment" href="#latex">&#x25B3;</a><a title="Jump to next segment" href="#history">&#x25BD;</a><a title="Jump to this segment" href="#man">&#x25CE;</a></div>
2322
+ <a name="man"/><div class="nav" id="man"><a title="Reverse jump to listing" href="#rev:man">&equiv;</a><a title="Jump to previous segment" href="#latex">&#x25B3;</a><a title="Jump to next segment" href="#History">&#x25BD;</a><a title="Jump to this segment" href="#man">&#x25CE;</a></div>
2304
2323
  <h1 class="title">
2305
2324
  Chapter&nbsp;5.4
2306
2325
  <br/>
@@ -2310,27 +2329,73 @@ at the root.
2310
2329
  <a href='http://en.wikipedia.org/wiki/Man_page'>http://en.wikipedia.org/wiki/Man_page</a></div>
2311
2330
  </div></p></div>
2312
2331
  </div><div class="chapter">
2313
- <a name="history"/><div class="nav" id="history"><a title="Reverse jump to listing" href="#rev:history">&equiv;</a><a title="Jump to previous segment" href="#man">&#x25B3;</a><a title="Jump to next segment" href="#Version-6.0.1-2009-01-19">&#x25BD;</a><a title="Jump to this segment" href="#history">&#x25CE;</a></div>
2332
+ <a name="History"/><div class="nav" id="History"><a title="Reverse jump to listing" href="#rev:History">&equiv;</a><a title="Jump to previous segment" href="#man">&#x25B3;</a><a title="Jump to next segment" href="#Version-6.1.0-2009-02-14">&#x25BD;</a><a title="Jump to this segment" href="#History">&#x25CE;</a></div>
2314
2333
  <h1 class="title">
2315
2334
  Chapter&nbsp;6
2316
2335
  <br/>
2317
- <big>Project history</big>
2336
+ <big>History</big>
2318
2337
  </h1>
2319
2338
  <div class="content"><p><p><div class="section">
2320
- <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">&equiv;</a><a title="Jump to previous segment" href="#history">&#x25B3;</a><a title="Jump to next segment" href="#Version-6.0.0-2009-01-19">&#x25BD;</a><a title="Jump to this segment" href="#Version-6.0.1-2009-01-19">&#x25CE;</a></div>
2339
+ <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">&equiv;</a><a title="Jump to previous segment" href="#History">&#x25B3;</a><a title="Jump to next segment" href="#New-features">&#x25BD;</a><a title="Jump to this segment" href="#Version-6.1.0-2009-02-14">&#x25CE;</a></div>
2321
2340
  <h2 class="title">
2322
- 6.1&nbsp;&nbsp;Version 6.0.1 (2009-01-19)
2341
+ 6.1&nbsp;&nbsp;Version 6.1.0 (2009-02-14)
2342
+ </h2>
2343
+ <div class="content"><p><div class="paragraph">
2344
+ <a name="New-features"/><div class="nav" id="New-features"><a title="Reverse jump to listing" href="#rev:New-features">&equiv;</a><a title="Jump to previous segment" href="#Version-6.1.0-2009-02-14">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes">&#x25BD;</a><a title="Jump to this segment" href="#New-features">&#x25CE;</a></div>
2345
+ <p class="title">New features</p>
2346
+ <div class="content"><ul>
2347
+ <li>
2348
+ <p>Added translations for English phrases used in the XHTML format (see the <tt>lang/</tt> directory).</p>
2349
+
2350
+ <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>
2351
+ </li>
2352
+
2353
+ <li>
2354
+ <p>Reduced brightness of links in local navigation menus; it was distracting from the main text of the document.</p>
2355
+ </li>
2356
+
2357
+ <li>
2358
+ <p>Draw the HTML &#60;hr/&#62; element as a dashed black line, instead of a <em>glaring</em> red line.</p>
2359
+ </li>
2360
+ </ul></div>
2361
+ </div> <div class="paragraph">
2362
+ <a name="Bug-fixes"/><div class="nav" id="Bug-fixes"><a title="Reverse jump to listing" href="#rev:Bug-fixes">&equiv;</a><a title="Jump to previous segment" href="#New-features">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes">&#x25CE;</a></div>
2363
+ <p class="title">Bug fixes</p>
2364
+ <div class="content"><ul>
2365
+ <li>LaTeX-style index numbers were calculated incorrectly for descendants of the &#8220;node&#8221; node.</li>
2366
+ </ul></div>
2367
+ </div> <div class="paragraph">
2368
+ <a name="Housekeeping"/><div class="nav" id="Housekeeping"><a title="Reverse jump to listing" href="#rev:Housekeeping">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes">&#x25B3;</a><a title="Jump to next segment" href="#Version-6.0.1-2009-01-19">&#x25BD;</a><a title="Jump to this segment" href="#Housekeeping">&#x25CE;</a></div>
2369
+ <p class="title">Housekeeping</p>
2370
+ <div class="content"><ul>
2371
+ <li>
2372
+ <p>Add release notes for past releases&#8230; two years have already passed since I started this project! Where did the time go?</p>
2373
+ </li>
2374
+
2375
+ <li>
2376
+ <p>List all contributors in the <a class="xref" href="#Credits" title="Section 1.3. &quot;Credits&quot;">Credits section</a> and make project logo a hyperlink to that section so interested people can quickly learn the source of the logo.</p>
2377
+ </li>
2378
+
2379
+ <li>
2380
+ <p>Mention that project license is ISC for reader&#8217;s convenience.</p>
2381
+ </li>
2382
+ </ul></div>
2383
+ </div></p></div>
2384
+ </div> <div class="section">
2385
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Housekeeping">&#x25B3;</a><a title="Jump to next segment" href="#Version-6.0.0-2009-01-19">&#x25BD;</a><a title="Jump to this segment" href="#Version-6.0.1-2009-01-19">&#x25CE;</a></div>
2386
+ <h2 class="title">
2387
+ 6.2&nbsp;&nbsp;Version 6.0.1 (2009-01-19)
2323
2388
  </h2>
2324
2389
  <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>
2325
2390
  </div> <div class="section">
2326
2391
  <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">&equiv;</a><a title="Jump to previous segment" href="#Version-6.0.1-2009-01-19">&#x25B3;</a><a title="Jump to next segment" href="#Incompatible-changes">&#x25BD;</a><a title="Jump to this segment" href="#Version-6.0.0-2009-01-19">&#x25CE;</a></div>
2327
2392
  <h2 class="title">
2328
- 6.1&nbsp;&nbsp;Version 6.0.0 (2009-01-19)
2393
+ 6.3&nbsp;&nbsp;Version 6.0.0 (2009-01-19)
2329
2394
  </h2>
2330
2395
  <div class="content"><p>This release improves the appearance &amp; usability of the XHTML format, refactors the core logic into reusable libraries, fixes some bugs and improves variable names.</p>
2331
2396
 
2332
2397
  <p><div class="paragraph">
2333
- <a name="Incompatible-changes"/><div class="nav" id="Incompatible-changes"><a title="Reverse jump to listing" href="#rev:Incompatible-changes">&equiv;</a><a title="Jump to previous segment" href="#Version-6.0.0-2009-01-19">&#x25B3;</a><a title="Jump to next segment" href="#New-features">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes">&#x25CE;</a></div>
2398
+ <a name="Incompatible-changes"/><div class="nav" id="Incompatible-changes"><a title="Reverse jump to listing" href="#rev:Incompatible-changes">&equiv;</a><a title="Jump to previous segment" href="#Version-6.0.0-2009-01-19">&#x25B3;</a><a title="Jump to next segment" href="#New-features-613455288">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes">&#x25CE;</a></div>
2334
2399
  <p class="title">Incompatible changes</p>
2335
2400
  <div class="content"><ul>
2336
2401
  <li>
@@ -2342,7 +2407,7 @@ at the root.
2342
2407
  </li>
2343
2408
  </ul></div>
2344
2409
  </div> <div class="paragraph">
2345
- <a name="New-features"/><div class="nav" id="New-features"><a title="Reverse jump to listing" href="#rev:New-features">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes">&#x25BD;</a><a title="Jump to this segment" href="#New-features">&#x25CE;</a></div>
2410
+ <a name="New-features-613455288"/><div class="nav" id="New-features-613455288"><a title="Reverse jump to listing" href="#rev:New-features-613455288">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-613490318">&#x25BD;</a><a title="Jump to this segment" href="#New-features-613455288">&#x25CE;</a></div>
2346
2411
  <p class="title">New features</p>
2347
2412
  <div class="content"><ul>
2348
2413
  <li>
@@ -2354,7 +2419,7 @@ at the root.
2354
2419
  </li>
2355
2420
 
2356
2421
  <li>
2357
- <p>Added &#8220;inline&#8221; node definition parameter (see <a class="xref" href="#SpecFile.nodes">Section 3.2.1. Node definition</a>).</p>
2422
+ <p>Added &#8220;inline&#8221; node definition parameter (see <a class="xref" href="#SpecFile.nodes">Section 3.2.1. &#8220;Node definition&#8221;</a>).</p>
2358
2423
  </li>
2359
2424
 
2360
2425
  <li>
@@ -2370,7 +2435,7 @@ at the root.
2370
2435
  </li>
2371
2436
 
2372
2437
  <li>
2373
- <p>Added a &#8220;node&#8221; 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>
2438
+ <p>Added a &#8220;node&#8221; node (see <a class="xref" href="#xhtml.nodes.node">Section 5.1.4.2.1. &#8220;node&#8221;</a>), which serves as a pass-through container, in the XHTML format.</p>
2374
2439
  </li>
2375
2440
 
2376
2441
  <li>
@@ -2392,7 +2457,7 @@ at the root.
2392
2457
  </li>
2393
2458
  </ul></div>
2394
2459
  </div> <div class="paragraph">
2395
- <a name="Bug-fixes"/><div class="nav" id="Bug-fixes"><a title="Reverse jump to listing" href="#rev:Bug-fixes">&equiv;</a><a title="Jump to previous segment" href="#New-features">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes">&#x25CE;</a></div>
2460
+ <a name="Bug-fixes-613490318"/><div class="nav" id="Bug-fixes-613490318"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613490318">&equiv;</a><a title="Jump to previous segment" href="#New-features-613455288">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping-613510338">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-613490318">&#x25CE;</a></div>
2396
2461
  <p class="title">Bug fixes</p>
2397
2462
  <div class="content"><ul>
2398
2463
  <li>
@@ -2408,7 +2473,7 @@ at the root.
2408
2473
  </li>
2409
2474
  </ul></div>
2410
2475
  </div> <div class="paragraph">
2411
- <a name="Housekeeping"/><div class="nav" id="Housekeeping"><a title="Reverse jump to listing" href="#rev:Housekeeping">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes">&#x25B3;</a>&#x25BD;<a title="Jump to this segment" href="#Housekeeping">&#x25CE;</a></div>
2476
+ <a name="Housekeeping-613510338"/><div class="nav" id="Housekeeping-613510338"><a title="Reverse jump to listing" href="#rev:Housekeeping-613510338">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-613490318">&#x25B3;</a><a title="Jump to next segment" href="#Version-5.0.0-2008-11-22">&#x25BD;</a><a title="Jump to this segment" href="#Housekeeping-613510338">&#x25CE;</a></div>
2412
2477
  <p class="title">Housekeeping</p>
2413
2478
  <div class="content"><ul>
2414
2479
  <li>
@@ -2424,12 +2489,488 @@ at the root.
2424
2489
  </li>
2425
2490
  </ul></div>
2426
2491
  </div></p></div>
2492
+ </div> <div class="section">
2493
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Housekeeping-613510338">&#x25B3;</a><a title="Jump to next segment" href="#Incompatible-changes-613551298">&#x25BD;</a><a title="Jump to this segment" href="#Version-5.0.0-2008-11-22">&#x25CE;</a></div>
2494
+ <h2 class="title">
2495
+ 6.4&nbsp;&nbsp;Version 5.0.0 (2008-11-22)
2496
+ </h2>
2497
+ <div class="content"><p>This release renames the &#8220;html&#8221; format to &#8220;xhtml&#8221;, 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>
2498
+
2499
+ <p><div class="paragraph">
2500
+ <a name="Incompatible-changes-613551298"/><div class="nav" id="Incompatible-changes-613551298"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613551298">&equiv;</a><a title="Jump to previous segment" href="#Version-5.0.0-2008-11-22">&#x25B3;</a><a title="Jump to next segment" href="#New-features-613563748">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes-613551298">&#x25CE;</a></div>
2501
+ <p class="title">Incompatible changes</p>
2502
+ <div class="content"><ul>
2503
+ <li>
2504
+ <p>Renamed the &#8220;html&#8221; format to &#8220;xhtml&#8221; (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>
2505
+ </li>
2506
+
2507
+ <li>
2508
+ <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>
2509
+ </li>
2510
+
2511
+ <li>
2512
+ <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>
2513
+ </li>
2514
+
2515
+ <li>
2516
+ <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 &#8220;Setup&#8221; section in the user manual for details.</p>
2517
+ </li>
2518
+ </ul></div>
2519
+ </div> <div class="paragraph">
2520
+ <a name="New-features-613563748"/><div class="nav" id="New-features-613563748"><a title="Reverse jump to listing" href="#rev:New-features-613563748">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes-613551298">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-613575558">&#x25BD;</a><a title="Jump to this segment" href="#New-features-613563748">&#x25CE;</a></div>
2521
+ <p class="title">New features</p>
2522
+ <div class="content"><ul>
2523
+ <li>
2524
+ <p>Added support for single-line eRuby directives (lines which begin with &#8221;%&#8221;), 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>
2525
+ </li>
2526
+
2527
+ <li>
2528
+ <p>Enhanced stack traces with information about the input file and also <tt>&lt;%#include#%&gt;</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>
2529
+ </li>
2530
+
2531
+ <li>
2532
+ <p>Omitted erbook internals from stack traces (unless in $DEBUG mode). This helps users concentrate on problems in their input document.</p>
2533
+ </li>
2534
+
2535
+ <li>
2536
+ <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>
2537
+ </li>
2538
+ </ul></div>
2539
+ </div> <div class="paragraph">
2540
+ <a name="Bug-fixes-613575558"/><div class="nav" id="Bug-fixes-613575558"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613575558">&equiv;</a><a title="Jump to previous segment" href="#New-features-613563748">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping-612924428">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-613575558">&#x25CE;</a></div>
2541
+ <p class="title">Bug fixes</p>
2542
+ <div class="content"><ul>
2543
+ <li>
2544
+ <p>Could not jump to examples and admonitions from the list of figures.</p>
2545
+ </li>
2546
+
2547
+ <li>
2548
+ <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>
2549
+ </li>
2550
+ </ul></div>
2551
+ </div> <div class="paragraph">
2552
+ <a name="Housekeeping-612924428"/><div class="nav" id="Housekeeping-612924428"><a title="Reverse jump to listing" href="#rev:Housekeeping-612924428">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-613575558">&#x25B3;</a><a title="Jump to next segment" href="#Version-4.0.0-2008-11-15">&#x25BD;</a><a title="Jump to this segment" href="#Housekeeping-612924428">&#x25CE;</a></div>
2553
+ <p class="title">Housekeeping</p>
2554
+ <div class="content"><ul>
2555
+ <li>Added API documentation for all methods listed in the user manual, while also omitting many irrelevant methods from the list.</li>
2556
+ </ul></div>
2557
+ </div></p></div>
2558
+ </div> <div class="section">
2559
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Housekeeping-612924428">&#x25B3;</a><a title="Jump to next segment" href="#Contributor-kudos">&#x25BD;</a><a title="Jump to this segment" href="#Version-4.0.0-2008-11-15">&#x25CE;</a></div>
2560
+ <h2 class="title">
2561
+ 6.5&nbsp;&nbsp;Version 4.0.0 (2008-11-15)
2562
+ </h2>
2563
+ <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>
2564
+
2565
+ <p><div class="paragraph">
2566
+ <a name="Contributor-kudos"/><div class="nav" id="Contributor-kudos"><a title="Reverse jump to listing" href="#rev:Contributor-kudos">&equiv;</a><a title="Jump to previous segment" href="#Version-4.0.0-2008-11-15">&#x25B3;</a><a title="Jump to next segment" href="#Incompatible-changes-613060388">&#x25BD;</a><a title="Jump to this segment" href="#Contributor-kudos">&#x25CE;</a></div>
2567
+ <p class="title">Contributor kudos</p>
2568
+ <div class="content"><ul>
2569
+ <li>
2570
+ <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>
2571
+ <a href='#Credits' class='xref' title='Section 1.3. &quot;Credits&quot;'><img src='erbook.png' alt='ERBook logo' /></a></li>
2572
+
2573
+ <li>
2574
+ <p>Maunika Gosike provided usability feedback to help improve the HTML format.</p>
2575
+ </li>
2576
+ </ul></div>
2577
+ </div> <div class="paragraph">
2578
+ <a name="Incompatible-changes-613060388"/><div class="nav" id="Incompatible-changes-613060388"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613060388">&equiv;</a><a title="Jump to previous segment" href="#Contributor-kudos">&#x25B3;</a><a title="Jump to next segment" href="#New-features-613094628">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes-613060388">&#x25CE;</a></div>
2579
+ <p class="title">Incompatible changes</p>
2580
+ <div class="content"><ul>
2581
+ <li>
2582
+ <p>The &#8220;Gerbil&#8221; project has been renamed to &#8220;erbook&#8221; to better reflect its purpose: it allows you to write books and documents using eRuby.</p>
2583
+ </li>
2584
+
2585
+ <li>
2586
+ <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>
2587
+ </li>
2588
+
2589
+ <li>
2590
+ <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>
2591
+ </li>
2592
+
2593
+ <li>
2594
+ <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>
2595
+ </li>
2596
+ </ul></div>
2597
+ </div> <div class="paragraph">
2598
+ <a name="New-features-613094628"/><div class="nav" id="New-features-613094628"><a title="Reverse jump to listing" href="#rev:New-features-613094628">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes-613060388">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping-613184078">&#x25BD;</a><a title="Jump to this segment" href="#New-features-613094628">&#x25CE;</a></div>
2599
+ <p class="title">New features</p>
2600
+ <div class="content"><ul>
2601
+ <li>
2602
+ <p>Added admonition icon for HTML <code class="code">&lt;blockquote&gt;</code> element.</p>
2603
+ </li>
2604
+
2605
+ <li>
2606
+ <p>A visual marker is shown on outgoing (external) hyperlinks.</p>
2607
+ </li>
2608
+
2609
+ <li>
2610
+ <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>
2611
+ </li>
2612
+ </ul></div>
2613
+ </div> <div class="paragraph">
2614
+ <a name="Housekeeping-613184078"/><div class="nav" id="Housekeeping-613184078"><a title="Reverse jump to listing" href="#rev:Housekeeping-613184078">&equiv;</a><a title="Jump to previous segment" href="#New-features-613094628">&#x25B3;</a><a title="Jump to next segment" href="#Version-3.1.0-2008-06-22">&#x25BD;</a><a title="Jump to this segment" href="#Housekeeping-613184078">&#x25CE;</a></div>
2615
+ <p class="title">Housekeeping</p>
2616
+ <div class="content"><ul>
2617
+ <li>
2618
+ <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 &#8220;frags&#8221; rather than &#8220;anchors&#8221; or &#8220;urls&#8221; from now on.</p>
2619
+ </li>
2620
+
2621
+ <li>
2622
+ <p>Refactored common logic from node output templates into Node class.</p>
2623
+ </li>
2624
+ </ul></div>
2625
+ </div></p></div>
2626
+ </div> <div class="section">
2627
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Housekeeping-613184078">&#x25B3;</a><a title="Jump to next segment" href="#New-features-613336208">&#x25BD;</a><a title="Jump to this segment" href="#Version-3.1.0-2008-06-22">&#x25CE;</a></div>
2628
+ <h2 class="title">
2629
+ 6.6&nbsp;&nbsp;Version 3.1.0 (2008-06-22)
2630
+ </h2>
2631
+ <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 &#8220;print preview&#8221; function in your browser; the output is simply beautiful!), and repairing some defects.</p>
2632
+
2633
+ <p><div class="paragraph">
2634
+ <a name="New-features-613336208"/><div class="nav" id="New-features-613336208"><a title="Reverse jump to listing" href="#rev:New-features-613336208">&equiv;</a><a title="Jump to previous segment" href="#Version-3.1.0-2008-06-22">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-613365218">&#x25BD;</a><a title="Jump to this segment" href="#New-features-613336208">&#x25CE;</a></div>
2635
+ <p class="title">New features</p>
2636
+ <div class="content"><ul>
2637
+ <li>The file size of the HTML format&#8217;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>
2638
+ </ul>
2639
+
2640
+ <p>Usability</p>
2641
+
2642
+ <ul>
2643
+ <li>
2644
+ <p>All headings are now hyperlinks to themselves. This allows readers to obtain a &#8220;permanent link&#8221; to any section in your HTML document.</p>
2645
+ </li>
2646
+
2647
+ <li>
2648
+ <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>
2649
+ </li>
2650
+
2651
+ <li>
2652
+ <p>The color of visited hyperlinks has been darkened to improve readability.</p>
2653
+ </li>
2654
+
2655
+ <li>
2656
+ <p>The style of <strong>blockquote</strong> now provides better focus on its content.</p>
2657
+ </li>
2658
+
2659
+ <li>
2660
+ <p>Cross-reference (xref) hyperlinks now have a mouse-hover title when you override the default link text.</p>
2661
+ </li>
2662
+ </ul>
2663
+
2664
+ <p>Printing</p>
2665
+
2666
+ <ul>
2667
+ <li>
2668
+ <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>
2669
+ </li>
2670
+
2671
+ <li>
2672
+ <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>
2673
+ </li>
2674
+
2675
+ <li>
2676
+ <p>Internal hyperlinks (which point to internal URI fragments) that are not cross-references are now shown as normal text to reduce distraction.</p>
2677
+ </li>
2678
+ </ul></div>
2679
+ </div> <div class="paragraph">
2680
+ <a name="Bug-fixes-613365218"/><div class="nav" id="Bug-fixes-613365218"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613365218">&equiv;</a><a title="Jump to previous segment" href="#New-features-613336208">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping-613389138">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-613365218">&#x25CE;</a></div>
2681
+ <p class="title">Bug fixes</p>
2682
+ <div class="content"><ul>
2683
+ <li>Cross-reference (xref) hyperlinks to paragraphs were broken due to a missing <strong>id</strong> attribute.</li>
2684
+ </ul></div>
2685
+ </div> <div class="paragraph">
2686
+ <a name="Housekeeping-613389138"/><div class="nav" id="Housekeeping-613389138"><a title="Reverse jump to listing" href="#rev:Housekeeping-613389138">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-613365218">&#x25B3;</a><a title="Jump to next segment" href="#Version-3.0.2-2008-06-08">&#x25BD;</a><a title="Jump to this segment" href="#Housekeeping-613389138">&#x25CE;</a></div>
2687
+ <p class="title">Housekeeping</p>
2688
+ <div class="content"><ul>
2689
+ <li>Removed useless CSS styles and fixed some XHTML validation issues.</li>
2690
+ </ul></div>
2691
+ </div></p></div>
2692
+ </div> <div class="section">
2693
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Housekeeping-613389138">&#x25B3;</a><a title="Jump to next segment" href="#Version-3.0.1-2008-06-03">&#x25BD;</a><a title="Jump to this segment" href="#Version-3.0.2-2008-06-08">&#x25CE;</a></div>
2694
+ <h2 class="title">
2695
+ 6.7&nbsp;&nbsp;Version 3.0.2 (2008-06-08)
2696
+ </h2>
2697
+ <div class="content"><p>This release implements a shorter, faster, better unindentation algorithm which:</p>
2698
+
2699
+ <ul>
2700
+ <li>Allows block beginnings <code class="code" lang="rhtml"><span style="background:#eee"><span style="font-weight:bold;color:#888">&lt;%</span> <span style="color:#080;font-weight:bold">do</span> <span style="font-weight:bold;color:#888">%&gt;</span></span></code> and endings <code class="code" lang="rhtml"><span style="background:#eee"><span style="font-weight:bold;color:#888">&lt;%</span> <span style="color:#080;font-weight:bold">end</span> <span style="font-weight:bold;color:#888">%&gt;</span></span></code> to span multiple lines.</li>
2701
+
2702
+ <li>Ignores blank lines (which may contain whitespace) after block beginnings.</li>
2703
+
2704
+ <li>Processes multiple lines per iteration, instead of one line at a time.</li>
2705
+ </ul></div>
2706
+ </div> <div class="section">
2707
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Version-3.0.2-2008-06-08">&#x25B3;</a><a title="Jump to next segment" href="#Version-3.0.0-2008-06-01">&#x25BD;</a><a title="Jump to this segment" href="#Version-3.0.1-2008-06-03">&#x25CE;</a></div>
2708
+ <h2 class="title">
2709
+ 6.8&nbsp;&nbsp;Version 3.0.1 (2008-06-03)
2710
+ </h2>
2711
+ <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>
2712
+ </div> <div class="section">
2713
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Version-3.0.1-2008-06-03">&#x25B3;</a><a title="Jump to next segment" href="#Incompatible-changes-613457568">&#x25BD;</a><a title="Jump to this segment" href="#Version-3.0.0-2008-06-01">&#x25CE;</a></div>
2714
+ <h2 class="title">
2715
+ 6.9&nbsp;&nbsp;Version 3.0.0 (2008-06-01)
2716
+ </h2>
2717
+ <div class="content"><p>This release improves the <strong>unindent</strong> feature and changes the <strong>include</strong> directive&#8217;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>
2718
+
2719
+ <p><div class="paragraph">
2720
+ <a name="Incompatible-changes-613457568"/><div class="nav" id="Incompatible-changes-613457568"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613457568">&equiv;</a><a title="Jump to previous segment" href="#Version-3.0.0-2008-06-01">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-613478758">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes-613457568">&#x25CE;</a></div>
2721
+ <p class="title">Incompatible changes</p>
2722
+ <div class="content"><ul>
2723
+ <li>
2724
+ <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>
2725
+ </li>
2726
+
2727
+ <li>
2728
+ <p>The <strong>include</strong> directive now has a symmetric # at the closing end: <pre>&lt;%# include ... #%&gt;</pre></p>
2729
+ </li>
2730
+ </ul></div>
2731
+ </div> <div class="paragraph">
2732
+ <a name="Bug-fixes-613478758"/><div class="nav" id="Bug-fixes-613478758"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613478758">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes-613457568">&#x25B3;</a><a title="Jump to next segment" href="#Version-2.1.0-2008-05-29">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-613478758">&#x25CE;</a></div>
2733
+ <p class="title">Bug fixes</p>
2734
+ <div class="content"><ul>
2735
+ <li>
2736
+ <p>The CSS for the horizontal rule (hr) element should now be consistent in all browsers.</p>
2737
+ </li>
2738
+
2739
+ <li>
2740
+ <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>
2741
+
2742
+ <ul>
2743
+ <li><code class="code">header_outside_above</code> - above the entire header block</li>
2744
+
2745
+ <li><code class="code">header_inside_above </code> - above the default header content</li>
2746
+
2747
+ <li><code class="code">header_inside_below </code> - below the default header content</li>
2748
+
2749
+ <li><code class="code">header_outside_below</code> - below the entire header block</li>
2750
+
2751
+ <li><code class="code">footer_outside_above</code> - above the entire footer block</li>
2752
+
2753
+ <li><code class="code">footer_inside_above </code> - above the default footer content</li>
2754
+
2755
+ <li><code class="code">footer_inside_below </code> - below the default footer content</li>
2756
+
2757
+ <li><code class="code">footer_outside_below</code> - below the entire footer block</li>
2758
+ </ul>
2759
+ </li>
2760
+ </ul></div>
2761
+ </div></p></div>
2762
+ </div> <div class="section">
2763
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-613478758">&#x25B3;</a><a title="Jump to next segment" href="#Version-2.0.0-2008-02-03">&#x25BD;</a><a title="Jump to this segment" href="#Version-2.1.0-2008-05-29">&#x25CE;</a></div>
2764
+ <h2 class="title">
2765
+ 6.10&nbsp;&nbsp;Version 2.1.0 (2008-05-29)
2766
+ </h2>
2767
+ <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>
2768
+ </div> <div class="section">
2769
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Version-2.1.0-2008-05-29">&#x25B3;</a><a title="Jump to next segment" href="#Incompatible-changes-613565638">&#x25BD;</a><a title="Jump to this segment" href="#Version-2.0.0-2008-02-03">&#x25CE;</a></div>
2770
+ <h2 class="title">
2771
+ 6.11&nbsp;&nbsp;Version 2.0.0 (2008-02-03)
2772
+ </h2>
2773
+ <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>
2774
+
2775
+ <p><div class="paragraph">
2776
+ <a name="Incompatible-changes-613565638"/><div class="nav" id="Incompatible-changes-613565638"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-613565638">&equiv;</a><a title="Jump to previous segment" href="#Version-2.0.0-2008-02-03">&#x25B3;</a><a title="Jump to next segment" href="#New-features-613589358">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes-613565638">&#x25CE;</a></div>
2777
+ <p class="title">Incompatible changes</p>
2778
+ <div class="content"><ul>
2779
+ <li>The <tt>lib/gerbil/rdoc.rb</tt> library has changed! Read it for details.</li>
2780
+ </ul></div>
2781
+ </div> <div class="paragraph">
2782
+ <a name="New-features-613589358"/><div class="nav" id="New-features-613589358"><a title="Reverse jump to listing" href="#rev:New-features-613589358">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes-613565638">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-613601568">&#x25BD;</a><a title="Jump to this segment" href="#New-features-613589358">&#x25CE;</a></div>
2783
+ <p class="title">New features</p>
2784
+ <div class="content"><ul>
2785
+ <li>
2786
+ <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>
2787
+
2788
+ <ul>
2789
+ <li><code class="code">header_outside_above</code> - above the entire header block</li>
2790
+
2791
+ <li><code class="code">header_inside_above </code> - above the default header content</li>
2792
+
2793
+ <li><code class="code">header_inside_below </code> - below the default header content</li>
2794
+
2795
+ <li><code class="code">header_outside_below</code> - below the entire header block</li>
2796
+
2797
+ <li><code class="code">footer_outside_above</code> - above the entire footer block</li>
2798
+
2799
+ <li><code class="code">footer_inside_above </code> - above the default footer content</li>
2800
+
2801
+ <li><code class="code">footer_inside_below </code> - below the default footer content</li>
2802
+
2803
+ <li><code class="code">footer_outside_below</code> - below the entire footer block</li>
2804
+ </ul>
2805
+ </li>
2806
+ </ul></div>
2807
+ </div> <div class="paragraph">
2808
+ <a name="Bug-fixes-613601568"/><div class="nav" id="Bug-fixes-613601568"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613601568">&equiv;</a><a title="Jump to previous segment" href="#New-features-613589358">&#x25B3;</a><a title="Jump to next segment" href="#Housekeeping-613616318">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-613601568">&#x25CE;</a></div>
2809
+ <p class="title">Bug fixes</p>
2810
+ <div class="content"><ul>
2811
+ <li>
2812
+ <p><a href='http://pluskid.lifegoo.com/?p=263'>Regexp substitution placeholders were being interpreted</a> in node content. In particular, any occurrences of &#8220;\0&#8221; in a node&#8217;s content was replaced by a strange SHA1 digest! (Zhang Chiyuan)</p>
2813
+ </li>
2814
+
2815
+ <li>
2816
+ <p>The <tt>lib/gerbil/rdoc.rb</tt> library did not extract method information recursively.</p>
2817
+ </li>
2818
+ </ul></div>
2819
+ </div> <div class="paragraph">
2820
+ <a name="Housekeeping-613616318"/><div class="nav" id="Housekeeping-613616318"><a title="Reverse jump to listing" href="#rev:Housekeeping-613616318">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-613601568">&#x25B3;</a><a title="Jump to next segment" href="#Version-1.1.0-2008-01-22">&#x25BD;</a><a title="Jump to this segment" href="#Housekeeping-613616318">&#x25CE;</a></div>
2821
+ <p class="title">Housekeeping</p>
2822
+ <div class="content"><ul>
2823
+ <li>
2824
+ <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>
2825
+ </li>
2826
+
2827
+ <li>
2828
+ <p>Fixed some Ruby code warnings in the <strong>html</strong> format.</p>
2829
+ </li>
2830
+ </ul></div>
2831
+ </div></p></div>
2832
+ </div> <div class="section">
2833
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Housekeeping-613616318">&#x25B3;</a><a title="Jump to next segment" href="#New-features-613634948">&#x25BD;</a><a title="Jump to this segment" href="#Version-1.1.0-2008-01-22">&#x25CE;</a></div>
2834
+ <h2 class="title">
2835
+ 6.12&nbsp;&nbsp;Version 1.1.0 (2008-01-22)
2836
+ </h2>
2837
+ <div class="content"><p>This release improves usability and fixes some bugs.</p>
2838
+
2839
+ <p><div class="paragraph">
2840
+ <a name="New-features-613634948"/><div class="nav" id="New-features-613634948"><a title="Reverse jump to listing" href="#rev:New-features-613634948">&equiv;</a><a title="Jump to previous segment" href="#Version-1.1.0-2008-01-22">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-613645288">&#x25BD;</a><a title="Jump to this segment" href="#New-features-613634948">&#x25CE;</a></div>
2841
+ <p class="title">New features</p>
2842
+ <div class="content"><ul>
2843
+ <li>External links are now marked with a &#8727; 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>
2844
+ </ul></div>
2845
+ </div> <div class="paragraph">
2846
+ <a name="Bug-fixes-613645288"/><div class="nav" id="Bug-fixes-613645288"><a title="Reverse jump to listing" href="#rev:Bug-fixes-613645288">&equiv;</a><a title="Jump to previous segment" href="#New-features-613634948">&#x25B3;</a><a title="Jump to next segment" href="#Version-1.0.0-2008-01-12">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-613645288">&#x25CE;</a></div>
2847
+ <p class="title">Bug fixes</p>
2848
+ <div class="content"><ul>
2849
+ <li>
2850
+ <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>
2851
+ </li>
2852
+
2853
+ <li>
2854
+ <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>
2855
+ </li>
2856
+ </ul></div>
2857
+ </div></p></div>
2858
+ </div> <div class="section">
2859
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-613645288">&#x25B3;</a><a title="Jump to next segment" href="#Incompatible-changes-612915118">&#x25BD;</a><a title="Jump to this segment" href="#Version-1.0.0-2008-01-12">&#x25CE;</a></div>
2860
+ <h2 class="title">
2861
+ 6.13&nbsp;&nbsp;Version 1.0.0 (2008-01-12)
2862
+ </h2>
2863
+ <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>
2864
+
2865
+ <p><div class="paragraph">
2866
+ <a name="Incompatible-changes-612915118"/><div class="nav" id="Incompatible-changes-612915118"><a title="Reverse jump to listing" href="#rev:Incompatible-changes-612915118">&equiv;</a><a title="Jump to previous segment" href="#Version-1.0.0-2008-01-12">&#x25B3;</a><a title="Jump to next segment" href="#Bug-fixes-612988718">&#x25BD;</a><a title="Jump to this segment" href="#Incompatible-changes-612915118">&#x25CE;</a></div>
2867
+ <p class="title">Incompatible changes</p>
2868
+ <div class="content"><ul>
2869
+ <li>
2870
+ <p>The <tt>gerbil</tt> file has been moved to <tt>bin/gerbil</tt>.</p>
2871
+ </li>
2872
+
2873
+ <li>
2874
+ <p>The <tt>format/</tt> directory has been renamed to <tt>fmt</tt>.</p>
2875
+ </li>
2876
+
2877
+ <li>
2878
+ <p>The <tt>format/html.rb</tt> file has been moved to <tt>lib/gerbil/html.rb</tt>.</p>
2879
+ </li>
2880
+
2881
+ <li>
2882
+ <p>The <tt>format/rdoc.rb</tt> file has been moved to <tt>lib/gerbil/rdoc.rb</tt>.</p>
2883
+ </li>
2884
+
2885
+ <li>
2886
+ <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 &#8594; trees) because it really returns an <em>array</em> of trees rather than a single tree.</p>
2887
+ </li>
2888
+
2889
+ <li>
2890
+ <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>
2891
+ </li>
2892
+
2893
+ <li>
2894
+ <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>
2895
+ </li>
2896
+ </ul></div>
2897
+ </div> <div class="paragraph">
2898
+ <a name="Bug-fixes-612988718"/><div class="nav" id="Bug-fixes-612988718"><a title="Reverse jump to listing" href="#rev:Bug-fixes-612988718">&equiv;</a><a title="Jump to previous segment" href="#Incompatible-changes-612915118">&#x25B3;</a><a title="Jump to next segment" href="#Version-0.0.1-2007-12-13">&#x25BD;</a><a title="Jump to this segment" href="#Bug-fixes-612988718">&#x25CE;</a></div>
2899
+ <p class="title">Bug fixes</p>
2900
+ <div class="content"><ul>
2901
+ <li>
2902
+ <p>User guide now says &#8220;gem install RedCloth&#8221; instead of &#8220;gem install redcloth&#8221;. I don&#8217;t see why RubyGems requires the correct capitalization, so I <a href='http://rubyforge.org/tracker/?func=detail&amp;aid=16937&amp;group_id=126&amp;atid=575'>filed a bug report</a> about it.</p>
2903
+ </li>
2904
+
2905
+ <li>
2906
+ <p>In the HTML format, images inside descendant nodes of a <em>figure</em> node were not properly centered.</p>
2907
+ </li>
2908
+
2909
+ <li>
2910
+ <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>
2911
+ </li>
2912
+ </ul></div>
2913
+ </div></p></div>
2914
+ </div> <div class="section">
2915
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Bug-fixes-612988718">&#x25B3;</a><a title="Jump to next segment" href="#Version-0.0.0-2007-12-09">&#x25BD;</a><a title="Jump to this segment" href="#Version-0.0.1-2007-12-13">&#x25CE;</a></div>
2916
+ <h2 class="title">
2917
+ 6.14&nbsp;&nbsp;Version 0.0.1 (2007-12-13)
2918
+ </h2>
2919
+ <div class="content"><ul>
2920
+ <li>
2921
+ <p>Fixed the generation of unique node URI fragments in the HTML format.</p>
2922
+ </li>
2923
+
2924
+ <li>
2925
+ <p>Added a <code class="code"><span style="color:#d70;font-weight:bold">$feeds</span></code> parameter to the HTML format.</p>
2926
+ </li>
2927
+
2928
+ <li>
2929
+ <p>Added the <tt>format/rdoc.rb</tt> library for accessing RDoc&#8217;s parse tree.</p>
2930
+ </li>
2931
+
2932
+ <li>
2933
+ <p>Updated the user guide:</p>
2934
+
2935
+ <ul>
2936
+ <li>added documentation for methods provided by the HTML format</li>
2937
+
2938
+ <li>added RSS feed for project release announcements</li>
2939
+
2940
+ <li>improved the ghastly HelloWorld example</li>
2941
+ </ul>
2942
+ </li>
2943
+
2944
+ <li>
2945
+ <p>Added a simple change-log (<tt>CHANGES.yaml</tt>) for the project.</p>
2946
+ </li>
2947
+ </ul></div>
2948
+ </div> <div class="section">
2949
+ <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">&equiv;</a><a title="Jump to previous segment" href="#Version-0.0.1-2007-12-13">&#x25B3;</a>&#x25BD;<a title="Jump to this segment" href="#Version-0.0.0-2007-12-09">&#x25CE;</a></div>
2950
+ <h2 class="title">
2951
+ 6.15&nbsp;&nbsp;Version 0.0.0 (2007-12-09)
2952
+ </h2>
2953
+ <div class="content"><p>Dear developers, technical writers, and documentation gurus,</p>
2954
+
2955
+ <p>I am proud to announce a new project of mine named &#8220;Gerbil&#8221; which is beautifully short (176 lines of code) and powerful!</p>
2956
+
2957
+ <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&#8217;m glad that&#8217;s over. :-)</p>
2958
+
2959
+ <p>The release notes are shown at the bottom of this message.</p>
2960
+
2961
+ <p>Cheers!</p>
2962
+ <hr />
2963
+ <p>This is the <em>first</em> release of <a href='http://gerbil.rubyforge.org.'>the Gerbil project</a> Happy birthday!</p>
2964
+
2965
+ <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&amp;aid=16202&amp;group_id=126&amp;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>
2966
+
2967
+ <p>Until this issue is resolved, please download the tarball/zip packages instead.</p></div>
2427
2968
  </div></p></p></div>
2428
2969
  </div></div>
2429
2970
 
2430
2971
  <div id="bib">
2431
2972
  <a name="References"/><div class="nav" id="References"><a title="Reverse jump to listing" href="#rev:References">&equiv;</a>&#x25B3;&#x25BD;<a title="Jump to this segment" href="#References">&#x25CE;</a></div>
2432
- <h1 class="title" >References</h1>
2973
+ <h1 class="title">References</h1>
2433
2974
  <ol>
2434
2975
  <li id="KDE.admonitions"><p>L. Watts, &#8220;Admonitions: Tips, hints, and Warnings&#8221;, 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>
2435
2976
  <li id="xhtml.nodes.reference.example"><p>This is how a <strong>reference</strong> node appears.</p></li>
@@ -2443,28 +2984,27 @@ at the root.
2443
2984
 
2444
2985
  <div id="footer">
2445
2986
 
2446
- Generated by <a href="http://snk.tuxfamily.org/lib/erbook/">ERBook 6.0.1</a> on Mon Jan 19 12:56:04 -0800 2009.
2447
2987
 
2448
2988
  <div id="footer-credits">
2449
2989
  <p>
2450
- <img class="icon" alt="caution" src="&icon_caution;"/>
2451
- <img class="icon" alt="tip" src="&icon_tip;"/>
2452
- <img class="icon" alt="important" src="&icon_important;"/>
2453
- <img class="icon" alt="note" src="&icon_note;"/>
2454
- <img class="icon" alt="warning" src="&icon_warning;"/>
2455
- <img class="icon" alt="quote" src="&icon_quote;"/>
2990
+ <img alt="caution" class="icon" src="&icon_caution;"/>
2991
+ <img alt="tip" class="icon" src="&icon_tip;"/>
2992
+ <img alt="important" class="icon" src="&icon_important;"/>
2993
+ <img alt="note" class="icon" src="&icon_note;"/>
2994
+ <img alt="warning" class="icon" src="&icon_warning;"/>
2995
+ <img alt="quote" class="icon" src="&icon_quote;"/>
2456
2996
 
2457
2997
  <br/>
2458
2998
 
2459
- The icons shown above are &copy; 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>.
2999
+ The icons shown above are part of <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a>, which is copyright &copy; 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>.
2460
3000
  </p>
2461
3001
 
2462
3002
  <p>
2463
- <img class="icon" alt="link" src="&icon_link;"/>
3003
+ <img alt="link" class="icon" src="&icon_link;"/>
2464
3004
 
2465
3005
  <br/>
2466
3006
 
2467
- The icons shown above are &copy; 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>.
3007
+ The icons shown above are part of <a href="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a>, which is copyright &copy; 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>.
2468
3008
  </p>
2469
3009
  </div>
2470
3010