10 votes

Epiphany SearchBoost (1)

SearchBoost is a project that will allow you to configure your Examine indexes to automatically boost certain DocTypes in your indexes, according to certain rules. So, for example you can make news articles appear higher in the search, or make it so that content that is less than a week old shows up higher in search results than older content.

The package installs a DLL and config file called "searchBoost.config". In this file you can define one or more rule sets that apply to the various indexes on your site. The syntax for each ruleset is:

 

<ruleSet indexName="" stackBoosts="">
    <rule docTypeAliases="" nodeIds="" boostAmount="" boostIfNewerThan="" dateField="" />
</ruleSet>

The properties are as follows:

 

ruleSet - this is a set of rules that apply to a specific index set, you can set the following properties:

 

  • indexName - the name of the indexer, taken from the "ExamineSettings.config" file, e.g. "InternalIndexer"
  • stackBoosts - (true/false) whether boosts should stack, if true, all matching boost amounts are added together, if false (the default) then only the highest matching boost is used
You may define as many ruleSets as you like. You should only have one ruleSet per index however. Each ruleSet can have any number of rules, which have the following properties:

 

 

  • docTypeAliases - a comma separated list of DocType aliases to match, you can specify a wildcard match by entering "*" as the value
  • nodeIds - a comma separated list of node ids to match against
  • boostAmount - the amount to boost matching documents by
  • boostIfNewerThan - if set to greater than 0, it will only apply the rule if the dateField you specify if within the last X days, where X is the value of this setting
  • dateField - the name of the field that contains the date to check for boostIfNewerThan
Set up the rules for the indexes, re-index your site, and you should be good to go. The package works by boostng the Lucene Documents for the items that match the rules. For some great information on boosting, see Ismail's blog post: http://thecogworks.co.uk/blog/posts/2012/november/examiness-hints-and-tips-from-the-trenches-part-3/

 

 

 

Screenshots

Package owner

Tim

Tim

Tim has 2653 karma points

Package Compatibility

This package is compatible with the following versions as reported by community members who have downloaded this package:
Untested or doesn't work on Umbraco Cloud
8.3.x (untested)
8.2.x (untested)
8.1.x (untested)
8.0.x (untested)
7.15.x (untested)
7.14.x (untested)
7.13.x (untested)
7.12.x (untested)
7.11.x (untested)
7.10.x (untested)
7.9.x (untested)
7.8.x (untested)
7.7.x (untested)
7.6.x (untested)
7.5.x (untested)
7.4.x (untested)
7.3.x (untested)
7.2.x (untested)
7.1.x (untested)
7.0.x (untested)
6.1.x (untested)
6.0.x (untested)

You must login before you can report on package compatibility.

Package Information

  • Package owner: Tim
  • Contributors: Drew , Ryan Lewis
  • Created: 21/02/2013
  • Current version 1.0
  • License MIT
  • Downloads: 1237