"imgr" Plugin - へっぽこPukiWikiプラグイン by takayan

"imgr"プラグインについて。

　PukiWiki添付の"ref"プラグインでは、イメージはattachプラグインで所定のサブディレクトリにアップロードするか、またはそのアドレスをフルパス指定（すなわち、http://やhttps://ではじまるURL）で指定しなければなりません（マニュアルには明記されていませんが、実はできます）。しかし、これではオフラインのとき、ローカルのバックアップでは何も表示できないですし、そうでなくてもせっかく自分のサーバーに持ってきた画像くらい相対パスで簡単に指定したい、と思う方もいらっしゃると思います。
　そこで、この"imgr"プラグインの出番です。このプラグインを使うと、相対パスでイメージのアドレスを指定できますので、これらの問題を解決することができます。なお、イメージはattachプラグインは使わずに、別途FTPソフトでアップロードしておくことが前提となります。

更新履歴

2008/06/04 v1.1

PLUGIN_IMGR_PAGE パラメーターが利用できなかった不具合に対応しました。このパラメーターを使っていない方には影響ありません。また、PLUGIN_IMGR_PAGEパラメーターを使用しない場合の機能については従来通りです。
ただし、PLUGIN_IMGR_PAGE パラメーターに値を代入した場合、上位ディレクトリ参照 （ファイル名を "../"からはじめること）ができなくなります ので、注意が必要です。

2005/12/19 v1.02

"linkr"プラグインのリリースに合わせ、ファイル名指定チェックのロジックを変更し、仕様通りであるかどうかのチェックをより厳しくしました。
　すべてのユーザーに新しいモジュールの使用を推奨します。
　ファイル名指定パラメーターに入れることができる文字は、半角英字（大文字・小文字）、半角数字のほか、半角記号の"="（イコール記号）、"#"（シャープ記号）、"&"（アンパーサント）、"%"（パーセント記号）、その他URIに含めることが認められている文字（ただし","［カンマ］と"~"［チルダ］は除く：" $ ! * ' ( ) ; : @ + "）です。
【注意】ファイル名にブランクやダブルバイト文字などが含まれる場合は、"%20"（半角ブランクの場合）などとエンコードして記述 してください。ただし、この場合、 ファイルの存在チェックはできません ので、 定数 'PLUGIN_IMGR_FILE_CHECK' を '0' としてください。

2005/12/08 v1.01

"_blank"パラメーターの追加、不具合修正
（v1.00でも実行にはほとんど影響ありませんが、念のため新しいモジュールの使用をおすすめいたします）

2005/12/06 v1.00

初版（その前は自スペースのPukiWikiでだけ密かに動作していました）

パラメーターの指定方法について。

　ファイル名の指定方法にちょっとクセがありますので、注意してください。
　このプラグインのパラメーター指定方法については、基本的に"ref"プラグインのそれに準じます。PukiWikiパッケージ添付の「プラグインマニュアル」をご参照ください。
　ただし、ファイル名の指定については、以下の内容に読み替えてください。
　ファイル名は、相対パスで指定します。ただし、頭に"../"または"./"がついている必要があります。これらがないと、エラーとして受け付けません。すなわち、以下のようなディレクトリ構造のサイトがあるとした場合、

[(ルート・ディレクトリ)]
  |
  +--[image]
  |    |
  |    +-- image1.jpg
  |
  +--[PukiWiki]（PukiWikiの各種iniファイルがはいっているディレクトリ）
       |
       +-- image2.jpg
       |
       +-- [image]
       |     |
       |     +-- image3.jpg
       |
       +-- [plugin]
             |
             +-- imgr.inc.php （ここに設置します）

　image1.jpg を参照する場合には、

&imgr(../image/image1.jpg)

　image2.jpg を参照する場合には、

&imgr(./image2.jpg)

　image3.jpg を参照する場合には、

&imgr(./image/image3.jpg)

　とそれぞれ指定すると、いかにも&refと同じような働きをします。
　ちなみに、&imgr（インライン）で例示しましたが、#imgr（ブロック）でも同じように動きます。

追加パラメーターについて。

【2005/12/08】"_blank"パラメーターを追加しました。
　このパラメーターを使うと、リンク先イメージを新しいウインドウに表示させることができます。
　※"nolink"パラメーターと一緒に指定すると無視されますのでご注意ください。

PLUGIN_IMGR_PAGE パラメーターの使用について。

　v1.1の変更履歴で述べたとおり、PLUGIN_IMGR_PAGEパラメーターの使用ができるようになりましたが、機能は限定的ですので、ご注意ください。以下のようなディレクトリ構造のサイトがあるとした場合、PLUGIN_IMGR_PAGE に "./image/" を指定する（このパラメーターも "./" または "../" ではじめる必要があることに注意！） と、

[(ルート・ディレクトリ)]
  |
  +--[image]
  |    |
  |    +-- ×image1.jpg
  |
  +--[PukiWiki]（PukiWikiの各種iniファイルがはいっているディレクトリ）
       |
       +-- ×image2.jpg
       |
       +-- [image] <=== PLUGIN_IMGR_PAGE が指しているディレクトリ
       |     |
       |     +-- image3.jpg
       |     |
       |     +-- [face]
       |           |
       |           +-- heart.png
       |
       +-- [plugin]
             |
             +-- imgr.inc.php （ここに設置します）

　image3.jpg を参照する場合には、

&imgr(./image3.jpg)

　heart.png を参照する場合には、

&imgr(./face/image3.jpg)

　とそれぞれ指定すると、画像が表示されますが、ファイル名の前に「×」がついている image1.jpg ならびに image2.jpg は表示できなくなりますので、注意してください。

ライセンスと保証について。

　この改造プラグインはフリーソフトウェアであり、ライセンスは、PukiWiki本体と同様、GNU GPL（一般公衆利用許諾契約書）［原文（英文）］［非公式日本語訳］が適用されます。

　この改造プラグインは"AS IS"、すなわち現存のままの状態で配布され、無保証です。自己責任にて使用してください。

設置方法について。

　標準プラグイン同様、imgr.inc.phpを、PukiWikiのpluginサブディレクトリにアップロードしてください。パーミッションも他のプラグインと同じにします。ほかのファイルはアップロード不要です。

ダウンロードはこちらから。

　"imgr"プラグイン(zip圧縮)
　"imgr"プラグイン(tar.gz圧縮)

問い合わせ先について。

この改造プラグインに関するお問い合わせはメールにてtakayan＠s41.xrea.comまで（＠は半角にしてください）。

へっぽこPukiWikiプラグイン by takayan - トップ に戻る

（最終更新日：2008-06-04 17:23:20）