Merge pull request #41 from Flowpack/add-completion-example

TASK: Add example for completion/suggestion result

Author: kdambekalns

README.md

@@ -1,6 +1,7 @@
 # Flowpack.SearchPlugin
 
 This plugin is a Search Plugin, to be used together with
+
 * [Flowpack.ElasticSearch.ContentRepositoryAdaptor](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor) or 
 * [Flowpack.SimpleSearch.ContentRepositoryAdaptor](https://github.com/Flowpack/Flowpack.SimpleSearch.ContentRepositoryAdaptor).
 
@@ -43,7 +44,7 @@ Thus you can easily adjust the rendering per type like this for an imaginary `Ac
 
 Feel free to use the `DocumentSearchResult.html` in the Flowpack.SearchPlugin as an example.
 
-## Search suggestions
+## 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
@@ -53,7 +54,47 @@ 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:
 
-    {f:uri.action(action: 'index', controller: 'Suggest', package: 'Flowpack.SearchPlugin', format: 'json', absolute: 1)}
+    {f:uri.action(action: 'index', controller: 'Suggest', package: 'Flowpack.SearchPlugin', format: 'json', absolute: 1, arguments: {contextNodeIdentifier: node.identifier, dimensionCombination: dimensionCombination})}
+
+The returned JSON looks like this (with a `term` of "content" after indexing the Neos demo site):
+
+    {
+      "completions": [
+        "content",
+        "content element",
+        "content in",
+        "content in neos",
+        "content in neos because",
+        "content in neos because you",
+        "content repository"
+      ],
+      "suggestions": [
+        {
+          "text": "995c9174-ddd6-4d5c-cfc0-1ffc82184677",
+          "score": 20,
+          "payload": {
+            "nodeIdentifier": "d17caff2-f50c-d30b-b735-9b9216de02e9"
+          }
+        },
+        {
+          "text": "a66ec7db-3459-b67b-7bcb-16e2508a89f0",
+          "score": 20,
+          "payload": {
+            "nodeIdentifier": "fd283257-9b12-8412-f922-6643ac818294"
+          }
+        },
+        {
+          "text": "a3474e1d-dd60-4a84-82b1-18d2f21891a3",
+          "score": 20,
+          "payload": {
+            "nodeIdentifier": "7eee2ee6-2a4e-5240-3674-2fb84a51900b"
+          }
+        }
+      ]
+    }
+
+The `completions` can be used to suggest search terms to the user. The `suggestions` contains
+"top search results" for the given term, the document they refer to is given in the `payload`.
 
 ## AJAX search