“I want to enjoy this code”

I saw “[EVALUATION]” in the title and shuddered.

(Referring to a particular friend on ruby-talk / ruby-core.)

Regarding the ruby-doc.org change itself: hooray!!!! A million times better.

Okay, so what’s the best way to organize our RDocs?

How about some slidey thingies that drop the Class, file, and method listings out from the side or the top or something… (my preference would be files on the top left, the complete method listings on the top right, and the classes on the left).

And maybe there can be a floating navigation bar that lets you jump up and down between methods in a particular RDoc page. That’d be nice.

Hrmm… wish I had better HTML skills.

Thanks for the kudos on ruby-doc. Yes, the API docs need a facelift. I’m looking at RDog right now, which has a different template than the conventional rdoc HTML . It uses some JavaScript/DHTML sldy stuff I believe.

Need to get something up that I can poke at for a bit. It’s important, though that each class/module have it’s own URI , an it would be ideal f that were true for methods as well (though URI fragments might be enough)

Viewing the same page twice makes it disappear. Reverse these lines:

ele.style.display = 'block';
c.style.display = 'none';

It wouldn’t be very useful with something as small as Camping, but client-side live search would be pretty easy to implement.

cool for the new site for ruby-doc. but I clicked “10 Things Every Java Programmer Should Know About Ruby” at the very top of the page and got a tgz with a bunch of HTML pages. I think to put this on the front of the site like that, a PDF of that presentation should be made so it’s easier to access.

• it seems i can’t bookmark or send a link about a certain class. the address bar of the browser always displays http://camping.rubyforge.org/ and there doesn’t seem to be frames (probably IFRAM Es?)

• when i got to “Module Camping::Models” (see, i can’t send you a link…) clicking on “Models” (link is javascript:showPage(‘Camping::Models’) ) nothing happens for me? many such links are dead for me ( javascript:showPage(‘Camping::Controllers::Base’) as well) so it’s difficult to evaluate more.

PS: using firefox 1.5 on win32

Would be nice if the docs where commentable. And building a diff file to update the source files.

zimbatim: what it needs it collaborative editing and cross-media scheduling of real-time examples with private messages and a calendar of events!

haha just kidding, i was reminded of this

comments would be nice though :)

Commentable docs sounds like a job for Hoodwink.d

why, see this and this for a possible solution to the link-ableness-problem.

zimbatm: what, you haven’t winked yet? Get with it, friend.

Huh… Actually, I’ve spent about all of 5 seconds thinking about RDoc thus far in the time I’m been playing with Ruby. I have to agree on the dislike of frames issue, so this is kinda nice. I’ll definately have to give this a try for FeedTools when I have the time.

phil: I’m not zimbatm, but a lot of us don’t wink because all we get are Internal Server 500 errors when we try.

looks nice!

Ah, nice!

Could certainly do with those URLs, though.

I played around with single-page templates using Javascript as well, but I have not touched it in months. Feel free to see if there is anything useful there: http://www.magical-cat.org/projects/ruedoc

dty

rue, that is almost exactly what I was thinking of except I’d like to see a dropdown for sections on the page that floated on the side so you could easily jump around inside of it.

Can’t seem to get it to work though… ran setup.rb and installed the rue.rb template into the rdoc html templates folder and it tells me that the RDoc::Page::STYLE constant is uninitialized when called from write_style_sheet.

Any ideas?

I’m trying to understand what’s wrong with one-file-per-class without using frames.

CPA Ns layout for documentation seems just fine and they don’t have any frame-like madness.

What’s different about Ruby?

• WWW-Search-2.486—Package Documentation
• WWW::Search—Module Documentation

Sure, sure, that’s the goal. Just need to do a bit more RDoc hacking.

I think your layout is great, I just found it didn’t act right when I tried to right-click to open something in a different tab.

Isn’t that the whole problem with some of the AJAX sites—how do you bookmark pages when you are using javascript to change between states?