RD（Ruby Document format）は、Rubyスクリプトに埋め込むことができるドキュメントフォーマットの一つです。Ruby関連のドキュメントで広く利用されており、その特徴は、Wiki文法に似たマークアップを使用して、簡潔に記述できる点にあります。HTMLなどの他の形式に比べて、より簡単に構造的なドキュメントを作成することが可能です。

マークアップ

RDはRubyスクリプトに埋め込む場合、`=begin`と`=end`で囲まれた部分に記述します。これにより、Rubyのコード内にドキュメントを直接記述できるため、コードとドキュメントの一体化が容易になります。

見出し

RDでは、見出しを以下のような記号を使って表現します。見出しのレベルは、記号の数によって制御され、HTMLに変換する際には適切な見出しタグ（`

`から`

`）に対応付けられます。


= 最大見出し
== 大見出し
段落1
=== 中見出し
段落2
==== 中小見出し
段落3
+ 小見出し
段落4
++ 最小見出し
段落5


上記のRD記述は、以下のようなHTML構造に変換されます。

html

最大見出し

大見出し

段落1

中見出し

段落2

中小見出し

段落3

小見出し

段落4

最小見出し

段落5

箇条書き

RDでは、箇条書きを表現するための記号が用意されており、順序なしリストと順序付きリストを作成できます。また、リストは入れ子にすることも可能です。

順序なしリストの例：


順序の無い箇条書き。

続き。改行があってもよい。
入れ子にすることができる。


このRD記述は、以下のようなHTML構造に変換されます。

html

• 順序の無い箇条書き。


• 続き。改行があってもよい。
  
  
  
  • 入れ子にすることができる。
  
  
  
  

順序付きリストの例：


(1) 順序つきの箇条書き
(2) 続き
違う種類の箇条書き


このRD記述は、以下のようなHTML構造に変換されます。

html

1. 順序つきの箇条書き


2. 続き
   
   
   
   • 違う種類の箇条書き
   
   
   
   

用語の定義：


:HTML
HyperText Markup Language の略。
:RD
Ruby Document format の略。


このRD記述は、以下のようなHTML構造に変換されます。

html

HTML

HyperText Markup Language の略。

RD

Ruby Document format の略。

リストの入れ子は、行頭の字下げ（スペースの数）が等しいかどうかで判断されます。字下げが深いほど、より深い入れ子構造になります。

関連項目

RDoc
コンピュータ言語'>コンピュータ言語
データ記述言語'>データ記述言語
マークアップ言語'>マークアップ言語
マークアップ言語'>軽量マークアップ言語

外部リンク

* RDtool - RD formatter

もう一度検索