adrexia/staticsearch

There is no license information available for the latest version (0.1) of this package.

Static Search provides an alternative search option to statically published silverstripe sites

Installs: 95

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 1

Forks: 2

Open Issues: 1

Language:JavaScript

Type:silverstripe-module

0.1 2015-05-27 08:28 UTC

This package is auto-updated.

Last update: 2021-04-06 08:20:23 UTC


README

An implementation of Tipue search designed to work in SilverStripe with the Static Publish Queue module. This implementation uses the static mode of Tipue search.

This module works with:

  • subsites (optional)
  • static publish queue (mandatory)

Approach

  • Extension to SiteTree to add methods that generate data for searchable fields. These can be overridden at Page level if necessary.
  • Build Task to generate json index files for each subsite (stored in the cache directory).
  • Basic implementation of Tipue JavaScript search, in static mode.
  • Search page controller to hold results of search (filled in by JavaScript search)

JSON Format:

{  
     "title": "page title",  
     "text":"Prepped page content",  
     "tags":"Taxonomy or meta description",  
     "loc":"Page URL"  
}

Set-up

Get the code

Add this to your composer.json file:

"adrexia/staticsearch": "dev-master"

Update your repo:

composer update

Integration

Add the search form to your page:

<% include StaticSearchForm %>

Include StaticSearchRequirements in the head of your page.

<% include StaticSearchRequirements %>

If you like, copy StaticSearchRequirements.ss to your theme, and override with any customized files. These files are only needed for the search page itself. Read the Tipue docs if you experience any issues with the search itself. It can be a bit particular about its set up.

http://www.tipue.com/search/docs/

If you want to make the searchpage fit your site design, copy SearchPage.ss to your theme folder. There is base css provided in staticsearch/css/tipuesearch.css. You can use this as is, or replace with your own css.

Customization of results

Methods generating the data for the json files live in staticsearch/code/extensions/StaticSearchSiteTreeExtension.php. You can override these methods at Page level (e.g. in Page.php). You may wish to have a smaller range of data appear, or you might want to index data objects as content on a page.

These methods can be overridden at Page level. It is suggested that if you are working with larger statically published sites, you use the tagging system (see getSearchableTags()) as the main search mechanism, and limit the content block to a simple abstract.

Generate results

Run the BuildStaticSearchIndexTask to generate the search_index.json files (note, the static publish queue tasks must have been run at least once to generate the cache itself).

dev/tasks/BuildStaticSearchIndexTask

You probably want to set this task up to run once a day on your live site to update the search index.