Forum: Ruby RDoc in latest version

Hello Kind people in Rubyland,

I hope I posted this to the mailing list as this pertains to ruby, but 
not
actual code. This is my first post, so forgive me if I've made a mistake
(and possibly guide me to the correct place to post).

My question is this: I'm working my way through the book "Beginning 
Ruby:
From Novice to Professional" and it's written for ruby versions 1.8 and
1.9. I am using the current version, which I believe is 1.9.3. In the 
book
the author, Peter Cooper, uses RDoc to help document his code.

It outputs something that has three frames at the top in his book. When 
I
run rdoc myself from the command line, it outputs a folder with an
index.html that allows a javascript search of the methods that are
documented in the class.

I did some searching and found http://rdoc.sourceforge.net/, but that 
seems
to be the three-framed rdoc mentioned in the book. Where can I learn 
about
this new rdoc? I can't seem to find information anywhere online, and I 
want
to be sure I'm learning the correct commands for it.

Thank you very much for your time,
Rashi

I think this is just a different "skin" or "theme" for RDoc. The 
command-line interface and the data is still the same; it's just 
displayed in a prettier way.

I noticed that the indentation of bullet points didn't seem to matter.

Such that:
* Bullet point one
     *Sub-bullet one
     *Sub-bullet two
*Bullet two
     *Sub-bullet one

Didn't come out formatted correctly. All the sub bullets looked like 
code.

Also, it didn't seem to process words between pluses as code ex: +this 
is
code+ did not format properly

Did the commands change? Where can I learn the new commands?

Also, where can I learn about the different skins or themes for Rdoc?

Sorry, I don't know.

Thanks for your help anyways. Maybe someone else knows?

On Mon, Feb 11, 2013 at 11:54 AM, RKA <roshkins@gmail.com> wrote:

>
Your sub-bullets need to line up with your new "let margin:
http://rdoc.rubyforge.org/RDoc/Markup.html#label-S...
The new left margin would be where the first character after the bullet
point character starts. In your example the 'B' after the star:


* Bullet point one ('B' is in the third column)
  * Sub-bullet one ('*' is also in the third column)
  * Sub-bullet two
* Bullet two
  * Sub-bullet two



>
> Also, it didn't seem to process words between pluses as code ex: +this is
> code+ did not format properly
>

If you look here:
http://rdoc.rubyforge.org/RDoc/Markup.html#label-Text+Markup
You'll see that the text markup using the start '*', underscore, '_', 
and
plus sign '+' only work when put around single words (no whitespace).
You'll have to use the HTML-tag style of markup (<b>, <em>, or <tt>
respectively) if you want to markup strings containing multiple words.


>
> Did the commands change? Where can I learn the new commands?
>

The markup reference I use is: 
http://rdoc.rubyforge.org/RDoc/Markup.html


>
> Also, where can I learn about the different skins or themes for Rdoc?
>

Using the command line: rdoc --help
You'll see that the "--template=NAME" command-line option allows you to
change which template to use. For a list of templates, check out:

https://www.ruby-toolbox.com/search?q=rdoc+template

Kendall, thank you very much for your help!

Am Tue, 12 Feb 2013 02:37:25 +0900
schrieb RKA <roshkins@gmail.com>:

> Hello Kind people in Rubyland,

Hi Rashi,

> It outputs something that has three frames at the top in his book.
> When I run rdoc myself from the command line, it outputs a folder
> with an index.html that allows a javascript search of the methods
> that are documented in the class.

The three-frames output is the old RDoc layout of RDoc prior to version
3 (I think it was this version). Modern versions of RDoc generate the
layout you’re seeing (and this new layout is called "Darkfish").

> I did some searching and found http://rdoc.sourceforge.net/, but that
> seems to be the three-framed rdoc mentioned in the book. Where can I
> learn about this new rdoc? I can't seem to find information anywhere
> online, and I want to be sure I'm learning the correct commands for
> it.

The RDoc sourceforge page is heavily outdated as nobody has the
credentials for it anymore. RDoc’s official homepage is at
http://rdoc.rubyforge.org and you can find a markup reference here:
http://rdoc.rubyforge.org/RDoc/Markup.html#label-R...

> Thank you very much for your time,
> Rashi

Vale,
Marvin