むとうです。こんばんわ。
On Sun, 31 Mar 2002 00:56:20 +0900
TADA Tadashi <sho@spc.gr.jp> wrote:
> ただただしです。
> 返事遅くてすみません。
>
> なんかコードを読む元気がなくて、ざっとしか見てないんだけど、こんな
> 方向性でいいんじゃないかと思います。#使ってる? >kitaj
>
> #ところでこのコード、tab=4?
えっと、Emacsのruby-modeのままです。確かに他のエディタで読むと
おかしくなりますね。
とりあえず、TABをスペースに変換してアップデートしました。
#保存するとき、自動的にTABをスペースに変換する方法ってどうすれば
#良いんでしたっけ(^^;)。
> あとはドキュメントか……。pluginの中にyasqueezeってディレクトリを
> 掘っちゃうか、yasqueeze.rb内にドキュメントへのURLを書くか。
>
> On Fri, 29 Mar 2002 22:21:42 +0900 "Masao Mutoh" <mutoh@highway.ne.jp> wrote:
> >ところで、ChangeLogの方も書き直した方が良いのでしょうか?
>
> coreのChageLogですか? pluginの変更は最近はcoreには書いてません。
> かといって代わりはないんですが(^^; 小さいのは.rb内に書いちゃってるし。
> やっぱドキュメントが大きいのや、複数ファイルから成立してるpluginは、
> ディレクトリを掘った方がいいかも知れません。その方向でやっちゃって
> くれちゃっていいですよ >むとうさん
もしかして、たださんの意図からずれちゃうかもしれませんが、勝手に以下の
ようにさせていただきました。
plugin/doc/
index.html
search_form.html
yasqueeze.html
doc.css
/rd/
makeindex.rb
makehtml.rb
search_form.rd
yasqueeze.rd
makeindex.rbは各rdファイルからH1部分と「機能」段落の最初の空行までから
index.htmlを生成します。
makehtml.rbは各rdファイルからhtmlファイルを生成し、かつmakeindex.rbを
呼び出します。
ドキュメントですが、書き方を以下のようにしようかなと思います。
#www.tdiary.net/howto.rhtmlに倣っています。
この通りに書いてrdディレクトリに放り込み、makehtml.rbを実行すると自動的に
HTMLファイルが生成され、かつindex.htmlにも含まれます。
#RDToolが必要です。
----------ここから-------------------
=begin
= hoge.rb - ホゲホゲプラグイン ←タイトル index.htmlで読み込まれる
== 機能
機能概要 ← 一つ目の段落がindex.htmlに読み込まれる
: ←
: ←
: ← 2つ目の段落からはindex.htmlには読み込まれません。
:
== 使う場所
本文、ヘッダもしくはフッタ
== 利用方法
説明、パラメータの説明など(この辺は書きやすいように適宜)
--- method_name(foo, bar) ← メソッド名
説明、パラメータの説明など(この辺も書きやすいように適宜)
例: <%= method_name "foo", "bar" %>
== 表用例
((: <hogehoge> :)) ← ((:, :))はHTMLをそのまま展開しますが、改行を含むことはできません
== ライセンスについて
== メンテナ
== ChangeLog
:2002-03-29 MUTOH Masao <mutoh@highway.ne.jp>
* version 1.0.0
=end
----------ここまで-------------------
懸案・確認事項です。
1. そもそもこの形態で良いか?
2. HTMLはRDから生成されるものとするとCVSには入れない方が良いのではないか
3. CVSに入れるので$Id$とかを取りたいが、HTML, RDのどちらに入れた方が良いのか
コメントいただけるとありがたいです。
それから、もし1.でOKということであれば、他のプラグインについてもRD書きますけど、
どうでしょう?
> この辺が落ち着いたら1.4.1にしちゃいましょう。
ドキュメントを一緒にリリースするのは、懸案・確認事項がクリアになってからの方が良いと思います。
しかし、ドキュメントはしばらく私のホームページにも載せておきますので、必須ではない
と思います。
したがって、この方向で問題があるようでしたら、ドキュメントの整備の遅れと1.4.1のリリースは
リンクさせないでいただけると助かります。
それでは。
--
.:% Masao Mutoh<mutoh@highway.ne.jp>
|