element. * A visual marker is shown on outgoing (external) hyperlinks. * Tooltips are shown upon mouse hover for section index and title links which instruct new users how to navigate the web page more efficiently. <% end %> <% paragraph "Housekeeping" do %> * Renamed `Node#url` to `Node#here_frag`. Also, speak of "frags" rather than "anchors" or "urls" from now on. * Refactored common logic from node output templates into Node class. <% end %> <% end %> <% section "Version 3.1.0 (2008-06-22)" do %> 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. <% paragraph "New features" do %> * 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! Usability * All headings are now hyperlinks to themselves. This allows readers to obtain a "permanent link" to any section in your HTML document. * A meta navigation menu is now emitted at the top of the HTML document. This menu contains hyperlinks to the various structural elements of a document, such as the abstract, table of contents, list of figures, and references. * The color of visited hyperlinks has been darkened to improve readability. * The style of **blockquote** now provides better focus on its content. * Cross-reference (xref) hyperlinks now have a mouse-hover title when you override the default link text. Printing * Page breaks are now inserted before major sections in the document. This allows for easier printing (you can print a subset of pages without fear of discontinuity) and improves readability through better organization. * 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. * Internal hyperlinks (which point to internal URI fragments) that are not cross-references are now shown as normal text to reduce distraction. <% end %> <% paragraph "Bug fixes" do %> * Cross-reference (xref) hyperlinks to paragraphs were broken due to a missing **id** attribute. <% end %> <% paragraph "Housekeeping" do %> * Removed useless CSS styles and fixed some XHTML validation issues. <% end %> <% end %> <% section "Version 3.0.2 (2008-06-08)" do %> This release implements a shorter, faster, better unindentation algorithm which: * Allows block beginnings <%% do %> and endings <%% end %> to span multiple lines. * Ignores blank lines (which may contain whitespace) after block beginnings. * Processes multiple lines per iteration, instead of one line at a time. <% end %> <% section "Version 3.0.1 (2008-06-03)" do %> 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. <% end %> <% section "Version 3.0.0 (2008-06-01)" do %> 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. <% paragraph "Incompatible changes" do %> * The `$unindent` parameter has been replaced by the --unindent command-line option, which automatically unindents each line of input by the inner margin of its containing node. * The **include** directive now has a symmetric # at the closing end:

<%%# include ... #%>

<% end %> <% paragraph "Bug fixes" do %> * The CSS for the horizontal rule (hr) element should now be consistent in all browsers. * 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: * `header_outside_above` - above the entire header block * `header_inside_above ` - above the default header content * `header_inside_below ` - below the default header content * `header_outside_below` - below the entire header block * `footer_outside_above` - above the entire footer block * `footer_inside_above ` - above the default footer content * `footer_inside_below ` - below the default footer content * `footer_outside_below` - below the entire footer block <% end %> <% end %> <% section "Version 2.1.0 (2008-05-29)" do %> This release adds image embedding methods for the HTML format and no longer appends (through CSS) an asterisk on outgoing hyperlinks. <% end %> <% section "Version 2.0.0 (2008-02-03)" do %> This release fixes some bugs, improves the RDoc library, and adds nodes for customization of the default header and footer. <% paragraph "Incompatible changes" do %> * The lib/gerbil/rdoc.rb library has changed! Read it for details. <% end %> <% paragraph "New features" do %> * In the **html** format, added the following nodes which allow you customize the default header and footer whilst preserving the default content: * `header_outside_above` - above the entire header block * `header_inside_above ` - above the default header content * `header_inside_below ` - below the default header content * `header_outside_below` - below the entire header block * `footer_outside_above` - above the entire footer block * `footer_inside_above ` - above the default footer content * `footer_inside_below ` - below the default footer content * `footer_outside_below` - below the entire footer block <% end %> <% paragraph "Bug fixes" do %> * [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) * The lib/gerbil/rdoc.rb library did not extract method information recursively. <% end %> <% paragraph "Housekeeping" do %> * In the **html** format, added a CSS margin above HTML tables because they were visually colliding with other elements above them. * Fixed some Ruby code warnings in the **html** format. <% end %> <% end %> <% section "Version 1.1.0 (2008-01-22)" do %> This release improves usability and fixes some bugs. <% paragraph "New features" do %> * 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. <% end %> <% paragraph "Bug fixes" do %> * Forgot to update some code when I renamed the `RDoc.gen_parse_tree` method in format/rdoc.rb during the last release. * Module methods were omitted by the `RDoc.gen_method_infos` method in format/rdoc.rb. <% end %> <% end %> <% section "Version 1.0.0 (2008-01-12)" do %> This release makes Gerbil available as a [RubyGem](http://rubygems.org), fixes some bugs, and updates the user guide. <% paragraph "Incompatible changes" do %> * The gerbil file has been moved to bin/gerbil. * The format/ directory has been renamed to fmt. * The format/html.rb file has been moved to lib/gerbil/html.rb. * The format/rdoc.rb file has been moved to lib/gerbil/rdoc.rb. * In format/rdoc.rb, the name of the `RDoc.gen_parse_tree` method has been pluralized (tree → trees) because it really returns an _array_ of trees rather than a single tree. * The CHANGES.yaml file has been removed, in favor of [this RSS feed](http://gerbil.rubyforge.org/news.xml). * The `GENERATOR` object has been renamed to `Gerbil`. <% end %> <% paragraph "Bug fixes" do %> * 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. * In the HTML format, images inside descendant nodes of a *figure* node were not properly centered. * In the HTML format, the `$title` parameter was not converted into HTML. <% end %> <% end %> <% section "Version 0.0.1 (2007-12-13)" do %> * Fixed the generation of unique node URI fragments in the HTML format. * Added a `$feeds` parameter to the HTML format. * Added the format/rdoc.rb library for accessing RDoc's parse tree. * Updated the user guide: * added documentation for methods provided by the HTML format * added RSS feed for project release announcements * improved the ghastly HelloWorld example * Added a simple change-log (CHANGES.yaml) for the project. <% end %> <% section "Version 0.0.0 (2007-12-09)" do %> Dear developers, technical writers, and documentation gurus, I am proud to announce a new project of mine named "Gerbil" which is beautifully short (176 lines of code) and powerful! Personally, I am baffled at the amount of documentation I wrote (and felt was necessary) to explain the plethora of things this tiny little utility does. About 70% of the development time was consumed by documentation alone! I'm glad that's over. :-) The release notes are shown at the bottom of this message. Cheers! * * * This is the _first_ release of [the Gerbil project](http://gerbil.rubyforge.org.) Happy birthday! 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 bin/ directory. Until this issue is resolved, please download the tarball/zip packages instead. <% end %> <% end %> <% end %>