plugins:clap

差分

この文書の現在のバージョンと選択したバージョンの差分を表示します。

この比較画面にリンクする

plugins:clap [2011/03/23 21:28] (現在)
ライン 1: ライン 1:
 +====== NP_Clap.php ======
 +ウェブ拍手(&へぇボタン)をNucleusで実現します。
  
 +^General Plugin info ^^
 +^作者: |[[plugins:​authors:​hsur|hsur]] |
 +^最新のバージョン:​ |v1.7 (2009/​11/​29) |
 +^入手先: |[[http://​blog.cles.jp/​np_cles/​category/​31/​subcatid/​13 |作者サイト]] [[http://​japan.nucleuscms.org/​bb/​viewtopic.php?​p=12355 |フォーラム内の記事 ]] |
 +^ソース: |[[http://​svn.sourceforge.jp/​view/​plugin/​trunk/​NP_Clap/?​root=nucleus-jp|Nucleus Japan SVN]] |
 +^動作サンプル:​ |[[http://​blog.cles.jp/​np_cles/​ |NP_cles()]] |
 +^フォーラム参照先:​ |[[http://​japan.nucleuscms.org/​bb/​viewtopic.php?​p=12355 |フォーラム内の記事 ]] |
 +
 +  * 以下の機能も備えています。
 +    * 簡易メールフォーム機能
 +    * 拍手のお礼に画像及び文章をランダムに表示
 +    * 拍手されると管理者へメールで通知。(すべて/コメントが書かれているときのみ/通知なしの選択ができます。)
 +    * もちろん[[plugins:​np_blacklist|NP_Blacklist]]等のSpamCheckイベントに対応。
 +    * 人気の高い順にリスト表示
 +    * へぇボタンの作り方から移行のための機能
 +    * 拍手はエントリごとだけでなく、自分の好みのグルーピングが可能。
 +    * HTML部分はカスタマイズ可能
 +
 +=====インストール方法=====
 +  - Zipファイルを展開して、中身をサーバーのプラグインディレクトリにアップロードする
 +  - 管理画面からプラグインをインストールする
 +
 +=====スキン/​テンプレートへの記述=====
 +
 +拍手送信ボタンや、人気ランキングを表示させるためにはスキンもしくはテンプレートへのプラグインの呼び出しを記述する必要があります。以下のスキン/​テンプレート変数が利用できます。
 +
 +<code file><​%Clap(button)%></​code>​
 +
 +拍手を送信するためのボタンを表示します。また、<​%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/​に移動して使ってください。
 +
 +<code file><​%Clap(actionurl)%></​code>​
 +
 +上級者及び、高度なカスタマイズを望む方向けオプションです。
 +設定できる項目はbuttonに準じますが、拍手を送信するためのURLのみを返すようになっているので自分で<​form>​や<​a>​タグを用いて画面を構成する必要があります。通常は上記のbuttonを使ってください。
 +
 +<code file><​%Clap(count)%>​ or <​%Clap(count,​ key)%></​code>​
 +拍手の送信数を表示します。
 +buttonと同じようにkeyを指定することができます。
 +
 +<code file><​%Clap(list,​リストの最大数,​集計対象blog,​昇降順指定,​集計日数)%></​code>​
 +人気リストを表示します。
 +
 +^リストの最大数 ​ |リストの最大数を指定。デフォルトは10 ​ |
 +^集計対象blog ​ |デフォルトはすべてのブログ。複数のブログIDを指定する場合には/​で区切る。 |
 +^昇降順指定 ​ |DESC: 降順(デフォルト) ASC:​昇順 ​ |
 +^集計日数 | 集計対象とする直近の日数を指定。デフォルトは全ての期間。 ​ |
 +
 +表示されるリストはclap/​template/​np_clap/​list_###​_japanese-###​.htmlの内容を書き換えることでカスタマイズすることができます。こちらもお使いのNucleusの文字コードにあわせて変更するファイルを選んでください。
 +
 +=====オプション=====
 +
 +    * 通知先メールアドレス
 +
 +拍手が送信された際に通知されるメールアドレスを指定します
 +通知を行わない場合には空欄にしておいてください。
 +
 +    * コメントが書かれている場合のみ通知?
 +
 +「はい」にするとコメントが書かれている場合のみメールで通知します。
 +
 +    * 連続投稿制限
 +
 +一定時間あたりに送信できる拍手の最大数を指定します。
 +「10/​600」と入力すると600秒あたり10回までという設定に解釈されます。
 +規定回数を超えた場合には、ThanksページではなくForbiddenページが表示されます。
 +
 +    * spamチェックを有効にするか?
 +
 +NP_Blacklistなどのspamチェック機構によるspamチェックを有効にします。
 +spam判定がされた場合にはThanksページではなく、Forbiddenページが表示されます。
 +
 +    * アンインストール時にデータを削除する
 +
 +アンインストール時にデータをすべて削除するかどうかを指定します。
 +
 +=====管理画面について=====
 +
 +プラグインをインストールすると左メニューに「Clap」という項目ができます。
 +このリンクをクリックすると以下の画像のような拍手データの管理画面に入ることができます。
 +
 +**まずは「Thanksページコンテンツ一覧」からThanksページに表示するお礼メッセージを登録してみてください。**
 +
 +{{:​plugins:​np_clap_thankscontent.png?​300|Thanksページコンテンツ一覧}}
 +{{:​plugins:​np_clap_thanksedit.png?​300|コンテンツ編集画面}}
 +
 +
 +
 +=====Tipsと裏技=====
 +
 +  * 表示部のカスタマイズ
 +
 +拍手が送信されたときに表示されるThanksページや、拍手の送信が拒否されたときに表示されるForbiddenページについてはプラグインディレクトリにあるclap/​template/​np_clap/​thanks_japanese-###​.htmlやclap/​template/​np_clap/​forbidden_japanese-###​.htmlファイルを編集することによってカスタマイズが可能です。
 +
 +**動作に必要なhiddenフィールド等がありますので、編集する際にはその部分を削除しないように気をつけてください。**
 +
 +  * カテゴリごとにテンプレートを切り替える(v1.5以上)
 +
 +拍手が送信されたときに表示されるページをカテゴリごとに切り替えられるようになりました。
 +
 +デフォルトのテンプレート(clap/​template/​np_clap/​thanks_japanese-###​.html)を、clap/​template/​clap_(カテゴリID)/​thanks_japanese-###​.htmlにコピーすると、カテゴリIDに合致する記事から拍手が送られた場合に個別のテンプレートを利用してThanks画面を表示します。\\
 +※keyにitemid以外のもの(globalなど)を使っている場合には(カテゴリID)の部分はkeyを使います\\
 +
 +例)keyがglobalの場合\\ ​
 +  テンプレートの場所 clap/​template/​clap_global/​thanks_japanese-###​.html
 +
 +=====希望事項=====
 +
 +=====バグ=====
 +
 +
 +=====開発履歴=====
 +  * version 1.7 [2009/​11/​29] [[http://​blog.cles.jp/​item/​3314 |Read here]]
 +    * [Added] Thanksページで送信されたメッセージを表示可能にした
 +    * [Fixed] メッセージ一覧において、Nextボタンを押すと「"​key"​ is not set.」と表示される問題を修正(藤咲さんありがとう)
 +    * [Fixed] リストの表示件数がおかしい問題を修正(藤咲さんありがとう)
 +
 +  * version 1.6 [2008-05-18] [[http://​blog.cles.jp/​item/​2568 |Read here]]
 +    * [Fixed] カテゴリの関連付けがおかしくなる問題に対応した
 +
 +  * version 1.5 [2007-11-11] [[http://​blog.cles.jp/​item/​2272 |Read here]]
 +    * [Added] メール内にhostname,​ useragent, refererを表示できるようにした
 +    * [Fixed] mysql_query()をsql_query()に変更
 +    * [Added] カテゴリごとに表示するコンテンツ・テンプレートが指定できるようにした
 +    * [Changed] ログインしている場合にカウントしないようにした
 +    * [Fixed] カテゴリの関連付けがおかしくなる問題に対応した (1.5.1)
 +
 +  * version 1.4 [2007-03-18] [[http://​blog.cles.jp/​item/​1904 |Read here]]
 +    * [Added] カウント表示の日付での絞り込み
 +    * [Fixed] カウント表示時にブログでの絞込みが効いていない不具合を修正
 +    * [Fixed] バックアップが正常に行われない不具合を修正
 +    * [Fixed] 拍手ボタンを押した後にエラーが表示される問題を修正
 +
 +  * version 1.3 [2006-11-26] [[http://​blog.cles.jp/​item/​1731 |Read here]]
 +    * [Added] Ticket処理を追加(CSRF対策)
 +    * [Added] グラフ表示機能を追加
 +    * [Added] 管理画面にアイコンを追加
 +
 +  * version 1.2 [2006-09-30] [[http://​blog.cles.jp/​item/​1626 |Read here]]
 +    * [Fixed] <​%Clap(actionurl)%>​の不具合を修正
 +    * [Fixed] 管理画面の不具合を修正
 +    * [Fixed] セキュリティの向上
 +
 +  * version 1.1 [2006-05-05] [[http://​blog.cles.jp/​item/​1415 |Read here]]
 +    * [Changed]Thanksページの内容の設定をプラグインオプションから、管理画面に移行
 +    * [Added]プレビュー機能を追加
 +
 +  * version 1.0 [2006-05-05] [[http://​blog.cles.jp/​item/​1398 |Read here]]
 +    * 初回リリース
 
plugins/clap.txt · 最終更新: 2011/03/23 21:28 (外部編集)