RD でも書いてみようか 【第 3 回】 RD as a ruby document format
初稿:2005-09-06
書いた人:mput
はじめに
これまでの連載をみても明らかなように、RD は一般的な文章を書くために使うことができます。実際に、RD を使って毎日の日記を書いている人も rubyist の中にはそれなりに存在します。しかし、多くの人にとって、RD の一番馴染み深い使い道は「ドキュメントを読み書きすること」でしょう。ライブラリについてきた README.rd を読まないと使い方が分からないとか、そういうケースは意外に多いものです。今回は、ドキュメント用フォーマットとしての RD の側面に光を当ててみたいと思います。
メソッドリスト
Ruby ドキュメントとしての顕著な記法のひとつにメソッドリストがあります。これはメソッドの名前とその役割をペアにして記述したもので、以下のような外見をしています。
見てのとおり “— “ ではじまっている行がメソッドの名前で、以下インデントをそろえてこのメソッドの解説が書いてあります。このメソッドには引数がないのですが、引数のあるメソッドの場合
このように、それっぽい場所に引数を書けばよいです。また、引数が省略できる場合は
のように、省略できる部分を[]で括って示すことができます。
多くの場合、拡張ライブラリに付属してくるリファレンスマニュアルにはこのようなメソッドリストがいくつも並んでいることでしょう。
ドキュメントでよく使うインライン
引数
ドキュメント内では、一般の文章とは違ったインラインがいくつか使われます。代表的なのは引数をあらわすインライン (( |
引数名 |
)) で、メソッドリストとともに使われる場合が多いものです。例を見てみましょう。 |
この文章の中で i とか j とか k とかの変数は例示のためにたまたま付けた変数であり、その名前に特に意味はありません。特に意味がないことを明示するために、これらの変数は (( |
名前 |
)) のような形でマークアップしてあります。 |
コード
他によく使うものとして、プログラムコードを文中に埋め込む際に使う (({…})) があります。これは以下のように使うことが多いでしょう。
入力
また、まれに使われるインラインとしては、ユーザーの入力を表す ((%…%)) があります。
これはユーザーに操作を求めるときに使います。
などと使うのが一般的です。HTML でいうと <kbd> ですね。
次回予告
というわけで、これまで 3 回にわけて RD の基本的な書き方を紹介してきました。
次回は、RD の文法そのものではなく、RD を処理して HTML やプレーンテキストに変換する処理系のお話をしたいと思います。おたのしみに。
RD でも書いてみようか連載一覧