ダウンロード

RecommendedEntry 　 ファイルのMD5ハッシュ値: 15936af0022a8c1e3135ceb93eefe985 ver.1.00, '07/02/12, 2508 bytes, MovableType 3.33 で動作確認、PHP 必須 初版公開

最新版のダウンロードやバグレポートはRecommendedEntry の trac レポジトリでも行っています。

動作環境

　ビジタの動向データの集積と集計に PHP を使用しています。 ご利用のサーバで PHP が使用でき、 かつ RecommendedEntry をご利用の予定のブログの個別記事ページで PHP が動作する必要があります。

• MovableType 3.3x 以上(もしかしたら 3.2 でも動くかも)
• [必須] 個別エントリアーカイブで PHP が動作すること

動作概要

　RecommendedEntry プラグインは、個別記事ページにユーザ追跡のためのコード片を埋め込みます。 ユーザが個別記事ページを閲覧する度に、ユーザがどのような順番でページを渡り歩いたのかを集積し、 このデータを集計することで記事間のユーザの移動状況を求めることができます。 ユーザ追跡にはブラウザの Cookie を使用していますが、 あくまで任意のユーザの記事間の移動を追跡することが重要であって、 ユーザを個々に限定・追跡することが目的でがありません。
　また、記事リコメンデーションの精度についてですが、 ユーザ嗜好や記事内容の関連性のクラスタリングと云ったリコメンデーションで多用される技術は全く使われていません。 個々のユーザが現在閲覧している記事を基点としたユーザの移動をデータとして集計し、 多いものから順に表示するだけの非常に好い加減かつお遊び的なものであることを了承ください。

導入方法

　少し手順が複雑ですが、気合で(ぇー

1. プラグインの導入
2. エントリ一覧用インデックステンプレートの作成
3. データフォルダの準備
4. エントリアーカイブテンプレートの修正

1.プラグインの導入

　ダウンロードしたアーカイブを展開します。 MTRecommendedEntry.pl というファイルが一つだけ現れるので、 MovableType のインストールフォルダにある plugins にコピーしてください。 その後、MovableType の管理画面から[プラグイン]と移り、 RecommendeEntry プラグインが表示されていることを確認します。

2.エントリ一覧用インデックステンプレートの作成

　RecommendeEntry プラグインはエントリの一覧を記述した PHP ファイルを要求します。 以下の内容でインデックステンプレートを新規作成してください。 インデックステンプレートの名前とファイルの出力先はどこでも構いませんが、どちらか一方を控えておいてください。
　このインデックステンプレートは、後述の $MTRecommendedEntryParam$ タグで必要とするパラメータに応じて編集してください。 下の挙げた例では記事タイトル(title)と記事のパーマリンク URL (permalink)が記述されています。 記事 ID (eid) の項は RecommendeEntry プラグインが使用するため変更しないでください。

<?php function RecommendedEntry_getAllEntries () { $ret = array (); <MTEntries lastn="999999"> array_push ($ret, array ( 'eid' => '<$MTEntryID$>', 'title' => '<$MTEntryTitle encode_php="q"$>', 'permalink' => '<$MTEntryPermalink$>', null)); </MTEntries> return ($ret); }?>

3.データフォルダの準備

　次に、RecommendeEntry プラグインが集計したユーザ動向のデータファイルを保存するためのディレクトリを作成してください。 データファイルには個人情報が含まれるわけではありませんが、気になる人はドキュメントルート以外に作成されることをオススメします。 作成したディレクトリの絶対パスを控えておいてください。

4.エントリアーカイブテンプレートの修正

　RecommendeEntry プラグインを用いて、ユーザ動向の集計と記事リコメンデーションを行うために、 個別アーカイブテンプレートを修正します。 最も小さな個別アーカイブテンプレートは次のようになります。

<$MTUseRecommendedEntry template="(2で作ったインデックステンプレートの名前)" datapath="/home/your/account/data/path"$> ： <h1><$MTEntryTitle$></h1> <p> <$MTEntryBody$> </p> ： <h2>この記事を読んだ人はこんな記事も読んでいます</h2> <ul><MTRecommendedEntries count="5"> <li> <a href="<$MTRecommendedEntryParam name="permalink"$>"><$MTRecommendedEntryParam name="title"$></a> (<$MTRecommendedEntryParam name="count"$> hits)</li> </MTRecommendedEntries></ul> ：

　<$MTUseRecommendedEntry$> タグには、 先ほど準備したエントリ一覧用インデックステンプレートの名前と データフォルダのディレクトリパスを指定する必要があります。 また <$MTUseRecommendedEntry$> タグはあらゆる文字出力が行われる前に記述されるよう、 必ずファイルの先頭に置いてください。

追加されるテンプレートタグ

$MTUseRecommendedEntry$ タグ

　記事リコメンデーションを行うページの一番最初で文字出力を行う前に一度だけ記述してください。 タグの前に文字列や空白文字、改行があると Cookie が正しく処理されませんので注意してください。 このタグは動作に必要な PHP のコード片を生成します。 個別エントリアーカイブのみで使用されることを想定していますので、 カテゴリ別アーカイブや月別アーカイブ、インデックステンプレートでは使用できません。

template [必須*]

　エントリ一覧用インデックステンプレートの名前を指定します。 このパラメータを省略する場合、後述のindexが必須です。 両方の指定がある場合、indexによる指定が優先されます。

index [必須*]

　エントリ一覧用インデックステンプレートによって出力されたファイルへの絶対パスを指定します。 このパラメータを省略する場合、先述のtemplateが必須です。 両方の指定がある場合、templateによる指定を上書きします。

datapath [必須]

　データフォルダの絶対パスを指定します。 ユーザ動向のデータファイルがここで指定されたパス以下に生成されます。 このパラメータは省略できません。

cookie_expire

　ユーザ追跡用 Cookie の有効期間を設定します。このパラメータは省略できます。 省略時のデフォルト設定値は 30 日間です。

cookie_name

　ユーザ追跡用 Cookie の名前を設定します。このパラメータは省略できます。 省略時のデフォルト設定値は mtrcmnd_eid です。 既存の Cookie と名前が衝突する場合には変更してください。

MTRecommendedEntries コンテナタグ

　現在のエントリについて、流入数、流出数の多いエントリを列挙するためのコンテナタグです。 このタグはループ処理のための小さな PHP コード片を生成します。 一般的な MovableType テンプレートタグとは動作が異なりますので注意ください。

mode

　集計モードを設定します(動作概要図も参照してください)

• 0 … 流入数(incoming flow)と流出数(outgoing flow)を合算します。ビジタの相互間の移動が多いエントリを集計します。デフォルト設定値です。
• 1 … 流入数(incoming flow)のみを集計します。現在のエントリへビジタが流入した流入元エントリを集計します。
• 2 … 流出数(outgoing flow)のみを集計します。現在のエントリからビジタが移動した流出先エントリを集計します。

offset

　ランキングの上位 offset 位を表示しません。デフォルト値は 0 です。

count

　ランキングの上位を offset で指定された順位から count 件だけ表示します。デフォルト値は 10 です。

$MTRecommendedEntryParam$ タグ

　MTRecommendedEntries コンテナタグの中で使用します。

name [必須]

　name で指定されたパラメータを表示します。 MovableType のテンプレートタグのようですが、実際には小さな PHP コード片を生成します。 そのため、テンプレートタグで有効なグローバルフィルタなどは使用できません。 name に指定できるパラメータには、エントリ一覧用インデックステンプレートで記述されたパラメータに加えて、 流入数または流出数を示す count が常に使用できます。
　先に挙げたエントリ一覧用インデックステンプレートの例では、 name パラメータには title と permalink を指定することができます。 例えばあなたが記事の作成された日付と投稿者名も表示したいと思うならば、 エントリ一覧用インデックステンプレートを以下のように修正し(一部抜粋)、 name="date"やname="author"とすることで実現できるでしょう。 'eid' => '<$MTEntryID$>', 'title' => '<$MTEntryTitle encode_php="q"$>', 'permalink' => '<$MTEntryPermalink$>', 'date' => '<$MTEntryDate format="%x" encode_php="q"$>', 'author' => '<$MTEntryAuthorName encode_php="q"$>',

ユーザ動向のデータファイルについて

　RecommendedEntry プラグインが利用するユーザ動向が集積されたデータファイルについて説明します。 MTUseRecommendedEntry タグの datapath パラメータによって指定されたディレクトリ以下に、 <記事 IDα>.txt というファイル名で記事毎にテキスト形式のデータファイルが生成されます。 <記事IDα> <流入カウントα> 0 <記事IDβ> <流入カウントβ> <流出カウントβ> <記事IDγ> <流入カウントγ> <流出カウントγ> ： 　<記事IDα> の記事には <記事IDβ> から <流入カウントβ> の訪問があり、 <記事IDα> の記事からは <記事IDβ> に <流出カウントβ> だけユーザが移動したことを示します。 初めてサイトを訪問するユーザや、Cookie の有効期限が切れたユーザが <記事IDα> を訪問した場合、 同じ <記事IDα> の <流入カウントα> として記録されます。

困った時は

Warning: touch(): Unable to create file XXX/XXX.txt because Permission denied in XXX line XXと表示される

　データファイルの保存先に指定したディレクトリ(datapath)にCGI/PHPからファイルを生成できるように，適切な書き込み権限を与えてください。

Warning: Cannot modify header information - headers already sent by (output started at XXX:XXX) in XXX on line XXXと表示される

　$MTUseRecommendedEntry$タグはページの一番最初に記述してください。 タグよりも前には空白・タブ文字や改行などのあらゆる文字出力があってはいけません。

ライセンス

• このソフトウェアプロダクトは、GPL ライセンス (GNU General Public License; GNU 一般公衆利用許諾契約書 (英語原文)) 定める範囲において自由に複製、頒布、改変、利用することができます。