From: MoonWolf <moonwolf@...>
Date: 2000-08-27T18:35:52+09:00
Subject: [ruby-list:24556] 埋め込みドキュメント仕様 RubyDoc( 提案)

MoonWolfです。

Rubyの埋め込みドキュメントを扱うRubyDocという仕様を考えました。実装も
あります。

  http://www.moonwolf.com/ruby/rubydoc/

[特徴]
・Rubyスクリプトからドキュメントを取り出すことが出来ます。 
・ドキュメントをRubyスクリプトに取り込むことが出来ます。 
・ドキュメントの差し替えが簡単です。英語と日本語ドキュメントの差し替え
 も数個のコマンドで出来ます。 
・スクリプトはプログラミング用のエディタで、ドキュメントはドキュメント
 用のエディタで効率的に編集出来ます。また、それぞれの編集を並行して
 作業出来ます。 

[書き方]
 =begin label で始まる行から =end で始まる行までがRubyDocになります。
labelはファイルの中でユニークである必要があります。label には空白を含
むことが出来ますが、末尾の空白は除去されます。日本語も使用可能です。

[ドキュメント]
RubyDocの中身にはプレーンテキスト、RD、HTMLが書けます。それぞれの仕様
はRubyDoc/plain,RubyDoc/RD,RubyDoc/HTMLとなっています。

# 単純なアイデアですいません。でも無いよりはましでしょ？

-- 
MoonWolf mailto:moonwolf@moonwolf.com