Ruby Document format
RD is a traditional format. In modern Ruby, developers tend to write documents in RDoc instead of RD.
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
Sample RD document
This document is syntactically correct RD, which attempts to follow the major conventions on section naming as well.
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
An Example List
An ordered List
Copyright 2005 J. Random Hacker <firstname.lastname@example.org>. 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.
- RDtool - Framework to translate RD document into other formats.
- rd-draft.rd - full description of RD markup languard (in RD format)
- rd-draft.html - full description of RD markup language (converted to HTML)