Preparing your Geeklog Plugin Distribut
提供: GeeklogJpWiki
［６］開発者用ドキュメント > プラグイン開発 > 作成したGeeklogプラグインを配布する準備
作成したGeeklogプラグインを配布する準備
プラグインのtar形式の圧縮ファイル
全てのGeeklogプラグイン圧縮ファイルは次の命名規則に従わなければなりません。
<プラグイン名>_<プラグインのバージョン>_<Geeklogのバージョン>.tar.gz <plugin name>_<plugin version>_<geeklog version>.tar.gz
説明
<プラグイン名>:
プラグイン名は次のような名前の制約を課しますので、プラグイン用に選ぶ値としては一番重要になります。
- Geeklogがプラグインを呼び出す時のAPI関数の名前はこれと同一
- サイトのディレクトリでプラグインプログラムを置くディレクトリの名前はこれと同一
- サイトのadminディレクトリで管理者用プログラムを置くディレクトリの名前はこれと同一
- モデレーションを使用する場合、モデレート対象となる主テーブルの名前はこれと同一
- モデレーションを使用する場合、投稿テーブルの名前は<plugin name>submission
<プラグイン バージョン>:
プラグインのインストール中にプラグインの更新をしようとしているのか新規インストールをしようとしているのかを決定するのに用います。新しいバージョンのプラグインが既にインストールされているのに旧バージョンをインストールしようとしていないかもチェックします。
<geeklog バージョン>: プラグインが動作しているGeeklogのバージョン
圧縮ファイルの構成も同様に標準化されます。各ディレクトリとファイルを説明します。圧縮ファイルを作成する時のプラグイン全体のディレクトリ名は<plugin name>でなければなりません。そのディレクトリ下には以下のものを置きます。
config.php:
プラグインの設定に関するファイルです。このファイルはいつでも呼び出すことができます。
functions.inc:
このファイルにGeeklogのAPIを実装し、プラグインの実際のプログラムもここにあります。このファイルはこの名前でなければなりません。lib-common.phpの最後で，有効にされた全てのプラグインのfunciton.incファイルを読み込むからです。そのためプラグインのプログラムはlib-common.phpにある全ての関数にアクセスできる点に注目してください。
lang.php と language/ ディレクトリ:
プラグイン用の言語ファイルです。このファイルをfuncitons.inc内で読み込む必要があります。 languageディレクトリを使って，サポートする各言語用の言語ファイル（english.phpなど）を用意することを推奨します。 Geeklog本体の振る舞いにならい，ユーザが選択した言語に基づいて言語ファイルを選択します（選択した言語用の言語ファイルがなければ，english.phpが選択されます）。
README
- ソフトウェアの通常のREADMEファイルです。
/docs:
- 履歴やTODOなどプラグインに添付したい文書を含みます。
/admin:
- 管理ページのみを含みます。
/public_html:
- 通常のWebページを含みます。
/updates:
- 更新のための全てのSQLとスクリプトを含みます。
