Segment7: RDoc's TemplatePage removed from Ruby

RDoc's TemplatePage removed from Ruby

drbrain@segment7.net (Eric Hodel) — Mon, 07 Jan 2008 02:59:54 -0800

If you’ve got a custom RDoc template, it won’t work with the next release of 1.9. I’ve removed the custom TemplatePage and replaced it with an ERB-based version that works similarly.

This should make it much, much easier to write a custom RDoc template as you can now use arbitrary ruby code inside your templates.

It’s really easy to convert an old RDoc template to the upcoming version:

Replace this	With this
`%blah%`	`<%= values["blah"] %>`
`!INCLUDE!`	`<%= template_include %>`
`HREF:aref:name`	`<%= href values["aref"], values["name"] %>`
`IF:blah`	`<% if values["blah"] then %>`
`IFNOT:blah`	`<% unless values["blah"] then %>`
`ENDIF:blah`	`<% end %>`
`START:blah`	`<% values["blah"].each do \|blah\| %>`
`END:blah`	`<% end %>`

To make nested loops easier to convert, convert START statements to:

<% values["blah"].each do |blah| $stderr.puts blah.keys %>

So you can see what is being used inside which loop.

I’ve also removed the old_html template, as I don’t think anybody uses it anymore, and updated all the existing templates in RDoc to use ERB. (If somebody could double-check my work on the CHM and XML outputters, that would be great.)

"RDoc's TemplatePage removed from Ruby" by Rob O

Sun, 27 Jan 2008 10:42:17 -0800

Awesome. Nice to see rDoc is still improving. Thanks.

"RDoc's TemplatePage removed from Ruby" by Eric Hodel

Tue, 15 Jan 2008 15:07:10 -0800

sb: You can see RDoc in action in ruby’s trunk. It should be 1.8 compatible, but the work won’t be backported for distribution with 1.8.

"RDoc's TemplatePage removed from Ruby" by sb

Mon, 14 Jan 2008 13:39:27 -0800

Please do release the new rdoc as a gem.

Until then, how can I get the code and use your changes? Does the new rdoc run under 1.8 too?

"RDoc's TemplatePage removed from Ruby" by Bruce Williams

Sun, 13 Jan 2008 21:52:40 -0800

Thanks, Eric!

"RDoc's TemplatePage removed from Ruby" by Eric Hodel

Sat, 12 Jan 2008 12:14:46 -0800

I’ll probably be making a release of RDoc as a gem to help flush out bugs in RDoc and to explore further RubyGems/Ruby integration.

"RDoc's TemplatePage removed from Ruby" by Tom

Sat, 12 Jan 2008 02:34:23 -0800

s/Runy/Ruby/

"RDoc's TemplatePage removed from Ruby" by Tom

Sat, 12 Jan 2008 02:33:48 -0800

When you say “next release of 1.9” is that Ruby 1.9? Is it possible to use your erb-based RDoc in Runy 1.8? Thanks.

"RDoc's TemplatePage removed from Ruby" by shaners

Mon, 07 Jan 2008 22:58:01 -0800

+1, bro.

"RDoc's TemplatePage removed from Ruby" by Joe Grossberg

Mon, 07 Jan 2008 17:20:58 -0800

So sensible. I appreciate you putting in the work to make things easier for other people.

"RDoc's TemplatePage removed from Ruby" by bryanl

Mon, 07 Jan 2008 08:50:20 -0800

This is a good change.

"RDoc's TemplatePage removed from Ruby" by Bil Kleb

Mon, 07 Jan 2008 03:09:04 -0800

Bravo!