Ruby Document format

Originally, most documentation in the Ruby world, including for Ruby itself, had been written in RD. Then in 2002, much of it was converted to RDoc format. Although, the Japanese version of the Ruby Reference Manual still remains in RD format.

RD is designed to be written by hand and easily read in its raw form. Most end-users however experience it after it has been converted into HTML or man pages.

RD can be embedded in Ruby code, and pure RD files usually have the extension .rd.

This document is syntactically correct RD,

which attempts to follow the major conventions on section naming as well.

{| class="wikitable"

! width="50%" | Source !! width="50%" | HTML result

|-

| style="background-color: white;" |

| style="background-color: white;" |

RD sample - A sample RD document

here.is_a?(Piece::Of::Code)

print <<"END"
This indented block will not be scanned for formatting
codes or directives, and spacing will be preserved.
END

Here's some normal text. It includes text that is

emphasized, {{mono|keyboard}}, code-formatted, variable part, indexed, and as-is^*1.

• This is a bulleted list.
• Here's another item.
• Nested list item.

1. This is the first item
2. second

:* Nested unordered list.

{{Ordered list |start{{=}}3|third}}

:#Nested ordered list

:#its second item

Here's some embedded HTML. In this block I can

include images, apply

styles, or do anything else I can do with

HTML. RD processors that aren't outputting HTML

will completely ignore it.

Copyright 2005 J. Random Hacker . Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.

|}

• Markdown
• Plain Old Documentation

{{reflist}}

• [http://raa.ruby-lang.org/project/rdtool?name=RDtool RDtool] - Framework to translate RD document into other formats.
• [https://github.com/uwabami/rdtool/blob/master/doc/rd-draft.rd rd-draft.rd] - full description of RD markup languard (in RD format)
• [http://rubyforge.org/docman/view.php/5708/3908/rd-draft.html rd-draft.html] - full description of RD markup language (converted to HTML)

{{Ruby programming language}}

Category:Lightweight markup languages

{{compu-lang-stub}}