README

Craft 用户手册允许开发人员（或甚至内容编辑人员）使用 Craft 内置的部分（单个、渠道或结构）提供 CMS 文档，直接在控制面板中创建“用户手册”或“帮助”部分。

需求

此插件需要 Craft CMS 3.0.0-beta.23 或更高版本。

安装

要安装此插件，请按照以下说明操作。

1. 打开您的终端并转到您的 Craft 项目

    cd /path/to/project
   

2. 然后告诉 Composer 加载插件

    composer require kuriousagency/craft-user-manual
   

3. 在控制面板中，转到设置 → 插件，并单击 usermanual 的“安装”按钮。

4. 在 CP 中选择插件应使用的部分作为 用户手册 页面。

   • （可选） - 将插件名称更改为用户容易理解的内容。
   • （可选） - 通过设置自定义模板覆盖来使用默认 body 字段以外的更多字段。

5. 单击 CP 导航中的 用户手册 链接。

配置

• 所有设置均可通过配置文件进行选择性地配置。以下是对包含在 config.php 中的值的描述。

pluginNameOverride

直观、易读的插件名称，供最终用户使用。

templateOverride

为了获得更多控制权，您可以选择覆盖默认模板。

路径相对于 ../craft/templates/。

section

本节中的条目必须具有关联的 URL。

一些说明

• 除非您正在使用模板覆盖，否则插件当前仅从所选部分的每个条目中提取 body 字段。
• 虽然 用户手册 部分与 结构 一起使用效果最佳，但您当然可以使用一次性的 单个。
• 如果您正在运行 Craft 客户端 或 Craft 专业版，请确保内容编辑人员没有权限编辑您选定的用于 用户手册 的部分。
• 只能使用具有条目 URL 的部分作为 用户手册 部分。

感谢

此插件受到 70kft 团队启发的灵感，他们为 Craft-Help 做出了贡献。虽然他们的插件在自定义 markdown 文件中写入方面肯定更具灵活性，但我们想创建一个可以让任何人在不更改服务器的情况下轻松编辑文档的东西。这对于涉及多人（特别是非开发人员）编写 CMS 使用说明的大型项目尤其有效。

发布

• 2.0.1 - 合并 @mgburns 修复的弃用警告问题。
• 2.0.0 - 合并 @jcdarwin 的 Craft3 端口。Craft User Manual 的 Craft3 版本。
• 1.1.1 - 添加 RTL 语言支持
• 1.1.0 - 合并 @timkelty 的工作成果，包括模板覆盖、更新错误提示和其他改进
• 1.0.1 - 在Craft 2.5中添加对插件自定义图标的支持
• 1.0.0 - Craft用户手册的初始发布。

希望这个插件对您有用，我们很乐意听取您可能提出的任何建议或问题。@erskinerob。

由Rob Erskine提供