- Ruby Document format
RD is a
lightweight markup language for writing Ruby related documents. It can be embeded in Ruby source code.RD is an abbreviation for Ruby Document.RD is a traditional format. In modern, Ruby developers tend to write documents in
RDoc instead of RD.Use
RD was used for many documentation in the Ruby world. The documentation of Ruby itself has been written in RD. In
2002 , the documenation was re-written in RDoc format. The Japanese version of "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 case, end-users read it after converted into
man page s or HTML pages.Pure RD files usually have the extension
.rd. RD can be embeded in Ruby code.ample RD document
This document is syntactically correct RD, which attempts to follow the major conventions on section naming as well.
ee also
*
RDoc
*Plain Old Documentation External links
* [http://raa.ruby-lang.org/list.rhtml?name=RDtool RDtool] - Framework to translate RD document into other formats.
Wikimedia Foundation. 2010.
