[Fswiki-dev] Re: FSWiki 4.0 のコードベース

Back to archive index

Naoki Takezoe takez****@gmail*****
2005年 11月 2日 (水) 18:58:57 JST


竹添です。

05/11/02 に あき<attin****@kk*****> さんは書きました:
> あきです。
>
> > Wiki.pmやWiki::xxxモジュール、Util.pmに関してAPIドキュメントを提供して
> > いますし、プラグインのIFについてもドキュメントはあります。
> > # これらはディストリビューションに含まれています。
> >
> > ただ、量的に十分かと言われると弱いとは思います。。。
>
> 一応書かれてはいるのですが、具体的にどういった使い方をするのか、という
> のがイメージしにくいんじゃないでしょうか?
> 言われてみて探してみたら、「ああ、確かに有ったね」みたいな。(少なくとも
> 私はそうでした)
> おそらくザッと見ただけでは「う〜ん、何だかいろいろ有るようだけど、よく
> 分からないなぁ。ま、いいか、とりあえず自分で適当なところ改造しちゃおう」
> きっとそういった部分が多分に有るのだと思います。
> 例えば、「Wiki変換ルールを改造したいな」って思った場合、きっと誰もがまず
> 目に付くのは、Parser.pmだと思います。これをformatプラグインの方に向かせ
> るには、逆引きリファレンスなんかを提供してやる必要があるんじゃないかと
> 思います。
> そしてこの時に忘れてはならないのはサンプルソースです。特に実用的な例で
> ある必要もなく、お遊び程度のもので十分だと思います。コピペだけで即動作が
> 確認できるものであれば申し分ないです。
> と、これが、私が思うところの『ガイドライン』というものです。

開発者向けのドキュメントが弱いという点は認識してます。
APIリファレンスも正直最低限、形だけ整えました、というレベルのものですし。
まあ、幸いFSWikiはスクリプト言語による実装なので既存のプラグインのソースを
簡単に見ることができる、という部分に助けられている部分も大きいかなと感じて
います。できるだけ充実させたいところですね。

# その前にユーザ向けのドキュメントも、もう少し充実させたいところですが…

この点に関しては問題意識はあっていると思います。

> > > そして理想を言うならば、せっかくオブジェクト指向で書いているのです
> > > から、機能の実装部とI/Fを切り分けて、プラグインの互換性が確保しやすい
> > > フレームワークがあると良いと思います。
> > > (オブジェクト指向の価値はそこにあるはずです。)
> > > 但し、その理想を実現するには、論理構造の見直しが必要かも知れません。
> >
> > 繰り返しになりますが、後方互換性に関しては3.5系に関して言えば、
> > これまでもかなり重要視していました。バージョンアップしたら動かなく
> > なったプラグインって今までに問題になるほど多かったでしょうか。
>
> 確かに、「バージョンアップで動かなくなった」というプラグインは、そう多く
> はないと思います。これに関しては、私も書き方を誤ったかもしれません。
> 深刻な問題となるのは、パッチ形式のプラグインが多いことです。

// 中略

> 本家側が、積極的にこれらパッチを取り込む努力を惜しまないか、又はパッチの
> 入る部分がどういった部分に集中しているか分析をして、そういった機能を極力
> 外に追いやるかしないと、こういった現状は改善されないままとなると思います。

なるほど〜、パッチ形式のプラグインというのは(パッチをあてる時点でもはやプラ
グインではないような気もしますが)考えていませんでした。とりあえず納得です。

ただ、パッチで実現されていたけど、必要だと感じたものについては単にパッチを
取り込むだけでなく、整理したうえで新たなAPIやモジュールを追加してきました。
ファームやフォーマットプラグインなどはその代表的なものです。今、取り込んで
いないものについてはあまり必要性を感じてないからなのですが、なかには見落と
しているものもあったかもしれません。

> 具体的にどういった部分か、と聞かれると、私も回答に戸惑うところがあるので
> すが、そうですね、基本的には入出力等、インターフェイス部分については外に
> 押しやってプラグイン側で処理させた方がいいと思います。
> 一例を挙げると、テンプレートを扱う部分でしょうか?
> テンプレートを使ってどのように出力するか、は、wiki.cgiが管理すべきでない
> と思います。
> 「ヘッダに何を出力するか?」とか、「タイトルはどのように付けるか?」は、
> 個人の好みが出る部分だと思われますので、こういった部分は自由に変更できる
> 仕組みにしておくことが望ましいと思います。

テンプレートの話はとりあえず置いておくとして、この部分の結論としては、
「(多くの人がカスタマイズしたいと思っているけど)プラグインでは実現できない
場合がある」ということが問題、ということでよろしいでしょうか。

だとすると、上であきさんがテンプレートについて意見を出していただいていますが、
それと同様に、現状のどこに問題があるか?という具体的な話になると思います。
パッチやサポート掲示板、雑談掲示板など私がすべて見きれていない部分もあり
ますので、そういったご意見は随時出していただければと思います。

# テンプレートについてはKGさんのパッチもありましたし少し考えさせてください。
# 必要であれば別スレッドで議論しましょう。

--
Naoki Takezoe <takez****@gmail*****>



Fswiki-dev メーリングリストの案内
Back to archive index