AjaxSearch

ページ遷移することなく、検索結果を表示する。スニペット。

サンプルサイトの書式

[!AjaxSearch? ajaxSearch=`1` &AS_landing=`8` &moreResultsPage=`8` &showMoreResults=`1` &addJscript=`0` &extract=`0` &AS_showResults=`0`!]

パラメータ無しでも使用可能です。

パラメータ

  • ajaxSearch
    AjaxSearchを使用するかしないか。デフォルトはする(1)。
  • AS_landing
    AjaxSearchを使用しない時に、結果を表示するドキュメントID。
    結果のページにスニペットコール([!AjaxSearch!])を記述しておきます。
  • moreResultPage
    AjaxSearchで「全ての検索結果を見る」をクリックした時に表示されるドキュメントID。
    AS_landing同様スニペットコールを記述しておきます。
  • showMoreResults
    検索結果が ajaxMax よりも多い場合に「全ての検索結果を見る」を挿入するかどうか。
    デフォルトはしない(0)。
  • addJscript
    AjaxSearchに必須のJavascriptライブラリを読み込むかどうか。
    デフォルトは読み込む(1)。読み込まない場合は、別途テンプレートなどで読み込んでおく必要がある。
  • extract
    検索結果の文中で検索キーワードをハイライト表示するかどうか。
    デフォルトはsuru(1)。
    ハイライト表示をするように設定すると、キーワードを<span class=”AS_ajax_highlight”>で囲むので、別途CSSで装飾するとよい。
  • AS_showResults
    AjaxSearchを使用せず、AS_landingも指定されていない場合に、検索結果を表示するかどうか。
    デフォルトは表示する(1)。
  • AS_showForm
    検索用のフォームを挿入するかどうか。デフォルトは挿入する(1)。
  • ajaxMax
    ajaxSearchで表示する最大検索結果数。
  • grabMax
    ajaxSearchを使用しない場合の最大検索結果数。
    このセット以上の検索結果がある場合は、ページナビゲーションが挿入される。
  • moreResultsText
    「全ての検索結果を見る」などの文字列を指定する。
    デフォルトは、「Click here to view all results」。

検索結果が無い(0件)の場合など、テキストを変更する箇所がいくつかあります。
それらのテキストの変更は、/assets/snippets/AjaxSearch/lang/japanese-utf8.inc.php を変更します。

また、環境によって、2バイト文字の検索に失敗する場合があります。

AjaxSearch 1.7 でオプション追加

  • parents
    検索する親ドキュメントのIDをカンマ区切りで指定。次のdepthとあわせて使用。デフォルトは全てのドキュメント。
  • depth
    検索する階層の深さを指定。デフォルトは全ての階層。
  • documents
    検索するドキュメントのIDをカンマ区切りで指定。
  • extractLength
    検索キーワード周辺の文字列を何文字まで結果に表示するか、80から800までで指定。デフォルトは(200)。
  • opacity
    ajaxSearchの結果表示DIVの透明度を0から1で指定(小数点の使用も可能)。デフォルトは(1)。
  • useAllWords
    全てのキーワードを含めるかどうか。デフォルトは(0)。
  • config
    設定をファイルで指定。設定ファイルは「<config_name>.config.php」という名前で、configsフォルダにアップロードしておきます。使用する場合は、<config_name>でファイル名を指定。