Ruby Document format

From Wikipedia, the free encyclopedia
Jump to: navigation, search

RD (Ruby Document) 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[edit]

RD was used for many documentation in the Ruby world. The documentation for Ruby itself was originally written in RD. In 2002, the documentation was re-written in RDoc format. The Japanese version of the Ruby Reference Manual is still written in RD.

RD is easy to read in the raw. It is designed to read or write by hand. But, in most cases, end-users read it after it has been converted into man pages or HTML pages.

Pure RD files usually have the extension .rd. RD can be embedded in Ruby code.

Sample RD document[edit]

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

Source HTML result
NAME

RD sample - A sample RD document

SYNOPSIS
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
DESCRIPTION

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

An Example List
  • This is a bulleted list.
  • Here's another item.
    • Nested list item.
An ordered List
  1. This is the first item
  2. second
  • Nested unordered list.
  1. start=3
  2. third
  1. Nested ordered list
  2. its second item
"Figure 1."

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 <jrh@cpan.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.

See also[edit]

External links[edit]

  • 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)