Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos and a few missing translations #74

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typos and a few missing translations #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions doc/user-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ In the end, you have access to ElasticSearch specific configuration parameters :

|Param Name|Description|
-----------|------------
|Facets Max Size|Maximum number of values to display into a facets <br /> **Note :** *This param applies only on term facet and is not used for prices, rating and categories facets.*|
|Facets Max Size|Maximum number of values to display into a facet <br /> **Note :** *This param applies only on term facet and is not used for prices, rating and categories facets.*|
|Enable Search on Options Labels|By default Magento searches only on option ids for select attributes. <br/> This setting allows to use their textual value into fulltext. <br/> Since there is no uses case where the default behavior is expected this setting will be removed from a future version and it's value will be yes by default.|
|Enable ICU Folding Token Filter|ES plugin filter used to clean UTF-8 invalid characters. This feature comes at the expense of the performances and should be enabled only if your catalog contains bad UTF-8 characters.|
|Enable Fuzzy Search|Enable the approching search. Used to automatically fix user mistyping. This feature replaces the traditionnal "Did you mean" feature into the module|
|Fuzzy Prefix Length, Fuzzy Min Similarity, Fuzzy Prefix Length, Fuzzy Max Expansions|Fuzzy search fine tunning. <br /> This parameters can be used to fix the fuzzy search behavior if it match too many or not enough products.<br />Full documentation for the params can be found into ElasticSearch official documentation : http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-flt-query.html|
|Fuzzy Prefix Length, Fuzzy Min Similarity, Fuzzy Prefix Length, Fuzzy Max Expansions|Fuzzy search fine tunning. <br /> These parameters can be used to fix the fuzzy search behavior if it matches too many or not enough products.<br />Full documentation for the params can be found into ElasticSearch official documentation : http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-flt-query.html|
|Fuzzy Query Boost|Relative weight of fuzzy search result. <br /> Exact matches have a weight of 1. <br /> The default value (0.3) will result approching result being 3 times less important than exact ones.|


Expand All @@ -40,9 +40,9 @@ In the end, you have access to ElasticSearch specific configuration parameters :
> Into our engine it is used to fix :

> * User mystipings (ex: frankenshten instead of frankenstein)
> * Give reponse for other form of a same word (ex: playing instead of play)
> * Give results for other form of a same word (ex: playing instead of play)
>
> It avoid the usage of a "Did you mean" feature by fixing the user query and consequently avoid an user click to refine it's query.
> It avoids the usage of a "Did you mean" feature by fixing the user query and consequently avoids an user click to refine his query.
>
> You can find a very complete documentation about possible implementation of fuzzy search into ES at this address : https://www.found.no/foundation/fuzzy-search/.
>
Expand All @@ -63,39 +63,39 @@ The main settings related to the search engines are :
|Param Name|Description|
-----------|------------
|Use in Quick Search|Indicates if the attributes has a role in search relevancy computation.|
|Search weight|Weight of the attributes into search relevancy.<br /> Typically we use higher score on product names than on it's description.|
|Search weight|Weight of the attributes into search relevancy.<br /> Typically we use higher score on product names than on its description.|
|Use in advanced search|Advanced search is not implemented. This settings is useless.|
|Use in layer navigation|Should the attribute be used as a facet into categories navigation|
|Use in search result layer|Should the attribute be used as a facet into search result|

**Notes :**
* This extension allows text attributes to be used as a facet (Magento only allows facets on select / multiselect attributes. Do this only on attributes that are imported from a clean source of data to avoid list which contains many times the same values with different typos (ex: "Robert De Niro" and "robert de Niro" will be two different facets).
* The attributes **Rating filter** is a vurtual attributes which allow to configure the rating facets and sort. You can change it's label per store view, show / hide the facet, manage the facet position or show / hide the sort order.
* This extension allows text attributes to be used as a facet (Magento only allows facets on select / multiselect attributes. Do this only on attributes that are imported from a clean source of data to avoid list which contains many times the same values with different typos (ex: "Robert De Niro" and "robert de Niro" will be two different values).
* The attribute **Rating filter** is a virtual attribute which allows to configure the rating facets and sort. You can change its label per store view, show / hide the facet, manage the facet position or show / hide the sort order.

Virtual categories
------------------

The module is shipped with interface allowing to configure Virtual Categories (sometimes called Smart Categories). The Virtual categories is a powerful mechanism allowing the admin to select product of a category by building a search engine query instead of picking the products one by one.
The module is shipped with interface allowing to configure Virtual Categories (sometimes called Smart Categories). The Virtual categories is a powerful mechanism allowing the admin to select products of a category by building a search engine query instead of picking the products one by one.

**Examples of Virtual Categories :**

* All blue products that are in stock into the category men
* All product of type "Blazer"
* All product having the containing the word "Kit" dans leur nom.
* All products of type "Blazer"
* All products containing the word "Kit" in their names.

To define a category as Virtual Category :

* Go into the **Category tab** of your category :
* Set the category virtual using the "Enable virtual category" switcher
* The manual product picket is now hidden and you can define the rule to match your product instead
* The manual product picker is now hidden and you can define the rule to match your product instead
* Save the category and navigate into you category on the front to verify everything is working as expected.

![Virtual categories](assets/virtual-categories.png)


> **About anchor categories**
>
> By default, Magento uses a categorie attribute call **Is Anchor** with is responsible of attributing all products of all children category to the parent category if the **Is Anchor**. This attribute is also responsible of triggering facet display / hide.
> By default, Magento uses a category attribute called **Is Anchor** which is responsible for attributing all products of all children category to the parent category if the **Is Anchor** is set to **Yes**. This attribute is also responsible of triggering facet display / hide.
>
> The virtual categories hide this attribute into the admin and make the default value equals to **Yes** for the **Is Anchor** categories

Expand All @@ -105,11 +105,11 @@ Front Office

### Facets

The default module implementation make all facets being multi-select facets :
The default module implementation makes all facets being multi-select facets :

![Multi-select facets](assets/facets-1.png)

Some facets like the price or the ratings have default templates bundled with the module. Developers can define custom facet for every attributes (see [Developper documentation](developper-documentation.md) for more information).
Some facets like the price or the ratings have default templates bundled with the module. Developers can define custom templates for every attributes (see [Developper documentation](developper-documentation.md) for more information).

![Price facet](assets/facets-2.png)

Expand All @@ -123,4 +123,4 @@ The module comes with an autocomplete which allows by default to autocomplete :

Default template is very simple (only name) but can be overridden by developers to display additional attributes (eg. image) like described into [Developper documentation](developper-documentation.md) :

![Price facet](assets/autocomplete.png)
![Price facet](assets/autocomplete.png)