README

轻松创建常见问题解答！如果您使用Winter.Translate，这些可以翻译。

注意：如果您不使用 Winter.Translate，一切都将正常工作，但“仅翻译常见问题解答”复选框将无作用，并且没有翻译支持。

注意

• 常见问题插件不包含 JavaScript 和 CSS。您必须自行进行样式设计，以确保它符合您的网站品牌。
• 您可以通过覆盖翻译。
• 您可以通过扩展任何 WinterCMS 插件。
• 您可以通过覆盖默认标记。

图片

功能

使用常见问题插件，您可以

• 创建和更新您的常见问题解答
• 创建和更新常见问题解答的分类
• 将分类分配给您的常见问题解答
• 在常见问题解答中定义问题和答案
• 控制哪些常见问题解答被发布
  • 已发布
  • 进行中（允许登录的后台用户在前端看到它们）
  • 隐藏
• 为常见问题解答添加特色状态
  • 特色
  • 非特色
• 在预定义选项之间选择排序方法
  • 分类（升序和降序）
  • 创建时间（升序和降序）
• 选择您要显示的分类
  • 您自己创建的分类
  • 您自己创建的其他分类
  • 您自己创建的其他其他分类
  • ...
  • 所有
• 选择您要显示的常见问题解答类型
  • 特色
  • 非特色
  • 所有
• 启用搜索字段，允许用户快速查找常见问题解答
• 定义显示搜索字段所需的最小记录数
• 确保只显示正确语言的常见问题解答
  • 例如：如果常见问题解答 #1 没有翻译成西班牙语，则当用户的区域设置为西班牙语时，它不会显示
  • 例如：如果常见问题解答 #2 翻译成西班牙语和英语，它将在西班牙语和英语中显示，但不在法语中显示。
• 默认标记使用HTML5 details & summary
  • 这为打开和关闭常见问题解答添加了默认行为
• 翻译常见问题解答

默认行为

• 自动显示所有常见问题解答分类
• 自动显示所有常见问题解答，无论它们的特色状态如何
• 如果总共有超过 10 个常见问题解答，将自动添加搜索框
  • 您可以通过更改“搜索最小结果”来在组件本身中更改此设置。
  • 如果未选中“启用搜索”，则不会显示
• 自动隐藏未翻译成当前网站语言的常见问题解答
  • 您可以通过在组件本身中取消选中“仅翻译常见问题解答”来更改此设置。

安装

您可以通过 WinterCMS 市场或（现在）使用 composer（composer require aic/wn-faq-plugin 和 php artisan winter:up）免费安装此插件。然后您可以去“CMS -> 组件”将常见问题解答拖放到页面/布局中。点击常见问题解答组件可以修改默认行为。

常见问题解答变量

在组件本身中，你可以使用以下变量（注意：如果你在一个页面上有多个常见问题组件，应该使用 {{ __SELF__ }} 作为前缀）

• items（项目数组）
  • name（=分类名称）
  • faqs（FAQ数组）
    • id
    • category_id
    • is_published
    • is_featured
    • question
    • answer
    • created_at
    • updated_at
• isSearch（如果为真，搜索框被启用）
• searchLabel（搜索字段的标签）
• searchPlaceholder（搜索字段的占位符）
• minSearchResults（显示搜索框所需的最小结果数量）
• searchQuery（用户在搜索框中使用的查询字符串）

告诉我您的想法

我花了大量时间将这个插件公开给社区。我唯一的要求是您 告诉我 您在使用我的插件。我确信你们都理解，如果知道我的插件是否被使用，这对我很重要（如果人们真的使用我的插件，将来可能会制作更多）。

您可以通过在 Discord（Makalele#4465）上给我发一条简单消息或发送电子邮件到 info@aic-bv.be 来这样做。不必太多，一句感谢就足够了 :)

特别感谢

特别感谢 WinterCMS 维护团队使这一切成为可能

• Ben Thomson
• Jack Wilkinson
• Luke Towers
• Marc Jauvin