Merge pull request #163 from Flowpack/daniellienert-patch-1

TASK: Update Readme

Author: daniellienert

README.md

@@ -6,32 +6,31 @@
 
 Created by Sebastian Kurfürst; [contributions by Karsten Dambekalns, Robert Lemke and others](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/graphs/contributors).
 
-This project connects the Neos Content Repository (TYPO3CR) to Elasticsearch; enabling two main functionalities:
+This project connects the Neos Content Repository to Elasticsearch; enabling two main functionalities:
 
-* finding Nodes in TypoScript / Eel by arbitrary queries
+* finding Nodes in Fusion / Eel by arbitrary queries
 * Full-Text Indexing of Pages and other Documents (of course including the full content)
 
 ## Relevant Packages
 
-* [TYPO3.TYPO3CR.Search](https://www.neos.io/download-and-extend/packages/typo3/typo3-typo3cr-search.html): provides common functionality for searching TYPO3CR nodes,
+* [Neos.ContentRepository.Search](https://www.neos.io/download-and-extend/packages/typo3/typo3-typo3cr-search.html): provides common functionality for searching Neos Content Repository nodes,
   does not contain a search backend
 * [Flowpack.ElasticSearch](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-elasticsearch.html): provides common code for working with Elasticsearch
 * [Flowpack.ElasticSearch.ContentRepositoryAdaptor](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-elasticsearch-contentrepositoryadaptor.html): this package
-* [Flowpack.SimpleSearch.ContentRepositoryAdaptor](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-simplesearch-contentrepositoryadaptor.html): an alternative search backend (to be used
-  instead of this package); storing the search index in SQLite
+* [Flowpack.SimpleSearch.ContentRepositoryAdaptor](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-simplesearch-contentrepositoryadaptor.html): an alternative search backend (to be used instead of this package); storing the search index in SQLite
 * [Flowpack.SearchPlugin](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-searchplugin.html): search plugin for Neos
 
 
 ## Installation
 
 ```
-composer require 'typo3/typo3cr-search'
+composer require 'neos/content-repository-search'
 composer require 'flowpack/elasticsearch-contentrepositoryadaptor'
 
 composer require 'flowpack/searchplugin'
 ```
 
-Now, add the routes as described in the [README of Flowpack.SearchPlugin](https://github.com/skurfuerst/Flowpack.SearchPlugin)
+Now, add the routes as described in the [README of Flowpack.SearchPlugin](https://github.com/Flowpack/Flowpack.SearchPlugin)
 as the **first route** in Configuration/Routes.yaml.
 
 Then, ensure to update `<your-elasticsearch>/config/elasticsearch.yml` as explained below; then start Elasticsearch.
@@ -96,7 +95,7 @@ If you use multiple client configurations, please change the *default* key just
 
 ## Doing Arbitrary Queries
 
-We'll first show how to do arbitrary Elasticsearch Queries in TypoScript. This is a more powerful
+We'll first show how to do arbitrary Elasticsearch Queries in Fusion. This is a more powerful
 alternative to FlowQuery. In the long run, we might be able to integrate this API back into FlowQuery,
 but for now it works well as-is.
 
@@ -153,25 +152,25 @@ In order to debug the query more easily, the following operation is helpful:
 Use Case: On a "Tag Overview" page, you want to show all pages being tagged in a certain way
 
 Setup: You have two node types in a blog called `Acme.Blog:Post` and `Acme.Blog:Tag`, both
-inheriting from `TYPO3.Neos:Document`. The `Post` node type has a property `tags` which is
+inheriting from `Neos.Neos:Document`. The `Post` node type has a property `tags` which is
 of type `references`, pointing to `Tag` documents.
 
-TypoScript setup:
+Fusion setup:
 
 ```
  # for "Tag" documents, replace the main content area.
-prototype(TYPO3.Neos:PrimaryContent).acmeBlogTag {
+prototype(Neos.Neos:PrimaryContent).acmeBlogTag {
 	condition = ${q(node).is('[instanceof Acme.Blog:Tag]')}
 	type = 'Acme.Blog:TagPage'
 }
 
  # The "TagPage"
-prototype(Acme.Blog:TagPage) < prototype(TYPO3.TypoScript:Collection) {
+prototype(Acme.Blog:TagPage) < prototype(Neos.Fusion:Collection) {
 	collection = ${Search.query(site).nodeType('Acme.Blog:Post').exactMatch('tags', node).sortDesc('creationDate').execute()}
 	itemName = 'node'
 	itemRenderer = Acme.Blog:SingleTag
 }
-prototype(Acme.Blog:SingleTag) < prototype(TYPO3.Neos:Template) {
+prototype(Acme.Blog:SingleTag) < prototype(Neos.Neos:Template) {
 	...
 }
 ```
@@ -239,8 +238,8 @@ fieldBasedAggregation("anotherAggregation", "field", "avg", "colors.avgprice")
 To add a custom aggregation you can use the `aggregation()` method. All you have to do is to provide an array with your
 aggregation definition. This example would do the same as the fieldBasedAggregation would do for you:
 ```
-aggregationDefinition = TYPO3.TypoScript:RawArray {
-	terms = TYPO3.TypoScript:RawArray {
+aggregationDefinition = Neos.Fusion:RawArray {
+	terms = Neos.Fusion:RawArray {
 		field = "color"
 	}
 }
@@ -254,11 +253,11 @@ an NodeTye ProductList with an property `products`. This property contains a com
 be a reference on other products.
 
 ```
-prototype(Vendor.Name:FilteredProductList) < prototype(TYPO3.Neos:Content)
+prototype(Vendor.Name:FilteredProductList) < prototype(Neos.Neos:Content)
 prototype(Vendor.Name:FilteredProductList) {
 
 	// Create SearchFilter for products
-	searchFilter = TYPO3.TypoScript:RawArray {
+	searchFilter = Neos.Fusion:RawArray {
 		sku = ${String.split(q(node).property("products"), ",")}
 	}
 
@@ -330,9 +329,9 @@ nodes = ${q(Search.query(site).....sortAsc("title").sortDesc("name").execute())}
 
 # Custom sort operation
 
-geoSorting = TYPO3.TypoScript:RawArray {
-    _geo_distance = TYPO3.TypoScript:RawArray {
-        latlng = TYPO3.TypoScript:RawArray {
+geoSorting = Neos.Fusion:RawArray {
+    _geo_distance = Neos.Fusion:RawArray {
+        latlng = Neos.Fusion:RawArray {
             lat = 51.512711
             lon = 7.453084
         }
@@ -365,9 +364,9 @@ First of all you have to define a property in your NodeTypes.yaml for your node
 
 Query your nodes in your TypoScript:
 ```
-geoSorting = TYPO3.TypoScript:RawArray {
-    _geo_distance = TYPO3.TypoScript:RawArray {
-        latlng = TYPO3.TypoScript:RawArray {
+geoSorting = Neos.Fusion:RawArray {
+    _geo_distance = Neos.Fusion:RawArray {
+        latlng = Neos.Fusion:RawArray {
             lat = 51.512711
             lon = 7.453084
         }
@@ -392,8 +391,8 @@ the `GetHitArrayForNodeViewHelper`:
 
 ```
 
-The ViewHelper will use \TYPO3\Flow\Utility\Arrays::getValueByPath() to return a specified path. So you can make use
-of an array or a string. Check the documentation \TYPO3\Flow\Utility\Arrays::getValueByPath() for more informations.
+The ViewHelper will use \Neos\Utility\Arrays::getValueByPath() to return a specified path. So you can make use
+of an array or a string. Check the documentation \Neos\Utility\Arrays::getValueByPath() for more information.
 
 **Important notice**
 
@@ -421,7 +420,7 @@ and finally one for the plain text (`__fulltext.text`). All of these fields add
 Elasticsearch `_all` field, and are configured with different `boost` values.
 
 In order to search this index, you can just search inside the `_all` field with an additional limitation
-of `__typeAndSupertypes` containing `TYPO3.Neos:Document`.
+of `__typeAndSupertypes` containing `Neos.Neos:Document`.
 
 **For a search user interface, checkout the Flowpack.SearchPlugin package**
 
@@ -459,10 +458,10 @@ You can access your suggestions inside your fluid template with
 Phrase query that returns query suggestions
 
 ```
-suggestionsQueryDefinition = TYPO3.TypoScript:RawArray {
+suggestionsQueryDefinition = Neos.Fusion:RawArray {
     text = 'some Text'
-    simple_phrase = TYPO3.TypoScript:RawArray {
-        phrase = TYPO3.TypoScript:RawArray {
+    simple_phrase = Neos.Fusion:RawArray {
+        phrase = Neos.Fusion:RawArray {
             analyzer = 'body'
             field = 'bigram'
             size = 1
@@ -480,7 +479,7 @@ suggestions = ${Search.query(site)...suggestions('my_suggestions', this.suggesti
 with sane defaults for all Neos data types.**
 
 Indexing of properties is configured at two places. The defaults per-data-type are configured
-inside `TYPO3.TYPO3CR.Search.defaultConfigurationPerType` of `Settings.yaml`.
+inside `Neos.ContentRepository.Search.defaultConfigurationPerType` of `Settings.yaml`.
 Furthermore, this can be overridden using the `properties.[....].search` path inside
 `NodeTypes.yaml`.
 
@@ -493,8 +492,8 @@ This configuration contains two parts:
 Example (from the default configuration):
 ```
  # Settings.yaml
-TYPO3:
-  TYPO3CR:
+Neos:
+  ContentRepository:
     Search:
       defaultConfigurationPerType:
 
@@ -509,7 +508,7 @@ TYPO3:
 
 ```
  # NodeTypes.yaml
-'TYPO3.Neos:Timable':
+'Neos.Neos:Timable':
   properties:
     '_hiddenBeforeDateTime':
       search:
@@ -545,7 +544,7 @@ In order to enable fulltext indexing, every `Document` node must be configured a
 the following is configured in the default configuration:
 
 ```
-'TYPO3.Neos:Document':
+'Neos.Neos:Document':
   search:
     fulltext:
       isRoot: true
@@ -560,7 +559,7 @@ in `NodeTypes.yaml` at `properties.[propertyName].search.fulltextExtractor`.
 An example:
 
 ```
-'TYPO3.Neos.NodeTypes:Text':
+'Neos.Neos.NodeTypes:Text':
   properties:
     'text':
       search:
@@ -614,17 +613,17 @@ If you want to index attachments, you need to install the [Elasticsearch Attachm
 Then, you can add the following to your `Settings.yaml`:
 
 ```
-TYPO3:
-  TYPO3CR:
+Neos:
+  ContentRepository:
     Search:
       defaultConfigurationPerType:
-        'TYPO3\Media\Domain\Model\Asset':
+        'Neos\Media\Domain\Model\Asset':
           elasticSearchMapping:
             type: attachment
             include_in_all: true
           indexing: ${Indexing.indexAsset(value)}
 
-        'array<TYPO3\Media\Domain\Model\Asset>':
+        'array<Neos\Media\Domain\Model\Asset>':
           elasticSearchMapping:
             type: attachment
             include_in_all: true
@@ -644,7 +643,7 @@ Flowpack:
   ElasticSearch:
     indexes:
       default:
-        'typo3cr': # This index name must be the same as in the TYPO3.TYPO3CR.Search.elasticSearch.indexName setting
+        'neoscontentrepository': # This index name must be the same as in the Neos.ContentRepository.Search.elasticSearch.indexName setting
           analysis:
             filter:
               elision:
@@ -663,7 +662,7 @@ Then, you can change the analyzers on a per-field level; or e.g. reconfigure the
 in the NodeTypes.yaml. Generally this works by defining the global mapping at `[nodeType].search.elasticSearchMapping`:
 
 ```
-'TYPO3.Neos:Node':
+'Neos.Neos:Node':
   search:
     elasticSearchMapping:
       _all:
@@ -684,7 +683,7 @@ In order to understand what's going on, the following commands are helpful:
 ## Version 2 vs Version 1
 
 * Version 1 is the initial, productive version of the Neos Elasticsearch adapter.
-* Version 2 has a dependency on TYPO3.TYPO3CR.Search; which contains base functionality
+* Version 2 has a dependency on Neos.ContentRepository.Search; which contains base functionality
   which is also relevant for other search implementations (like the SQLite based SimpleSearch).
 
 The configuration from Version 1 to Version 2 has changed; here's what to change:
@@ -693,7 +692,7 @@ The configuration from Version 1 to Version 2 has changed; here's what to change
 **Settings.yaml**
 
 1. Change the base namespace for configuration from `Flowpack.ElasticSearch.ContentRepositoryAdaptor`
-   to `TYPO3.TYPO3CR.Search`. All further adjustments are made underneath this namespace:
+   to `Neos.ContentRepository.Search`. All further adjustments are made underneath this namespace:
 2. (If it exists in your configuration:) Move `indexName` to `elasticSearch.indexName`
 3. (If it exists in your configuration:) Move `log` to `elasticSearch.log`
 4. search for `mapping` (inside `defaultConfigurationPerType.<typeName>`) and replace it by
@@ -709,4 +708,3 @@ The configuration from Version 1 to Version 2 has changed; here's what to change
    `elasticSearchMapping`.
 3. Replace `ElasticSeach.fulltext` by `Indexing`
 4. Search for `ElasticSearch.` (inside the `indexing` expressions) and replace them by `Indexing.`
-