Ruby Document format


RD is a lightweight markup language
for writing Ruby-related documents.
It can be embedded in Ruby source code.
RD is a traditional format.
In modern Ruby, developers tend to write documents in RDoc instead of RD.

Use

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.

Sample RD document

This document is syntactically correct RD,
which attempts to follow the major conventions on section naming as well.

NAME

RD sample - A sample RD document

SYNOPSIS

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

DESCRIPTION

Here's some normal text. It includes text that is
emphasized,, code-formatted, variable part, indexed, and as-is*1.

An Example List

  1. This is the first item
  2. second
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

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.