"RD" による html ファイルの作成
このページの文章は, RD で書き, "dcmodel.css" というスタイルシートを使用しております.
にも関わらず, そのスタイルで表示されないのはなぜか, 現在調査中.
RD とは？
ruby というプログラム言語で表現されたスクリプト (ruby script) に埋め込むドキュメント形式. 詳しくはこちら .
RD を書くための準備
以下では, 自分が行った作業ログのようなものである.
- 計算機環境
- OS : Ubuntu (ver.9.04)
- ここでの目的は, RD による文書の書き方を習得するためのものであるため, ソースからのインストールは行わず, パッケージからのインストールを行う.
- 以下, 作業ログ
パッケージのインストール
# apt-get install ruby rdtool librd-ruby1.8 librd-html-ext-ruby1.8 rdtool-elisp
ここで, すでにインストール済みのパッケージがあれば, 適宜変更すること.
- 環境設定
- RD から html に変換する際, ここでは専用の Makefile を用いて make する. 専用のMakefile は以下から取得する. また, html ファイル用のスタイルシートも取得しておく.
ファイルの書き方
- 基本文は Tex と同じように, =begin と =end との間に本文を表記する。コメントアウトは # で行う.
- 箇条書きは = が大きなくくりで, これより小さな箇条書きが * で行う. また, html に変換する際, ページの <title> には, = にかかれている文字が代入される.
以下に例文を示す.
=begin = 大見出し (この部分は <title> に置換される) # この文がコメントアウト == 中見出し (用いる "=" の数でインデントが変化する) * さらに小さな箇条書き * さらにさらに小さな箇条書き =end
- 注意
- html に変換する際, rd 文の改行は有効にならない
- 段落を変える際は, 空行を入れる
- 文章のべた書きは, 行頭に空白を入れる
この他にもいくつかルールは存在するが, ここでは以上でとどめておく.
html への変換
変換には, 2 つの方法があり, Makefile を用いて make するか, さまざまなオプションをつけ, rd2 コマンドを使用する.
Makefile を用いた変換
- 先ほどダウンロードした Makefile.rd2html を変換したい rd ファイルと同じディレクトリに配置し, 名称を "Makefile" に変更する.
- 自分の目的に合うように, Makefile の中身を変更する.
- コマンド make を行う.
以上で, rd ファイルと同じディレクトリに, htm ファイルが生成されるはずである.
rd2 コマンドを用いた変換
基本的には,
$ rd2 sample.rd > sample.html
を行うことで, html ファイルを生成できる. 複雑なオプションをつけることで, 自分好みの html ファイルを生成することができる.
スタイルシートの使用
先ほど Makefile と同じようにダウンロードしたスタイルシートを任意のディレクトリに配置しておく. rd2 コマンドで変換する際は, --with-css オプションを用いることで使用可能となる. Makefile で make する際は, Makefile の中身を
CSS = /library/dcmodel/htmltools/dcmodel.css
を配置したスタイルシートの元までのパスに書き換えたあとで, make を行う.