mirror of
https://github.com/Codappix/search_core.git
synced 2024-11-22 20:36:10 +01:00
TASK: Update docs
* Cover new features and how to use them.
This commit is contained in:
parent
18b7f2d8b1
commit
dfed17bb6c
3 changed files with 69 additions and 0 deletions
41
Documentation/source/features.rst
Normal file
41
Documentation/source/features.rst
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
.. _features:
|
||||||
|
|
||||||
|
Features
|
||||||
|
========
|
||||||
|
|
||||||
|
The following features are currently provided:
|
||||||
|
|
||||||
|
.. _features_indexing:
|
||||||
|
|
||||||
|
Indexing
|
||||||
|
--------
|
||||||
|
|
||||||
|
Indexing data to Elasticsearch is provided. The extension delivers an indexer for TCA with zero
|
||||||
|
configuration needs. Still it's possible to configure the indexer.
|
||||||
|
|
||||||
|
Own indexer are not possible yet, but will.
|
||||||
|
|
||||||
|
.. _features_search:
|
||||||
|
|
||||||
|
Searching
|
||||||
|
---------
|
||||||
|
|
||||||
|
Currently all fields are searched for a single search input.
|
||||||
|
|
||||||
|
Also multiple filter are supported. Filtering results by fields for string contents.
|
||||||
|
|
||||||
|
.. _features_planned:
|
||||||
|
|
||||||
|
Planned
|
||||||
|
---------
|
||||||
|
|
||||||
|
The following features are currently planned and will be integrated:
|
||||||
|
|
||||||
|
#. Mapping Configuration
|
||||||
|
Allowing to configure the whole mapping, to define type of input, e.g. integer, keyword.
|
||||||
|
|
||||||
|
|
||||||
|
#. Facets / Aggregates
|
||||||
|
Based on the mapping configuration, facets will be configurable and fetched. Therefore mapping is
|
||||||
|
required and we will adjust the result set to be of a custom model providing all information in a
|
||||||
|
more clean way.
|
|
@ -7,6 +7,7 @@ Table of Contents
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:glob:
|
:glob:
|
||||||
|
|
||||||
|
features
|
||||||
installation
|
installation
|
||||||
configuration
|
configuration
|
||||||
usage
|
usage
|
||||||
|
|
|
@ -37,3 +37,30 @@ Searching / Frontend Plugin
|
||||||
|
|
||||||
To provide a search interface you can insert the frontend Plugin as normal content element of type
|
To provide a search interface you can insert the frontend Plugin as normal content element of type
|
||||||
plugin. The plugin is named *Search Core*.
|
plugin. The plugin is named *Search Core*.
|
||||||
|
|
||||||
|
Please provide your own template, the extension will not deliver a useful template for now.
|
||||||
|
|
||||||
|
The extbase mapping is used, this way you can create a form:
|
||||||
|
|
||||||
|
.. code-block:: html
|
||||||
|
|
||||||
|
<f:form name="searchRequest" object="{searchRequest}">
|
||||||
|
<f:form.textfield property="query" />
|
||||||
|
<f:form.submit value="search" />
|
||||||
|
</f:form>
|
||||||
|
|
||||||
|
.. _usage_searching_filter:
|
||||||
|
|
||||||
|
Filter
|
||||||
|
""""""
|
||||||
|
|
||||||
|
Thanks to extbase mapping, filter are added to the form:
|
||||||
|
|
||||||
|
.. code-block:: html
|
||||||
|
:emphasize-lines: 3
|
||||||
|
|
||||||
|
<f:form name="searchRequest" object="{searchRequest}">
|
||||||
|
<f:form.textfield property="query" />
|
||||||
|
<f:form.textfield property="filter.exampleName" value="the value to match" />
|
||||||
|
<f:form.submit value="search" />
|
||||||
|
</f:form>
|
||||||
|
|
Loading…
Reference in a new issue