Rdoc frame placement?

Hi all,

Is there a command line option to place the HTML frames that rdoc
generates on the left side of the page instead of the top? Or would I
have to use a template of some sort?

If it requires a template, could someone please kindly paste one here?
I have no idea how to write one.

Regards,

Dan

PS - I may have asked this before a long time ago, but I couldn't find
it on a search, so my apologies in advance if that's the case.

Daniel Berger wrote:

Hi all,

Is there a command line option to place the HTML frames that rdoc
generates on the left side of the page instead of the top? Or would I
have to use a template of some sort?

In general, you have to use a template specifically made to output the frames how you want them. (I'm sure a template could be made that output both styles, but I don't know if rdoc supports an option to specify that or not.)

If it requires a template, could someone please kindly paste one here?
I have no idea how to write one.

The rdoc template I use to generate the documentation for my projects (http://copland.rubyforge.org/api, http://needle.rubyforge.org/api, http://sqlite-ruby.rubyforge.org, etc.) is available online, at:

   http://ruby.jamisbuck.org/jamis.rb

Just save that file in the rdoc/generators/template/html subdirectory of your ruby library directory, and then specificy --template=jamis to use it. (Assuming you _want_ to use it, of course. ;))

- Jamis

···

--
Jamis Buck
jgb3@email.byu.edu
http://www.jamisbuck.org/jamis