直リンク画像表示プラグイン

β版公開中

2006/05/11 - 縮小画像自動生成機能追加の為、β版公開を再開しました。

現在公開中のβ版は、正式公開版に縮小画像の自動生成機能を追加したものです。縮小画像生成には、ImgResize.pmが別途必要となります。上記リンク先よりダウンロードし、lib ディレクトリ内に置いてください。

なお、設置する環境において ImgResize.pm が対応している「外部コマンド」や「モジュール」がない場合は、画像添付フォームに「縮小画像オプション」が表示されません。その場合は、縮小画像自動生成機能の利用は諦めてください・・・。

どのようなフォームが表示されるかは、「こちら」でご確認ください。

なおβ版の為、内部仕様を変更する可能性がありますのでご注意ください。使用方法等は出来る限り変更しない方向で行きたいと思います。

ImgResize の使用をやめて、Image::Thumbnail に変更するかも知れません。。

内容

添付された画像ファイルへのimgタグによる直リンクを張ります。

  • 添付先は従来の attach ディレクトリではなく、専用のディレクトリになります。
  • setup.dat への設定の追加(image_dir, image_uri)が必要です。
  • image_dir に相当するディレクトリを作成する必要があります。
  • image_uri 内のファイルへ直リンクを必要とする為、アクセス権限を変更する必要が出る場合があります。
従来の ref_image との違い
ref_image で表示した画像ファイルは wiki.cgi を経由して画像ファイルを表示している為、サーバへの負荷も高く、また表示に時間がかかる。表示画像ファイルへは直リンクにすることで、wiki.cgi を経由せずに画像ファイルへアクセスできる為、サーバへの負荷も軽減されて高速に表示されるようになります。

当プラグインでは、直リンクの画像ファイル用に新たにディレクトリを設け、そのディレクトリへファイルを添付し、さらに添付したファイルへ直接リンクする IMGタグの生成を行えるようにします。
attachプラグインで添付した画像ファイルを移行するときの注意点
attachプラグインを用いた添付ファイルは ファイル名の "." がエンコードされた状態で保存されています。当imageプラグインで添付するファイルは "." をエンコードしません。その為、attachディレクトリにある画像ファイルを直接 image ファイルに移動しても、ファイルを表示することは出来ません。以降の際は、必ず添付し直すようにしてください。

インストール方法

  • 添付ファイルを解凍し、各ディレクトリに展開してください。また、プラグイン設定画面で image を有効にしてください。
  • また、setup.dat ファイルへ以下の設定(例)を追加します。
# 画像ファイルを保存するディレクトリ
image_dir = ./image
# 画像ファイルを表示するURI
image_uri = /fswiki/image
  • さらに、上記 image_dir に相当するディレクトリを作成します。
  • image_dir へのuriパス(image_uri)に対してアクセス権限を設定します。

ダウンロード

以下のサイトからダウンロードしてインストールしてください。

※βバージョンの公開は終了しました。

依存関係

なし

利用方法

image

添付した画像ファイルを表示します。

{{image ファイル名[,ページ名[,オプション,...]}}

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

オプションへ指定可能な値は以下の通りです。

  • alt:振替テキスト - 画像ファイルに任意の alt 属性を付加
  • size:WIDTHxHEIGHT - 画像の表示サイズの指定(% or px)
  • float:left or right - テキストの回りこみ指定
  • thumbnail:縮小画像ファイル名 - 縮小画像を表示したい場合

例)サイズを指定した場合は、画像ファイルへの直リンクも作成されます。

{{image sample.jpg,,alt:サンプル,size:50%,float:left}}

例)縮小画像を指定した場合は、縮小画像が表示されてファイル名で指定したファイルへのリンクとなります。これらの画像は同一ページに存在する必要があります。

{{image sample.jpg,,alt:サンプル,thumbnail:sample_s.jpg}}
image_files

表示中のページに添付されている画像ファイルを一覧表示します。

FooterやMenuに記述しておくと便利です。

{{image_files}}

Menuに記述する場合など、vオプションをつけると縦に表示することができます。

{{image_files v}}
image_form

画像ファイルを添付するためのフォームを表示します。

{{image_form}}

添付した画像ファイルはフォームの上に一覧表示されます。 同じ名前の画像ファイルを添付すると上書きされます。 nolistオプションをつけると一覧表示を行いません。

{{image_form nolist}}

画像ファイルを添付するためのフォームを表示します。

{{image_form}}

添付した画像ファイルはフォームの上に一覧表示されます。 同じ名前の画像ファイルを添付すると上書きされます。 nolistオプションをつけると一覧表示を行いません。

{{image_form nolist}}

プラグイン開発者向け情報

plugin::image::Image モジュール内に以下の関数を用意しています。これらを利用することで、表示用に添付された画像ファイルのファイル名、リンク等を取得することが出来ます。

create_image_filename($wiki, $page, $file)
指定されたパラメータを与えることで、画像ファイルへのフルパス名を取得することが出来ます。
  • パラメータ
    • $wiki - Wikiオブジェクト
    • $page - 画像ファイルが添付してあるページ名
    • $file - 画像ファイル名
  • 戻り値
    • 画像ファイルへのフルパス名
create_image_url($wiki, $page, $file)
指定されたパラメータを与えることで、画像ファイルへのURLを取得することが出来ます。
  • パラメータ
    • $wiki - Wikiオブジェクト
    • $page - 画像ファイルが添付してあるページ名
    • $file - 画像ファイル名
  • 戻り値
    • 画像ファイルへのURL
url_encode($retstr)
指定された文字列をエンコードします。 &Util::url_encode()とほぼ同じだが、"."もエンコードしない値が戻ります。
  • パラメータ
    • $retstr - 文字列
  • 戻り値
    • エンコード文字列

変更履歴

2006/02/26
  • ベータバージョンの公開
2006/02/27
  • farm 動作時の image_uri 設定ミスを修正
  • alt属性のデフォルト値(ファイル名)を設定 - (11:00)
  • WIDTHxHEIGHTオプションを追加 - (18:13)
2006/02/28
  • 本家へ投稿
2006/03/03
  • オプションパラメータの指定方法を変更
Comment(14)
  • 早速導入しました。最高です。{{ image_form }} では、farm に対応したアップロードが出来ているようですが、 {{ image }}の方は、farm に対応していないようで残念です。まだベータという事で期待しています。 - yushi (2006/02/26-23:49:14)
  • コメントありがとうございます。そういえば、farm の事をすっかり忘れてました。上記の指定箇所は、例えば farm 間をまたがって画像ファイルを指定したいということでしょうか? - KG (2006/02/27-00:01:18)
  • こちらの設置ミスかもしれませんが、ファームアップのフロントページにアップした test.jpg が、image test.jpg で上手く表示できず、webページのソースをみると /fs/image/FrontPage.test.jpg となっており、farm のディレクトリが抜けていたので farm に対応していないのかな。と思ったのです。 - yushi (2006/02/27-00:07:35)
  • farm の名前は、css で、/fs/image/css には、FrontPage.test.jpg が、バッチリ保存されていました。 - yushi (2006/02/27-00:09:46)
  • 修正しました。当方の環境では修正版で正常に稼動することを確認しました。 - KG (2006/02/27-00:25:37)
  • すばやい対応ありがとうございます。こちらの環境でも動作確認しました。 - yushi (2006/02/27-00:31:43)
  • alt属性値が2重にエスケープされているようです。 - typer (2006/05/14-16:00:04)
  • 本当ですね、次版で修正しておきます。ご報告ありがとうございます。 - KG (2006/05/15-09:30:23)
  • 添付ファイル名をクリックされた数 or そのファイルが開かれた数 がわかるようになると、より良いと思います。 - ゆう (2007/05/11-16:28:30)
  • pxでのサイズ指定はどのように書けばいいのですか? - nori (2013/06/26-15:56:16)
  • いろいろやって自己解決しました。 - nori (2013/06/26-16:01:39)
  • _ex_attachプラグインのように、編集画面で複数ファイルの削除ができるようになりませんか? - ken (2014/08/21-13:37:04)
  • kenさん、本家サイトへ投稿しているバージョンに対してご要望の機能を追加しましたので参照してください。 - KG (2014/08/25-16:28:20)
  • 画像縮小化対応版は今回修正していませんが、こちらの方が良かったですか? - KG (2014/08/25-20:35:20)
お名前: コメント: