[トップ] [更新履歴] [著書] [コンピュータ] [ゲーム] [CGI配布]


Title: RD事始め

Index


1 RDって何?

RDは以下の特徴を持ったドキュメント体系である。 とても簡単なので慣れれば誰でも書ける。 Rubyに興味がある人も興味がない人も試してみよう。 やってて損はないから。

すなわち、ぶっちゃけた話HTMLを楽して書いちゃえ!ってところだ。 HTMLをそのまま書くとしても、どうせ使う要素(タグ)は限られている。 だったら楽して書かないか?

HTMLへの変換はRDtoolがやってくれる。 しかし、ここではウェブ上で気楽に変換してほしいのでCGI版RDコンバータを用意した。 どんどん使ってくれ。 一種のHTML作成支援ツールである。 普通のHTML作成支援ツールが気に入らないあるいは飽きてきたのならRDを試してごらん。 こういうビルダーもあるんだということで。

2 とりあえず書いちゃえ♪

RD は

=begin

で始まり、

=end

で終わる。 この中にはほぼ何を書いてもいい。 ただし、HTMLに変換すると改行は有効にならないので注意。 段落を変えるときは、空行を作る必要がある。 以下が一番単純なRDである。

=begin
これは RD だよ〜〜ん。
とっても簡単な RD。
みんなも覚えてね☆

次の段落だよ〜
=end

これをHTMLに変換してみよう。「変換」ボタンを押してみて。 あっ、そうそう。 CGI版を使うときは「=begin」と「=end」は省略できるからね。

RDソース
スタイルシートのURL(省略可)
HTMLタイトル(省略可)

3 もう少しRD

3.1 大小の見出し(HeadLine)

RD では見出しを付けることができる。 見出しの下にはさらに見出しをつけることができる。 "="と"+"を先頭の文字にしてスペースをあけて見出しの名前を書く。 見出しの大小は"="や"+"の数で表す。 たとえば、

= 見出しだよ

と使う。 見出しは大きいものから

=
==
===
====
+
++

となっている。

=begin
= 大見出しI
== 小見出し1
段落1
== 小見出し2
段落2
= 大見出しII
〜〜〜〜
=end

って感じになる。見やすいでしょ? んじゃ、変換してみよう。

RDソース
スタイルシートのURL(省略可)
HTMLタイトル(省略可)

3.2 箇条書き

先頭の文字を"*"にすれば箇条書きになる。 しかも、箇条書きは入れ子にできる。 入れ子にするときは2文字だけ字下げすること。

例
=begin
* item 1
* item 2
  * item 2-1
  * item 2-2
    * item 2-3
=end

RDソース
スタイルシートのURL(省略可)
HTMLタイトル(省略可)

3.3 番号付き箇条書き

先頭の文字を"(1)"のようなカッコ付き数字すれば箇条書きになる。 これも入れ子にできる。 入れ子にするときは4文字だけ字下げすること。

例
=begin
朝やることは、
(1) 起きて、
(2) 顔を洗って、
(3) 食事を取って、
    * パン
    * 牛乳
(4) 歯を磨いて、
(5) 出勤
することです(笑)
=end

RDソース
スタイルシートのURL(省略可)
HTMLタイトル(省略可)

3.4 用語定義リスト

これはあまり使わないかもだけど、用語の説明用の構文が用意されている。 用語じゃなくても、更新履歴を書いたりもできる。 この構文は2つの要素から成る。 「用語部」と「説明部」だ。 用語部は行の先頭を“:”で始め、その直後に用語を書く。 説明部は用語部の下に書く。 このとき、用語部よりも深くインデントを取る必要がある。 俺が推奨する書き方は、

としている。

=begin
= プログラミング言語
:Ruby
  和製オジェクト指向スクリプト言語。
  とにかく非常に手軽かつ強力だ。
:Perl
  CGIっていったらまだPerlが全盛だ。
  プログラムが暗号のようになりやすい。
:C
  高級アセンブラ言語。動作は非常に高速。
  機械語レベルの操作もできる反面、プログラムミスすると大変。
= 履歴
:[2001/01/29]
  これを書く。
:[2001/01/20]
  RDコンバータを組み込む。
=end  

では、変換してみよう。

RDソース
スタイルシートのURL(省略可)
HTMLタイトル(省略可)

3.5 打ったそのままを出すには

一度「とりあえず書いちゃえ♪」へ戻って変換結果を再確認してみよう。 「普通に」文を書いていったのでは、折り返しをしてくれないのがわかるはずだ。 これだと困るときがあるよね。 ちゃんと改行してほしいときもあるはずだろう。 プログラミングをやってる人なら、プログラムのリストを貼り付けたりしたいときを考えてみよう。 やり方はいたって簡単で、その部分をインデント(先頭にスペースを入れること)するだけだ。

=begin
プログラムリストの例。
そのまま表示させたくば、インデントするだけだ。
  time = Time.now.hour
  print case time
        when 0..4, 18..23
          'こんばんは'
        when 5..11
          'おはよう'
        when 12..17
          'こんにちは'
        end
これでよし。
=end

RDソース
スタイルシートのURL(省略可)
HTMLタイトル(省略可)

4 HTMLへ変換

RDtoolを使うことで、RDをHTMLに変換できる。 CGI版ではなく、ここでは自分でインストールしてみよう。

4.1 必要なツールのインストール

以下のツールをドキュメントに従って、この順序でインストールする。

4.2 使い方

$ rd2 hogehoge.rd

で、RDを処理し、標準出力にHTMLを出力する。 一番良く使われるのが

$ rd2 hogehoge.rd > hogehoge.html

という形であろう。


戻る ホームページへ戻る

Valid XHTML 1.0!
rubikitch(rubikitch@ruby-lang.org)

投書箱:コメントや伝えたい情報などがあればお気軽にどうぞ
名前 メール [説明]
URL
本文