Skip to content

Commit

Permalink
[Core] Reworked group and fields descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@rbayet
rbayet committed Jan 17, 2025
1 parent d2298ca commit 98aaeb0
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 48 deletions.
25 changes: 15 additions & 10 deletions src/module-elasticsuite-core/etc/adminhtml/system.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,43 +183,48 @@

<group id="advanced" translate="label" type="text" sortOrder="99" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Advanced Settings</label>
<field id="info" translate="label comment" type="label" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="0" >
<label>Using popular search terms for autocomplete search of products and categories</label>
<comment><![CDATA[Historically, both for leveraging user behavioral patterns and performance purposes, Elasticsuite relies on the Popular Search Terms Autocomplete results to complete and extend the search terms submitted by the user before searching for matching products or categories.<br />For instance, if a user types "comp" in the search box and the suggested popular search terms are "computer", "peach computer", "computer for kids", then categories and products matching either one of those three search terms will be shown and the original "comp" search term is discarded.<br />On the other hand, if no popular search term is found, then Elasticsuite will try finding products and categories matching only "comp", which might not provide any results unless some attributes have built-in autocompletion capability (by using the "standard_edge_ngram" as their search analyzer).<br />The settings below provide you with the ability to have more control over that "extension" mechanism: whether to disable it entirely, limit its extend, forcing the original search term to always be requested, etc.]]></comment>
<frontend_model>Smile\ElasticsuiteCore\Block\Adminhtml\System\Config\Comment</frontend_model>
</field>
<field id="extension_enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Use suggested search terms to fetch results</label>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<comment><![CDATA[Default: Yes. When enabled, autocompletion box results will be computed from the suggested search terms. This is intended to suggest results when the user is in the process of typing. Eg : When the user is typing "comp", the popular search term "computer" will be suggested, and therefore products or categories matching "computer" will be shown.]]></comment>
<comment><![CDATA[Default: Yes (legacy behavior). When set to "Yes", products and categories autocomplete will use the search terms suggested in the popular term autocomplete. When set to "No", products and categories autocomplete results will be based solely on the original user raw search term, which might be a partial word being typed (eg "comp" for "computer").]]></comment>
</field>
<field id="preserve_base_query" translate="label comment" type="select" sortOrder="15" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Always use the user raw input for suggestions.</label>
<label>Always use the user raw input for suggestions</label>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<depends>
<field id="extension_enabled">1</field>
</depends>
<comment><![CDATA[Default: No. When set to "Yes", this setting will always proceed to fetch suggestions on the query typed by the user in addition to the extended terms. Eg : When the user is typing "comp", the popular search term "computer" will be suggested, but products or categories matching either "comp" or "computer" will be shown.]]></comment>
<comment><![CDATA[Default: No (legacy behavior). When set to "No", the user raw search term, which might be a partial word being typed, will only be used to fetch suggestions if no matching popular terms were found. When set to "Yes", it will always be used, whether matching popular terms were found or not. Eg if set to "Yes" : when the user is typing "comp" and the popular search term "computer" is suggested, then products or categories matching either "comp" or "computer" will be shown.]]></comment>
</field>
<field id="extension_limited" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Limit the amount of suggested search terms used for autocomplete matching</label>
<label>Limit the amount of suggested search terms used</label>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<depends>
<field id="extension_enabled">1</field>
</depends>
<comment><![CDATA[Default: No. When set to "No", this setting will use the maximum number of suggested popular search terms configured in the dedicated section.]]></comment>
<comment><![CDATA[Default: No (legacy behavior). When set to "No", all the suggested popular search terms will be used for the products and categories autocomplete. When set to "Yes", you will be able to define the maximum number of suggested search terms to use below.]]></comment>
</field>
<field id="extension_size" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>The number of suggested popular search terms to use for fetching results.</label>
<validate>integer validate-greater-than-zero</validate>
<label>Maximum number of popular search terms to use</label>
<validate>required integer validate-greater-than-zero</validate>
<depends>
<field id="extension_enabled">1</field>
<field id="extension_limited">1</field>
</depends>
<comment><![CDATA[The number of suggested search terms that will be used for fetching results in the autocompletion box.]]></comment>
<comment><![CDATA[The maximum number of suggested search terms that will be used for fetching results in the products and categories autocomplete boxes. Having a value greater than the "Max Size" defined in the "Popular Term Autocomplete" section above has no effect.]]></comment>
</field>
<field id="stop_extension_on_match" translate="label comment" type="select" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
<label>Stop the extension mechanism when the current search term of the user is suggested.</label>
<label>No extension for actual popular search terms</label>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
<depends>
<field id="extension_enabled">1</field>
</depends>
<comment><![CDATA[Default: No. When set to "Yes", this setting will discard the extension mechanism as soon as the exact search term entered by the user is part of the suggestions. Eg : When the user has finished to type "computer", if the list of suggested search terms is "computer", "apple computer", "computer for kids", only "computer" will be considered as it's exactly what the user has written.]]></comment>
<comment><![CDATA[Default: No. When set to "Yes", the extension mechanism will be discarded when the search term entered by the user is amongst the popular terms suggestions. Eg : When the user has finished typing "computer", if the list of suggested search terms is ("computer", "peach computer", "computer for kids"), only "computer" will be taken into account for the products and categories autocomplete.]]></comment>
</field>
</group>
</section>
Expand Down
3 changes: 2 additions & 1 deletion src/module-elasticsuite-core/etc/config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,10 @@
</term_autocomplete>
<advanced>
<extension_enabled>1</extension_enabled>
<preserve_base_query>0</preserve_base_query>
<extension_limited>0</extension_limited>
<extension_size>5</extension_size>
<stop_extension_on_match>0</stop_extension_on_match>
<preserve_base_query>0</preserve_base_query>
</advanced>
</smile_elasticsuite_autocomplete_settings>

Expand Down
20 changes: 11 additions & 9 deletions src/module-elasticsuite-core/i18n/de_DE.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,15 @@
"Click here to go to the <a href=""%1""><strong>Elasticsuite Indices</strong></a> page to take appropriate actions.","Klicken Sie hier, um zu den <a href=""%1""><strong>Elasticsuite Indizes</strong></a> Seite zu gelangen, um entsprechende Aktionen durchzuführen."
"Click <a href=""%1""><strong>here</strong></a> to go to the <strong>Elasticsuite Indices</strong> page to take appropriate actions.","Klicken Sie <a href=""%1""><strong>hier</<strong></a>, um zu den <strong>Elasticsuite Indizes</strong> Seite zu gelangen, um entsprechende Aktionen durchzuführen."
"Advanced Settings","Erweiterte Einstellungen"
"Using popular search terms for autocomplete search of products and categories","Verwendung beliebter Suchbegriffe zur automatischen Vervollständigung der Suche nach Produkten und Kategorien"
"Historically, both for leveraging user behavioral patterns and performance purposes, Elasticsuite relies on the Popular Search Terms Autocomplete results to complete and extend the search terms submitted by the user before searching for matching products or categories.<br />For instance, if a user types ""comp"" in the search box and the suggested popular search terms are ""computer"", ""peach computer"", ""computer for kids"", then categories and products matching either one of those three search terms will be shown and the original ""comp"" search term is discarded.<br />On the other hand, if no popular search term is found, then Elasticsuite will try finding products and categories matching only ""comp"", which might not provide any results unless some attributes have built-in autocompletion capability (by using the ""standard_edge_ngram"" as their search analyzer).<br />The settings below provide you with the ability to have more control over that ""extension"" mechanism: whether to disable it entirely, limit its extend, forcing the original search term to always be requested, etc.","Traditionell verlässt sich Elasticsuite sowohl für die Nutzung von Benutzerverhaltensmustern als auch für Leistungszwecke auf die Ergebnisse der automatischen Vervollständigung beliebter Suchbegriffe, um die vom Benutzer übermittelten Suchbegriffe zu vervollständigen und zu erweitern, bevor nach passenden Produkten oder Kategorien gesucht wird.<br />Zum Beispiel, wenn ein Benutzer Geben Sie ""comp"" in das Suchfeld ein und die vorgeschlagenen beliebten Suchbegriffe sind ""Computer"", ""Pfirsich Computer"" und ""Computer für Kinder"". Anschließend werden Kategorien und Produkte angezeigt, die einem dieser drei Suchbegriffe entsprechen wird angezeigt und der ursprüngliche ""Comp"" Suchbegriff wird verworfen.<br />Wenn andererseits kein beliebter Suchbegriff gefunden wird, versucht Elasticsuite, Produkte und Kategorien zu finden, die nur mit ""comp"" übereinstimmen. Dies liefert möglicherweise keine Ergebnisse, es sei denn, einige Attribute verfügen über integrierte in der Fähigkeit zur automatischen Vervollständigung (durch Verwendung von ""standard_edge_ngram"" als Suchanalysator).<br />Die folgenden Einstellungen bieten Ihnen die Möglichkeit, mehr Kontrolle über diesen ""Erweiterungs""-Mechanismus zu haben: ob Sie ihn vollständig deaktivieren oder einschränken möchten seine Ausdehnung, Erzwingen, dass immer der ursprüngliche Suchbegriff abgefragt wird usw."
"Use suggested search terms to fetch results","Verwenden Sie vorgeschlagene Suchbegriffe, um Ergebnisse abzurufen"
"Default: Yes. When enabled, autocompletion box results will be computed from the current search term the user is typing, but also with the suggested search terms. This is intended to suggest results when the user is in the process of typing. Eg : When the user is typing ""comp"", the popular search term ""computer"" will be suggested, and therefore products or categories matching ""computer"" will be shown.","Standard: Ja. Wenn aktiviert, werden die Ergebnisse der Autovervollständigungsbox basierend auf dem aktuellen Suchbegriff des Benutzers berechnet, aber auch mit den vorgeschlagenen Suchbegriffen. Dies soll Ergebnisse vorschlagen, während der Benutzer tippt. Beispiel: Wenn der Benutzer ""comp"" eingibt, wird der beliebte Suchbegriff ""computer"" vorgeschlagen, und Produkte oder Kategorien, die zu ""computer"" passen, werden angezeigt."
"Limit the amount of suggested search terms used for autocomplete matching","Begrenzen Sie die Anzahl der vorgeschlagenen Suchbegriffe für die Autovervollständigung"
"Default: No. When set to ""No"", this setting will use the maximum number of suggested popular search terms configured in the dedicated section.","Standard: Nein. Wenn auf ""Nein"" gesetzt, verwendet diese Einstellung die maximale Anzahl an vorgeschlagenen beliebten Suchbegriffen, die im entsprechenden Abschnitt konfiguriert sind."
"The number of suggested popular search terms to use for fetching results.","Die Anzahl der vorgeschlagenen beliebten Suchbegriffe, die für das Abrufen von Ergebnissen verwendet werden sollen."
"The number of suggested search terms that will be used for fetching results in the autocompletion box.","Die Anzahl der vorgeschlagenen Suchbegriffe, die in der Autovervollständigungsbox verwendet werden sollen, um Ergebnisse abzurufen."
"Stop the extension mechanism when the current search term of the user is suggested.","Stoppen Sie den Erweiterungsmechanismus, wenn der aktuelle Suchbegriff des Benutzers vorgeschlagen wird."
"Default: No. When set to ""Yes"", this setting will discard the extension mechanism as soon as the exact search term entered by the user is part of the suggestions. Eg : When the user has finished to type ""computer"", if the list of suggested search terms is ""computer"", ""apple computer"", ""computer for kids"", only ""computer"" will be considered as it's exactly what the user has written.","Standard: Nein. Wenn auf ""Ja"" gesetzt, wird dieser Mechanismus deaktiviert, sobald der genaue Suchbegriff, den der Benutzer eingegeben hat, Teil der Vorschläge ist. Beispiel: Wenn der Benutzer ""computer"" fertig eingegeben hat und die Liste der vorgeschlagenen Suchbegriffe ""computer"", ""apple computer"", ""computer für Kinder"" enthält, wird nur ""computer"" berücksichtigt, da es genau das ist, was der Benutzer eingegeben hat."
"Always use the user raw input for suggestions.","Immer die Rohdaten des Benutzers für Vorschläge verwenden."
"Default: No. When set to ""Yes"", this setting will always proceed to fetch suggestions on the query typed by the user in addition to the extended terms. Eg : When the user is typing ""comp"", the popular search term ""computer"" will be suggested, but products or categories matching either ""comp"" or ""computer"" will be shown.","Standard: Nein. Wenn diese Option auf ""Ja"" gesetzt ist, werden immer Vorschläge basierend auf der eingegebenen Benutzereingabe sowie den erweiterten Begriffen abgerufen. Beispiel: Wenn der Benutzer ""comp"" eingibt, wird der beliebte Suchbegriff ""computer"" vorgeschlagen, aber Produkte oder Kategorien, die entweder ""comp"" oder ""computer"" entsprechen, werden angezeigt."
"Default: Yes (legacy behavior). When set to ""Yes"", products and categories autocomplete will use the search terms suggested in the popular term autocomplete. When set to ""No"", products and categories autocomplete results will be based solely on the original user raw search term, which might be a partial word being typed (eg ""comp"" for ""computer"").","Standard: Ja (Legacy-Verhalten). Bei der Einstellung ""Ja"" verwendet die Autovervollständigung für Produkte und Kategorien die Suchbegriffe, die in der beliebten Autovervollständigung vorgeschlagen werden. Bei der Einstellung ""Nein"" basieren die Ergebnisse der automatischen Vervollständigung von Produkten und Kategorien ausschließlich auf dem ursprünglichen Rohsuchbegriff des Benutzers, bei dem es sich möglicherweise um einen Teil des eingegebenen Worts handelt (z. B. ""comp"" für ""Computer"")."
"Always use the user raw input for suggestions","Immer die Rohdaten des Benutzers für Vorschläge verwenden"
"Default: No (legacy behavior). When set to ""No"", the user raw search term, which might be a partial word being typed, will only be used to fetch suggestions if no matching popular terms were found. When set to ""Yes"", it will always be used, whether matching popular terms were found or not. Eg if set to ""Yes"" : when the user is typing ""comp"" and the popular search term ""computer"" is suggested, then products or categories matching either ""comp"" or ""computer"" will be shown.","Standard: Nein (Legacy-Verhalten). Bei der Einstellung ""Nein"" wird der Rohsuchbegriff des Benutzers, bei dem es sich möglicherweise um einen Teil des eingegebenen Wortes handelt, nur zum Abrufen von Vorschlägen verwendet, wenn keine passenden beliebten Begriffe gefunden wurden. Bei der Einstellung ""Ja"" wird immer verwendet, unabhängig davon, ob passende beliebte Begriffe gefunden wurden oder nicht. Wenn beispielsweise ""Ja"" eingestellt ist: Wenn der Benutzer ""comp"" eingibt und der beliebte Suchbegriff ""Computer"" vorgeschlagen wird, werden Produkte oder Kategorien angezeigt, die entweder mit ""comp"" oder ""computer"" übereinstimmen."
"Limit the amount of suggested search terms used","Begrenzen Sie die Anzahl der vorgeschlagenen Suchbegriffe"
"Default: No (legacy behavior). When set to ""No"", all the suggested popular search terms will be used for the products and categories autocomplete. When set to ""Yes"", you will be able to define the maximum number of suggested search terms to use below.","Standard: Nein (Legacy-Verhalten). Bei der Einstellung ""Nein"" werden alle vorgeschlagenen beliebten Suchbegriffe für die automatische Vervollständigung von Produkten und Kategorien verwendet. Bei Einstellung auf ""Ja"" können Sie unten die maximale Anzahl der vorgeschlagenen Suchbegriffe definieren, die verwendet werden sollen."
"Maximum number of popular search terms to use","Maximale Anzahl beliebter Suchbegriffe zu verwenden"
"The maximum number of suggested search terms that will be used for fetching results in the products and categories autocomplete boxes. Having a value greater than the ""Max Size"" defined in the ""Popular Term Autocomplete"" section above has no effect.","Die maximale Anzahl vorgeschlagener Suchbegriffe, die zum Abrufen von Ergebnissen in den Autovervollständigungsfeldern für Produkte und Kategorien verwendet werden. Ein Wert, der größer als die im Abschnitt ""Autovervollständigung geläufiger Bezeichnungen"" oben definierte ""Maximale Größe"" ist, hat keine Auswirkung."
"No extension for actual popular search terms","Keine Erweiterung für tatsächlich beliebte Suchbegriffe"
"Default: No. When set to ""Yes"", the extension mechanism will be discarded when the search term entered by the user is amongst the popular terms suggestions. Eg : When the user has finished typing ""computer"", if the list of suggested search terms is (""computer"", ""peach computer"", ""computer for kids""), only ""computer"" will be taken into account for the products and categories autocomplete.","Standard: Nein. Bei der Einstellung ""Ja"" wird der Erweiterungsmechanismus verworfen, wenn der vom Benutzer eingegebene Suchbegriff zu den Vorschlägen für beliebte Begriffe gehört. Beispiel: Wenn der Benutzer mit der Eingabe von ""Computer"" fertig ist und die Liste der vorgeschlagenen Suchbegriffe ""Computer"", ""Pfirsich Computer"", ""Computer für Kinder"" lautet, wird nur ""Computer"" für die Produkte und berücksichtigt Kategorien automatisch vervollständigen."
Loading

0 comments on commit 98aaeb0

Please sign in to comment.