Quick start

Follow the steps below to set up a simple fulltext search for your pages. In order to use the faceting feature see "Faceting".

Download and installation

Install the extension ke_search via extension manager or via composer (recommended):

composer require tpwd/ke_search
Copied!

You can find the current version (and older ones) at

https://extensions.typo3.org/extension/ke_search

Include TypoScript

Site Sets

New in version TYPO3 v13.1 / ke_search v6.3.0

The extension ships some TypoScript code which can be included in the site configuration via Site sets:

  1. Got to backend module Site Management > Sites.
  2. Edit the configuration of your site.
  3. On the first tab go to Sets for this Site.
  4. Include the set Faceted Search (ke_search).

TypoScript sets (the traditional way)

If you are not using Site Sets you can add the TypoScript via the TypoScript module (formerly known as "Include static template"):

  1. Got to backend module Site Management > TypoScript.
  2. Select Edit TypoScript record --> Edit the whole TypoScript record.
  3. On the first tab go to Include TypoScript sets.
  4. Include the set Faceted Search (ke_search).

Create pages

Create a new page called "Search" (or similar) and a sysfolder called "Search data" (or similar).

Page tree with search page

Configure Plugins

You need to create two plugins: The searchbox and the resultlist.

Faceted Search plugin in new content element wizard
  1. Create a plugin Faceted Search: Show searchbox and filters on the page Search

    Fill in the field Record Storage Page in the Tab Plugin > General with the folder that you created in step 2 (our example: Search data).

    Plugin tab on "searchbox and filters" plugin
  2. Create a plugin Faceted Search: Show resultlist on the page Search

    In the field Load FlexForm config from this search box fill in the Search-Plug-In that you created in the previous step (our example: Searchbox).

    Plugin tab

    After this steps, you should have two plugins on your search page.

    Page module view with two Faceted Search plugins

Create the indexer configuration

Use the List module to create an indexer configuration on the page Search data.

New record view
  • Choose a title.
  • Set the Type to Pages.
  • Set the Storage to your folder Search data.
  • Choose the pages you wish to index. You can decide whether the indexing process runs on all pages recursively or if only one page will be indexed. You can combine both fields.
Example for an indexer configuration

Start Indexer

Open the backend module Web > Faceted Search and start the indexing process.

Backend module view

You're done!

Open the Search page in the frontend and start finding ...