プログラミング言語/Ruby/RD の履歴(No.2)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• プログラミング言語/Ruby/RD へ行く。
  • 1 (2007-12-09 (日) 20:46:12)
  • 2 (2007-12-09 (日) 20:46:12)
  • 3 (2007-12-10 (月) 02:17:05)
  • 4 (2007-12-13 (木) 18:12:57)
  • 5 (2007-12-13 (木) 18:12:57)

プログラミング言語/Ruby

RD†

RDとはRuby Documentationの略です。

ソースコードに埋め込む形式としてはRDocのほうが主流になりがちですが、 RWiki*1や VikiWiki*2、 BitChannel*3や tDiary*4、 新リファレンスマニュアル*5など、 用いられているものはたくさんあります。

書く場所†

=begin
 ...
=end

という複数行コメントがRubyにはありますが、PerlにおけるRODのような 感じでそこに埋め込むことを考えられていましたが、 前述の通りRDocにその役目は譲りつつありますし、 RDtoolは=beginや=end行を補完してくれたりします。

書式†

基本的に、Inlineを除く書式は先頭の文字(HeadChar)で決まり、 要素の連なりはインデントによって判別されます。

TextBlock

通常のテキスト段落。 空白以外から始まる行の連なり。

Example:
こんにちは。
わたしは、
VIPからきますた。

Verdatim

整形済みテキスト。 インデントがそれまでより深い行の連続。 インデントが同じ行の連続がひとつのVerdatimとして扱われる。 Verdatim内ではInlineは解釈されない。

Example:
ここはインデント深くないのでTextBlock。
ここも。
  ここからVerdatim。
  改行などもそのまま反映される。
    ここからさらに別のVerdatim。
    前より深いので。
  前より浅くなったので前のVerdatim終わり。新しいVerdatim。
  入れ子になっていて、最初のVerdatimと同じというわけではない。
インデントが戻ったので、ここは普通のTextBlock。

Comment

コメント。 `#'で始まる行がコメント行とされる。 Rubyと使う文字が一緒だが、Rubyとは違って行の途中からの コメントはない。

HeadLine

見出し。 六段階の見出しが書ける。 内容がLabelとなる(Labelについては後述)。

Example:
= HeadLine-1
== HeadLine-2
=== HeadLine-3
==== HeadLine-4
+ HeadLine-5
++ HeadLine-6

Include

別ファイルの取り込み。 RDを取り込む方法と、変換するのフォーマットを取り込む方法とがある。

Example:
#RDを取り込む
<<< anothoer_file.rd
#変換フォーマットに従って取り込む(HTMLならexternal_file.htmlを)
<<< external_file

ItemList

箇条書き。 `*'から始まる行は箇条書きの項目(Item)になり、 Itemの連続で箇条書きリストになります。

Example1:
* これが
* リスト
* です

ItemにはTextBlockから始まる各要素の連なりが置けます。 そのTextBlockの始まりがインデントの基準とされます。

Example2:
* つまり、Verdatimを書くには
    インデント基準より深くすればぉk
    なのでこれはVerdatim。
  ここからはTextBlock。
* 二つ目のItem。
  * 要素を入れ子に、ということは、
  * とうぜんリスト自体も含められるわけで。
*ただしHeadLineやIncludeは無理だよーん

EnumList

番号付き箇条書き。

DescList

定義や説明の記述。

MethodList

メソッド説明専用のDescList。

Inline

文中要素の総称。

Inline†