PyukiWiki仕様書(仮)

"PyukiWiki" ver 0.2.1-beta2-dev1 $$
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.33 2012/09/05 23:45:25 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メソッドの返り値(ハッシュ)

内部変数仕様情報

JavaScript関数仕様一覧

common.???.jsにある関数一覧です。

ua

入力
(ブラウザー名)
出力
true、false

使用中のブラウザーの種類を返します。
以下のオプションが選択できます。

MSIE、FIREFOX、GECKO、CHROME、SAFARI、WINDOWS、MACOS、VERSION、MAGERVERSION

ln

入力
(langname),(string),(langname),(string)...
出力
string

言語セレクターです。
langnameは、en、ja、stringは、対応する言語の出力する文字列です。

sins

入力
エレメントオブジェクト, HTML
出力
なし

エレメントオブジェクトにinnerhtmlをします。

sinss

入力
エレメントオブジェクトの文字列, HTML
出力
なし

エレメントオブジェクトの文字列にinnerhtmlをします。

gid

入力
エレメントオブジェクトの文字列
出力
エレメントオブジェクト

エレメントオブジェクトを返します。(getElementById)

ou

入力
URL,target
出力
なし

window.openをします。targetの文字列を"b"とすると、"_blank" に入れ替わります。

keyCode

入力
イベント
出力
キーコード

入力されたキーボードのコードを返します。

getClientWidth

入力
なし
出力
ウィンドウの幅

ブラウザーの幅を返します。

getClientHeight

入力
なし
出力
ウィンドウの高さ

ブラウザーの高さを返します。

getDocHeight

入力
なし
出力
ドキュメントの高さ

表示されているページの高さを返します。

getScrollY

入力
なし
出力
現在位置

表示されている位置を返します。

ar

入力
なし
出力
new Arrayの返り値
new Array を行ないます。

defined

入力
オブジェクト、変数
出力
true, false
指定したオブジェクト、または変数が存在するか確認します。

http

入力
メソッド, URL, POSTするデータ, 正常時のコールバック関数, 異常時のコールバック関数
出力
なし

http非同期クライアントです。コールバック関数は、以下の通りの引数です。

okfunc

入力
HTTPステータス, レスポンステキスト
出力
なし

errfunc

入力
HTTPステータス, レスポンステキスト
出力
なし

httpreq

入力
なし
出力
http object
ブラウザーのhttpクライアントオブジェクトを返します

ev.add

入力
イベント名, 実行する関数(文字列), 実行する関数のパラメータ
出力
なし

イベントハンドラーです。対応しているイベントは以下の通り

ev.del

入力
イベント名, 実行する関数(文字列)
出力
なし

イベントを削除します

ev.ex

入力
イベント名
出力
なし

イベントを強制実行します。

debug

入力
メッセージ
出力
なし

デバッグログをtextareaフォーム、及び、console.logに出力します。