README

使用composer安装包

composer require tweakwise/magento2-tweakwise

这将安装tweakwise/magento2-tweakwise和tweakwise/magento2-tweakwise-export

启用模块并运行安装程序

php bin/magento module:enable Tweakwise_Magento2TweakwiseExport Tweakwise_Magento2Tweakwise
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

配置

扩展安装后默认禁用。有三个不同的部分可以单独启用。配置可以在“店铺 -> 配置 -> 目录 -> Tweakwise”中找到。

所有可能的设置概述

以下是所有配置选项的概述

常规

1. 认证密钥：用于与tweakwise通信，确定您的导航实例，它应与导航下的“连接 > 端点”中找到的密钥相同。
2. 服务器URL：tweakwise服务器的URL。
3. 超时：如果tweakwise在指定秒数后无法响应，则请求被中止。

分层导航（所有设置取决于已启用值为是）

1. 已启用：使用tweakwise结果进行导航，如果禁用，则使用标准magento导航。不要禁用主类别的锚点标签，这会导致显示所有产品。可以在子类别中禁用锚点标签。

2. 隐藏只有一个选项的筛选器：给定来自tweakwise的结果集，其中有一个筛选器只有一个选项，显示该筛选器还是不显示？

3. 使用默认magento筛选器渲染器：使用Magento标准筛选器模板或使用模块捆绑的模板。如果您想充分利用该模块提供的功能，则应将其设置为否（即使用tweakwise模板文件）。

4. 筛选器表单：这取决于“使用默认magento筛选器渲染器”的值为否。以带有筛选器按钮的表单的形式渲染所有筛选器，以便用户可以选择一组筛选器，然后导航到结果，而不是在点击筛选器时立即导航到结果。

5. 筛选器URL查询参数：tweakwise筛选器URL将包含页面的所有查询参数，包括“cid”和utm_source参数（如果存在）。您可以确定您希望以何种方式筛选这些参数（如果有的话）。

6. 筛选器URL查询参数：这取决于“筛选器URL查询参数”的任何值不等于“不筛选”。此字段指定应从tweakwise筛选器URL中删除哪些参数。

7. URL策略：有两个选项：查询参数和SEO路径别名。如果选择查询参数，则tweakwise筛选器URL（以及因此您的导航URL）将构造为 www.example.com/example-category?color=red。

   如果选择SEO路径别名，则URL将构造为 www.example.com/example-category/color/red。

SEO（所有设置取决于已启用值为是）

1. 已启用：使用SEO选项是或否。
2. 筛选器白名单：应索引的筛选器列表（未在此处选择的筛选器不可索引）。如果筛选器标记为不可索引，则其href属性将设置为“#”，其原始URL将设置为data-seo-href属性中，该属性将由javascript用于导航。请注意，类别筛选器始终标记为可索引。这曾经是一个包含magento属性的复选框字段，但是tweakwise促进了导出属性，这些属性与magento属性无关，因此这些筛选器不可索引。该字段已更改为逗号分隔的文本字段，以便正确列出这些导出属性。
3. 最大允许面数：此设置与过滤器白名单设置结合使用。只有当过滤器在白名单中且选择的过滤器数量不超过max_allowed_facets时，过滤器才是可索引的。这是AND检查的原因，因为否则即使是非白名单的过滤器也会进行索引，而且不清楚哪个URL存在（可以任意选择大量的过滤器）。假设最大允许面数是1，且只有"尺寸"在白名单中。那么带有值"红色"的"颜色"过滤器不可索引（因为"颜色"不在白名单中）。如果我们现在允许尺寸过滤器仍然可索引，那么url example.com/category/color/red/size/M将是可索引的，而example.com/category/color/red则不是，这是不正确的。这会导致过滤器URL上的无限爬取，这是不希望的。

自动完成（所有设置均取决于Enabled的值为yes）

1. 启用：使用tweakwise自动完成结果或否。
2. 使用建议自动完成：使用新的建议API（是）或使用标准自动完成API（否）
3. 显示产品 *：在自动完成结果中显示产品建议。
4. 显示建议 *：在自动完成结果中显示搜索建议。
5. 保持类别：获取自动完成结果时使用当前类别。
6. 最大结果数 *：最多显示这么多自动完成结果。

• 当启用使用建议自动完成时隐藏。这些设置在新建议API中不使用。新的建议API在tweakwise中进行配置。

搜索（所有设置均取决于Enabled的值为yes）

1. 启用：使用tweakwise搜索或默认的magento搜索结果
2. Tweakwise搜索模板：用于搜索结果的Tweakwise模板（这决定了哪些过滤器可见）
3. 搜索语言：这决定了商店使用的语言，并传递给tweakwise。Tweakwise使用此信息来确定词形变化，并在考虑向用户显示哪些结果时纠正拼写错误。例如：假设语言设置为'Dutch'，用户输入'Bed'（在英语中与睡觉的地方相同），那么tweakwise可能会建议'Bedden'（这是'Beds'的复数形式）。如果语言设置为英语，那么在上面的例子中，tweakwise可能会建议'Beds'。
4. 搜索横幅启用：在搜索结果中显示搜索横幅。搜索横幅需要在tweakwise中进行配置。

商品促销构建器

1. 启用：使用商品促销构建器（是/否）。这仅在您使用ajax过滤时可用。
2. Cookie名称：存储tweakwise配置文件ID的Cookie，此Cookie通常由跟踪脚本设置。此Cookie的值将添加到tweakwise请求中，响应将包含针对该特定客户的个性化排序顺序。

注意，Varnish必须启用才能正确工作。无论如何，Varnish都是Magento推荐的。Varnish缓存的巨大优势当然是速度的提升。此外，它确保服务器负载较低，从而提高峰值抵抗力。使用此功能意味着所有类别页面都有个性化内容。因此，不再可能缓存使用此配置文件Cookie名称的导航响应。只有当以下条件满足时，产品列表才通过商品促销构建器加载

1. 启用个性化商品促销设置
2. Cookie名称设置具有值
3. 用户具有指定的非空值的Cookie。

以这种方式加载产品列表时，结果将不可缓存。这会影响服务器负载，请注意。

推荐

1. 相关产品启用：用tweakwise交叉销售和促销推荐替换magento原生的相关产品。术语混乱，因为这与magento相关产品相关，而不是与magento交叉销售产品相关。
2. 默认相关产品模板：用于相关产品的推荐模板选择。仅在启用交叉销售时适用。此设置也可以在产品和类别上进行配置。模板选择如下：首先检查产品是否已配置模板，如果没有，则检查产品类别模板。如果类别没有配置模板，则使用默认模板。
3. 默认相关分组代码：仅在“默认交叉销售模板”具有“- 分组代码 -”值时可见。使用此选项指定推荐分组。
4. 启用升级：用tweakwise的交叉销售和升级推荐替换magento本地的升级结果。
5. 默认升级模板：用于升级产品的推荐模板选择。仅在启用升级时适用。此设置也可以在产品和类别上进行配置。模板选择如下：首先检查产品是否已配置模板，如果没有，则检查产品类别模板。如果类别没有配置模板，则使用默认模板。
6. 默认升级分组代码：仅在“默认升级模板”具有“- 分组代码 -”值时可见。使用此选项指定推荐分组。
7. 启用特色产品：如果选择是，则tweakwise可以在类别页面上显示特色产品。
8. 默认特色产品模板：渲染特色产品时使用的默认模板。模板也可以按类别设置，如果类别中没有找到模板，则回退到此设置。可以选择的模板对应于tweakwise中“推荐 -> 特色产品”下的模板。
9. 在购物车中显示交叉销售项目。启用tweakwise购物车中的交叉销售项目。应在“商店 -> 配置 -> 销售 -> 结账 -> 在购物车中显示交叉销售项目”下启用magento购物车交叉销售项目。
10. 默认交叉销售模板：用于购物车交叉销售项目的tweakwise推荐模板选择。仅在启用购物车交叉销售时适用。
11. 默认交叉销售分组代码：仅在“默认购物车交叉销售模板”具有“- 分组代码 -”值时可见。使用此选项指定推荐分组。
12. 交叉销售类型：在购物车中显示交叉销售或特色产品。
13. 仅显示当前类别中的产品作为特色产品：在特色产品中显示当前类别的产品。
14. 限制分组代码推荐：如果使用分组代码进行一个或多个推荐，则限制返回的产品总数。如果为空或0，则返回所有产品。

支持

有关配置和tweakwise提供的所有选项的深入支持，请使用以下链接。

1. tweakwise支持：https://www.tweakwise.com/support/
2. tweakwise API 文档：http://developers.tweakwise.com/
3. 一般问题：https://www.tweakwise.com/contact/
4. 安全漏洞：将邮件发送到support@tweakwise.com，并在邮件中说明这是magento插件的安全问题。

有关功能请求，请参阅上面的链接。有关技术问题，请使用github。如果您发现技术问题，请在github上创建一个问题，并通过上面的链接通知tweakwise。如果您也恰好有该问题的解决方案，请随时创建合并请求。

兼容性

我们致力于与所有 Magento 2.X 版本以及最新的 2.X-1 版本保持兼容，其中 X 是 Magento 官方最高的 '子' 发布版。目前 X=4，因此我们应该与所有 2.4 版本以及最新的 2.3.x 版本兼容。我们不会主动放弃对低于此范围版本的 support，并且如果这意味着我们可以保持与低于此范围的版本兼容，我们将实施 小版本 更改。话虽如此，如果我们能够在牺牲对 2.3.Y 版本 support 的代价下大幅简化代码，我们将这样做。我们还参考了 Magento 软件生命周期：https://magento.com/sites/default/files/magento-software-lifecycle-policy.pdf。请注意，2.3 已到生命周期结束。

贡献者

如果您想作为贡献者创建一个 pull request，请使用语义发布指南。语义发布自动化整个包发布工作流程，包括：确定下一个版本号、生成发布说明以及发布包。通过遵循提交信息格式，将自动创建一个包含提交信息作为发布说明的 release。请遵循以下指南：https://github.com/semantic-release/semantic-release?tab=readme-ov-file#commit-message-format。