NP_cles()

12345678910111213141516171819202122232425262728293031

NP_Clap v1.0

 
投稿者:hsur 投稿日時:2006-05-05 - 23:16
カテゴリー:Plug-in - - トラックバック(0)- Views: 209

mcity.orgのyamaneさんがNucleusでウェブ拍手が作れないかと書いておられたので、そのアイディアをちょっといただいてこの連休の気分転換にプラグインを書いてみました。拍手系のCGIってお礼を表示することがメインだったとは・・・。僕にはそういう発想が自体がありませんでした。これでNucleusでへぇボタンを作るTipsのリプレースを狙ってみたいと思います。

NP_Webclapとかあるといいのになぁ(ヲイ) - mcity.org

NP_Karmaを使うことで「へぇボタン」を実現されているわけですが、そのお礼を何か表示できないかと考えるとやはりWeb拍手系になるのではないかと。

どれくらいアイディアが汲み取れたのかという問題はあるんですが、とりあえずは大体の部分ができたので公開してみます。ついでに前々からいろいろと試していた、UTF-8とEUCの両対応版の技術を取り入れてみました。その分いろいろと手間が増えてしまったんですが、その分いろいろカスタマイズはしやすくなっていると思います。

ダウンロードはこちら [NP_Clap v1.0][107clicks](UTF-8/EUC-JP共用)
機能追加版のNP_Clap v1.1をリリースしました。
※使い方についてはplugins:clap [Nucleus CMS Japan Wiki]にまとめてあります

動作確認はNucleus 3.22(UTF-8)、PHP 4.4.2環境で行っています。動作確認報告、バグ報告はこのエントリへ、コメント・トラックバックをお願いします。

概要

Nucleusでウェブ拍手を実現するプラグインです。

以下の機能も備えています。
・簡易メールフォーム機能
・拍手のお礼に画像及び文章をランダムに表示
・拍手されると管理者へメールで通知。(すべて/コメントが書かれているときのみ/なしの選択ができます。)
・もちろんNP_Blacklist対応。
・人気の高い順にリスト表示(←左メニューMostへぇみたいな機能)
へぇボタンの作り方から移行のための機能
・拍手はエントリごとだけでなく、自分の好みのグルーピングが可能。
・HTML部分はカスタマイズ可能

インストール

ダウンロードしたアーカイブを展開し、出てきたファイルとフォルダを(nucleusインストールディレクトリ)/nucleus/pluginsに配置します。NP_MoblogやNP_TypeKeyを使っているといくつかファイルを上書きしてよいか尋ねられると思いますので、その際はファイルを必ず上書きしてください。

その後、管理画面のプラグイン管理からインストールを行います。

スキン/テンプレート変数

拍手送信ボタンや、人気ランキングを表示させるためにはスキンもしくはテンプレートへのプラグインの呼び出しを記述する必要があります。以下のスキン/テンプレート変数が利用できます。

・<%Clap(button)%>

拍手を送信するためのボタンを表示します。また、<%Clap(button, Key)%>のように追加のオプションとしてkeyを設定できます。keyを省略した場合にはアイテム個別ページの場合にはアイテムidへの拍手に、それ以外のページの場合には'global'という特殊なキーを指定したものとして扱われるようになっていますが、必要な場合にはKeyを強制的に指定することができます。自分でキーを指定する場合には英数字10桁以内になるようにしてください。

表示されるボタンはclap/template/np_clap/button_japanese-utf8.htmlもしくはclap/template/np_clap/button_japanese-euc.htmlの内容を書き換えることでカスタマイズすることができます。お使いのNucleusの文字コードにあわせて変更するファイルを選んでください。なお、clap/template/np_clap_clesblogにcles::blogで使っているテンプレートをいれておきましたので、へぇボタンスタイルで使いたい方はこのディレクトリの中身をclap/template/np_clap/に移動して使ってください。

・<%Clap(actionurl)%>

上級者及び、高度なカスタマイズを望む方向けオプションです。
設定できる項目はbuttonに準じますが、拍手を送信するためのURLのみを返すようになっているので自分で<form>や<a>タグを用いて画面を構成する必要があります。通常は上記のbuttonを使ってください。

・<%Clap(count)%>

拍手の送信数を表示します。
buttonと同じようにkeyを指定することができます。

・<%Clap(list)%>

人気リストを表示します。左メニュー部のMostへぇのようなリストを表示する機能です。

<%Clap(list, count, blogid)%>のように2つの追加オプションが指定できます。countはリストの最大数を指定します。デフォルトは10です。blogidは指定したblogidからのみのランキングを表示するようになります。デフォルトはすべてのブログのランキングを表示するようになっています。複数のブログIDを指定する場合には/で区切って指定します。

表示されるリストはclap/template/np_clap/list_###_japanese-###.htmlの内容を書き換えることでカスタマイズすることができます。こちらもお使いのNucleusの文字コードにあわせて変更するファイルを選んでください。

プラグインオプション

プラグインオプション - NP_Clap v1.0

・通知先メールアドレス

拍手が送信された際に通知されるメールアドレスを指定します
通知を行わない場合には空欄にしておいてください。

・コメントが書かれている場合のみ通知?

「はい」にするとコメントが書かれている場合のみメールで通知します。

・連続投稿制限

一定時間あたりに送信できる拍手の最大数を指定します。
「10/600」と入力すると600秒あたり10回までという設定に解釈されます。
規定回数を超えた場合には、ThanksページではなくForbiddenページが表示されます。

・spamチェックを有効にするか?

NP_Blacklistなどのspamチェック機構によるspamチェックを有効にします。
spam判定がされた場合にはThanksページではなく、Forbiddenページが表示されます。

・Thanksページ内容

Thanksページで表示されるランダム画像とコメント(文章)を,で区切って指定します。

(入力の例)

http://example.com/images/1.jpg,ありがとう http://example.com/images/2.jpg,さんきゅー http://example.com/images/3.jpg,Thanks ,こうするとコメントだけ、以下の場合には画像だけ。 http://example.com/images/3.jpg,

1行が1つの組として扱われますので、複数行の内容が入力されている場合にはランダムで1つが表示されるようになります。画像、コメントのいずれかが必要ない場合には空欄を指定することが可能です。つまり、画像のみやコメントのみという使い方もできるということです(下記、4,5行目参照)。その際はカンマをつけるのを忘れないようにしてください。

・アンインストール時にデータを削除する

アンインストール時にデータをすべて削除するかどうか?

Thanksページ・Forbiddenページのカスタマイズ

拍手が送信されたときに表示されるThanksページや、拍手の送信が拒否されたときに表示されるForbiddenページについてはプラグインディレクトリにあるclap/template/np_clap/thanks_japanese-###.htmlclap/template/np_clap/forbidden_japanese-###.htmlファイルを編集することによってカスタマイズが可能です。

動作に必要なhiddenフィールド等がありますので、編集する際にはその部分を削除しないように気をつけてください。

拍手データの管理

プラグインをインストールすると左メニューに「Clap」という項目ができます。
このリンクをクリックすると以下の画像のような拍手データの管理画面に入ることができます。

拍手データ管理 - NP_Clap v1.0

    このエントリは役に立ちましたか?

      

    トラックバックについて [policy]

    Trackback URL:
    Trackbacks
    このエントリにトラックバックはありません

    Comments [policy]

    藤咲 wrote:

    web拍手なプラグインは面白いですね。うちのがブログ以外の2次小説系サイトをやってまして、そこでもweb拍手を使ってます。
    ただ、そういった2次小説系サイトだと、Thanksページ内容というのはショートショートの2次小説だったりするので、文章を行で区切る形の実装だと使いどころが限られるかも…と思ったりします。

    2006-05-06 23:56 <%HatenaAuth()%> 

    yamane wrote:

    mcity.orgのyamaneでございます。
    身勝手な要望にお応えいただき誠にありがとうございました。
    早速導入させていただきました。思い描いていた機能がすべて入っていて感動いたしました。
    細かいところですが、NucleusをEUC-JPで導入している場合、表示部の1行目のencodingがUTF-8になっていますので文字化けします。
    EUC-JPに変更すれば問題ありませんでしたが、一応ご報告させていただきます。

    2006-05-07 00:01 <%HatenaAuth()%> 

    hsur wrote:

    藤咲さん

    ただ、そういった2次小説系サイトだと、Thanksページ内容というのはショートショートの2次小説だったりするので、文章を行で区切る形の実装だと使いどころが限られるかも…と思ったりします。

    僕自身はあまりウェブ拍手系のCGIを活用しているわけではないので、参考になります。Thanksページには長文が必要な場合もあるんですね。次回バージョンアップの課題とさせてください。

    yamaneさん

    細かいところですが、NucleusをEUC-JPで導入している場合、表示部の1行目のencodingがUTF-8になっていますので文字化けします。

    ご指摘ありがとうございます。ファイルは差し替えておきたいと思います。

    2006-05-07 00:22 <%HatenaAuth()%> 

    mar wrote:

    hsurさん、はじめまして!
    NP_Clap頂戴しました。
    NP_TrackbackとNP_HideCommentMailAddrも使わせて頂いております!
    そうそうたる方々のコメントばかりなので恐縮ですが、ぜひ御礼申し上げたいと思いました。
    これからも素晴らしいプラグインを開発してください!

    2006-05-11 23:18 <%HatenaAuth()%> 

    hsur wrote:

    よろこんでいただけたみたいでなによりです。また、新しいアイディアが浮かべばプラグインも開発していきます。

    そんなに恐縮されなくても結構ですから、これからも気軽にコメントしてくださいね。

    2006-05-11 23:50 <%HatenaAuth()%> 

    みえ wrote:

    初めまして。
    以前別のエントリーを読みbookmarkし 一ヶ月経過して「あれ?コレ何のエントリー?」と読み始め 過去記事を遡っている途中です。
    当方、hsur氏の親御さん世代かもしれません。以前へぇへぇボタンを設置したい、と思った事があるのですが ブログに このように組み込んであるのには「感激」しました。当方のブログは Blogn Plusで・・・でも欲しいなーと思ったので そのままの気持ちをコメントし もう少し「溯上」してみます。

    2006-07-14 16:16 <%HatenaAuth()%> 

    Add Comments

    コメントは承認後の表示となります。
    OpenIDでログインすると、即時に公開されます。

    OpenID を使ってログインすることができます。

    Identity URL: Yahoo! JAPAN IDでログイン