S
Suraj Kurapati
erbook : write books and documents in eRuby
===========================================
erbook is an extensible document processor that emits XHTML
(web page), LaTeX (PDF), man (UNIX manual page), plain text,
and any document format you can imagine from eRuby templates
that allow scripting and dynamic content generation.
erbook is a light (210 source lines of code), extensible
(create your own document formats), and flexible (your content
is scriptable) alternative to DocBook, Deplate, and SiSU.
Visit http://snk.tuxfamily.org/lib/erbook/ for more information.
* * * RELEASE NOTES * * *
erbook 5.0.0
Contents
• 1 Caution
• 2 Improvements
• 3 Repairs
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.
1 Caution
• Renamed the “html†format to “xhtml†(and all similarly
named methods and files) in order to support custom DTD
extensions which reduce the overall file size of the
output. See this note in the user manual for the
consequences of this change.
• Removed the $use_icons parameter from the XHTML format.
Now, icons are always used, whether you like it or not!
;-)
• Replaced the implicit ERB::Util#h method with a
verbatim() method in the XHTML format.
• The Trollop library (used for command-line options
parsing) is now required to run erbook. See the “Setupâ€
section in the user manual for details.
2 Improvements
• Added support for single-line eRuby directives (lines
which begin with “%â€), both in general and in the
--unindent option. See this section of the user manual
for examples.
• Enhanced stack traces with information about the input
file and also <%#include#%>-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. ;-)
• Omitted erbook internals from stack traces (unless in
$DEBUG mode). This helps users concentrate on problems
in their input document.
• Used colors for hyperlinks and suffix icon for external
hyperlinks from the MediaWiki software, which powers
the famous Wikipedia.
3 Repairs
• Could not jump to examples and admonitions from the
list of figures.
• 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.
• Added API documentation for all methods listed in the
user manual, while also omitting many irrelevant
methods from the list.
===========================================
erbook is an extensible document processor that emits XHTML
(web page), LaTeX (PDF), man (UNIX manual page), plain text,
and any document format you can imagine from eRuby templates
that allow scripting and dynamic content generation.
erbook is a light (210 source lines of code), extensible
(create your own document formats), and flexible (your content
is scriptable) alternative to DocBook, Deplate, and SiSU.
Visit http://snk.tuxfamily.org/lib/erbook/ for more information.
* * * RELEASE NOTES * * *
erbook 5.0.0
Contents
• 1 Caution
• 2 Improvements
• 3 Repairs
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.
1 Caution
• Renamed the “html†format to “xhtml†(and all similarly
named methods and files) in order to support custom DTD
extensions which reduce the overall file size of the
output. See this note in the user manual for the
consequences of this change.
• Removed the $use_icons parameter from the XHTML format.
Now, icons are always used, whether you like it or not!
;-)
• Replaced the implicit ERB::Util#h method with a
verbatim() method in the XHTML format.
• The Trollop library (used for command-line options
parsing) is now required to run erbook. See the “Setupâ€
section in the user manual for details.
2 Improvements
• Added support for single-line eRuby directives (lines
which begin with “%â€), both in general and in the
--unindent option. See this section of the user manual
for examples.
• Enhanced stack traces with information about the input
file and also <%#include#%>-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. ;-)
• Omitted erbook internals from stack traces (unless in
$DEBUG mode). This helps users concentrate on problems
in their input document.
• Used colors for hyperlinks and suffix icon for external
hyperlinks from the MediaWiki software, which powers
the famous Wikipedia.
3 Repairs
• Could not jump to examples and admonitions from the
list of figures.
• 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.
• Added API documentation for all methods listed in the
user manual, while also omitting many irrelevant
methods from the list.