============================================================================== 拡張スクリプト仕様書 ============================================================================== 最終更新日:2003-01-14 14:05 ■概要 外部スクリプトをインプリメントさせることにより,柔軟な掲示板構築を可能 にします. ■ファイル構成 cgi/ | +-- pl/ | +-- *.pl ただし,pl ディレクトリは config.pl の $pl_dir で決められています. ■変数定義 ・$main::PLUGIN_NAME{'FILENAME'} = 'プラグイン名'; 主にシステムインフォメーションで使用されます. 必ず定義してください. FILENAME: プラグインのファイル名 'プラグイン名': システムインフォメーションなどで表示させるプラ グインの名前(変数展開可能) パッケージ定義をしているプラグインもあると思いますので,必ずパ ッケージ名を付けて変数定義をしてください. ・$main::PLUGIN_REV{'FILENAME'} = 'プラグインリビジョン番号'; プラグインのリビジョン表示などに使用します. 定義必須ではありません. FILENAME: プラグインのファイル名 'プラグインリビジョン番号': プラグインのリビジョン番号.ここに 記述されている文字列がそのまま表示されます.「Rev-」等の文字補 完は行われません. ■制限 ・なるだけ package 宣言をして,名前空間を独立させてください. ・初めから定義されている変数は変更,破壊をしないで下さい. ■資源の有効利用 拡張スクリプト制作者は,Gloriosa が標準でサポートしている外部スクリプ トなどの全ての変数,サブルーチンなどが使用できます. (すくなくとも gwbbs.pl 及び gwbbs.cgi 内部で使用している変数及びサブル ーチンは自由に使用できます) 共通サブルーチンは gwbbs.pl に全てパッケージングされていますので, 「Gloriosa 共通コード」仕様書を参考に,共通サブルーチンを使用すること が可能です. また,config.pl などに記述されている変数も再利用できますので,ご自由に 使っていただいてかまいません. ただし,それらの変数は読み込み専用として扱ってください. 定義されている変数を変更・破壊することは許されません. ■呼び出し方法 プラグインを呼び出す場合は,かならずインプリメントフラグを参照してイン プリメントしてください. コレを行わないと,プラグインが存在しなかったときにエラーになります. 書式は以下の通りです. 書式: if ($PLUGIN_FLAG{FILENAME}) { &plugin_packages::subroutin; } プラグインのインプリメントが成功している場合は,$PLUGIN_FLAG{} は 1 を 保持しています. インプリメントが何らかの要員で失敗した場合は 0 を保持しています. 上記書式は,「1ならばサブルーチンに飛ぶ」という風にしてあります. FILENAME: プラグインのファイル名