Work-Related/search_core
Work-Related/search_core
1
0
mirror of https://github.com/Codappix/search_core.git synced 2024-12-22 19:56:10 +01:00
Code Releases Activity

TASK: Update docs

Browse source 
* Cover new features and how to use them.
This commit is contained in:
Daniel Siepmann 2017-06-29 08:42:38 +02:00
parent 18b7f2d8b1
commit dfed17bb6c
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
3 changed files with 69 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
Documentation/source/features.rst Normal file
View 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.

1
Documentation/source/index.rst
View file

@ -7,6 +7,7 @@ Table of Contents
:maxdepth: 1
:glob:
features
installation
configuration
usage

27
Documentation/source/usage.rst
View file

@ -37,3 +37,30 @@ Searching / Frontend Plugin
To provide a search interface you can insert the frontend Plugin as normal content element of type
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>