Ruby Document format
Encyclopedia
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.
The documentation for Ruby itself was originally written in RD.
In 2002, the documenation 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 can be embedded in Ruby code.
which attempts to follow the major conventions on section naming as well.
Lightweight markup language
A lightweight markup language is a markup language with a simple syntax, designed to be easy for a human to enter with a simple text editor, and easy to read in its raw form....
for writing Ruby
Ruby (programming language)
Ruby is a dynamic, reflective, general-purpose object-oriented programming language that combines syntax inspired by Perl with Smalltalk-like features. Ruby originated in Japan during the mid-1990s and was first developed and designed by Yukihiro "Matz" Matsumoto...
-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
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 natural style....
instead of RD.
Use
RD was used for many documentation in the Ruby world.The documentation for Ruby itself was originally written in RD.
In 2002, the documenation 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
This document is syntactically correct RD,which attempts to follow the major conventions on section naming as well.
| Source | HTML result |
|---|---|
| =begin | NAMERD sample - A sample RD document SYNOPSIShere.is_a?(Piece::Of::Code) DESCRIPTIONHere's some normal text. It includes text that is An Example List
An ordered List
|
External links
- RDtool - Framework to translate RD document into other formats.