rdoc frame placement?

D

Daniel Berger

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.
 
J

Jamis Buck

Daniel said:
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
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
474,189
Messages
2,571,014
Members
47,611
Latest member
LaunaVerju

Latest Threads

Top