Geeklog汎用プラグインツールキット

汎用プラグインツールキットは,GeeklogのプラグインAPI要件を満たし,独自のプラグインをさっと書くためのファイルを提供します。自分の書いたコードとGeeklogとのインターフェースを構築するのに必要な全てのファイルで構成されています。同梱されているのは,

同梱されているファイル:

汎用プラグインツールキットの使用法

ファイルを適切なディレクトリにコピーした後で最初にすべきことは,プラグインの名前を決め,テキストエディタなどを使って,

  1. 文字列 {plugin} をプラグイン名に
  2. 文字列 {conf_var_prefix} をプラグインの設定値を保持する変数の接頭辞に
  3. 文字列 {lang_var_postfix} を言語ファイルで使用する変数の接尾辞に
  4. 文字列 {display_name} を表示名に

置換することです。対象ファイルは,

です。

なお,配布物の中には,mystral-kk氏が開発した make_pi.php というPHPスクリプトが同梱されています。このスクリプトは,上述の置換を行ってくれますので,どうぞご利用ください。

例えば、upkit という名前のプラグインを作成し、
文字列 {plugin} を upkit に
文字列 {conf_var_prefix} を UPKに
文字列 {lang_var_postfix} を UPK に
文字列 {display_name} を UPKit に
したい場合は、パラメータを次のように指定してスクリプトを実行します。

php.exe -f make_pi upkit UPK UPK UPKit

注意: gl_vars テーブルを使用するので,プラグイン名は15文字以下にしてください。

次に,config.php をエディタで開き,作成するテーブル名を $_TABLES配列に追加します。ファイルの中のサンプルを参考にして,テーブル名を追加・削除してください。プラグインのバージョンも設定してください。

次に,spl/mysql_install.php を開き,作成するテーブルの構造を設定します。$_SQL配列に,ファイルの中のサンプルを参考にして,SQL文を追加・削除してください。(spl/mssql_install.phpも同様に。)

次に,admin/install.phpを開き,Geeklogのバージョン,プラグイン制作者のURLを設定してください。
さらに,同ファイル内の4つの配列に値を設定します。
1番目の配列($GROUPS)には,セキュリティグループが入っています。
2番目の配列($FEATURES)には,セキュリティ項目(security features)が入っています。
3番目の配列($MAPPINGS)では,セキュリティ項目とセキュリティグループの関連づけを設定しています。
4番目の配列($DEFVALUES)には,テーブルにサンプルないしデフォルトのデータを追加するためのSQL文が入っています。

最後に,functions.inc を開き,プラグインをアンインストールできるよう,アンインストール関数(plugin_uninstall_{plugin})にテーブルとセキュリティ項目を追加します。

この時点で動作するプラグインの骨格ができているはずです。インストールすれば,Geeklogに表示されるでしょう。さあ,コードを書いて,Geeklogのコミュニティと共有しましょう。

プラグインが動作するようになったら,プラグインのルートディレクトリにあるINSTALLドキュメント(とINSTALL_ja)とinstall.html(とinstall_ja.html)を編集するとよいでしょう。

ここまで述べてきたことにピンと来なければ,Links や Polls などの標準的なプラグインを調べてみてください。