Tipue London
Home

Products

Blog

Support

About
Close

Tipue Search

Tipue Search is an open source site search engine jQuery plugin

Download

Tipue Search documentation

Version 6.1

Options

The options for Tipue Search are held in tipuesearch_set.js and also set as arguments in the tipuesearch() method.

Options in tipuesearch_set.js

Stop words are common words filtered out of the search query. These are held in tipuesearch_stop_words, a simple JavaScript array. Items should be lowercase.

Word replace is designed to replace frequently misspelled searches on your site. These are held in tipuesearch_replace as a JavaScript object.

JS
Words rather than phrases are replaced, so no spaces are allowed. Items should be lowercase.

You can bump the search weighting for each page in the tipuesearch_weight object, with plus and minus values allowed. The url value must be the same as the url value in Static mode, and the tipuesearch_pages value in Live mode.

JS
The tipuesearch_stem object allows the use of synonyms as well as the more traditional word stemming. If the word is found in the search query, the stem is silently added to the search.
JS
Words rather than phrases are included, so again no spaces and everything should be lowercase.

You can show related searches in the The tipuesearch_related object. These are search terms related to the search query. There are optional properties for before and after, these show text before and after the related search but are not included in the search.

JS
Words rather than phrases are included, so again no spaces and everything should be lowercase.

Last but not least, tipuesearch_set.js contains a list of internal strings for multilingual support.

Options in the .tipuesearch() method

Other settings for Tipue Search are set as arguments in the tipuesearch() method.
HTML
contentLocation

The location for the JSON file if using JSON mode. The default is 'tipuesearch/tipuesearch_content.json'.

contextBuffer

The number of characters displayed before the search term in context, if showContext is true. The default is 60.

contextLength

The minimum number of characters displayed if showContext is true. The default is 60.

contextStart

The starting position in the descriptive text before the search term is shown in context, if showContext is true. The default is 90 characters.

debug

The score for each search result is displayed if set to true. The default is false.

descriptiveWords

The number of words displayed in the descriptive text in the search search. The default is 25.

highlightTerms

Search terms are highlighted if set to true. The default is true.

liveContent

In Live mode, the element containing the content to be searched. The default is '*'.

liveDescription

In Live mode, the element containing the descriptive text. The default is '*'.

minimumLength

The minimum length of characters in a search query. The default is 3.

mode

The mode for loading content. The value can be 'static', 'live' or 'json'. The default is 'static'.

newWindow

The search result opens in a new browser tab if set to true. The default is false.

show

The number of results displayed. The default is 9.

showContext

The search term is shown in context in the descriptive text if set to true. The default is true.

showTime

The time taken for the search to complete is displayed in tenths of a second. The default is true.

showTitleCount

The number of search results is displayed in the document title if set to true. The default is true.

showURL

The URL is displayed in each search result if set to true. The default is true.

wholeWords

Searches for whole words if set to true. The default is true. wholeWords is English language only. If you're using a language other than English, wholeWords should be set to false.

© 2017, Tipue. Made in London.
Privacy  T&Cs