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

Title: rd2html-ext 〜rd2html-lib.rbの拡張〜

Index

• 必要なもの
• インストール
• 使い方
• 使用例
• ライセンス
• 更新履歴

RDtool標準についてくるrd2html-lib.rbを拡張。 以下の拡張機能をつけている。

• Headlineごとに節番号をつける。
• TextBlock上の改行を反映する

• 画像挿入などができるようにReferenceを拡張。

  • [2001/10/14][RAA:image_size]がインストールされていれば画像挿入時に大きさも計算してくれる。
• BODY要素内に任意のHTML inlineを入れられる。
• [2001/10/14]HEAD要素内に任意のHTML片を入れられる。

ダウンロード

1 必要なもの

• RDtool

2 インストール

あおきぷろだくつと同じ。

$ ruby setup.rb config
$ ruby setup.rb setup
$ ruby setup.rb install

注意！

~/.rd2rcのない人は事前にrd/dot.rd2rcをコピーしてからインストールすること。 それを忘れたときにはあわてずに

$ ruby setup.rb setup

を起動すること。

3 使い方

$ rd2 -r rd/rd2html-ext-lib.rb [オプション] ファイル

rd2html-extでは、標準のrd2htmlに加えて以下のオプションが使用可能。

--headline-secno

Headlineをもとに節番号をつける。 論理構造が重視される文章におすすめ。

• 「=」は自動的にタイトルとなる。
• 「==」は「1」、「2」になる。
• 「===」は「1.1」、「1.2」になる。
• 「====」は「1.1.1」、「1.1.2」になる。

--enable-br

TextBlockでの改行は出力HTMLではBR要素に置き換えられる。 RDはBR要素すら表現できないのかよ、貧弱なやつめなどと思っている人はこれをonにしよう。

--ref-extension

画像の挿入、Rubyメーリングリストの参照、RAAの参照ができるようにRefereneを拡張する。^*1

画像の挿入

次のようにすると画像の挿入ができる。

例：
((<画像だよ|"IMG:test.jpg">))

この例では <img src="test.jpg" alt="画像だよ"> というHTML要素に変換される。 くれぐれも「"」を忘れないように。

Rubyメーリングリストの参照

RubyメーリングリストのbladeでのURLに変換することができる。

例：
((<ruby-list:0001>))
((<ruby-talk:0001>))
((<ruby-math:0001>))
((<ruby-dev:0001>))

Ruby Application Archiveの参照

RAAの参照もできる。

例：
((<RAA:RDtool>))

--native-inline

((:〜:))で任意のHTML inline要素を入れることができる。 もともとはIndexに使われるInlineであるが、使われていないのでこのバージョンではIndexを代用することにする。 将来のRDtoolでは好きなInlineを定義できるようになるので、((!〜!))などに割り当てればいいだろう。 これをonにすることにより、RDはHTMLと同等の表現力をもつことになる。

例：
((:<big>大きな文字だー</big>:))

--head-element

現状のRDtoolを適用してもHTMLのHEAD要素内にはCSSやタイトルなど決まったHTML片を付け加えることはできなかった。 しかしこの--head-elementオプションと--with-part=head:headオプションをつけることで任意のHTML片をHEAD要素内に指定することができる。 たとえばキーワードやロボットよけのためにMETA要素を加えるといった使い方がある。

付け加えるにはRDのFilter機能を使えばよい。 くれぐれも本文開始直前の「=end」を忘れないように。

例：

=begin head
<meta name="keyword" content="RD" />
=end
=begin
本文
=end

4 使用例

使用例はパッケージの sample/sample.{rd,html} を参考にしてね。 また、RDコンバータの拡張機能のチェックボックスをonにすればこれらの機能も使うことができるので、御気軽に実験してみよう。

5 ライセンス

setup.rbの著作権はあおきさんにあり、GPLである。 その他の著作権はるびきちにあってRuby'sにしておく。

6 更新履歴

[2003/10/30]

--headline-titleのバグを修正。遅くなりまして申し訳ありません。

[2003/01/30]

RAAのURL変更。

[2003/05/08]

RAAのURL変更。(遅くなりました(^^;)

戻る ホームページへ戻る

^*1RWikiよりいただいた。