erbook 6.1.0 → 7.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/bin/erbook +29 -25
- data/doc/HelloWorld.spec +3 -1
- data/doc/api/classes/ERBook.html +86 -0
- data/doc/api/classes/ERBook/Document.html +399 -0
- data/doc/api/classes/ERBook/Document/Node.html +110 -0
- data/doc/api/classes/ERBook/Template.html +309 -0
- data/doc/api/classes/ERBook/Template/Sandbox.html +134 -0
- data/doc/api/classes/RDoc.html +69 -0
- data/doc/api/classes/RDoc/AnyMethod.html +249 -0
- data/doc/api/classes/RDoc/DummyMarkup.html +60 -0
- data/doc/api/classes/RDoc/DummyMixin.html +54 -0
- data/doc/api/classes/RDoc/DummyOptions.html +60 -0
- data/doc/api/classes/RDoc/TopLevel.html +344 -0
- data/doc/api/classes/String.html +212 -0
- data/doc/api/created.rid +1 -0
- data/doc/api/css/main.css +263 -0
- data/doc/api/css/panel.css +383 -0
- data/doc/api/css/reset.css +53 -0
- data/doc/api/files/ANN_eml.html +276 -0
- data/doc/api/files/ANN_html.html +407 -0
- data/doc/api/files/ANN_txt.html +271 -0
- data/doc/api/files/LICENSE.html +76 -0
- data/doc/api/files/lib/erbook/document_rb.html +74 -0
- data/doc/api/files/lib/erbook/rdoc_rb.html +77 -0
- data/doc/api/files/lib/erbook/template_rb.html +66 -0
- data/doc/api/files/lib/erbook/to_xhtml_rb.html +89 -0
- data/doc/api/files/lib/erbook_rb.html +70 -0
- data/doc/api/i/arrows.png +0 -0
- data/doc/api/i/results_bg.png +0 -0
- data/doc/api/i/tree_bg.png +0 -0
- data/doc/api/index.html +14 -18
- data/doc/api/js/jquery-1.3.2.min.js +19 -0
- data/doc/api/js/jquery-effect.js +593 -0
- data/doc/api/js/main.js +22 -0
- data/doc/api/js/searchdoc.js +605 -0
- data/doc/api/panel/index.html +63 -0
- data/doc/api/panel/search_index.js +1 -0
- data/doc/api/panel/tree.js +1 -0
- data/doc/formats.erb +63 -115
- data/doc/history.erb +125 -92
- data/doc/index.erb +12 -7
- data/doc/index.xhtml +1020 -1347
- data/doc/intro.erb +42 -40
- data/doc/setup.erb +18 -18
- data/doc/theory.erb +24 -31
- data/doc/usage.erb +14 -24
- data/fmt/xhtml.icons/index.yaml +16 -14
- data/fmt/xhtml.icons/rakefile +33 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/16x16/places/start-here.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/32x32/actions/go-down.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/32x32/actions/go-up.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/32x32/places/start-here.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/32x32/status/software-update-available.png +0 -0
- data/fmt/xhtml.icons/{tango-icon-theme-0.8.1 → tango-icon-theme-0.8.90}/48x48/apps/accessories-text-editor.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/48x48/apps/internet-group-chat.png +0 -0
- data/fmt/xhtml.icons/{tango-icon-theme-0.8.1 → tango-icon-theme-0.8.90}/48x48/emblems/emblem-important.png +0 -0
- data/fmt/xhtml.icons/{tango-icon-theme-0.8.1 → tango-icon-theme-0.8.90}/48x48/status/dialog-error.png +0 -0
- data/fmt/xhtml.icons/{tango-icon-theme-0.8.1 → tango-icon-theme-0.8.90}/48x48/status/dialog-information.png +0 -0
- data/fmt/xhtml.icons/{tango-icon-theme-0.8.1 → tango-icon-theme-0.8.90}/48x48/status/dialog-warning.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/COPYING +1 -0
- data/fmt/xhtml.icons/{tango-icon-theme-0.8.1 → tango-icon-theme-0.8.90}/README +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/bookmark-new.svg +672 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/go-down.svg +200 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/go-home.svg +445 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/go-up.svg +196 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/actions/view-refresh.svg +393 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/apps/accessories-text-editor.svg +554 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/apps/internet-group-chat.svg +312 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/emblems/emblem-favorite.svg +242 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/emblems/emblem-important.svg +164 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/mimetypes/application-certificate.svg +443 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/places/start-here.svg +492 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/status/dialog-error.svg +330 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/status/dialog-information.svg +1159 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/status/dialog-warning.svg +373 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.90/scalable/status/software-update-available.svg +209 -0
- data/fmt/xhtml.scripts/jquery-1.3.2.min.js +19 -0
- data/fmt/xhtml.scripts/jquery.localscroll-1.2.7-min.js +9 -0
- data/fmt/xhtml.scripts/jquery.scrollTo-1.4.1-min.js +11 -0
- data/fmt/xhtml.yaml +470 -454
- data/lang/de.yaml +5 -5
- data/lang/el.yaml +4 -4
- data/lang/es.yaml +5 -5
- data/lang/fr.yaml +5 -5
- data/lang/it.yaml +5 -5
- data/lang/ja.yaml +4 -4
- data/lang/ko.yaml +4 -4
- data/lang/nl.yaml +4 -4
- data/lang/phrases.yaml +4 -4
- data/lang/pt.yaml +5 -5
- data/lang/ru.yaml +5 -5
- data/lang/zh.yaml +5 -5
- data/lang/zt.yaml +5 -5
- data/lib/erbook.rb +12 -5
- data/lib/erbook/document.rb +127 -107
- data/lib/erbook/rdoc.rb +18 -11
- data/lib/erbook/template.rb +86 -176
- data/lib/erbook/to_xhtml.rb +98 -25
- data/{Rakefile → rakefile} +1 -0
- metadata +106 -53
- data/doc/api/ERBook.html +0 -35
- data/doc/api/ERBook/Document.html +0 -669
- data/doc/api/ERBook/Document/Node.html +0 -102
- data/doc/api/ERBook/Template.html +0 -670
- data/doc/api/RDoc.html +0 -23
- data/doc/api/RDoc/AnyMethod.html +0 -302
- data/doc/api/RDoc/DummyMarkup.html +0 -73
- data/doc/api/RDoc/DummyMixin.html +0 -23
- data/doc/api/RDoc/DummyOptions.html +0 -140
- data/doc/api/RDoc/TopLevel.html +0 -465
- data/doc/api/String.html +0 -372
- data/doc/api/all-methods.html +0 -253
- data/doc/api/all-namespaces.html +0 -42
- data/doc/api/app.js +0 -18
- data/doc/api/jquery.js +0 -11
- data/doc/api/readme.html +0 -38
- data/doc/api/style.css +0 -68
- data/doc/api/syntax_highlight.css +0 -21
- data/fmt/xhtml.icons/tango-icon-theme-0.8.1/48x48/README +0 -2
- data/fmt/xhtml.icons/tango-icon-theme-0.8.1/48x48/apps/internet-group-chat.png +0 -0
- data/fmt/xhtml.icons/tango-icon-theme-0.8.1/COPYING +0 -67
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
4
|
+
|
|
5
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
6
|
+
<head>
|
|
7
|
+
<title>layout</title>
|
|
8
|
+
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
|
|
9
|
+
<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
<script src="search_index.js" type="text/javascript" charset="utf-8"></script>
|
|
11
|
+
<script src="tree.js" type="text/javascript" charset="utf-8"></script>
|
|
12
|
+
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
|
|
13
|
+
<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
|
|
14
|
+
<script type="text/javascript" charset="utf-8">
|
|
15
|
+
//<![CDATA[
|
|
16
|
+
function placeholder() {
|
|
17
|
+
if (jQuery.browser.safari) return;
|
|
18
|
+
$('#search-label').click(function() {
|
|
19
|
+
$('#search').focus();
|
|
20
|
+
$('#search-label').hide();
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
$('#search').focus(function() {
|
|
24
|
+
$('#search-label').hide();
|
|
25
|
+
});
|
|
26
|
+
$('#search').blur(function() {
|
|
27
|
+
this.value == '' && $('#search-label').show()
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
$('#search')[0].value == '' && $('#search-label').show();
|
|
31
|
+
|
|
32
|
+
setInterval(function() { $('#search')[0].value != '' && $('#search-label').hide() }, 100)
|
|
33
|
+
}
|
|
34
|
+
$(function() {
|
|
35
|
+
placeholder();
|
|
36
|
+
new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
|
|
37
|
+
$('#search').focus();
|
|
38
|
+
})
|
|
39
|
+
//]]>
|
|
40
|
+
</script>
|
|
41
|
+
</head>
|
|
42
|
+
<body>
|
|
43
|
+
<div class="panel panel_tree" id="panel">
|
|
44
|
+
<div class="header">
|
|
45
|
+
<div>
|
|
46
|
+
<label for="search" id="search-label" style="display: none">Search</label>
|
|
47
|
+
<table>
|
|
48
|
+
<tr><td>
|
|
49
|
+
<input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
|
|
50
|
+
</td></tr>
|
|
51
|
+
</table></div>
|
|
52
|
+
</div>
|
|
53
|
+
<div class="tree">
|
|
54
|
+
<ul>
|
|
55
|
+
</ul>
|
|
56
|
+
</div>
|
|
57
|
+
<div class="result">
|
|
58
|
+
<ul>
|
|
59
|
+
</ul>
|
|
60
|
+
</div>
|
|
61
|
+
</div>
|
|
62
|
+
</body>
|
|
63
|
+
</html>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var search_data = {"index":{"info":[["ERBook","lib\/erbook.rb","classes\/ERBook.html","","",1],["Document","ERBook","classes\/ERBook\/Document.html"," < Object","",1],["Node","ERBook::Document","classes\/ERBook\/Document\/Node.html"," < OpenStruct","",1],["Template","ERBook","classes\/ERBook\/Template.html"," < Ember::Template","eRuby template that provides access to the underlying result buffer (which contains the result of template",1],["Sandbox","ERBook::Template","classes\/ERBook\/Template\/Sandbox.html"," < Object","Environment for template evaluation. ",1],["RDoc","lib\/erbook\/rdoc.rb","classes\/RDoc.html","","",1],["AnyMethod","RDoc","classes\/RDoc\/AnyMethod.html"," < Object","",1],["TopLevel","RDoc","classes\/RDoc\/TopLevel.html"," < Object","",1],["String","lib\/erbook\/to_xhtml.rb","classes\/String.html"," < Object","",1],["__block_content__","ERBook::Template::Sandbox","classes\/ERBook\/Template\/Sandbox.html#M000038","(*block_args)","Returns an array of things that the given block wants to append to the buffer. If the given block does",2],["all_classes","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000045","()","Returns an array of all classes recorded thus far. ",2],["all_methods","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000047","()","Returns an array of RDoc::AnyMethod objects representing all methods recorded thus far. ",2],["all_modules","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000046","()","Returns an array of all modules recorded thus far. ",2],["buffer","ERBook::Template","classes\/ERBook\/Template.html#M000034","()","Returns the result of template evaluation thus far. ",2],["comment_html","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000053","()","Returns a HTML version of this method's comment. ",2],["decl","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000052","()","Returns a complete method declaration with block parameters and all. ",2],["full_name","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000051","()","Returns the fully qualified name of this method. ",2],["new","ERBook::Document","classes\/ERBook\/Document.html#M000042","(format_name, input_text, input_file, options = {})","==== Parameters [format_name] Either the short-hand name of a built-in format or the path to a format",2],["new","ERBook::Template","classes\/ERBook\/Template.html#M000032","(source, input, unindent = true, safe_level = nil)","==== Parameters [source] Replacement for the ambiguous '(erb)' identifier in stack traces; so that the",2],["parse","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000049","(aCodeString, aFileName = __FILE__)","Returns a RDoc::TopLevel object containing information parsed from the given code string. This information",2],["parse_file","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000050","(aFileName)","Returns a RDoc::TopLevel object containing information parsed from the code in the given file. This",2],["refresh_all_classes_and_modules","RDoc::TopLevel","classes\/RDoc\/TopLevel.html#M000048","()","Update the return value of the all_classes_and_modules() method to *really* include every class and every",2],["render","ERBook::Template","classes\/ERBook\/Template.html#M000033","()","Returns the output of evaluating this template inside the given context. If no context is given, then",2],["render_with","ERBook::Template","classes\/ERBook\/Template.html#M000035","(inst_vars = {})","Renders this template within a fresh sandbox that is populated with the given instance variables, whose",2],["to_inline_xhtml","String","classes\/String.html#M000036","()","Transforms this string into an *inline* XHTML string (one that does not contain any block-level XHTML",2],["to_s","ERBook::Document","classes\/ERBook\/Document.html#M000055","()","Returns the output of this document. ",2],["to_s","ERBook::Document::Node","classes\/ERBook\/Document\/Node.html#M000056","()","Returns the output of this node. ",2],["to_xhtml","String","classes\/String.html#M000037","(inline = false)","Transforms this string into XHTML while ensuring that the result contains one or more block-level elements",2],["top_level","RDoc::AnyMethod","classes\/RDoc\/AnyMethod.html#M000054","()","Returns the RDoc::TopLevel object which contains this method. ",2],["ANN.eml","files\/ANN_eml.html","files\/ANN_eml.html","","Date: Mon, 04 May 2009 01:18:22 -0700 To: ruby-talk@ruby-lang.org From: \"Suraj N. Kurapati\" <sunaku@gmail.com>",3],["ANN.html","files\/ANN_html.html","files\/ANN_html.html",""," <center> <h1>ERBook 7.0.0<\/h1> <p>Extensible document processor",3],["ANN.txt","files\/ANN_txt.html","files\/ANN_txt.html",""," ERBook 7.0.0 Extensible document processor based on eRuby ",3],["LICENSE","files\/LICENSE.html","files\/LICENSE.html","","(the ISC license) Copyright 2006 Suraj N. Kurapati <sunaku@gmail.com> Permission to use, copy, modify,",3],["erbook.rb","files\/lib\/erbook_rb.html","files\/lib\/erbook_rb.html",""," ",3],["document.rb","files\/lib\/erbook\/document_rb.html","files\/lib\/erbook\/document_rb.html",""," ",3],["rdoc.rb","files\/lib\/erbook\/rdoc_rb.html","files\/lib\/erbook\/rdoc_rb.html","","Workaround for `rdoc --fmt xml` not dumping information about methods. ",3],["template.rb","files\/lib\/erbook\/template_rb.html","files\/lib\/erbook\/template_rb.html",""," ",3],["to_xhtml.rb","files\/lib\/erbook\/to_xhtml_rb.html","files\/lib\/erbook\/to_xhtml_rb.html","","This file defines the String#to_xhtml and String#to_inline_xhtml methods, which are invoked to transform",3]],"searchIndex":["erbook","document","node","template","sandbox","rdoc","anymethod","toplevel","string","__block_content__()","all_classes()","all_methods()","all_modules()","buffer()","comment_html()","decl()","full_name()","new()","new()","parse()","parse_file()","refresh_all_classes_and_modules()","render()","render_with()","to_inline_xhtml()","to_s()","to_s()","to_xhtml()","top_level()","ann.eml","ann.html","ann.txt","license","erbook.rb","document.rb","rdoc.rb","template.rb","to_xhtml.rb"],"longSearchIndex":["erbook.rb","erbook","document","erbook","template","rdoc.rb","rdoc","rdoc","to_xhtml.rb","sandbox","toplevel","toplevel","toplevel","template","anymethod","anymethod","anymethod","document","template","toplevel","toplevel","toplevel","template","template","string","document","node","string","anymethod","files\/ann_eml.html","files\/ann_html.html","files\/ann_txt.html","files\/license.html","files\/lib\/erbook_rb.html","files\/lib\/erbook\/document_rb.html","files\/lib\/erbook\/rdoc_rb.html","files\/lib\/erbook\/template_rb.html","files\/lib\/erbook\/to_xhtml_rb.html"]}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var tree = [["ERBook","classes\/ERBook.html","",[["Document","classes\/ERBook\/Document.html"," < Object",[["Node","classes\/ERBook\/Document\/Node.html"," < OpenStruct",[]]]],["Template","classes\/ERBook\/Template.html"," < Ember::Template",[["Sandbox","classes\/ERBook\/Template\/Sandbox.html"," < Object",[]]]]]],["RDoc","classes\/RDoc.html","",[["AnyMethod","classes\/RDoc\/AnyMethod.html"," < Object",[]],["TopLevel","classes\/RDoc\/TopLevel.html"," < Object",[]]]],["String","classes\/String.html"," < Object",[]]]
|
data/doc/formats.erb
CHANGED
|
@@ -1,16 +1,21 @@
|
|
|
1
|
-
|
|
1
|
+
%#--
|
|
2
|
+
%# Copyright 2007 Suraj N. Kurapati
|
|
3
|
+
%# See the LICENSE file for details.
|
|
4
|
+
%#++
|
|
5
|
+
|
|
6
|
+
%|part "Formats"
|
|
2
7
|
This part describes the default formats provided along with <%= $project %>. The <%= xref "SpecFile", "format specification files" %> for these formats can be found in the <tt>fmt/</tt> directory of the <%= $project %> installation directory (see <%= xref "Manifest" %>).
|
|
3
8
|
|
|
4
9
|
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 <%= xref "License", "contact the author" %>.
|
|
5
10
|
|
|
6
|
-
|
|
11
|
+
%|chapter "XHTML (web page)", "xhtml"
|
|
7
12
|
This format generates a _monolithic_ XHTML document that allows users to easily search for a particular topic using nothing more than their web browser's built-in text search mechanism. This facilitates offline reading, where an Internet search engine is not available.
|
|
8
13
|
|
|
9
14
|
When viewing an XHTML document in a graphical web browser, you will notice navigation menus to the left of chapters, sections, figures, admonitions, and so on. These menus contain hyperlinks that make it easy to navigate the XHTML document, especially for users of text-only web browsers.
|
|
10
15
|
|
|
11
16
|
Furthermore, the XHTML document comes equipped with a stylesheet that makes it suitable for printing. In particular, users of web browsers that support CSS3 selectors will notice that all hyperlinks have been expanded to include their target URL next to them. Try the "print preview" function of your web browser to see how the XHTML document would appear when printed.
|
|
12
17
|
|
|
13
|
-
|
|
18
|
+
%|section "Text to XHTML conversion"
|
|
14
19
|
The <tt>lib/<%= $program %>/to_xhtml.rb</tt> file inside <%= $project %>'s installation directory (see <%= xref "Manifest" %>) defines the following methods:
|
|
15
20
|
|
|
16
21
|
* `String#to_xhtml` - Transforms this string into XHTML while ensuring that the result contains one or more block-level elements at the root.
|
|
@@ -39,7 +44,7 @@
|
|
|
39
44
|
|
|
40
45
|
In addition to supporting Markdown syntax, the default implementation has some additional features which are described in the following subsections.
|
|
41
46
|
|
|
42
|
-
|
|
47
|
+
%|section "Syntax coloring for source code"
|
|
43
48
|
Syntax coloring is _automatically added_ to source code found inside the **<code>** and **</code>** HTML tags. The syntax coloring library, [CodeRay](http://coderay.rubychan.de), currently supports the following programming languages:
|
|
44
49
|
* Ruby
|
|
45
50
|
* C
|
|
@@ -48,7 +53,7 @@
|
|
|
48
53
|
* RHTML (Rails)
|
|
49
54
|
* Nitro-XHTML
|
|
50
55
|
|
|
51
|
-
|
|
56
|
+
%|section "Specifying the programming language"
|
|
52
57
|
Because different programming languages have different syntax coloring schemes, you can specify the language of your source code using the `lang` attribute to ensure that only the appropriate coloring scheme is used. Note that unless the `lang` attribute is specified, _Ruby_ is assumed to be the programming language of all source code by default.
|
|
53
58
|
|
|
54
59
|
<% sampleCode = %q{
|
|
@@ -85,23 +90,18 @@
|
|
|
85
90
|
And here is the same source code with a `lang="html"` attribute:
|
|
86
91
|
|
|
87
92
|
<code lang="html"><%= verbatim sampleCode %></code>
|
|
88
|
-
<% end %>
|
|
89
|
-
<% end %>
|
|
90
93
|
|
|
91
|
-
|
|
94
|
+
%|section "Smart sizing of source code"
|
|
92
95
|
Source code is _automatically sized_ to be displayed as either a line or paragraph of text, depending on whether it contains line breaks.
|
|
93
96
|
|
|
94
97
|
For example, here is a single line <code>life = true or false</code> of code. And here is a paragraph <code>life =
|
|
95
|
-
|
|
98
|
+
true or
|
|
96
99
|
false</code> of code.
|
|
97
|
-
<% end %>
|
|
98
100
|
|
|
99
|
-
|
|
101
|
+
%|section "Protecting verbatim text"
|
|
100
102
|
Sometimes you just need to protect some text from being mangled by the text-to-XHTML conversion process . In such cases, you can wrap the text you want to proctect within **<noformat>** and **</noformat>** tags.
|
|
101
|
-
<% end %>
|
|
102
|
-
<% end %>
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
%|section "Parameters"
|
|
105
105
|
The XHTML format accepts the following document parameters. To disable the default value for a particular parameter, simply set that parameter to `nil`. For example, to disable the `$authors` parameter, you would write `$authors = nil` in your input document.
|
|
106
106
|
|
|
107
107
|
| Parameter | Type | Default value | Description |
|
|
@@ -112,9 +112,8 @@
|
|
|
112
112
|
| `$date` | `String` | `Time.now.strftime("%d %B %Y")` | Date when the document was written. |
|
|
113
113
|
| `$logo` | `String` | `nil` | Arbitrary content that goes above the document title in the default header. |
|
|
114
114
|
| `$feeds` | `Hash` | `nil` | A mapping of feed URL to feed format. Here is an example: <code>$feeds = { "my_rss_feed.xml" => "rss", "my_atom_feed.xml" => "atom" }</code> |
|
|
115
|
-
<% end %>
|
|
116
115
|
|
|
117
|
-
|
|
116
|
+
%|section "Methods"
|
|
118
117
|
The XHTML format provides the following methods. In the method declarations shown below,
|
|
119
118
|
* a pound sign (#) indicates that the method is an *instance method*, meaning that it can only be invoked on instances of a class, not on the classes themselves.
|
|
120
119
|
* a double colon sign (::) indicates that the method is a *class method*, meaning that it can only be invoked on a class.
|
|
@@ -131,9 +130,8 @@
|
|
|
131
130
|
end
|
|
132
131
|
end
|
|
133
132
|
%>
|
|
134
|
-
<% end %>
|
|
135
133
|
|
|
136
|
-
|
|
134
|
+
%|chapter "Nodes", "xhtml.nodes"
|
|
137
135
|
Unless otherwise noted, all nodes defined by the XHTML format accept two arguments, in this order:
|
|
138
136
|
1. a required *title* for the node
|
|
139
137
|
2. an optional *unique identifier* for the node
|
|
@@ -147,22 +145,19 @@
|
|
|
147
145
|
| toc | Boolean | Include this node in the **Table of Contents** (TOC)? |
|
|
148
146
|
| lof | Boolean | Include this node in the **List of Figures** (LOF)? |
|
|
149
147
|
|
|
150
|
-
|
|
148
|
+
%|section "Structural nodes"
|
|
151
149
|
The nodes described in this section form the overall structure of the output document.
|
|
152
150
|
|
|
153
|
-
|
|
151
|
+
%|section "header", "xhtml.nodes.header"
|
|
154
152
|
This node overrides the logo, title, list of authors, and date when the document was written, all of which are shown at the top of the document.
|
|
155
|
-
<% end %>
|
|
156
153
|
|
|
157
|
-
|
|
154
|
+
%|section "footer", "xhtml.nodes.footer"
|
|
158
155
|
This node overrides (1) the date when this document was generated and (2) the hyperlink to the <%= $project %> website, shown at the bottom of the document. The hyperlink is there as a way of saying thanks for <%= $project %>, the _wonderful_ little utility you have grown so fond of! ;-)
|
|
159
|
-
<% end %>
|
|
160
156
|
|
|
161
|
-
|
|
157
|
+
%|section "abstract", "xhtml.nodes.abstract"
|
|
162
158
|
A summary of the entire document. This is what most readers will _skim_ through, if you are lucky. Alas, nobody reads entire documents these days! :-(
|
|
163
|
-
<% end %>
|
|
164
159
|
|
|
165
|
-
|
|
160
|
+
%|section "xref", "xhtml.nodes.xref"
|
|
166
161
|
A cross-reference; a hyperlink that takes you to any node in the document.
|
|
167
162
|
|
|
168
163
|
The first argument of this node is either the unique identifier or the user-defined title of the node you wish to cross-reference. If no nodes in the document have the given identifier or user-defined title, then an error will be raised.
|
|
@@ -180,171 +175,132 @@
|
|
|
180
175
|
<%%= xref "SpecFile", "custom link text" %>
|
|
181
176
|
|
|
182
177
|
appears in the output document like this: <%= xref "SpecFile", "custom link text" %>.
|
|
183
|
-
<% end %>
|
|
184
|
-
<% end %>
|
|
185
178
|
|
|
186
|
-
|
|
179
|
+
%|section "Organizational nodes"
|
|
187
180
|
The nodes described in this section are meant to help organize the document's content logically. Based on how deeply these nodes are nested in the document, their heading will be larger (shallow depth) or smaller (deep depth).
|
|
188
181
|
|
|
189
|
-
|
|
182
|
+
%|section "node", "xhtml.nodes.node"
|
|
190
183
|
A placeholder that simply passes its content to the output.
|
|
191
184
|
|
|
192
185
|
This node has no real use in the writing of a document. It mainly helps programmers define "virtual" nodes that simply wrap some user-provided content. Programmers can then manipluate the content of those virtual nodes when processing the document.
|
|
193
186
|
|
|
194
|
-
|
|
187
|
+
%|node "An example"
|
|
195
188
|
This is how a **node** node appears.
|
|
196
|
-
<% end %>
|
|
197
|
-
<% end %>
|
|
198
189
|
|
|
199
|
-
|
|
190
|
+
%|section "part", "xhtml.nodes.part"
|
|
200
191
|
A collection of chapters.
|
|
201
192
|
|
|
202
|
-
|
|
193
|
+
%|part "An example"
|
|
203
194
|
This is how a **part** node appears.
|
|
204
|
-
<% end %>
|
|
205
|
-
<% end %>
|
|
206
195
|
|
|
207
|
-
|
|
196
|
+
%|section "chapter", "xhtml.nodes.chapter"
|
|
208
197
|
A collection of sections.
|
|
209
198
|
|
|
210
|
-
|
|
199
|
+
%|chapter "An example"
|
|
211
200
|
This is how a **chapter** node appears.
|
|
212
|
-
<% end %>
|
|
213
|
-
<% end %>
|
|
214
201
|
|
|
215
|
-
|
|
202
|
+
%|section "section", "xhtml.nodes.section"
|
|
216
203
|
A collection of paragraphs about a particular topic.
|
|
217
204
|
|
|
218
|
-
|
|
205
|
+
%|section "An example"
|
|
219
206
|
This is how a **section** node appears.
|
|
220
|
-
<% end %>
|
|
221
|
-
<% end %>
|
|
222
207
|
|
|
223
|
-
|
|
208
|
+
%|section "paragraph", "xhtml.nodes.paragraph"
|
|
224
209
|
A collection of sentences about a particular idea.
|
|
225
210
|
|
|
226
|
-
|
|
211
|
+
%|paragraph "An example"
|
|
227
212
|
This is how a **paragraph** node appears. Notice that there is no LaTeX-style index number in the heading of this **paragraph** node.
|
|
228
|
-
<% end %>
|
|
229
|
-
<% end %>
|
|
230
|
-
<% end %>
|
|
231
213
|
|
|
232
|
-
|
|
214
|
+
%|section "Admonition nodes"
|
|
233
215
|
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.
|
|
234
216
|
|
|
235
217
|
I like to follow the KDE guidelines<%= cite "KDE.admonitions" %> when determining which admonition to use in my documents.
|
|
236
218
|
|
|
237
|
-
|
|
219
|
+
%|reference "KDE.admonitions"
|
|
238
220
|
L. Watts, "Admonitions: Tips, hints, and Warnings", in _The KDE DocBook Authors guide_, Chapter 13, \[Online document], 22 September 2004 (Revision 1.00.00), \[cited 8 December 2007], Available at <%= hyperlink "http://l10n.kde.org/docs/markup/tips-hints-etc.html" %>
|
|
239
|
-
<% end %>
|
|
240
221
|
|
|
241
|
-
|
|
222
|
+
%|section "warning", "xhtml.nodes.warning"
|
|
242
223
|
Use a **warning** node when "data loss could occur if you follow the procedure being described." <%= cite "KDE.admonitions" %>
|
|
243
224
|
|
|
244
|
-
|
|
225
|
+
%|warning "An example"
|
|
245
226
|
This is how a **warning** node appears.
|
|
246
|
-
<% end %>
|
|
247
|
-
<% end %>
|
|
248
227
|
|
|
249
|
-
|
|
228
|
+
%|section "caution", "xhtml.nodes.caution"
|
|
250
229
|
bq. A note of caution. Use this for example when the reader may lose easily recovered or replaceable information (e.g. user settings), or when they could cause data loss if they don't correctly follow the procedure being outlined. <%= cite "KDE.admonitions" %>
|
|
251
230
|
|
|
252
|
-
|
|
231
|
+
%|caution "An example"
|
|
253
232
|
This is how a **caution** node appears.
|
|
254
|
-
<% end %>
|
|
255
|
-
<% end %>
|
|
256
233
|
|
|
257
|
-
|
|
234
|
+
%|section "important", "xhtml.nodes.important"
|
|
258
235
|
Use an **important** node when:
|
|
259
236
|
|
|
260
237
|
bq. When there is no danger of data loss, but you wish to make clear to the reader a consequence that isn't immediately obvious (e.g. when changing the font for one instance of a program also changes the default setting, and this isn't clear from the GUI.) <%= cite "KDE.admonitions" %>
|
|
261
238
|
|
|
262
|
-
|
|
239
|
+
%|important "An example"
|
|
263
240
|
This is how a **important** node appears.
|
|
264
|
-
<% end %>
|
|
265
|
-
<% end %>
|
|
266
241
|
|
|
267
|
-
|
|
242
|
+
%|section "note", "xhtml.nodes.note"
|
|
268
243
|
Use a **note** node to convey:
|
|
269
244
|
|
|
270
245
|
bq. Information the user should be aware of, but is peripheral to the actual task being described. <%= cite "KDE.admonitions" %>
|
|
271
246
|
|
|
272
|
-
|
|
247
|
+
%|note "An example"
|
|
273
248
|
This is how a **note** node appears.
|
|
274
|
-
<% end %>
|
|
275
|
-
<% end %>
|
|
276
249
|
|
|
277
|
-
|
|
250
|
+
%|section "tip", "xhtml.nodes.tip"
|
|
278
251
|
Use a **tip** node when:
|
|
279
252
|
|
|
280
253
|
bq. When you're giving a hint to make things easier or more productive for the reader. <%= cite "KDE.admonitions" %>
|
|
281
254
|
|
|
282
|
-
|
|
255
|
+
%|tip "An example"
|
|
283
256
|
This is how a **tip** node appears.
|
|
284
|
-
<% end %>
|
|
285
|
-
<% end %>
|
|
286
|
-
<% end %>
|
|
287
257
|
|
|
288
|
-
|
|
289
|
-
|
|
258
|
+
%|section "Auxilary materials"
|
|
259
|
+
%|section "figure", "xhtml.nodes.figure"
|
|
290
260
|
A diagram, sketch, image, or illustration; something that visually depicts an idea or thought.
|
|
291
261
|
|
|
292
|
-
|
|
262
|
+
%|figure "An example"
|
|
293
263
|
This is how a **figure** node appears.
|
|
294
|
-
<% end %>
|
|
295
|
-
<% end %>
|
|
296
264
|
|
|
297
|
-
|
|
265
|
+
%|section "table", "xhtml.nodes.table"
|
|
298
266
|
Information (typically measurement data) represented in tabular form for easy reading, comparison, and analysis.
|
|
299
267
|
|
|
300
|
-
|
|
268
|
+
%|table "An example"
|
|
301
269
|
This is how a **table** node appears.
|
|
302
|
-
<% end %>
|
|
303
|
-
<% end %>
|
|
304
270
|
|
|
305
|
-
|
|
271
|
+
%|section "example", "xhtml.nodes.example"
|
|
306
272
|
A sample application of an idea or thought.
|
|
307
273
|
|
|
308
|
-
|
|
274
|
+
%|example "An example"
|
|
309
275
|
This is how a **example** node appears.
|
|
310
|
-
<% end %>
|
|
311
|
-
<% end %>
|
|
312
276
|
|
|
313
|
-
|
|
277
|
+
%|section "equation", "xhtml.nodes.equation"
|
|
314
278
|
A mathematical equation or formula.
|
|
315
279
|
|
|
316
|
-
|
|
280
|
+
%|equation "An example"
|
|
317
281
|
This is how a **equation** node appears.
|
|
318
|
-
<% end %>
|
|
319
|
-
<% end %>
|
|
320
282
|
|
|
321
|
-
|
|
283
|
+
%|section "procedure", "xhtml.nodes.procedure"
|
|
322
284
|
An outline; a series of steps outlining some kind of process.
|
|
323
285
|
|
|
324
|
-
|
|
286
|
+
%|procedure "An example"
|
|
325
287
|
This is how a **procedure** node appears.
|
|
326
|
-
<% end %>
|
|
327
|
-
<% end %>
|
|
328
|
-
<% end %>
|
|
329
288
|
|
|
330
|
-
|
|
289
|
+
%|section "Bibliographical nodes"
|
|
331
290
|
The nodes in this section deal with attribution of ideas---an important weapon against plagiarism.
|
|
332
291
|
|
|
333
|
-
|
|
292
|
+
%|section "reference", "xhtml.nodes.reference"
|
|
334
293
|
This node stores bibliography information about an information source that is relevant to your document.
|
|
335
294
|
|
|
336
295
|
If you wish to cite a certain source in several places in your document, start by creating a **reference** node first and then use a **cite** node (see <%= xref "xhtml.nodes.cite" %>) to perform the citation.
|
|
337
296
|
|
|
338
|
-
|
|
297
|
+
%|paragraph "An example"
|
|
339
298
|
See <%= xref "xhtml.nodes.reference.example" %> for an example of how a **reference** node appears.
|
|
340
|
-
<% end %>
|
|
341
299
|
|
|
342
|
-
|
|
300
|
+
%|reference "xhtml.nodes.reference.example"
|
|
343
301
|
This is how a **reference** node appears.
|
|
344
|
-
<% end %>
|
|
345
|
-
<% end %>
|
|
346
302
|
|
|
347
|
-
|
|
303
|
+
%|section "cite", "xhtml.nodes.cite"
|
|
348
304
|
A citation to a **reference** node (see <%= xref "xhtml.nodes.reference" %>) in the document's bibliography.
|
|
349
305
|
|
|
350
306
|
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.
|
|
@@ -360,28 +316,20 @@
|
|
|
360
316
|
<%%= cite "xhtml.nodes.reference.example", "chapter 10", "page 53", "..." %>
|
|
361
317
|
|
|
362
318
|
appears in the output document like this: <%= cite "xhtml.nodes.reference.example", "chapter 10", "page 53", "..." %>
|
|
363
|
-
<% end %>
|
|
364
|
-
<% end %>
|
|
365
|
-
<% end %>
|
|
366
|
-
<% end %>
|
|
367
319
|
|
|
368
320
|
<% patches_are_welcome = "This format is not yet implemented. Patches are welcome! :-)" %>
|
|
369
321
|
|
|
370
|
-
|
|
322
|
+
%|chapter "Plain text", "text"
|
|
371
323
|
<%= patches_are_welcome %>
|
|
372
324
|
|
|
373
325
|
<%= hyperlink "http://en.wikipedia.org/wiki/Plain_text" %>
|
|
374
|
-
<% end %>
|
|
375
326
|
|
|
376
|
-
|
|
327
|
+
%|chapter "LaTeX (PDF)", "latex"
|
|
377
328
|
<%= patches_are_welcome %>
|
|
378
329
|
|
|
379
330
|
<%= hyperlink "http://www.latex-project.org" %>
|
|
380
|
-
<% end %>
|
|
381
331
|
|
|
382
|
-
|
|
332
|
+
%|chapter "UNIX manual page", "man"
|
|
383
333
|
<%= patches_are_welcome %>
|
|
384
334
|
|
|
385
335
|
<%= hyperlink "http://en.wikipedia.org/wiki/Man_page" %>
|
|
386
|
-
<% end %>
|
|
387
|
-
<% end %>
|
data/doc/history.erb
CHANGED
|
@@ -1,7 +1,82 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
%#--
|
|
2
|
+
%# Copyright 2007 Suraj N. Kurapati
|
|
3
|
+
%# See the LICENSE file for details.
|
|
4
|
+
%#++
|
|
5
|
+
|
|
6
|
+
%|chapter "History"
|
|
7
|
+
%|history
|
|
8
|
+
%|section "Version 7.0.0 (2009-05-03)"
|
|
9
|
+
This release improves the appearance, usability, and validity of <%= xref "xhtml" %> output, upgrades to a new eRuby templating system, adds new processing options to node definitions, and fixes some bugs.
|
|
10
|
+
|
|
11
|
+
%|paragraph "Incompatible changes"
|
|
12
|
+
* If you add methods to the `ERBook::Template` class, in order to provide them to eRuby templates, you must now add those methods to the `ERBook::Template::Sandbox` class instead.
|
|
13
|
+
|
|
14
|
+
* The [<%= Ember::PROJECT %>](<%= Ember::WEBSITE %>) template processor is now used to render eRuby templates instead of the ERB library that is shipped with Ruby.
|
|
15
|
+
|
|
16
|
+
* The file inclusion directive has been removed:
|
|
17
|
+
|
|
18
|
+
<%%# include YOUR_FILE #%>
|
|
19
|
+
|
|
20
|
+
<%= Ember::PROJECT %> provides equivalent functionality:
|
|
21
|
+
|
|
22
|
+
%%< "YOUR_FILE"
|
|
23
|
+
|
|
24
|
+
* The <tt>erbook/to_xhtml</tt> library now annotates <code> elements with a "line" or "para" class indicating whether they span a single or mulitple lines respectively.
|
|
25
|
+
|
|
26
|
+
The "pre.code" CSS class is no longer emitted.
|
|
27
|
+
|
|
28
|
+
* The <tt>erbook/rdoc</tt> library has been updated to work with RDoc 2.4.3. It no longer supports the old RDoc that is shipped with Ruby 1.8.
|
|
29
|
+
|
|
30
|
+
* Just a reminder from the <%= xref "Version 5.0.0 (2008-11-22)" %> release notes:
|
|
31
|
+
|
|
32
|
+
> Internet Explorer 6 and 7 [*do not* support](http://www.w3.org/MarkUp/2004/xhtml-faq#ie) the application/xhtml+xml mime type, so the output generated by the <%= xref "xhtml" %> format cannot be viewed in those browsers.
|
|
33
|
+
|
|
34
|
+
%|paragraph "New features"
|
|
35
|
+
* Replace dark background theme with a "wide open spaces" theme.
|
|
36
|
+
|
|
37
|
+
* Use icons instead of unicode glyphs for mini navigation menus.
|
|
38
|
+
|
|
39
|
+
* Put mini navigation menus on right-hand side of headings
|
|
40
|
+
|
|
41
|
+
* Use [scrolling animation](http://demos.flesler.com/jquery/scrollTo/) when local links (URI fragments) are visited, instead of instantly teleporting to the destination. This gives a sense of spatial existence to the web page, making it feel almost tangible!
|
|
42
|
+
|
|
43
|
+
* XHTML output is now valid XHTML 1.0 Transitional!
|
|
44
|
+
And the embedded CSS it contains is now valid CSS 3!
|
|
45
|
+
|
|
46
|
+
* Minify CSS in XHTML output using the [Rainpress library](http://github.com/sprsquish/rainpress/tree/master).
|
|
47
|
+
|
|
48
|
+
* Add CSS style for HTML definition lists.
|
|
49
|
+
|
|
50
|
+
* Omit target type and index ("Section X.Y.Z") in output of `xref()` nodes in the screen-version (CSS stylesheet) of the generated output document.
|
|
51
|
+
|
|
52
|
+
This information is still present in the print-version (CSS stylesheet) of the generated output document, where it is truly helpful to the reader.
|
|
53
|
+
|
|
54
|
+
* Add "bypass" option to node definitions to properly support the generic "node" node. Invalid XHTML was being generated because the 'node' node was marked as simply "inline", so it was not pulled out of the <p> tag created by Maruku.
|
|
55
|
+
|
|
56
|
+
%|paragraph "Bug fixes"
|
|
57
|
+
* The "silent" property in node definitions was not being honored.
|
|
58
|
+
|
|
59
|
+
* Fix error when inserting reference nodes (they are not inline!).
|
|
60
|
+
|
|
61
|
+
* Add workaround for Maruku treating first line of input as parameter definition, and thereby omitting it from the output!
|
|
62
|
+
|
|
63
|
+
* `Array#to_s` is equivalent to `Array#inspect` in Ruby 1.9.
|
|
64
|
+
|
|
65
|
+
* <%= xref "HelloWorld.spec" %> added methods to the nonexistent `ERBook::Node` class instead of adding them to the `ERBook::Document::Node` class.
|
|
66
|
+
|
|
67
|
+
%|paragraph "Housekeeping"
|
|
68
|
+
* Simplify language phrases used in mini navigation menus.
|
|
69
|
+
|
|
70
|
+
* Remove CSS hacks for supporting IE6; it cannot render XHTML anyway.
|
|
71
|
+
|
|
72
|
+
* Render italics and boldface equally in serif font. Bold is truly **bold** now and italic is *distinctive*.
|
|
73
|
+
|
|
74
|
+
* Adjust spacing between document title, author, and date headings.
|
|
75
|
+
|
|
76
|
+
* Add copyright notice at the top of every file.
|
|
77
|
+
|
|
78
|
+
%|section "Version 6.1.0 (2009-02-14)"
|
|
79
|
+
%|paragraph "New features"
|
|
5
80
|
* Added translations for English phrases used in the XHTML format (see the <tt>lang/</tt> directory).
|
|
6
81
|
|
|
7
82
|
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.
|
|
@@ -9,35 +84,29 @@
|
|
|
9
84
|
* Reduced brightness of links in local navigation menus; it was distracting from the main text of the document.
|
|
10
85
|
|
|
11
86
|
* Draw the HTML <hr/> element as a dashed black line, instead of a *glaring* red line.
|
|
12
|
-
<% end %>
|
|
13
87
|
|
|
14
|
-
|
|
88
|
+
%|paragraph "Bug fixes"
|
|
15
89
|
* LaTeX-style index numbers were calculated incorrectly for descendants of the "node" node.
|
|
16
|
-
<% end %>
|
|
17
90
|
|
|
18
|
-
|
|
91
|
+
%|paragraph "Housekeeping"
|
|
19
92
|
* Add release notes for past releases... two years have already passed since I started this project! Where did the time go?
|
|
20
93
|
|
|
21
94
|
* 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
95
|
|
|
23
96
|
* Mention that project license is ISC for reader's convenience.
|
|
24
|
-
<% end %>
|
|
25
|
-
<% end %>
|
|
26
97
|
|
|
27
|
-
|
|
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
|
|
29
|
-
<% end %>
|
|
98
|
+
%|section "Version 6.0.1 (2009-01-19)"
|
|
99
|
+
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 %>.
|
|
30
100
|
|
|
31
|
-
|
|
101
|
+
%|section "Version 6.0.0 (2009-01-19)"
|
|
32
102
|
This release improves the appearance & usability of the XHTML format, refactors the core logic into reusable libraries, fixes some bugs and improves variable names.
|
|
33
103
|
|
|
34
|
-
|
|
104
|
+
%|paragraph "Incompatible changes"
|
|
35
105
|
* Renamed `@types` to `@nodes_by_type` and `@spec` to `@format` in XHTML format.
|
|
36
106
|
|
|
37
107
|
* Moved the core logic of the **erbook** executable into the `ERBook::Document` and `ERBook::Document::Template` classes.
|
|
38
|
-
<% end %>
|
|
39
108
|
|
|
40
|
-
|
|
109
|
+
%|paragraph "New features"
|
|
41
110
|
* Addded navigation menus beside every segment in the user manual. These menus allow you to jump to the next/previous segment, whereas previously you always had to go back to the table of contents and select a new segment.
|
|
42
111
|
|
|
43
112
|
* A star is drawn beside a reverse jump target in the table of contents, so the user can continue where they left off.
|
|
@@ -68,40 +137,37 @@
|
|
|
68
137
|
</code><br/>
|
|
69
138
|
|
|
70
139
|
* Paragraph nodes are now included in the table of contents.
|
|
71
|
-
<% end %>
|
|
72
140
|
|
|
73
|
-
|
|
141
|
+
%|paragraph "Bug fixes"
|
|
74
142
|
* Input to unindentation algorithm was being partially unindented beforehand by the logic that silences code-only eRuby directives. This corrupted the unindentation algorithm's output in some cases.
|
|
75
143
|
|
|
76
144
|
* `<pre>` blocks now expand to fit their content in the XHTML format. No more scrollbars!
|
|
77
145
|
|
|
78
146
|
* `<a/>` without href was treated as external hyperlink.
|
|
79
|
-
<% end %>
|
|
80
147
|
|
|
81
|
-
|
|
148
|
+
%|paragraph "Housekeeping"
|
|
82
149
|
* Revised the project logo to emphasize the owl mascot.
|
|
83
150
|
|
|
84
151
|
* Replaced dull MediaWiki hyperlink colors with more lively colors in XHTML format.
|
|
85
152
|
|
|
86
153
|
* Wrote more API documentation and use [<%= Inochi::PROJECT %>](<%= Inochi::WEBSITE %>) to simplify project maintenance.
|
|
87
|
-
<% end %>
|
|
88
|
-
<% end %>
|
|
89
154
|
|
|
90
|
-
|
|
155
|
+
%|section "Version 5.0.0 (2008-11-22)"
|
|
91
156
|
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
157
|
|
|
93
158
|
|
|
94
|
-
|
|
159
|
+
%|paragraph "Incompatible changes"
|
|
95
160
|
* 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
161
|
|
|
162
|
+
* Internet Explorer 6 and 7 [*do not* support](http://www.w3.org/MarkUp/2004/xhtml-faq#ie) the application/xhtml+xml mime type, so the output generated by the <%= xref "xhtml" %> format cannot be viewed in those browsers.
|
|
163
|
+
|
|
97
164
|
* Removed the `$use_icons` parameter from the XHTML format. Now, icons are always used, whether you like it or not! ;-)
|
|
98
165
|
|
|
99
166
|
* Replaced the implicit `ERB::Util#h` method with a `verbatim()` method in the XHTML format.
|
|
100
167
|
|
|
101
168
|
* 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
169
|
|
|
104
|
-
|
|
170
|
+
%|paragraph "New features"
|
|
105
171
|
* 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
172
|
|
|
107
173
|
* 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. ;-)
|
|
@@ -109,31 +175,26 @@
|
|
|
109
175
|
* Omitted erbook internals from stack traces (unless in $DEBUG mode). This helps users concentrate on problems in their input document.
|
|
110
176
|
|
|
111
177
|
* 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
178
|
|
|
114
|
-
|
|
179
|
+
%|paragraph "Bug fixes"
|
|
115
180
|
* Could not jump to examples and admonitions from the list of figures.
|
|
116
181
|
|
|
117
182
|
* 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
183
|
|
|
120
|
-
|
|
184
|
+
%|paragraph "Housekeeping"
|
|
121
185
|
* 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
186
|
|
|
125
|
-
|
|
187
|
+
%|section "Version 4.0.0 (2008-11-15)"
|
|
126
188
|
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
189
|
|
|
128
|
-
|
|
190
|
+
%|paragraph "Contributor kudos"
|
|
129
191
|
* 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
192
|
|
|
131
193
|
<%= $logo %>
|
|
132
194
|
|
|
133
195
|
* Maunika Gosike provided usability feedback to help improve the HTML format.
|
|
134
|
-
<% end %>
|
|
135
196
|
|
|
136
|
-
|
|
197
|
+
%|paragraph "Incompatible changes"
|
|
137
198
|
* The "Gerbil" project has been renamed to "erbook" to better reflect its purpose: it allows you to write books and documents using eRuby.
|
|
138
199
|
|
|
139
200
|
* 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! :-)
|
|
@@ -141,27 +202,23 @@
|
|
|
141
202
|
* 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
203
|
|
|
143
204
|
* [Markdown](http://daringfireball.net/projects/markdown/syntax) is now the default text-to-HTML formatting system for the HTML format.
|
|
144
|
-
<% end %>
|
|
145
205
|
|
|
146
|
-
|
|
206
|
+
%|paragraph "New features"
|
|
147
207
|
* Added admonition icon for HTML <code><blockquote></code> element.
|
|
148
208
|
|
|
149
209
|
* A visual marker is shown on outgoing (external) hyperlinks.
|
|
150
210
|
|
|
151
211
|
* 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
212
|
|
|
154
|
-
|
|
213
|
+
%|paragraph "Housekeeping"
|
|
155
214
|
* Renamed `Node#url` to `Node#here_frag`. Also, speak of "frags" rather than "anchors" or "urls" from now on.
|
|
156
215
|
|
|
157
216
|
* Refactored common logic from node output templates into Node class.
|
|
158
|
-
<% end %>
|
|
159
|
-
<% end %>
|
|
160
217
|
|
|
161
|
-
|
|
218
|
+
%|section "Version 3.1.0 (2008-06-22)"
|
|
162
219
|
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
220
|
|
|
164
|
-
|
|
221
|
+
%|paragraph "New features"
|
|
165
222
|
* 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
223
|
|
|
167
224
|
|
|
@@ -185,39 +242,33 @@
|
|
|
185
242
|
* 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
243
|
|
|
187
244
|
* 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
245
|
|
|
190
|
-
|
|
246
|
+
%|paragraph "Bug fixes"
|
|
191
247
|
* Cross-reference (xref) hyperlinks to paragraphs were broken due to a missing **id** attribute.
|
|
192
|
-
<% end %>
|
|
193
248
|
|
|
194
|
-
|
|
249
|
+
%|paragraph "Housekeeping"
|
|
195
250
|
* Removed useless CSS styles and fixed some XHTML validation issues.
|
|
196
|
-
<% end %>
|
|
197
|
-
<% end %>
|
|
198
251
|
|
|
199
|
-
|
|
252
|
+
%|section "Version 3.0.2 (2008-06-08)"
|
|
200
253
|
This release implements a shorter, faster, better unindentation algorithm which:
|
|
201
254
|
* Allows block beginnings <code lang="rhtml"><%% do %></code> and endings <code lang="rhtml"><%% end %></code> to span multiple lines.
|
|
202
255
|
* Ignores blank lines (which may contain whitespace) after block beginnings.
|
|
203
256
|
* Processes multiple lines per iteration, instead of one line at a time.
|
|
204
|
-
<% end %>
|
|
205
257
|
|
|
206
|
-
|
|
258
|
+
%|section "Version 3.0.1 (2008-06-03)"
|
|
207
259
|
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
260
|
|
|
210
|
-
|
|
261
|
+
%|section "Version 3.0.0 (2008-06-01)"
|
|
211
262
|
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
263
|
|
|
213
|
-
|
|
264
|
+
%|paragraph "Incompatible changes"
|
|
214
265
|
* 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
266
|
|
|
216
267
|
* The **include** directive now has a symmetric # at the closing end:
|
|
217
|
-
<pre><%%# include ... #%></pre>
|
|
218
|
-
<% end %>
|
|
219
268
|
|
|
220
|
-
|
|
269
|
+
<%%# include ... #%>
|
|
270
|
+
|
|
271
|
+
%|paragraph "Bug fixes"
|
|
221
272
|
* The CSS for the horizontal rule (hr) element should now be consistent in all browsers.
|
|
222
273
|
|
|
223
274
|
* 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:
|
|
@@ -229,21 +280,17 @@
|
|
|
229
280
|
* `footer_inside_above ` - above the default footer content
|
|
230
281
|
* `footer_inside_below ` - below the default footer content
|
|
231
282
|
* `footer_outside_below` - below the entire footer block
|
|
232
|
-
<% end %>
|
|
233
|
-
<% end %>
|
|
234
283
|
|
|
235
|
-
|
|
284
|
+
%|section "Version 2.1.0 (2008-05-29)"
|
|
236
285
|
This release adds image embedding methods for the HTML format and no longer appends (through CSS) an asterisk on outgoing hyperlinks.
|
|
237
|
-
<% end %>
|
|
238
286
|
|
|
239
|
-
|
|
287
|
+
%|section "Version 2.0.0 (2008-02-03)"
|
|
240
288
|
This release fixes some bugs, improves the RDoc library, and adds nodes for customization of the default header and footer.
|
|
241
289
|
|
|
242
|
-
|
|
290
|
+
%|paragraph "Incompatible changes"
|
|
243
291
|
* The <tt>lib/gerbil/rdoc.rb</tt> library has changed! Read it for details.
|
|
244
|
-
<% end %>
|
|
245
292
|
|
|
246
|
-
|
|
293
|
+
%|paragraph "New features"
|
|
247
294
|
* In the **html** format, added the following nodes which allow you customize the default header and footer whilst preserving the default content:
|
|
248
295
|
* `header_outside_above` - above the entire header block
|
|
249
296
|
* `header_inside_above ` - above the default header content
|
|
@@ -253,39 +300,32 @@
|
|
|
253
300
|
* `footer_inside_above ` - above the default footer content
|
|
254
301
|
* `footer_inside_below ` - below the default footer content
|
|
255
302
|
* `footer_outside_below` - below the entire footer block
|
|
256
|
-
<% end %>
|
|
257
303
|
|
|
258
|
-
|
|
304
|
+
%|paragraph "Bug fixes"
|
|
259
305
|
* [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
306
|
|
|
261
307
|
* The <tt>lib/gerbil/rdoc.rb</tt> library did not extract method information recursively.
|
|
262
|
-
<% end %>
|
|
263
308
|
|
|
264
|
-
|
|
309
|
+
%|paragraph "Housekeeping"
|
|
265
310
|
* In the **html** format, added a CSS margin above HTML tables because they were visually colliding with other elements above them.
|
|
266
311
|
|
|
267
312
|
* Fixed some Ruby code warnings in the **html** format.
|
|
268
|
-
<% end %>
|
|
269
|
-
<% end %>
|
|
270
313
|
|
|
271
|
-
|
|
314
|
+
%|section "Version 1.1.0 (2008-01-22)"
|
|
272
315
|
This release improves usability and fixes some bugs.
|
|
273
316
|
|
|
274
|
-
|
|
317
|
+
%|paragraph "New features"
|
|
275
318
|
* External links are now marked with a ∗ symbol to help the user distinguish between internal and external links. This is helpful because a user may not wish to follow a link that takes them outside a document, say, when they are reading the document offline, without an Internet connection.
|
|
276
|
-
<% end %>
|
|
277
319
|
|
|
278
|
-
|
|
320
|
+
%|paragraph "Bug fixes"
|
|
279
321
|
* 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
322
|
|
|
281
323
|
* Module methods were omitted by the `RDoc.gen_method_infos` method in <tt>format/rdoc.rb</tt>.
|
|
282
|
-
<% end %>
|
|
283
|
-
<% end %>
|
|
284
324
|
|
|
285
|
-
|
|
325
|
+
%|section "Version 1.0.0 (2008-01-12)"
|
|
286
326
|
This release makes Gerbil available as a [RubyGem](http://rubygems.org), fixes some bugs, and updates the user guide.
|
|
287
327
|
|
|
288
|
-
|
|
328
|
+
%|paragraph "Incompatible changes"
|
|
289
329
|
* The <tt>gerbil</tt> file has been moved to <tt>bin/gerbil</tt>.
|
|
290
330
|
|
|
291
331
|
* The <tt>format/</tt> directory has been renamed to <tt>fmt</tt>.
|
|
@@ -299,18 +339,15 @@
|
|
|
299
339
|
* The <tt>CHANGES.yaml</tt> file has been removed, in favor of [this RSS feed](http://gerbil.rubyforge.org/news.xml).
|
|
300
340
|
|
|
301
341
|
* The `GENERATOR` object has been renamed to `Gerbil`.
|
|
302
|
-
<% end %>
|
|
303
342
|
|
|
304
|
-
|
|
343
|
+
%|paragraph "Bug fixes"
|
|
305
344
|
* 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
345
|
|
|
307
346
|
* In the HTML format, images inside descendant nodes of a *figure* node were not properly centered.
|
|
308
347
|
|
|
309
348
|
* In the HTML format, the `$title` parameter was not converted into HTML.
|
|
310
|
-
<% end %>
|
|
311
|
-
<% end %>
|
|
312
349
|
|
|
313
|
-
|
|
350
|
+
%|section "Version 0.0.1 (2007-12-13)"
|
|
314
351
|
* Fixed the generation of unique node URI fragments in the HTML format.
|
|
315
352
|
* Added a `$feeds` parameter to the HTML format.
|
|
316
353
|
* Added the <tt>format/rdoc.rb</tt> library for accessing RDoc's parse tree.
|
|
@@ -319,9 +356,8 @@
|
|
|
319
356
|
* added RSS feed for project release announcements
|
|
320
357
|
* improved the ghastly HelloWorld example
|
|
321
358
|
* Added a simple change-log (<tt>CHANGES.yaml</tt>) for the project.
|
|
322
|
-
<% end %>
|
|
323
359
|
|
|
324
|
-
|
|
360
|
+
%|section "Version 0.0.0 (2007-12-09)"
|
|
325
361
|
Dear developers, technical writers, and documentation gurus,
|
|
326
362
|
|
|
327
363
|
I am proud to announce a new project of mine named "Gerbil"
|
|
@@ -343,6 +379,3 @@
|
|
|
343
379
|
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
380
|
|
|
345
381
|
Until this issue is resolved, please download the tarball/zip packages instead.
|
|
346
|
-
<% end %>
|
|
347
|
-
<% end %>
|
|
348
|
-
<% end %>
|