RD (Ruby Document) is a
lightweight markup language
A lightweight markup language (LML), also termed a simple or humane markup language, is a markup language with simple, unobtrusive syntax. It is designed to be easy to write using any generic text editor and easy to read in its raw form. Lightwei ...
for writing
Ruby
A ruby is a pinkish red to blood-red colored gemstone, a variety of the mineral corundum ( aluminium oxide). Ruby is one of the most popular traditional jewelry gems and is very durable. Other varieties of gem-quality corundum are called sa ...
-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
RDoc, designed by Dave Thomas, is an embedded documentation generator for the Ruby programming language.
It analyzes Ruby source code, generating a structured collection of pages for Ruby objects and methods.
Code comments can be added in a nat ...
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 page
A man page (short for manual page) is a form of software documentation usually found on a Unix or Unix-like operating system. Topics covered include computer programs (including library and system calls), formal standards and conventions, and e ...
s.
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.
See also
*
Markdown
Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form. Markdown is ...
*
Plain Old Documentation
Plain Old Documentation (pod) is a lightweight markup language used to document the Perl programming language as well as Perl modules and programs.
Design
Pod is designed to be a simple, clean language with just enough syntax to be useful. It pur ...
External links
RDtool- Framework to translate RD document into other formats.
rd-draft.rd- full description of RD markup languard (in RD format)
- full description of RD markup language (converted to HTML)
Lightweight markup languages
{{compu-lang-stub