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,53 @@
|
|
1
|
+
/* http://meyerweb.com/eric/tools/css/reset/ */
|
2
|
+
/* v1.0 | 20080212 */
|
3
|
+
|
4
|
+
html, body, div, span, applet, object, iframe,
|
5
|
+
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
|
6
|
+
a, abbr, acronym, address, big, cite, code,
|
7
|
+
del, dfn, em, font, img, ins, kbd, q, s, samp,
|
8
|
+
small, strike, strong, sub, sup, tt, var,
|
9
|
+
b, u, i, center,
|
10
|
+
dl, dt, dd, ol, ul, li,
|
11
|
+
fieldset, form, label, legend,
|
12
|
+
table, caption, tbody, tfoot, thead, tr, th, td {
|
13
|
+
margin: 0;
|
14
|
+
padding: 0;
|
15
|
+
border: 0;
|
16
|
+
outline: 0;
|
17
|
+
font-size: 100%;
|
18
|
+
vertical-align: baseline;
|
19
|
+
background: transparent;
|
20
|
+
}
|
21
|
+
body {
|
22
|
+
line-height: 1;
|
23
|
+
}
|
24
|
+
ol, ul {
|
25
|
+
list-style: none;
|
26
|
+
}
|
27
|
+
blockquote, q {
|
28
|
+
quotes: none;
|
29
|
+
}
|
30
|
+
blockquote:before, blockquote:after,
|
31
|
+
q:before, q:after {
|
32
|
+
content: '';
|
33
|
+
content: none;
|
34
|
+
}
|
35
|
+
|
36
|
+
/* remember to define focus styles! */
|
37
|
+
:focus {
|
38
|
+
outline: 0;
|
39
|
+
}
|
40
|
+
|
41
|
+
/* remember to highlight inserts somehow! */
|
42
|
+
ins {
|
43
|
+
text-decoration: none;
|
44
|
+
}
|
45
|
+
del {
|
46
|
+
text-decoration: line-through;
|
47
|
+
}
|
48
|
+
|
49
|
+
/* tables still need 'cellspacing="0"' in the markup */
|
50
|
+
table {
|
51
|
+
border-collapse: collapse;
|
52
|
+
border-spacing: 0;
|
53
|
+
}
|
@@ -0,0 +1,276 @@
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<title>ANN.eml</title>
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
8
|
+
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
|
9
|
+
<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
|
10
|
+
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
|
11
|
+
<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
|
12
|
+
<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
|
13
|
+
</head>
|
14
|
+
|
15
|
+
<body>
|
16
|
+
<div class="banner">
|
17
|
+
<h1>
|
18
|
+
ANN.eml
|
19
|
+
</h1>
|
20
|
+
<ul class="files">
|
21
|
+
<li>ANN.eml</li>
|
22
|
+
<li>Last modified: Mon May 04 01:18:29 -0700 2009</li>
|
23
|
+
</ul>
|
24
|
+
</div>
|
25
|
+
|
26
|
+
<div id="bodyContent">
|
27
|
+
<div id="content">
|
28
|
+
|
29
|
+
<div class="description">
|
30
|
+
<p>
|
31
|
+
Date: Mon, 04 May 2009 01:18:22 -0700 To: ruby-talk@ruby-lang.org From:
|
32
|
+
“Suraj N. Kurapati” <sunaku@gmail.com> Subject: [ANN] <a
|
33
|
+
href="../classes/ERBook.html">ERBook</a> 7.0.0
|
34
|
+
</p>
|
35
|
+
<pre>
|
36
|
+
ERBook 7.0.0
|
37
|
+
|
38
|
+
Extensible document processor based on eRuby
|
39
|
+
|
40
|
+
http://snk.tuxfamily.org/lib/erbook/
|
41
|
+
|
42
|
+
ERBook is an extensible document processor that emits [1]any
|
43
|
+
document you can imagine from [2]eRuby templates that allow
|
44
|
+
scripting and dynamic content generation.
|
45
|
+
|
46
|
+
A working [3]XHTML (web page) format is provided, while
|
47
|
+
[4]LaTeX (PDF), [5]UNIX manual page, and [6]plain text
|
48
|
+
formats are planned... [7]patches are welcome!
|
49
|
+
|
50
|
+
ERBook is exciting because:
|
51
|
+
|
52
|
+
* Its documents are scriptable [8]eRuby templates.
|
53
|
+
|
54
|
+
* It lets you [9]define your own document formats.
|
55
|
+
|
56
|
+
* Its core contains less than 300 lines of code.
|
57
|
+
|
58
|
+
These features distinguish ERBook from the competition, which
|
59
|
+
offers neither scriptable documents nor definable document
|
60
|
+
formats:
|
61
|
+
|
62
|
+
* [10]DocBook
|
63
|
+
|
64
|
+
* [11]Deplate
|
65
|
+
|
66
|
+
* [12]SiSU
|
67
|
+
|
68
|
+
* [13]AsciiDoc
|
69
|
+
|
70
|
+
* [14]txt2tags
|
71
|
+
|
72
|
+
* [15]Grutatxt
|
73
|
+
</pre>
|
74
|
+
<p>
|
75
|
+
Logistics
|
76
|
+
</p>
|
77
|
+
<pre>
|
78
|
+
* [16]Release notes -- history of project releases.
|
79
|
+
|
80
|
+
* [17]Source code -- obtain via [18]Git or browse online.
|
81
|
+
|
82
|
+
* [19]API reference -- documentation for source code.
|
83
|
+
|
84
|
+
* [20]Project home -- the ERBook project home page.
|
85
|
+
|
86
|
+
To get help or provide feedback, simply [21]contact the
|
87
|
+
authors.
|
88
|
+
|
89
|
+
Version numbers
|
90
|
+
|
91
|
+
ERBook releases are numbered in major.minor.patch form
|
92
|
+
according to the [22]RubyGems rational versioning policy,
|
93
|
+
which can be summarized thus:
|
94
|
+
What increased in the version number? The increase indicates
|
95
|
+
that the release:
|
96
|
+
Is backward compatible? Has new features? Has bug fixes?
|
97
|
+
major No Yes Yes
|
98
|
+
minor Yes Yes Yes
|
99
|
+
patch Yes No Yes
|
100
|
+
</pre>
|
101
|
+
<p>
|
102
|
+
Version 7.0.0 (2009-05-03)
|
103
|
+
</p>
|
104
|
+
<pre>
|
105
|
+
This release improves the appearance, usability, and validity
|
106
|
+
of [23]XHTML (web page) output, upgrades to a new eRuby
|
107
|
+
templating system, adds new processing options to node
|
108
|
+
definitions, and fixes some bugs.
|
109
|
+
|
110
|
+
Incompatible changes
|
111
|
+
|
112
|
+
* If you add methods to the ERBook::Template class, in
|
113
|
+
order to provide them to eRuby templates, you must now
|
114
|
+
add those methods to the ERBook::Template::Sandbox class
|
115
|
+
instead.
|
116
|
+
|
117
|
+
* The [24]Ember template processor is now used to render
|
118
|
+
eRuby templates instead of the ERB library that is
|
119
|
+
shipped with Ruby.
|
120
|
+
+ The file inclusion directive has been removed:
|
121
|
+
</pre>
|
122
|
+
<p>
|
123
|
+
<%# include YOUR_FILE #%>
|
124
|
+
</p>
|
125
|
+
<pre>
|
126
|
+
Ember provides equivalent functionality:
|
127
|
+
</pre>
|
128
|
+
<p>
|
129
|
+
%< “YOUR_FILE“
|
130
|
+
</p>
|
131
|
+
<pre>
|
132
|
+
* The erbook/to_xhtml library now annotates <code> elements
|
133
|
+
with a "line" or "para" class indicating whether they
|
134
|
+
span a single or mulitple lines respectively.
|
135
|
+
The "pre.code" CSS class is no longer emitted.
|
136
|
+
|
137
|
+
* The erbook/rdoc library has been updated to work with
|
138
|
+
RDoc 2.4.3. It no longer supports the old RDoc that is
|
139
|
+
shipped with Ruby 1.8.
|
140
|
+
|
141
|
+
* Just a reminder from the [25]Version 5.0.0 (2008-11-22)
|
142
|
+
release notes:
|
143
|
+
|
144
|
+
Internet Explorer 6 and 7 [26]do not support the
|
145
|
+
application/xhtml+xml mime type, so the output generated
|
146
|
+
by the [27]XHTML (web page) format cannot be viewed in
|
147
|
+
those browsers.
|
148
|
+
|
149
|
+
New features
|
150
|
+
|
151
|
+
* Replace dark background theme with a "wide open spaces"
|
152
|
+
theme.
|
153
|
+
+ Use icons instead of unicode glyphs for mini
|
154
|
+
navigation menus.
|
155
|
+
+ Put mini navigation menus on right-hand side of
|
156
|
+
headings
|
157
|
+
+ Use [28]scrolling animation when local links (URI
|
158
|
+
fragments) are visited, instead of instantly
|
159
|
+
teleporting to the destination. This gives a sense
|
160
|
+
of spatial existence to the web page, making it feel
|
161
|
+
almost tangible!
|
162
|
+
|
163
|
+
* XHTML output is now valid XHTML 1.0 Transitional! And the
|
164
|
+
embedded CSS it contains is now valid CSS 3!
|
165
|
+
+ Minify CSS in XHTML output using the [29]Rainpress
|
166
|
+
library.
|
167
|
+
+ Add CSS style for HTML definition lists.
|
168
|
+
|
169
|
+
* Omit target type and index ("Section X.Y.Z") in output of
|
170
|
+
xref() nodes in the screen-version (CSS stylesheet) of
|
171
|
+
the generated output document.
|
172
|
+
This information is still present in the print-version
|
173
|
+
(CSS stylesheet) of the generated output document, where
|
174
|
+
it is truly helpful to the reader.
|
175
|
+
|
176
|
+
* Add "bypass" option to node definitions to properly
|
177
|
+
support the generic "node" node. Invalid XHTML was being
|
178
|
+
generated because the `node' node was marked as simply
|
179
|
+
"inline", so it was not pulled out of the <p> tag created
|
180
|
+
by Maruku.
|
181
|
+
|
182
|
+
Bug fixes
|
183
|
+
|
184
|
+
* The "silent" property in node definitions was not being
|
185
|
+
honored.
|
186
|
+
|
187
|
+
* Fix error when inserting reference nodes (they are not
|
188
|
+
inline!).
|
189
|
+
|
190
|
+
* Add workaround for Maruku treating first line of input as
|
191
|
+
parameter definition, and thereby omitting it from the
|
192
|
+
output!
|
193
|
+
|
194
|
+
* Array#to_s is equivalent to Array#inspect in Ruby 1.9.
|
195
|
+
|
196
|
+
* [30]HelloWorld format specification file added methods to
|
197
|
+
the nonexistent ERBook::Node class instead of adding them
|
198
|
+
to the ERBook::Document::Node class.
|
199
|
+
|
200
|
+
Housekeeping
|
201
|
+
|
202
|
+
* Simplify language phrases used in mini navigation menus.
|
203
|
+
|
204
|
+
* Remove CSS hacks for supporting IE6; it cannot render
|
205
|
+
XHTML anyway.
|
206
|
+
|
207
|
+
* Render italics and boldface equally in serif font. Bold
|
208
|
+
is truly bold now and italic is distinctive.
|
209
|
+
|
210
|
+
* Adjust spacing between document title, author, and date
|
211
|
+
headings.
|
212
|
+
|
213
|
+
* Add copyright notice at the top of every file.
|
214
|
+
</pre>
|
215
|
+
<p>
|
216
|
+
References
|
217
|
+
</p>
|
218
|
+
<pre>
|
219
|
+
1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld
|
220
|
+
2. http://en.wikipedia.org/wiki/ERuby
|
221
|
+
3. http://snk.tuxfamily.org/lib/erbook/#xhtml
|
222
|
+
4. http://snk.tuxfamily.org/lib/erbook/#latex
|
223
|
+
5. http://snk.tuxfamily.org/lib/erbook/#man
|
224
|
+
6. http://snk.tuxfamily.org/lib/erbook/#text
|
225
|
+
7. http://snk.tuxfamily.org/lib/erbook/#License
|
226
|
+
8. http://en.wikipedia.org/wiki/ERuby
|
227
|
+
9. http://snk.tuxfamily.org/lib/erbook/#HelloWorld
|
228
|
+
10. http://www.docbook.org/
|
229
|
+
11. http://deplate.sourceforge.net/
|
230
|
+
12. http://www.jus.uio.no/sisu/SiSU/
|
231
|
+
13. http://www.methods.co.nz/asciidoc/
|
232
|
+
14. http://txt2tags.sourceforge.net/
|
233
|
+
15. http://www.triptico.com/software/grutatxt.html
|
234
|
+
16. http://snk.tuxfamily.org/lib/erbook/#History
|
235
|
+
17. http://github.com/sunaku/erbook
|
236
|
+
18. http://git-scm.com/
|
237
|
+
19. http://snk.tuxfamily.org/lib/erbook/./api/index.html
|
238
|
+
20. http://snk.tuxfamily.org/lib/erbook/
|
239
|
+
21. http://snk.tuxfamily.org/lib/erbook/#License
|
240
|
+
22. http://www.rubygems.org/read/chapter/7
|
241
|
+
23. http://snk.tuxfamily.org/lib/erbook/#xhtml
|
242
|
+
24. http://snk.tuxfamily.org/lib/ember
|
243
|
+
25. http://snk.tuxfamily.org/lib/erbook/#Version-5.0.0-2008-11-22
|
244
|
+
26. http://www.w3.org/MarkUp/2004/xhtml-faq#ie
|
245
|
+
27. http://snk.tuxfamily.org/lib/erbook/#xhtml
|
246
|
+
28. http://demos.flesler.com/jquery/scrollTo/
|
247
|
+
29. http://github.com/sprsquish/rainpress/tree/master
|
248
|
+
30. http://snk.tuxfamily.org/lib/erbook/#HelloWorld.spec
|
249
|
+
</pre>
|
250
|
+
|
251
|
+
</div>
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
</div>
|
274
|
+
</div>
|
275
|
+
</body>
|
276
|
+
</html>
|
@@ -0,0 +1,407 @@
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<title>ANN.html</title>
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
8
|
+
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
|
9
|
+
<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
|
10
|
+
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
|
11
|
+
<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
|
12
|
+
<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
|
13
|
+
</head>
|
14
|
+
|
15
|
+
<body>
|
16
|
+
<div class="banner">
|
17
|
+
<h1>
|
18
|
+
ANN.html
|
19
|
+
</h1>
|
20
|
+
<ul class="files">
|
21
|
+
<li>ANN.html</li>
|
22
|
+
<li>Last modified: Mon May 04 01:18:29 -0700 2009</li>
|
23
|
+
</ul>
|
24
|
+
</div>
|
25
|
+
|
26
|
+
<div id="bodyContent">
|
27
|
+
<div id="content">
|
28
|
+
|
29
|
+
<div class="description">
|
30
|
+
<pre>
|
31
|
+
<center>
|
32
|
+
<h1>ERBook 7.0.0</h1>
|
33
|
+
<p>Extensible document processor based on eRuby</p>
|
34
|
+
<p>http://snk.tuxfamily.org/lib/erbook/</p>
|
35
|
+
</center>
|
36
|
+
<p>ERBook is an extensible document processor that emits <a class="xref" href="http://snk.tuxfamily.org/lib/erbook/#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>
|
37
|
+
</pre>
|
38
|
+
<p>
|
39
|
+
<p>A working <a class=“xref” href=“<a
|
40
|
+
href="http://snk.tuxfamily.org/lib/erbook/#xhtml">snk.tuxfamily.org/lib/erbook/#xhtml</a>“
|
41
|
+
title=“Chapter 5.1. &quot;XHTML (web page)&quot;”>XHTML
|
42
|
+
(web page)</a> format is provided, while <a class=“xref”
|
43
|
+
href=“<a
|
44
|
+
href="http://snk.tuxfamily.org/lib/erbook/#latex">snk.tuxfamily.org/lib/erbook/#latex</a>“
|
45
|
+
title=“Chapter 5.3. &quot;LaTeX (PDF)&quot;”>LaTeX
|
46
|
+
(PDF)</a>, <a class=“xref” href=“<a
|
47
|
+
href="http://snk.tuxfamily.org/lib/erbook/#man">snk.tuxfamily.org/lib/erbook/#man</a>“
|
48
|
+
title=“Chapter 5.4. &quot;UNIX manual page&quot;”>UNIX
|
49
|
+
manual page</a>, and <a class=“xref” href=“<a
|
50
|
+
href="http://snk.tuxfamily.org/lib/erbook/#text">snk.tuxfamily.org/lib/erbook/#text</a>“
|
51
|
+
title=“Chapter 5.2. &quot;Plain text&quot;”>plain
|
52
|
+
text</a> formats are planned&8230; <a class=“xref”
|
53
|
+
href=“<a
|
54
|
+
href="http://snk.tuxfamily.org/lib/erbook/#License">snk.tuxfamily.org/lib/erbook/#License</a>“
|
55
|
+
title=“Section 1.1. &quot;License&quot;”>patches are
|
56
|
+
welcome</a>!</p>
|
57
|
+
</p>
|
58
|
+
<p>
|
59
|
+
<p><a href="../classes/ERBook.html">ERBook</a> is exciting because:</p>
|
60
|
+
</p>
|
61
|
+
<p>
|
62
|
+
<ul> <li>Its documents are scriptable <a href=’<a
|
63
|
+
href="http://en.wikipedia.org/wiki/ERuby'>eRuby">en.wikipedia.org/wiki/ERuby'>eRuby</a>
|
64
|
+
templates</a>.</li>
|
65
|
+
</p>
|
66
|
+
<p>
|
67
|
+
<li>It lets you <a class=“xref” href=“<a
|
68
|
+
href="http://snk.tuxfamily.org/lib/erbook/#HelloWorld">snk.tuxfamily.org/lib/erbook/#HelloWorld</a>“
|
69
|
+
title=“Section 3.2.3. &quot;Creating your own document
|
70
|
+
format&quot;”>define your own document formats</a>.</li>
|
71
|
+
</p>
|
72
|
+
<p>
|
73
|
+
<li>Its core contains less than 300 lines of code.</li> </ul>
|
74
|
+
</p>
|
75
|
+
<p>
|
76
|
+
<p>These features distinguish <a href="../classes/ERBook.html">ERBook</a>
|
77
|
+
from the competition, which offers neither scriptable documents nor
|
78
|
+
definable document formats:</p>
|
79
|
+
</p>
|
80
|
+
<p>
|
81
|
+
<ul> <li><a href=’<a
|
82
|
+
href="http://www.docbook.org'>DocBook</a></li">www.docbook.org'>DocBook</a></li</a>>
|
83
|
+
</p>
|
84
|
+
<p>
|
85
|
+
<li><a href=’<a
|
86
|
+
href="http://deplate.sourceforge.net'>Deplate</a></li">deplate.sourceforge.net'>Deplate</a></li</a>>
|
87
|
+
</p>
|
88
|
+
<p>
|
89
|
+
<li><a href=’<a
|
90
|
+
href="http://www.jus.uio.no/sisu/SiSU/'>SiSU</a></li">www.jus.uio.no/sisu/SiSU/'>SiSU</a></li</a>>
|
91
|
+
</p>
|
92
|
+
<p>
|
93
|
+
<li><a href=’<a
|
94
|
+
href="http://www.methods.co.nz/asciidoc/'>AsciiDoc</a></li">www.methods.co.nz/asciidoc/'>AsciiDoc</a></li</a>>
|
95
|
+
</p>
|
96
|
+
<p>
|
97
|
+
<li><a href=’<a
|
98
|
+
href="http://txt2tags.sourceforge.net'>txt2tags</a></li">txt2tags.sourceforge.net'>txt2tags</a></li</a>>
|
99
|
+
</p>
|
100
|
+
<p>
|
101
|
+
<li><a href=’<a
|
102
|
+
href="http://www.triptico.com/software/grutatxt.html'>Grutatxt</a></li">www.triptico.com/software/grutatxt.html'>Grutatxt</a></li</a>>
|
103
|
+
</ul>
|
104
|
+
</p>
|
105
|
+
<p>
|
106
|
+
<div class=“section”>
|
107
|
+
</p>
|
108
|
+
<pre>
|
109
|
+
<a name="Logistics"/>
|
110
|
+
<h2 class="title">Logistics
|
111
|
+
</h2>
|
112
|
+
<div class="content"><ul>
|
113
|
+
</pre>
|
114
|
+
<p>
|
115
|
+
<li><a class=“xref” href=“<a
|
116
|
+
href="http://snk.tuxfamily.org/lib/erbook/#History">snk.tuxfamily.org/lib/erbook/#History</a>“
|
117
|
+
title=“Chapter 6. &quot;History&quot;”>Release
|
118
|
+
notes</a> &8212; history of project releases.</li>
|
119
|
+
</p>
|
120
|
+
<p>
|
121
|
+
<li><a href=’<a
|
122
|
+
href="http://github.com/sunaku/erbook'>Source">github.com/sunaku/erbook'>Source</a>
|
123
|
+
code</a> &8212; obtain via <a href=’<a
|
124
|
+
href="http://git-scm.com'>Git</a">git-scm.com'>Git</a</a>> or browse
|
125
|
+
online.</li>
|
126
|
+
</p>
|
127
|
+
<p>
|
128
|
+
<li><a href=’<a
|
129
|
+
href="http://snk.tuxfamily.org/lib/erbook/./api/index.html'>API">snk.tuxfamily.org/lib/erbook/./api/index.html'>API</a>
|
130
|
+
reference</a> &8212; documentation for source code.</li>
|
131
|
+
</p>
|
132
|
+
<p>
|
133
|
+
<li><a href=’<a
|
134
|
+
href="http://snk.tuxfamily.org/lib/erbook/'>Project">snk.tuxfamily.org/lib/erbook/'>Project</a>
|
135
|
+
home</a> &8212; the <a href="../classes/ERBook.html">ERBook</a> project
|
136
|
+
home page.</li> </ul></div> </div><p> To get help or provide feedback,
|
137
|
+
simply <a class=“xref” href=“<a
|
138
|
+
href="http://snk.tuxfamily.org/lib/erbook/#License">snk.tuxfamily.org/lib/erbook/#License</a>“
|
139
|
+
title=“Section 1.1. &quot;License&quot;”>contact the
|
140
|
+
authors</a>.</p>
|
141
|
+
</p>
|
142
|
+
<p>
|
143
|
+
<div class=“paragraph”>
|
144
|
+
</p>
|
145
|
+
<pre>
|
146
|
+
<a name="Version-numbers"/>
|
147
|
+
<p class="title">Version numbers</p>
|
148
|
+
<div class="content"><p>ERBook releases are numbered in <em>major.minor.patch</em> form according to the <a href='http://www.rubygems.org/read/chapter/7'>RubyGems rational versioning policy</a>, which can be summarized thus:</p>
|
149
|
+
</pre>
|
150
|
+
<p>
|
151
|
+
<table border=“1”>
|
152
|
+
</p>
|
153
|
+
<pre>
|
154
|
+
<thead>
|
155
|
+
<tr>
|
156
|
+
<td rowspan='2'>What increased in the version number?</td>
|
157
|
+
<td colspan='3'>The increase indicates that the release:</td>
|
158
|
+
</tr>
|
159
|
+
<tr>
|
160
|
+
<th>Is backward compatible?</th>
|
161
|
+
<th>Has new features?</th>
|
162
|
+
<th>Has bug fixes?</th>
|
163
|
+
</tr>
|
164
|
+
</thead>
|
165
|
+
<tbody>
|
166
|
+
<tr>
|
167
|
+
<th>major</th>
|
168
|
+
<td style='background-color: #FFE4E1;'>No</td>
|
169
|
+
<td>Yes</td>
|
170
|
+
<td>Yes</td>
|
171
|
+
</tr>
|
172
|
+
<tr>
|
173
|
+
<th>minor</th>
|
174
|
+
<td>Yes</td>
|
175
|
+
<td>Yes</td>
|
176
|
+
<td>Yes</td>
|
177
|
+
</tr>
|
178
|
+
<tr>
|
179
|
+
<th>patch</th>
|
180
|
+
<td>Yes</td>
|
181
|
+
<td style='background-color: #FFE4E1;'>No</td>
|
182
|
+
<td>Yes</td>
|
183
|
+
</tr>
|
184
|
+
</tbody>
|
185
|
+
</pre>
|
186
|
+
<p>
|
187
|
+
</table></div> </div><p></p>
|
188
|
+
</p>
|
189
|
+
<pre>
|
190
|
+
<div class="section">
|
191
|
+
<a name="Version-7.0.0-2009-05-03"/>
|
192
|
+
<h2 class="title">Version 7.0.0 (2009-05-03)
|
193
|
+
</h2>
|
194
|
+
<div class="content"><p>This release improves the appearance, usability, and validity of <a class="xref" href="http://snk.tuxfamily.org/lib/erbook/#xhtml" title="Chapter 5.1">XHTML (web page)</a> output, upgrades to a new eRuby templating system, adds new processing options to node definitions, and fixes some bugs.</p>
|
195
|
+
</pre>
|
196
|
+
<p>
|
197
|
+
<div class=“paragraph”>
|
198
|
+
</p>
|
199
|
+
<pre>
|
200
|
+
<a name="Incompatible-changes"/>
|
201
|
+
<p class="title">Incompatible changes</p>
|
202
|
+
<div class="content"><ul>
|
203
|
+
</pre>
|
204
|
+
<p>
|
205
|
+
<li> <p>If you add methods to the <code class=“line”><span
|
206
|
+
style=“color:036;font-weight:bold”>ERBook</span>::<span
|
207
|
+
style=“color:036;font-weight:bold”>Template</span></code>
|
208
|
+
class, in order to provide them to eRuby templates, you must now add those
|
209
|
+
methods to the <code class=“line”><span
|
210
|
+
style=“color:036;font-weight:bold”>ERBook</span>::<span
|
211
|
+
style=“color:036;font-weight:bold”>Template</span>::<span
|
212
|
+
style=“color:036;font-weight:bold”>Sandbox</span></code> class
|
213
|
+
instead.</p> </li>
|
214
|
+
</p>
|
215
|
+
<p>
|
216
|
+
<li> <p>The <a href=’<a
|
217
|
+
href="http://snk.tuxfamily.org/lib/ember'>Ember</a">snk.tuxfamily.org/lib/ember'>Ember</a</a>>
|
218
|
+
template processor is now used to render eRuby templates instead of the ERB
|
219
|
+
library that is shipped with Ruby.</p>
|
220
|
+
</p>
|
221
|
+
<p>
|
222
|
+
<ul> <li> <p>The file inclusion directive has been removed:</p>
|
223
|
+
</p>
|
224
|
+
<p>
|
225
|
+
<pre>&lt;%# include YOUR_FILE #%&gt;</pre>
|
226
|
+
</p>
|
227
|
+
<p>
|
228
|
+
<p>Ember provides equivalent functionality:</p>
|
229
|
+
</p>
|
230
|
+
<p>
|
231
|
+
<pre>%&lt; &quot;YOUR_FILE&quot;</pre> </li> </ul> </li>
|
232
|
+
</p>
|
233
|
+
<p>
|
234
|
+
<li> <p>The <tt>erbook/to_xhtml</tt> library now annotates
|
235
|
+
&60;code&62; elements with a &8220;line&8221; or
|
236
|
+
&8220;para&8221; class indicating whether they span a single or
|
237
|
+
mulitple lines respectively.</p>
|
238
|
+
</p>
|
239
|
+
<p>
|
240
|
+
<p>The &8220;pre.code&8221; CSS class is no longer emitted.</p>
|
241
|
+
</li>
|
242
|
+
</p>
|
243
|
+
<p>
|
244
|
+
<li> <p>The <tt>erbook/rdoc</tt> library has been updated to work with <a
|
245
|
+
href="../classes/RDoc.html">RDoc</a> 2.4.3. It no longer supports the old
|
246
|
+
<a href="../classes/RDoc.html">RDoc</a> that is shipped with Ruby 1.8.</p>
|
247
|
+
</li>
|
248
|
+
</p>
|
249
|
+
<p>
|
250
|
+
<li> <p>Just a reminder from the <a class=“xref” href=“<a
|
251
|
+
href="http://snk.tuxfamily.org/lib/erbook/#Version-5.0.0-2008-11-22">snk.tuxfamily.org/lib/erbook/#Version-5.0.0-2008-11-22</a>“
|
252
|
+
title=“Section 6.5“>Version 5.0.0 (2008-11-22)</a> release
|
253
|
+
notes:</p>
|
254
|
+
</p>
|
255
|
+
<p>
|
256
|
+
<blockquote> <p>Internet Explorer 6 and 7 <a href=’<a
|
257
|
+
href="http://www.w3.org/MarkUp/2004/xhtml-faq#ie'>do">www.w3.org/MarkUp/2004/xhtml-faq#ie'>do</a><em>
|
258
|
+
not</em> support</a> the application/xhtml+xml mime type, so the output
|
259
|
+
generated by the <a class=“xref” href=“<a
|
260
|
+
href="http://snk.tuxfamily.org/lib/erbook/#xhtml">snk.tuxfamily.org/lib/erbook/#xhtml</a>“
|
261
|
+
title=“Chapter 5.1“>XHTML (web page)</a> format cannot be
|
262
|
+
viewed in those browsers.</p> </blockquote> </li> </ul></div> </div><div
|
263
|
+
class=“paragraph”>
|
264
|
+
</p>
|
265
|
+
<pre>
|
266
|
+
<a name="New-features"/>
|
267
|
+
<p class="title">New features</p>
|
268
|
+
<div class="content"><ul>
|
269
|
+
</pre>
|
270
|
+
<p>
|
271
|
+
<li> <p>Replace dark background theme with a &8220;wide open
|
272
|
+
spaces&8221; theme.</p>
|
273
|
+
</p>
|
274
|
+
<p>
|
275
|
+
<ul> <li> <p>Use icons instead of unicode glyphs for mini navigation
|
276
|
+
menus.</p> </li>
|
277
|
+
</p>
|
278
|
+
<p>
|
279
|
+
<li> <p>Put mini navigation menus on right-hand side of headings</p> </li>
|
280
|
+
</p>
|
281
|
+
<p>
|
282
|
+
<li> <p>Use <a href=’<a
|
283
|
+
href="http://demos.flesler.com/jquery/scrollTo/'>scrolling">demos.flesler.com/jquery/scrollTo/'>scrolling</a>
|
284
|
+
animation</a> when local links (URI fragments) are visited, instead of
|
285
|
+
instantly teleporting to the destination. This gives a sense of spatial
|
286
|
+
existence to the web page, making it feel almost tangible!</p> </li> </ul>
|
287
|
+
</li>
|
288
|
+
</p>
|
289
|
+
<p>
|
290
|
+
<li> <p>XHTML output is now valid XHTML 1.0 Transitional! And the embedded
|
291
|
+
CSS it contains is now valid CSS 3!</p>
|
292
|
+
</p>
|
293
|
+
<p>
|
294
|
+
<ul> <li> <p>Minify CSS in XHTML output using the <a href=’<a
|
295
|
+
href="http://github.com/sprsquish/rainpress/tree/master'>Rainpress">github.com/sprsquish/rainpress/tree/master'>Rainpress</a>
|
296
|
+
library</a>.</p> </li>
|
297
|
+
</p>
|
298
|
+
<p>
|
299
|
+
<li> <p>Add CSS style for HTML definition lists.</p> </li> </ul> </li>
|
300
|
+
</p>
|
301
|
+
<p>
|
302
|
+
<li> <p>Omit target type and index (&8220;Section X.Y.Z&8221;) in
|
303
|
+
output of <code class=“line”>xref()</code> nodes in the
|
304
|
+
screen-version (CSS stylesheet) of the generated output document.</p>
|
305
|
+
</p>
|
306
|
+
<p>
|
307
|
+
<p>This information is still present in the print-version (CSS stylesheet)
|
308
|
+
of the generated output document, where it is truly helpful to the
|
309
|
+
reader.</p> </li>
|
310
|
+
</p>
|
311
|
+
<p>
|
312
|
+
<li> <p>Add &8220;bypass&8221; option to node definitions to
|
313
|
+
properly support the generic &8220;node&8221; node. Invalid XHTML
|
314
|
+
was being generated because the &8216;node&8217; node was marked as
|
315
|
+
simply &8220;inline&8221;, so it was not pulled out of the
|
316
|
+
&60;p&62; tag created by Maruku.</p> </li> </ul></div> </div><div
|
317
|
+
class=“paragraph”>
|
318
|
+
</p>
|
319
|
+
<pre>
|
320
|
+
<a name="Bug-fixes"/>
|
321
|
+
<p class="title">Bug fixes</p>
|
322
|
+
<div class="content"><ul>
|
323
|
+
</pre>
|
324
|
+
<p>
|
325
|
+
<li> <p>The &8220;silent&8221; property in node definitions was not
|
326
|
+
being honored.</p> </li>
|
327
|
+
</p>
|
328
|
+
<p>
|
329
|
+
<li> <p>Fix error when inserting reference nodes (they are not
|
330
|
+
inline!).</p> </li>
|
331
|
+
</p>
|
332
|
+
<p>
|
333
|
+
<li> <p>Add workaround for Maruku treating first line of input as parameter
|
334
|
+
definition, and thereby omitting it from the output!</p> </li>
|
335
|
+
</p>
|
336
|
+
<p>
|
337
|
+
<li> <p><code class=“line”><span
|
338
|
+
style=“color:036;font-weight:bold”>Array</span><span
|
339
|
+
style=“color:888“>to_s</span></code> is equivalent to <code
|
340
|
+
class=“line”><span
|
341
|
+
style=“color:036;font-weight:bold”>Array</span><span
|
342
|
+
style=“color:888“>inspect</span></code> in Ruby 1.9.</p> </li>
|
343
|
+
</p>
|
344
|
+
<p>
|
345
|
+
<li> <p><a class=“xref” href=“<a
|
346
|
+
href="http://snk.tuxfamily.org/lib/erbook/#HelloWorld.spec">snk.tuxfamily.org/lib/erbook/#HelloWorld.spec</a>“
|
347
|
+
title=“Example 1”>HelloWorld format specification file</a>
|
348
|
+
added methods to the nonexistent <code class=“line”><span
|
349
|
+
style=“color:036;font-weight:bold”>ERBook</span>::<span
|
350
|
+
style=“color:036;font-weight:bold”>Node</span></code> class
|
351
|
+
instead of adding them to the <code class=“line”><span
|
352
|
+
style=“color:036;font-weight:bold”>ERBook</span>::<span
|
353
|
+
style=“color:036;font-weight:bold”>Document</span>::<span
|
354
|
+
style=“color:036;font-weight:bold”>Node</span></code>
|
355
|
+
class.</p> </li> </ul></div> </div><div class=“paragraph”>
|
356
|
+
</p>
|
357
|
+
<pre>
|
358
|
+
<a name="Housekeeping"/>
|
359
|
+
<p class="title">Housekeeping</p>
|
360
|
+
<div class="content"><ul>
|
361
|
+
</pre>
|
362
|
+
<p>
|
363
|
+
<li> <p>Simplify language phrases used in mini navigation menus.</p> </li>
|
364
|
+
</p>
|
365
|
+
<p>
|
366
|
+
<li> <p>Remove CSS hacks for supporting IE6; it cannot render XHTML
|
367
|
+
anyway.</p> </li>
|
368
|
+
</p>
|
369
|
+
<p>
|
370
|
+
<li> <p>Render italics and boldface equally in serif font. Bold is truly
|
371
|
+
<strong>bold</strong> now and italic is <em>distinctive</em>.</p> </li>
|
372
|
+
</p>
|
373
|
+
<p>
|
374
|
+
<li> <p>Adjust spacing between document title, author, and date
|
375
|
+
headings.</p> </li>
|
376
|
+
</p>
|
377
|
+
<p>
|
378
|
+
<li> <p>Add copyright notice at the top of every file.</p> </li>
|
379
|
+
</ul></div> </div><p> </p></div> </div>
|
380
|
+
</p>
|
381
|
+
|
382
|
+
</div>
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
</div>
|
405
|
+
</div>
|
406
|
+
</body>
|
407
|
+
</html>
|