S
Suraj Kurapati
ERBook 6.0.0
Extensible document processor based on eRuby
http://snk.tuxfamily.org/lib/erbook/
ERBook is an extensible document processor that emits [1]any
document you can imagine from [2]eRuby templates that allow
scripting and dynamic content generation.
A working [3]XHTML (web page) format is provided, while
[4]LaTeX (PDF), [5]UNIX manual page, and [6]plain text
formats are planned... [7]patches are welcome!
6.1 Version 6.0.0 (2009-01-19)
This release improves the appearance & usability of the XHTML
format, refactors the core logic into reusable libraries,
fixes some bugs and improves variable names.
Incompatible changes
* Renamed @types to @nodes_by_type and @spec to @format in
XHTML format.
* Moved the core logic of the erbook executable into the
ERBook:
ocument and ERBook:ocument::Template classes.
New features
* 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.
* A star is drawn beside a reverse jump target in the table
of contents, so the user can continue where they left
off.
* Added "inline" node definition parameter (see [8]Section
3.2.1. Node definition).
* Added $subtitle parameter to XHTML format.
* Document parameters for the XHTML format, such as $title,
can now be disabled by setting them to nil.
* Relative file paths can now be specified in <%#include#%>
directives.
* Added a "node" node (see [9]Section 5.1.4.2.1. node),
which serves as a pass-through container, in the XHTML
format.
* Allow user to type <pre> blocks on single lines without
affecting the display of their content.
* Initial newline in the body of <code> is now stripped.
This allows users to write their code blocks normally:
<code>
foo
bar
</code>
Instead of abnormally to avoid an extra leading newline:
<code>foo
bar
</code>
* Paragraph nodes are now included in the table of
contents.
Bug fixes
* 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.
* <pre> blocks now expand to fit their content in the XHTML
format. No more scrollbars!
* <a/> without href was treated as external hyperlink.
Housekeeping
* Revised the project logo to emphasize the owl mascot.
* Replaced dull MediaWiki hyperlink colors with more lively
colors in XHTML format.
* Wrote more API documentation and use [10]Inochi to
simplify project maintenance.
References
1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld
2. http://en.wikipedia.org/wiki/ERuby
3. http://snk.tuxfamily.org/lib/erbook/#xhtml
4. http://snk.tuxfamily.org/lib/erbook/#latex
5. http://snk.tuxfamily.org/lib/erbook/#man
6. http://snk.tuxfamily.org/lib/erbook/#text
7. http://snk.tuxfamily.org/lib/erbook/#License
8. http://snk.tuxfamily.org/lib/erbook/#SpecFile.nodes
9. http://snk.tuxfamily.org/lib/erbook/#xhtml.nodes.node
10. http://snk.tuxfamily.org/lib/inochi
Extensible document processor based on eRuby
http://snk.tuxfamily.org/lib/erbook/
ERBook is an extensible document processor that emits [1]any
document you can imagine from [2]eRuby templates that allow
scripting and dynamic content generation.
A working [3]XHTML (web page) format is provided, while
[4]LaTeX (PDF), [5]UNIX manual page, and [6]plain text
formats are planned... [7]patches are welcome!
6.1 Version 6.0.0 (2009-01-19)
This release improves the appearance & usability of the XHTML
format, refactors the core logic into reusable libraries,
fixes some bugs and improves variable names.
Incompatible changes
* Renamed @types to @nodes_by_type and @spec to @format in
XHTML format.
* Moved the core logic of the erbook executable into the
ERBook:
ocument and ERBook:ocument::Template classes.New features
* 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.
* A star is drawn beside a reverse jump target in the table
of contents, so the user can continue where they left
off.
* Added "inline" node definition parameter (see [8]Section
3.2.1. Node definition).
* Added $subtitle parameter to XHTML format.
* Document parameters for the XHTML format, such as $title,
can now be disabled by setting them to nil.
* Relative file paths can now be specified in <%#include#%>
directives.
* Added a "node" node (see [9]Section 5.1.4.2.1. node),
which serves as a pass-through container, in the XHTML
format.
* Allow user to type <pre> blocks on single lines without
affecting the display of their content.
* Initial newline in the body of <code> is now stripped.
This allows users to write their code blocks normally:
<code>
foo
bar
</code>
Instead of abnormally to avoid an extra leading newline:
<code>foo
bar
</code>
* Paragraph nodes are now included in the table of
contents.
Bug fixes
* 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.
* <pre> blocks now expand to fit their content in the XHTML
format. No more scrollbars!
* <a/> without href was treated as external hyperlink.
Housekeeping
* Revised the project logo to emphasize the owl mascot.
* Replaced dull MediaWiki hyperlink colors with more lively
colors in XHTML format.
* Wrote more API documentation and use [10]Inochi to
simplify project maintenance.
References
1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld
2. http://en.wikipedia.org/wiki/ERuby
3. http://snk.tuxfamily.org/lib/erbook/#xhtml
4. http://snk.tuxfamily.org/lib/erbook/#latex
5. http://snk.tuxfamily.org/lib/erbook/#man
6. http://snk.tuxfamily.org/lib/erbook/#text
7. http://snk.tuxfamily.org/lib/erbook/#License
8. http://snk.tuxfamily.org/lib/erbook/#SpecFile.nodes
9. http://snk.tuxfamily.org/lib/erbook/#xhtml.nodes.node
10. http://snk.tuxfamily.org/lib/inochi