FSWikiLite/readme

FSWikiLiteとは？

FSWikiLiteの元になっているFreeStyleWikiはPerlによるmodulableなWikiクローンです。プラグインによって様々な機能を追加することができます。ただし、高機能な分、通常のCGIスクリプトと比較すると動作が重いという欠点がありました。

FSWikiLiteはFSWikiほど高機能ではありませんが、機能を限定することで軽快に動作します。プラグインは一部しか使用できませんが、文法はFSWikiと完全互換です。また、FSWikiと比べると構造がシンプルな分、設置も容易です。

その他にFSWikiLiteは以下のような特徴があります。

• tDiaryのテーマを使用可能。
• サイドバーやヘッダ、フッタを表示可能。
• FSWikiとは異なるシンプルなプラグイン機構を備えている。
• .htaccessを使用することで編集を管理人のみに限定することが可能。
• ページのカテゴライズが可能。
• ファイルの添付が可能。
• PDF生成、キーワードリンク、InterWikiなどは使用不可。

インストール

lib/setup.plを編集し、各自の設定を行います。

• $DATA_DIR - データファイルの格納場所。
• $BACKUP_DIR - バックアップファイルの格納場所。
• $ATTACH_DIR - 添付ファイルの格納場所。
• $THEME_URL - テーマ（CSS）の場所。
• $SEND_MAIL - sendmailのパス。更新通知を受け取る場合は設定してください。
• $ADMIN_MAIL- 管理者のメールアドレス。更新通知を受け取る場合は設定してください。
• $WIKI_NAME - WikiNameを使用する場合は1、使用しない場合は0を指定してください。
• $BR_MODE - 改行箇所でBRタグを出力したい場合は1、BRタグを出力したくない場合は0を指定してください。
• $DISPLAY_IMAGE - 画像のURLをIMGタグで表示する場合は1、通常のリンクとして表示する場合は0を指定してください。
• $MAIN_SCRIPT - メインスクリプトのファイル名。変更しなくてもいいです。
• $EDIT_SCRIPT - 編集用スクリプトのファイル名。変更しなくてもいいです。
• $DOWNLOAD_SCRIPT - 添付ファイルのダウンロード用スクリプトのファイル名。変更しなくてもいいです。
• $CATEGORY_SCRIPT - カテゴリ表示用スクリプトのファイル名。変更しなくてもいいです。
• $SITE_TITLE - サイト名。自由に変更してください。
• $VERSION - FSWikiLiteのバージョン。変更しなくてもいいです。
• $SITE_URL - FSWiki公式サイトのURL。変更しなくてもいいです。

FTPなどで以下のようにファイルを配置します（デフォルトの設定の場合）。

-+- wiki.cgi
 |
 +- edit.cgi
 |
 +- category.cgi
 |
 +- download.cgi
 |
 +- /lib （ライブラリを配置します）
 |   |
 |   +- jcode.pl
 |   |
 |   +- cgi-lib.pl
 |   |
 |   +- setup.pl
 |   |
 |   +- common.pl
 |   |
 |   +- mimew.pl
 |
 +- /plugin （プラグインを配置します）
 |   |
 |   +- core.pl
 |
 +- /data （ページデータが出力されます）
 |
 +- /backup （バックアップファイルが出力されます）
 |
 +- /attach（添付ファイルが出力されます）
 |
 +-/theme （テーマを配置します）
    |
    +- /default
        |
        +- default.css

wiki.cgi、edit.cgi、category.cgi、download.cgiのパーミッションをCGIとして実行可能なように設定します。また、dataディレクトリ、backupディレクトリ、attachディレクトリはCGIから書き込み可能なパーミッションに設定します。なお、ディレクトリ構成に関してはsetup.plを編集することで任意の構造に変更することができます。

テーマに関しては現在のFSWikiLiteの配布アーカイブには同梱されていません。FSWikiのディストリビューションや、tDiaryのWebサイトよりお好みのテーマを取得してください。

編集を管理者に限定する

.htaccessを使ってedit.cgiにアクセス制限をかけます。詳細についてはそのうち。

使用可能なプラグイン

 category

ページをカテゴライズするためのプラグインです。引数にカテゴリ名を指定します。

{{category カテゴリ名}}

 category_list

カテゴリごとのページ一覧を表示します。

{{category_list}}

引数として表示するカテゴリを指定することもできます。

{{category_list カテゴリ名}}

 lastmodified

ページの最終更新日時を表示します。

{{lastmodified}}

引数でページ名を指定すると指定したページの最終更新日時を表示します。

{{lastmodified ページ名}}

 outline

ページのアウトラインを表示します。見出しがツリー形式で表示され、クリックするとその見出しにジャンプします。Headerなどに入れておくと便利です。

{{outline}}

引数でページ名を指定すると指定したページを対象とします。

{{outline ページ名}}

 pre

preタグを出力するブロックプラグインです。

{{pre
ここにテキストを書く
}}

引数に"num"を指定すると行番号付きになります。

{{pre num
ここにテキストを書く
}}

 raw

引数で指定した文字列をそのまま表示します。

{{raw テキスト}}

 recent

更新日時順にページ名の一覧を出力します。引数で表示件数を指定できます。引数に"v"を指定すると縦に表示します。表示件数を省略すると全件出力します。

{{recent 10}}
{{recent 10,v}}

 recentdays

日付ごとに更新されたページを一覧表示します。引数で表示日数を指定できます。表示日数を省略すると最新の５日分を出力します。

{{recentdays 10}}

 ref

添付ファイルへのリンクを出力するプラグインです。

{{ref ファイル名}}

別のページに添付されたファイルを参照することもできます。

{{ref ファイル名,ページ名}}

通常はアンカとしてファイル名が表示されますが、 別名として任意の文字列を表示することもできます。

{{ref ファイル名,ページ名,別名}}

 ref_image

添付ファイルを画像として表示するプラグインです。

{{ref_image ファイル名}}

オプションで画像のサイズを指定することができます。 以下の例では幅650ピクセル、高さ400ピクセルで画像を表示します。

{{ref_image ファイル名,w650,h400}}

別のページに添付されたファイルを参照することもできます。

{{ref_image ファイル名,ページ名}}

 ref_text

添付ファイルを整形済テキストとして表示するプラグインです。

{{ref_text ファイル名}}

別のページに添付されたファイルを参照することもできます。

{{ref_text ファイル名,ページ名}}

 search

検索フォームを表示します。

{{search}}

引数に"v"を指定すると縦に表示します。サイドバーなどに入れておくと便利です。

{{search v}}

ライセンス

FSWikiLiteはGNUL GPLライセンスに基づいて改変、再配布が可能です。

作成者

Copyright (C) 2002 Naoki Takezoe, FreeStyleWiki Development Team.