名前¶

CGI::Kwiki - トリッキーすぎないお手軽なWiki。

概要¶

    > mkdir cgi-bin/my-kwiki
    > cd cgi-bin/my-kwiki
    > kwiki-install

    Kwiki software installed! Point your browser at this location.

KWIKI スタート¶

Kwikiのオフィシャルホームページは http://www.kwiki.org です。このサイト自身がKwikiです。ここには配布されているドキュメントよりもずっと多くのKwikiについての情報があります。

詳細¶

Wikiはユーザーにページの追加と、全ての既存ページの編集を許すWebサイトです。これはWebコラボレーションのもっともポピュラーな形態の一つです。もしWikiが初めてであれば、最古のWikiであり、Wikiがどのように働くのかについての多くの情報をもつ http://c2.com/cgi/wiki?WelcomeVisitors を訪ねて下さい。

世界には何ダースものWikiの実装があり、その多くがPerlでかかれています。多くのPerlハックは共通であるのに、モジュールは少なく、CPANにもリリースされて来ませんでした。その有名な例外はCGI::Wikiです。これは拡張性のある、活発にメンテナンスが行なわれているwikiフレームワークです。

もう一つの例外がこのモジュール、CGI::Kwikiです。CGI::Kwikiはシンプルさと拡張性にフォーカスしています。新しいkwiki Webサイトの作成は1コマンドでできます。このモジュールはPerlとともにインストールされるもの以外の前提モジュールはありません。これはバックエンドにデータベースを必要としませんが、データベースを使うこともできます。デフォルトのkwikiの動作は、HTMLテーブルのサポートを含むフル機能です。Kwikiの動作は大きなトラブルを起こすことなしに、カスタマイズ可能です。

特殊な機能¶

CGI::Kwikiには大半のWiki実装には見られない装飾的なaddonが同梱されています。これらはデフォルトのKwikiのまったくシンプルなインターフェースに干渉しないことを約束します。

どんなホットな機能が追加されたかを、時々 http://www.kwiki.org/index.cgi?KwikiFeatures でチェックしてください。

Kwikiスライドショウ¶

まるでPowerPointのようなスライドショウを、一つのkwikiページで作成できます。スライドやその他の改良にはJavaScriptマジックが使われています。サンプルページであるKwikiSlideShowをご覧下さい。

拡張¶

CGI::Kwikiは完全にオブジェクト指向です。各クラスモジュールのサブクラスを作り、その一つないし複数のメソッドを上書きすることで、その最終的な動作を簡単に変更することができます。これらは一般にたった数行のPerl コードで実行されています。

これを説明する最良の方法は例示でしょう。configファイルから始めましょう。デフォルトのconfigファイルはconfig.yamlと呼ばれます。これは次のような行を含んでいます:

    config_class:      CGI::Kwiki::Config
    driver_class:      CGI::Kwiki::Driver
    cgi_class:         CGI::Kwiki::CGI
    cookie_class:      CGI::Kwiki::Cookie
    database_class:    CGI::Kwiki::Database
    metadata_class:    CGI::Kwiki::Metadata
    display_class:     CGI::Kwiki::Display
    edit_class:        CGI::Kwiki::Edit
    formatter_class:   CGI::Kwiki::Formatter
    template_class:    CGI::Kwiki::Template
    search_class:      CGI::Kwiki::Search
    changes_class:     CGI::Kwiki::Changes
    prefs_class:       CGI::Kwiki::Prefs
    pages_class:       CGI::Kwiki::Pages
    slides_class:      CGI::Kwiki::Slides
    javascript_class:  CGI::Kwiki::Javascript
    style_class:       CGI::Kwiki::Style
    scripts_class:     CGI::Kwiki::Scripts

これらはkwikiを作り上げる全てのクラスのリストです。このいずれかを、あなたの独自のクラスに変更することができます。

BOLDの指定方法を*bold*から'''bold'''に変更したいのだとしましょう。その時は、Formatterクラスのbold()メソッドを上書きするだけです。config.yamlの変更から始めましょう。

    formatter_class: MyKwikiFormatter

次に、MyKwikiFormatter.pmと呼ばれるモジュールを書きます。このモジュールを正しいkwikiのインストールディレクトリに置きたいと思えば、そうして構いません。このモジュールは、このようなものになるでしょう:

    package MyKwikiFormatter;
    use base 'CGI::Kwiki::Formatter';

    sub bold {
        my ($self, $text) = @_;
        $text =~ s!'''(.*?)'''!<b>$1</b>!g;
        return $text;
    }

    1;

どう、たいして難しくないでしょ？データベースストレージから検索エンジン、メインドライバーコードまでCGI::Kwikiのあらゆる面をこのように変更することができます。もしクラスのセットを世界中で共有したくなったら、ディストリビューションとしてパッケージ化し、CPANに置くだけです。

ところで、設定ファイルのフォーマットをデフォルトのYAMLから変更することもできます。もしXMLを使いたい、というのであれば、 CGI::Kwiki::Config_xmlというモジュールを書き、config.xmlを呼ぶだけです。

作者¶

Brian Ingerson <INGY@cpan.org>

コピーライト¶

このプラグラムはフリーソフトウェアです; Perl自身と同じ条件下で再配布や編集を行なうことができます。

http://www.perl.com/perl/misc/Artistic.html 参照

名前¶

概要¶

KWIKI スタート¶

詳細¶

特殊な機能¶

Kwikiスライドショウ¶

拡張¶

SEE ALSO¶

作者¶

コピーライト¶