README

警告！此软件目前处于预1.0.0版本。在官方1.0.0版本发布之前，可能会出现破坏性更改。请参阅通往1.0.0之路项目，了解在发布标记版本之前预期的内容。

此模块允许业务用户在Magento 2管理控制台中创建产品问卷推荐。

安装

建议通过Composer安装此软件包。要使用推荐方法进行安装，请运行以下命令

composer require silentpost/module-product-quiz
bin/magento module:enable Silentpost_ProductQuiz
bin/magento setup:upgrade
bin/magento setup:di:compile

Packagist

此模块托管在packagist上。如果您正在使用默认的Magento元包，则需要将packagist存储库添加到商店的composer.json文件中

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com"
        },
        {
            "type": "composer",
            "url": "https://packagist.org.cn"
        }
    ]
}

设置

在Magento 2管理控制台中从头开始设置产品问卷，可以在产品问卷项目的wiki中找到，见此处。

前端开发

目前，此问卷没有通过Magento管理员提供的前端配置。因此，需要进行以下额外开发

布局XML
Knockout模板
CSS

布局XML

将问卷添加到前端需要更改所需的layout.xml文件。可以在此处查看示例layout.xml文件

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceContainer name="content">
            <block class="Silentpost\ProductQuiz\Block\Quiz" name="product-quiz" as="product-quiz" before="-" template="Silentpost_ProductQuiz::product-quiz.phtml" />
        </referenceContainer>
    </body>
</page>

Knockout模板

将来可能会考虑其他框架（例如，使用Hyvä主题的AlpineJS），但当前前端完全由Knockout JS驱动。

要自定义Knockout模板，请将此软件包的view/frontend/web/template目录复制到以下目录，app/design/frontend/<Vendor>/<theme>/Silentpost_ProductQuiz

# Path: app/design/frontend/<Vendor>/<theme>/Silentpost_ProductQuiz 

web/template
├── product-quiz
│   └── stage
│       ├── error.html
│       ├── intro.html
│       ├── quiz
│       │   ├── answer.html
│       │   └── question.html
│       └── quiz.html
└── product-quiz.html

3 directories, 6 files

CSS

产品问卷没有定义其外观的约定；利益相关者可能希望将问卷内联在主页上，以模态覆盖显示问卷，或者两者结合。考虑到这一点，产品问卷的样式故意很简单。作为参考，项目Wiki中有一个示例Less文件，用于对产品问卷进行样式设计，见此处。

注意：产品问卷与Magento 2的前端CSS建议不同。相反，产品问卷使用BEM作为CSS约定。有关BEM的更多信息，请参阅此链接。

要向产品问卷的前端添加CSS，请将以下文件添加到新目录app/design/frontend/<Vendor>/<theme>/Silentpost_ProductQuiz

# Path: app/design/frontend/<Vendor>/<theme>/Silentpost_ProductQuiz 

web
└── css
    └── source
        └── _module.less

2 directories, 1 file

贡献

请参阅CONTRIBUTING.md以了解贡献者行为准则以及提交拉取请求的过程。

版本控制

此项目尽量使用语义版本控制。有关可用的版本，请参阅此存储库的标签。

许可

在MIT许可下分发。有关更多信息，请参阅LICENSE.md。

silentpost / module-product-quiz

维护者

详细信息