Jump to main content Jump to doc navigation

SimpleSearch

Other versions: 3.x — Found a problem? Please edit this page or report an issue.

What is SimpleSearch?

SimpleSearch is a simple search component for MODX Revolution. It supports searching Resource content and TV content.

Requirements

  • MODX Revolution 2.0.0-RC-2 or later
  • PHP5 or later

History

SimpleSearch was written by Shaun McCormick as a simple search component, and first released on June 2nd, 2010. It is loosely based on AjaxSearch for MODX Evolution by KyleJ/coroico, without the Ajax functionality.

Upgrade risks

First of all: ALWAYS MAKE A BACKUP BEFORE UPDATING!

Upgrading to 2.0.0 from 1.* is highly recommended, but it does introduce some risks.

Important changes from 1.* to 2.0.0:

  • The namespace has been changed from sisea to simplesearch. If you're using custom System Settings, then please migrate them.
  • The ElasticSearch and SOLR drivers have been removed, because they were in need of improvements. Future drivers should be seperate addons. Feel free to ask us for help here.

Download

It can be downloaded from within the MODX Revolution manager via Package Management, or from the MODX Extras Repository, here: http://modxcms.com/extras/package/683

Development and Bug Reporting

SimpleSearch is stored and developed in GitHub, and can be found here:https://github.com/Sterc/SimpleSearch

Bugs can be filed here: https://github.com/Sterc/SimpleSearch/issues

Usage

SimpleSearch has 2 snippets - one to display a form ("SimpleSearchForm"), and the other to display search results ("SimpleSearch").

Examples

Display a search form, and below it, the results:

[[!SimpleSearchForm]]

<h2>Results</h2>
[[!SimpleSearch]]

Display a Search form that sends you to a results page in Resource 123 (which has the SimpleSearch call in it):

[[!SimpleSearchForm? &landing=`123`]]

See Also

  1. SimpleSearch.Roadmap
  2. SimpleSearch.SimpleSearch
    1. SimpleSearch.SimpleSearch.containerTpl
    2. SimpleSearch.SimpleSearch.currentPageTpl
    3. SimpleSearch.SimpleSearch.pageTpl
    4. SimpleSearch.SimpleSearch.tpl
    5. SimpleSearch.Faceted Search Through PostHooks
  3. SimpleSearch.SimpleSearchForm
    1. SimpleSearch.SimpleSearchForm.tpl
  4. SimpleSearch.Solr