plugins:thumbnail

NP_Thumbnail

概要

タグ<%Thumbnail%>をテンプレート/スキン/アイテムに記述することで、サムネイル画像を表示することができます。また、プラグインオプションを有効にすることで、アイテム内のタグ<%popup%>でもサムネイル画像を表示することができます。表示するサムネイル画像は、プラグインオプションのテンプレートで設定できます。サムネイルの動的/静的出力のどちらも可能です。

プラグイン内での処理の大部分をNP_MediaUtilsが担っているため、NP_MediaUtilsを先にインストールしておく必要があります。

General Plugin info
作者: Mocchi nakahara21 jirochou
最新のバージョン: Ver.3.9.6 (RC2)
フォーラム参照先: 現トピック (旧トピック)
依存関係: NP_MediaUtilsに依存しています
対応環境: Nucleus CMS 3.40以上、PHPのバージョン5以上

インストール方法

  1. まず、Nucleus CMSの設定で指定したメディア用ディレクトリのパーミションが「0777」となっていることを確認してください。
  2. ZIPファイルを展開して、中身をサーバーのプラグインディレクトリにアップロードします
  3. スクリプトのパーミションを変更し、実行権限を付与します
  4. 管理画面からプラグインをインストールして下さい

このプラグインの使い方

  1. アイテム/テンプレート/スキン中にタグ<%Thumbnail%>を挿入します。タグの書式は以下となります。
<%Thumbnail(ファイルへの相対パス | 横幅の最大値 | 縦幅の最大値 | 説明文)%>

ファイルへの相対パスは、Nucleus CMSのコア機能で埋め込まれる<%image%>や<%popup%>、<%media%>と同じ文字列を指定します。つまり、ユーザ専用ディレクトリを利用するのであればファイル名のみ、それ以外はメディア用ディレクトリからの相対パスとなります。例えば「20101205-sample.png」や「public/sample2.jpeg」となります。

説明文は(X)HTMLのimg要素におけるalt属性となります。

これらはどれも必須です。

また、オプションを有効にすることでNucleus CMSコア機能が使う<%popup%>を、ポップアップリンク付きサムネイルに置き換えることができます。その場合のテンプレートは、ウェブログオプションで個別に指定することができます。

プラグインのグローバルオプションでファイルシステムを選択にしている場合、サムネイルをサーバに保存するようになるため、サーバの負担を軽減し、表示速度を早めることができます。保存先はメディア用ディレクトリの「.thumb」です。サムネイル生成のタイミングは表示する際とアップロードする際となります。

オプション

グローバルオプションとウェブログオプションを設けます。

グローバルオプション

  • サムネイルの横幅の最大値
    • 標準の縦幅を設定します。
  • サムネイルの縦幅の最大値
    • 標準の縦幅を設定します。
  • サムネイル画像を保存します
    • 保存先は標準ではメディア用ディレクトリの「.thumb」となります。

ウェブログオプション

  • タグ<%popup%>をサムネイルにします
  • タグ<%Thumbnail%>あるいは<%popup%>を置き換える際のテンプレート。

テンプレートでは、以下を使うことができます。

使用可能なテンプレート一覧
<%thumb_url%>サムネイル画像のURLになります。
<%thumb_width%>サムネイル画像の横幅になります。
<%thumb_height%>サムネイル画像の縦幅になります。
<%link%>オリジナル画像のURLになります。
<%width%>オリジナル画像の横幅になります。
<%height%>オリジナル画像の縦幅になります。
<%text%>ファイルの説明文(代替文)になります。
<%media%>オリジナル画像への完全なリンクになります。<%text%>を含む(X)HTMLのa要素になります。
<%rawpopuplink%>ポップアップ・リンクへのURLとなります。
<%popuptext%>上の<%text%>と同じですが、JavaScriptで利用できるようにhtmlエンティティ変換されています。
<%popupcode%>ポップアップウィンドウを開くためのJavaScriptコード(windowオブジェクトのopenメソッドを使用)になります。
<%popuplink%>画像への完全なポップアップ・リンクになります。<%popuptext%>を含む(X)HTMLのa要素であり、<%rawpopuplink%>、<%popupcode%>を含みます。

動的/静的生成のルール

サムネイル画像を保存するように設定した状態で、<%Thumbnail%>や<%popup%>に与える数値でサムネイルのサイズを任意の値に指定した場合、テンプレートの<%thumb_url%>の挙動が変わります。

  1. 指定した縦幅と横幅が、グローバルオプションで設定した縦幅と横幅よりも小さい場合
    • ファイルシステムに保存したサムネイルへのURLとなります。ブラウザでさらに縮小リサイズされて表示されるのを期待しています
  2. 指定した縦幅と横幅のいずれかが、グローバルオプションで設定した縦幅と横幅よりも大きい場合
    • 動的出力を行うURLとなります。ファイルシステムに保存したサムネイルを出力しないのは、指定したサイズよりもサムネイルの方が小さいのが原因でブラウザで表示される画像が荒くなるのを防ぐためです。

リサイズのルール

プラグインのグローバルオプションで設定した横幅と縦幅、あるいはタグで指定した横幅と縦幅に従い、NP_MediaUtilsのルールでリサイズされます。

サムネイル生成/削除画面

グローバルオプションでサムネイル画像を保存するように設定している場合、Nucleus CMS管理画面左のクイックメニューに、NP_Thumbnailの管理画面へのリンクが表示されます。この管理画面では、サムネイル画像の連続生成と削除を行うことができます。

ボタンsyncでサムネイル画像を連続生成します。一度に生成できるサムネイルは10枚に限定しています。これは、サムネイル生成のような重い処理を一度に実行しようとすると、サーバに負担がかかり、他のユーザにとって迷惑となることに対する配慮からです。

ボタンclearでサムネイル画像をすべてクリアします。特定のサムネイル画像だけ削除することはできません。

プラグインのグローバルオプションで標準のサイズを変更した際、sync機能とclear機能を組み合わせることで、サムネイルの再生成を行うことができます。

開発履歴

  • 2011.04.04 Ver.3.9.6 (RC2)
    • [Mocchi] NP_MediaUtilsの仕様変更に合わせて再開発
    • [Mocchi] リリースキャンディデート2
  • 2011.12.26 Ver.3.9.5 (RC1) 非公開
    • [Mocchi] プラグインとしての体裁を整理
    • [Mocchi] リリースキャンディデート1
  • 2010.12.15. Ver.3.9.0 (Ver.4.0 Beta)
    • [Mocchi] ソースコードを引き継いで、NP_MediaUtilsに依存する形で再開発

Ver.3.x系

  • 2005.02.16. Ver.3.0+
    • [Fujisaki] gif support
  • 2004.06.28 Ver.3.0
    • [jirochou] trivial update to support Nucleus CMS version3.0
  • 2004.05.30 Ver.2.1b
    • [jirochou] bug fix
  • 2004.05.24 Ver.2.0b
    • [jirochou] generate static thumbnail images on media directory
  • 2004.05.23 Ver.1.1
    • [jirochou] add classname to img tag
  • 2004.05.23 Ver.1.0
    • [jirochou] First imprementation.

Ver.1.x系

  • 2005.10.25 Ver.1.6
    • [nakahara21] fixed bug: resize as Chada mentioned
    • [nakahara21] support correct link-url
  • 2005.09.07 Ver.1.5
    • [nakahara21] support doSkinVer. for specific maxsize (by nakahara21).
  • 2005.06.16 Ver.1.4
    • [nakahara21] maximum size of popup windows support.
  • 2004.07.07 Ver.1.3
    • [Jirochou] add force_thumbnail option
    • [Fujisaki] modification above code
    • [Fujisaki] GIF support.
  • 2004.07.07 Ver.1.2
    • [nakahara21] Bug fix
  • 2004.07.06 Ver.1.1
    • [nakahara21] Bug fixed :image path
  • 2004.05.23 Ver.1.0
    • [jirochou] First imprementation
 
plugins/thumbnail.txt · 最終更新: 2011/04/06 21:03 (外部編集)