Rote is a lightweight, powerful documentation and templating system that provides an easy-to-use Rake-based build for your software documentation and other static text for the web. Rote's approach is to provide the expert Rubyist with an intuitive solution based on familiar technologies like Erb, Red/BlueCloth and Syntax. Rote is simple enough to be used with zero configuration, yet flexible enough to satisfy fairly complex requirements thanks to it's open-ended design, reliance on Ruby code for configuration, and tight integration with Rake.
This release introduces several new features and enhancements, and some small fixes:
* BlueCloth now used for Markdown
* Dynamic dependency cache
* File-dependency based block memoize
* Implemented nested layout
* Implemented ruby eval macro
* Implemented external command macro
* (re)fixed COMMON.rb bug (bug 3040)
* Fixed a lot of documentation errors
This release is backward compatible with Rote 0.3.0(.2) and takes Rote closer to it's final form for 1.0 - apart from improved compatibility with the ActionView helpers (for those that want it) and pseudo-section support, we feel that this is pretty much how Rote 1.0 will look. It is a recommended upgrade for all users.
In addition to the download links above, you can of course install Rote via RubyGems:
gem install rote
If you do not have RubyGems, you can download one of:
I'm once again indebted to the fledgling community that's developing around Rote, both for some remarkable contributions, but also for responding to my request for feedback a short while ago with good bug reports and suggestions. As we head for 1.0 I hope that even more feedback (good and bad) will come from you guys, so we can make Rote the tool that Rubyists truly want.
Unfortunately not I tend to think that the best example is probably the Rote documentation, but then I am told that's too complex (it's only three pages but the guide is quite long I guess). It does, however, make use of many of the features (though still not all). You can browse it in SVN:
or alternatively it's bundled with the Gem and archives if you've downloaded Rote.
Generally I struggle to make worthwhile examples anyway, and especially with Rote it's hard to make an easy example since it's a 'project' based thing, so any example is necessarily going to seem 'too much' I guess. I've tried to avoid having a separate 'sample project' since that just means two downloads rather than one to get a look at Rote
If anyone has any ideas for good examples, (or even wants to make one ;)), I'm very interested in getting something together on that front.
Cheers,
···
On Fri, 06 Jan 2006 06:23:42 -0000, Joel VanderWerf <vjoel@path.berkeley.edu> wrote:
Hopefully, by the end of the week I can show you something. I am
currently moving my loose collection of "tips and tricks", notes,
assorted text files and so on over to rote. Some might say, that my
tasks is well suited for a wiki, but I don't like wikis. I want vim
to edit the files, markdown for markup, and some rake task to actually
upload the stuff to my webserver. Here rote looks like a nice solution
to me.
Best regards,
Oliver
···
On Fri, Jan 06, 2006 at 03:23:42PM +0900, Joel VanderWerf wrote:
Other than the user's guide, are there any gee-whiz examples posted
somewhere?
Hopefully, by the end of the week I can show you something. I am
currently moving my loose collection of "tips and tricks", notes,
assorted text files and so on over to rote.
I tend to think that the best example is probably the Rote documentation, but then I am told that's too complex (it's only three pages but the guide is quite long I guess). It does, however, make use of many of the features (though still not all). You can browse it in SVN: