From: Ben Giddings Date: 2005-06-21T03:47:10+09:00 Subject: Re: [ANN] Frameless RDoc template ('technology preview') On Saturday 18 June 2005 00:28, John W. Long wrote: > ES wrote: > > From a slight frustration with the current RDoc templates and general > > boredom I decided to try my hand in implementing one; the main goal was > > to get rid of frames in a graceful manner. > > Wow. This is cool. Am I right to assume that all of the pages are > contained in a single document? > > I was working on my own template a while back: > > http://johnwlong.com/downloads/rubyred-rdoc-template-test-1.html > > and > > http://johnwlong.com/downloads/rubyred-rdoc-template.zip Hey John, lovely design as usual. The problem I see isn't so much "framed" vs "frameless" but more the contents of the boxes. The files box: Most of the time, I don't care what file something is in. I can't think of the last time I used the "files" area. The classes box: This is useful, until there are too many classes. I think the current core has far too many classes for them to just be thrown in a list with no grouping. There should be some kind of grouping or packaging to make it easier for humans to navigate. The methods box: Whoa. If there are too many classes to navigate, there are *way* too many methods. Sometimes a full list of every method that exists in the core is useful, but that's more of an "appendix" sort of thing. Mostly I want to know what methods exist in a particular class I've selected. I still think the original pickaxe online documentation has the easiest to navigate interface to the core api: http://www.rubycentral.com/book/builtins.html You have to scroll the page to see everything, but searching for a class is easy, and finding the methods of a particular class is really intuitive. If you want to find a method but can't remember what class it's in, you can always use the browser's page search to find the method. I wonder, is RDoc flexible enough to allow someone to generate a page like the above? Ben