ハンチングガールド: 検索結果ハイライトプラグイン

検索結果ハイライトプラグイン

オオカワ 2005-03-04 [MovableType]

俺の行動の半分は「勢い」で出来ています。と思います。そんな勢いを駆使して、今回も変なもん作ってみました。

先日のエントリーでJavaScript＋DHTMLを使ったMT検索結果キーワードハイライト表示を紹介してみたんですが、これ、DHTML使ってるもんでMacじゃウマイこといかないんですな。（つか、元々動かないし。）

それに正規表現を利用した検索もせっかくできるのに、ハイライト箇所を探すのに単純文字列比較しかしてなかったもんだから、該当キーワードが見つけられないのでイマイチ面白みなかったっつーのもあって、「せっかくだからMTのプラグイン化でもしてみっか。」と作ってみました。

とりあえずダウンロードはこちら。

Search Keyword Highlight Plugin
(Highlight.zip 1.54KB)

まず最初に注意。このプラグイン、Movable Type のバージョン2.661でしか動作確認してません。文字コードもUTF-8環境でのみ確認です。というか、ハンチングでしか確認してないので他で動くかわかりません。バージョン3以降に適用した場合にメニューに表示される概要説明とか実装してますが、カッコ付けたかっただけで動くか確認してません。ごまんなさい。

バージョン3以降で動かして動いたりなんかしたら、「動くっぽいよ。」とか教えてもらえればシアワセです。

Zipファイルを解凍してplファイルを取り出します。プラグインのインストールは他のMTプラグインと同じようにMT設置ディレクトリ直下のpluginsディレクトリにぶっこんでおいてもらえればOKです。で、それが完了したら、検索画面テンプレートにハイライトフィルタの設定を行います。検索画面テンプレートはMT設置ディレクトリ直下のsearch_templatesディレクトリ内にあるdefault.tmplってファイルです。

このファイルをエディタなどで開いて、<MTSearchResults>コンテナタグで囲まれた中にある<$MTEntryTitle$>や<$MTEntryExcerpt$>にhighlightフィルタを設定します。

例）
<$MTEntryTitle$>　→　<$MTEntryTitle highlight="2"$>

のような感じです。highlightフィルタを効果的に、というか、検索該当箇所がある本文を直接見えるようにしたほうがハイライトさせる意味もあると思いますので、<$MTEntryExcerpt$>でエントリー概要を表示する代わりに、<$MTEntryBody$>や<$MTEntryMore$>タグを使って本文そのものを表示させてみるのもいいかもしれません。（ってか、おすすめです。）

それと、highlightフィルタパラメータには2種類あります。

highlight="1"

1はタグ内容テキストに対してハイライト加工（ハイライトタグの追加）のみを行います。

highlight="2"

2はタグ内容テキストに元々含まれるHTMLタグを全て取り除いた上で、ハイライト加工を行います。MT標準で用意されているグローバルフィルタのremove_htmlをハイライト加工前に処理するのと同じです。（注意：highlightフィルタを利用した場合、指定タグ内で同時にremove_htmlを指定することは出来ません。remove_htmlを指定するとハイライト加工が消去されてしまいます。）　とりあえずよくわかんない場合はこっちを指定しておいたほうがいいと思います。なんとなく。

上記のフィルタ設定をテンプレートに反映させたらプラグインの導入、用意が完了です。

早速検索ページから任意のキーワードで検索を試してみてくださいな。Googleキャッシュ気分満載。

（仕様制限）
・大小文字を区別した検索の場合、検索結果は指定を反映していますが、フィルタは区別無くハイライトしてしまいます。
・<MTComment>コンテナタグを利用してコメント本文にhighlightフィルタを適用する場合は、<$MTCommentBody$>タグにフィルタ設定するのではなく、<MTComment>コンテナタグのほうにhighlightフィルタを設定してください。ハイライト背景色スタイルが反映されない現象がおきます。
（sanitizesの許可タグ制限が影響してるようなのでmt.cfgのGlobalSanitizeSpec設定で回避できそうですが別にコンテナタグに設定してても不自由無いのでこれで使ってみてください。）