海外格安航空券 海外旅行保険が無料！ FreeStyle WikiはPerlによる拡張可能なWikiクローンです。FreeStyle Wikiは以下のような特徴を持っています。
アーカイブを展開し、そのままのフォルダ構造でサーバにアップロードします（docsディレクトリは不要）。wiki.cgiはブラウザから起動されるスクリプトなのでパーミッションを実行可能にしておきます。また、アップロードしたディレクトリの直下にbackup、attach、pdf、logディレクトリを作成します。ディレクトリのうちdata、backup、attach、pdf、log、configディレクトリにはCGIから書き込みができるパーミッションに、また、data、configディレクトリ内のファイルもCGIから書き込み可能なようにパーミッションを変更してください。
全体の構成は以下のようになります（数字はパーミッションの一例です）。なお、サーバ上でシェルが利用可能な場合はインストールディレクトリの直下にあるsetup.shを実行することで必要なディレクトリの作成やパーミッションの設定をを自動的に行うことができます。
-+-/attach (添付ファイル) 707 | +-/pdf (PDFファイル) 707 | +-/tmpl (テンプレート) | +-/backup (バックアップファイル) 707 | +-/data (データファイル) 707 | | | +-*.wiki (デフォルトのデータファイル) 606 | +-/log (ログファイル) 707 | +-/config (設定ファイル) 707 | | | +-*.dat (デフォルトの設定ファイル) 606 | +-/theme (テーマ) | +-/plugin (プラグイン) | +-/lib (ライブラリ) | +-wiki.cgi (CGIスクリプト本体) 705 | +-setup.dat (設定ファイル)
設定が完了したらブラウザからwiki.cgiを呼び出してみてください。FrontPageが表示されればとりあえず設置は成功です。
データ保管場所などFreeStyle Wikiの基本的な設定はsetup.datを編集することで行います。
FreeStyle Wikiでは、ページが変更された場合に管理者にメールで通知する機能があります。この機能を有効にするにはsetup.datの設定内容にsendmailのパスかSMTPサーバのホスト名を設定します。
また、デフォルトではバックアップは一世代のみですが、backupというパラメータにバックアップする世代数を指定することができます。0を指定すると無制限にバックアップを行います。世代バックアップを行う場合、画面上部の「差分」メニューを選択すると過去の編集履歴が表示され、それぞれについて現在のソースとの差分を閲覧することができます。
また、rssやamazonなど、一部のプラグインはプログラム中からHTTPで外部のサーバに接続します。プロキシを使用している場合はproxy_host、proxy_port、proxy_user、proxy_passを設定しておく必要があります（proxy_userとproxy_passは認証が必要な場合のみ）。
上記で解説したインストール方法ではsetup.datや各種データを保存しているディレクトリをHTTPで参照できてしまいます。セキュリティ上問題になるようであれば.htaccessを使用してアクセス制限を行ってください。
<FilesMatch "\.(pm|dat|wiki|log)$"> deny from all </FilesMatch>
なお、データディレクトリに関してはHTTPでは見えない場所に配置することも可能です。その場合はsetup.datのディレクトリ指定部分を変更してください。
設置ディレクトリ直下にあるsetup.dat、dataディレクトリ、backupディレクトリ、pdfディレクトリ、logディレクトリ、configディレクトリ以外のファイルおよびディレクトリをいったん削除し、配布ファイルで置き換えてください。また、dataディレクトリ内のhelp.wikiはヘルプで表示されるページですのでこれも最新版のファイルで上書きしてください。
setup.datはできるだけバージョン間で相違のないよう配慮していますが、止むを得ずバージョンアップ時に内容を変更する必要がある場合があります。できれば最新のファイルで上書きしたあと、設定内容を修正するようにしてください。
また、3.4.0以降ではバージョンアップによって管理画面での設定項目が追加されている場合があります。一度管理ユーザにてログインし、設定の更新を行ってください。
dataディレクトリ、attachディレクトリ、configディレクトリをコピーしてください。差分表示が必要であればbackupディレクトリ、PDFも必要であればpdfディレクトリもコピーしてください（PDFファイルはPDFアンカ押下時に生成することができるのでバックアップしなくても構いません）。
ログは、デフォルトではlogディレクトリにaccess.log（アクセスログ）、freeze.log（凍結用のログ）、attach.log（添付ファイルのログ）が出力されていますので、必要に応じてこれらもコピーしておいてください。
Ver3.4.1よりmod_perlにも対応しています。wiki.cgiの先頭部分を編集し、chdirの引数にFSWikiのインストールディレクトリを指定してください。例えばFSWikiをC:/Apache/htdocs/fswikiに配置した場合は以下のようになります。
BEGIN {
if(exists $ENV{MOD_PERL}){
# カレントディレクトリの変更
use Cwd;
chdir("C:/Apache/htdocs/fswiki");
3.5.1以降はApache::Registory環境下でも完全に動作することを確認していますが、それ以前にバージョンでは差分表示やPDF生成など一部の機能の動作に支障がありますApache::PerlRun環境下であれば問題ありません。
プラグインはパッケージごとにディレクトリを作成し、pluginディレクトリに配置します。プラグインを有効にするには管理画面から「プラグインの設定」で該当するプラグインにチェックを入れます。
プラグインを開発する場合、パッケージごとにまとめてパッケージ名::Installというモジュールを作成し、そのモジュール内でインストール処理を行うようにします。
package plugin::test::Install;
sub install {
my $wiki = shift;
$wiki->add_inline_plugin("hello","plugin::test::TestPlugin");
}
有効になっているパッケージは自動的ににplugin::test::Installモジュールのinstallメソッドが呼び出され、プラグインのインストールが行われます。
アクションハンドラプラグインはactionというリクエストパラメータによってクライアントへのレスポンスを行うプラグインです。アクションハンドラプラグインはdo_actionメソッドを実装したクラスでなくてはなりません。また、戻り値として、表示する内容（HTML）を返すようにします。
sub do_action {
my $self = shift;
my $wiki = shift;
return "アクションハンドラプラグインからの出力";
}
アクションハンドラの登録はインストールスクリプト中でWiki#add_handlerメソッドによって行います。
$wiki->add_handler("EDIT","plugin::core::EditPage");
管理者のみ使用可能なアクションハンドラはWiki#add_admin_handlerメソッドによって登録します。このメソッドによって登録されたアクションハンドラは管理者としてログインしている場合のみ実行可能になり、それ以外の場合はエラーメッセージを表示します。
$wiki->add_admin_handler("ADMINPAGE","plugin::admin::AdminPageHandler");
フックプラグインはある契機で特定のメソッドを実行するプラグインです。メニューのON/OFF切り替えや、ページ保存時などのタイミングで特殊な処理を行う場合に使用します。フックプラグインはhookメソッドを実装したクラスでなくてはなりません。
hookメソッドの第３引数には起動されたフックの名前が渡されます。１つのクラスで複数の処理を実装する場合はこの変数を見て処理を分けます。また、第４引数以降にはWiki#do_hookメソッド呼び出し時に指定されたパラメータ（呼び出し側に依存）が渡されます。独自にフックを定義してパラメータを渡したい場合に使用してください。
sub hook {
my $self = shift;
my $wiki = shift;
my $name = shift;
my @params = @_;
...
}
フックプラグインの登録はインストールスクリプト中でWiki#add_hookメソッドによって行います。
$wiki->add_hook("show","plugin::core::BBS");
フックには以下ものが存在します。
また、これ以外にプラグインによっては独自にフックを定義している場合があります。
インラインプラグインはWiki文書中にプラグイン名プラグインは存在しません。で埋め込むことで、特殊な出力を行うプラグインです。インラインプラグインはinlineメソッドを実装したクラスでなくてはなりません。戻り値としてWiki形式の文字列またはHTMLを返すようにします。Wiki形式のテキストを返す場合はPDFにも出力が反映されます。
以下にHTMLを返すプラグインの例を示します。
sub inline {
my $self = shift;
my $wiki = shift;
return "<B>簡単なプラグインです。</B>";
}
以下はWiki形式のテキストを返すプラグインの例です。
sub inline {
my $self = shift;
my $wiki = shift;
my $parser = shift;
return "[[FrontPage]]";
}
インラインプラグインの登録はインストールスクリプト中でWiki#add_inline_pluginメソッドによって行います。第一引数には実際にWikiページを記述する際にプラグインを指定するための文字列、第二引数にはプラグインのクラス名、第三引数にはそのプラグインの返す文字列に応じてHTMLまたはWIKIを指定します。
$wiki->add_inline_plugin("edit","plugin::core::Edit","HTML");
パラグラフプラグインはWiki文書中にプラグイン名プラグインは存在しません。で埋め込むことで、特殊な出力を行うプラグインです。インラインプラグインと違って１行にプラグインしか記述できず、Pタグの補完も行われません。テーブルやフォーム、リストなどを出力するプラグインをパラグラフプラグインとして実装します。パラグラフプラグインはparagraphメソッドを実装したクラスでなくてはなりません。
paragraphメソッドは実装方法自体はインラインプラグインと同様です。以下にHTMLを返す場合の例を示します。Pタグは補完されないので必要に応じてプラグイン側でつけてやる必要があります。
sub paragraph {
my $self = shift;
my $wiki = shift;
return "<p>パラグラフプラグインです。</p>";
}
以下はWiki形式の文字列を返す場合の例です。
sub paragraph {
my $self = shift;
my $wiki = shift;
return "*[[FrontPage]]\n*[[Help]]\n";
}
パラグラフプラグインの登録はインストールスクリプト中でWiki#add_paragraph_pluginメソッドによって行います。第一引数には実際にWikiページを記述する際にプラグインを指定するための文字列、第二引数にはプラグインのクラス名、第三引数にはそのプラグインの返す文字列に応じてHTMLまたはWIKIを指定します。
$wiki->add_paragraph_plugin("bbs","plugin::bbs::BBS","HTML");
ブロックプラグインは複数行の引数を取ることができるパラグラフプラグインです。以下のようにして使用します。引数3の部分は複数行に渡って記述することができます。
{{プラグイン名 引数1,引数2,
引数3
}}
ブロックプラグインではparagraph()メソッドの代わりにblock()メソッドを実装します。複数行の引数が第一引数として、それ以外の引数は第二引数以降に渡されてきます。
sub block {
my $self = shift;
my $wiki = shift;
my $text = shift;
return "<p>".Util::escapeHTML($text)."</p>";
}
パラグラフプラグインの登録はインストールスクリプト中でWiki#add_block_pluginメソッドによって行います。第一引数には実際にWikiページを記述する際にプラグインを指定するための文字列、第二引数にはプラグインのクラス名、第三引数にはそのプラグインの返す文字列に応じてHTMLまたはWIKIを指定します。
$wiki->add_block_plugin("pre","plugin::core::PRE","HTML");
エディットフォームプラグインはページの編集画面に表示されるプラグインです。エディットフォームプラグインはeditformメソッドを実装したクラスでなくてはなりません。editformメソッドは編集画面に表示するHTMLを返却するよう実装します。
エディットフォームプラグインの登録はインストールスクリプト中でWiki#$wiki->add_editform_pluginメソッドによって行います。
$wiki->add_editform_plugin("plugin::core::EditHelper",0);
第３引数にはそのプラグインの表示優先度を指定します。この値が大きいほど上位に表示されます。
フォーマットプラグインはFSWiki以外のWikiの書式での編集を行なうためのプラグインです。フォーマットプラグインは以下のメソッドを実装していなくてはいけません。
フォーマットプラグインはインストールスクリプト中で以下のようにして登録を行ないます。
$wiki->add_format_plugin("Hiki","plugin::format::HikiFormat");
Wikiオブジェクトのadd_menuメソッドで画面上部のメニューアイテムを追加することができます。
$wiki->add_menu(名称,URL,優先度);
第３引数にはそのプラグインの表示優先度を指定します。この値が大きいほど左側に表示されます。また、URLを省略するか、空文字列を設定すると無効なメニューが登録されます。既に同じ名前のアイテムが登録されていた場合は上書きされます。
Wikiオブジェクトのadd_admin_menuメソッドで管理者ログイン時のメニューを追加することができます。このメニューが表示されるのは管理者がログインした場合のみです。一般ユーザがログインしても表示されません。また、管理者メニューから呼び出されるアクションハンドラはadd_admin_handlerで登録しておくとログインチェック、権限チェックが自動化されます。
$wiki->add_admin_menu(名称,URL);
FreeStyle Wikiでは以下のライブラリを使用しています。これらについての著作権は原作者が持ちます。有用なライブラリを無償で提供してくださっている作者の皆様に感謝します。
FreeStyle WikiはGNU GPLライセンスの元で配布、改変が可能です。FreeStyle Wikiに組み込むプラグインを公開される方はGPLコンパチのライセンスを推奨しますが、その他のライセンスを宣言されても構いません。また、パッチに関しては本体および標準添付のプラグインにあてるものはGPL、プラグインにあてるものはプラグインのライセンスにしたがうものとします。
Copyright 2002 - 2007 Naoki Takezoe <takezoe@aa.bb-east.ne.jp>
無料ホームページ 楽天モバイル[UNLIMITが今なら1円] 海外格安航空券 海外旅行保険が無料！