!!! TASK: Remove default autocomplete setup

This removes the default addition of the AutocompletableMixin and the
SuggestableMixin from the package, as well as the analyzer setup done
in the settings.

Instead the README is amended with instructions on how to use this.

This avoids errors when using a custom index name.

Author: kdambekalns

Configuration/NodeTypes.yaml

@@ -4,18 +4,3 @@
   ui:
     label: 'Search'
     icon: 'icon-search'
-
-'Neos.Neos:Document':
-  superTypes:
-    'Flowpack.SearchPlugin:SuggestableMixin': true
-    'Flowpack.SearchPlugin:AutocompletableMixin': true
-
-'Neos.Neos:Shortcut':
-  superTypes:
-    'Flowpack.SearchPlugin:SuggestableMixin': false
-    'Flowpack.SearchPlugin:AutocompletableMixin': false
-
-'Neos.NodeTypes:TitleMixin':
-  superTypes:
-    'Flowpack.SearchPlugin:SuggestableMixin': true
-    'Flowpack.SearchPlugin:AutocompletableMixin': true

Configuration/Settings.yaml

@@ -15,21 +15,3 @@ Neos:
     Search:
       defaultContext:
         Flowpack.SearchPlugin.Suggestion: Flowpack\SearchPlugin\EelHelper\SuggestionIndexHelper
-
-Flowpack:
-  ElasticSearch:
-    indexes:
-      default:
-        typo3cr:
-          analysis:
-            filter:
-              autocompleteFilter:
-                max_shingle_size: 5
-                min_shingle_size: 2
-                type: 'shingle'
-            analyzer:
-              autocomplete:
-                filter: [ 'lowercase', 'autocompleteFilter' ]
-                char_filter: [ 'html_strip' ]
-                type: 'custom'
-                tokenizer: 'standard'

README.md

@@ -33,27 +33,6 @@ To specify a custom index name, the following is needed:
         Search:
           elasticSearch:
             indexName: acmecom
-    
-    Flowpack:
-      ElasticSearch:
-        indexes:
-          default:      # client name used to connect (see Flowpack.ElasticSearch.clients)
-            acmecom:    # custom index name
-              analysis:
-                filter:
-                  autocompleteFilter:
-                    max_shingle_size: 5
-                    min_shingle_size: 2
-                    type: 'shingle'
-                analyzer:
-                  autocomplete:
-                    filter: [ 'lowercase', 'autocompleteFilter' ]
-                    char_filter: [ 'html_strip' ]
-                    type: 'custom'
-                    tokenizer: 'standard'
-
-The latter is the custom analysis configuration used by the completion / suggestion and must be
-repeated for a custom index name.
 
 ### Pagination 
 
@@ -80,9 +59,50 @@ Feel free to use the `DocumentSearchResult.html` in the Flowpack.SearchPlugin as
 ## Search completions and suggestions
 
 The default search form template comes with a `data-autocomplete-source` attribute pointing to the 
-`SuggestController` of this package. Fed with a `term` parameter via a `GET` request, it returns a
-JSON-encoded array of suggestions from Elasticsearch. These are fetched with a term suggester from
-the `_all` field, i.e. "the fulltext index".
+`SuggestController` of this package.
+
+To use this term suggester, you need to configure the indexing like this, to define a custom
+analyzer to be used:
+
+    Flowpack:
+      ElasticSearch:
+        indexes:
+          default:      # client name used to connect (see Flowpack.ElasticSearch.clients)
+            acmecom:    # your (custom) index name
+              analysis:
+                filter:
+                  autocompleteFilter:
+                    max_shingle_size: 5
+                    min_shingle_size: 2
+                    type: 'shingle'
+                analyzer:
+                  autocomplete:
+                    filter: [ 'lowercase', 'autocompleteFilter' ]
+                    char_filter: [ 'html_strip' ]
+                    type: 'custom'
+                    tokenizer: 'standard'
+
+Then you need to configure the node types to be be included in the suggestion building, this can be
+done like this:
+
+    'Neos.Neos:Document':
+      superTypes:
+        'Flowpack.SearchPlugin:SuggestableMixin': true
+        'Flowpack.SearchPlugin:AutocompletableMixin': true
+    
+    'Neos.Neos:Shortcut':
+      superTypes:
+        'Flowpack.SearchPlugin:SuggestableMixin': false
+        'Flowpack.SearchPlugin:AutocompletableMixin': false
+    
+    'Neos.NodeTypes:TitleMixin':
+      superTypes:
+        'Flowpack.SearchPlugin:SuggestableMixin': true
+        'Flowpack.SearchPlugin:AutocompletableMixin': true
+
+When fed with a `term` parameter via a `GET` request, the `SuggestController` will return a
+JSON-encoded array of suggestions from Elasticsearch. They are fetched with a term suggester
+from the `_all` field, i.e. "the fulltext index".
 
 These can be used to provide autocompletion on the search input using a JS library of your choice.
 In case you need to build the URI to the suggest controller yourself, this is what the form uses: