PyukiWiki仕様書(仮)

"PyukiWiki" ver 0.2.1-beta1 $$
Copyright (C) 2005-2012 PukiWiki Developers Team
Copyright (C) 2004-2012 Nekyo (Based on PukiWiki, YukiWiki)
License: GPL version 3 or (at your option) any later version
and/or Artistic version 1 or later version.
Based on YukiWiki http://www.hyuki.com/yukiwiki/
and PukiWiki http://pukiwiki.sfjp.jp/
URL:
http://pyukiwiki.info/

MAIL:
ななみ <nanami (at) daiba (dot) cx> (注:バーチャル女の子です)

$Id: specification.html,v 1.1 2012/08/16 01:24:37 papu Exp $
This text file written UTF-8 Codeset

目次

注意

突然、何らかの理由で、仕様変更を行なうことがあります。
この説明書は、参考までで、内容を保障するものではありません。

CGI起動

CGIは、通常の index.cgi形式、及び、nph-index.cgi形式で起動されます。mod_perl環境で動作はしますが、あくまで互換環境での動作となります。

多くの環境変数が Apacheに依存していますが、一部のみIISで動作確認は行なわれています。

urlhack.inc.cgi Explugin は、PATH_INFO、または、404 ステータスの戻り値の、REDIRECT_URL を参照して、ページ名を決定します。PATH_INFOのが汎用性が高い分、制限がありますが、REDIRECT_URLのが、自由度が高く設定できます。

ディレクトリ構成

主な本体ファイル構成

主なperlモジュール構成

主なExplugin構成

主なプラグイン構成

執筆中

explugin仕様情報

初期化

有効になっているexpluginの強制読み込み

依存関係で、先に読み込む必要があるexpluginは、以下のようにして読み出すことができる。

&exec_explugin_sub("explugin name") ;

リソースの読み込み

&read_resource で読み込まれます。

プラグインと同じ名前のファイルであれば、指定しなくても自動読み込みをします。

JavaScript、CSSの読み込み

&jscss_include で読み込まれます。

プラグインと同じ名前のファイルであれば、指定しなくても自動読み込みをします。

初期化時の返り値(ハッシュ)

return('init'=>1, func=>'override1,override2',
  'jsheader'=>$javascript, 'lastfunc'=>'&lastcallback;');

プラグイン仕様情報

初期化

初期化することはできません。

リソースの読み込み

&read_resource で読み込まれます。

プラグインと同じ名前のファイルであれば、指定しなくても自動読み込みをします。

JavaScript、CSSの読み込み

&jscss_include で読み込まれます。

プラグインと同じ名前のファイルであれば、指定しなくても自動読み込みをします。

inlineメソッド

&plugin(...) ; で呼び出されます。

引数は、上記の ... の中身のテキストが入ります。

sub plugin_NAME_inline {
my @arg=split(/,/,shift);

戻り値は、文字列で、HTMLを返すことにより表示されます。

return $html;

convertメソッド

#plugin (...) で呼び出されます。

引数は、上記の ... の中身のテキストが入ります。

sub plugin_NAME_convert {
my @arg=split(/,/,shift);

戻り値は、文字列で、HTMLを返すことにより表示されます。

return $html;

actionメソッド

URLの cmd=pluginname で呼び出されます。

引数はありませんので、$::form から読み出す必要があります。

actionメソッドの返り値(ハッシュ)

内部変数仕様情報