README

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

要求

此插件需要 Craft CMS 4.0.0 或更高版本；或 Craft CMS 5.0.0 或更高版本。

安装

Craft 4 和 Craft 5

要在您的 Craft 4 或 Craft 5 项目中安装此插件，请按照以下说明操作。

打开您的终端并转到您的 Craft 项目
```
 cd /path/to/project
```

然后让 Composer 加载插件

 composer require hillholliday/craft-user-manual

为什么它说 hillholliday 而不是 roberskine 作为组织？这个软件包最初是以 hillholliday 的名义提交的，为了在 Packagist 上保留这些工件，我们将其保留为 hillholliday。

在控制面板中，转到设置→插件，然后点击 usermanual 的“安装”按钮。
选择插件应在 CP 中用作 用户手册 页面的部分。
- (可选) - 将插件名称更改为用户能理解的内容。
- (可选) - 通过设置自定义模板覆盖来使用默认的 body 字段以外的字段。
点击 CP 导航中的 用户手册 链接。

Craft 3

要安装 Craft 3 项目中的插件，请按照以下说明操作。

打开您的终端并转到您的 Craft 项目
```
 cd /path/to/project
```

然后让 Composer 加载插件

 composer require hillholliday/craft-user-manual:2.1.2

在控制面板中，转到设置→插件，然后点击 usermanual 的“安装”按钮。
选择插件应在 CP 中用作 用户手册 页面的部分。
- (可选) - 将插件名称更改为用户能理解的内容。
- (可选) - 通过设置自定义模板覆盖来使用默认的 body 字段以外的字段。
点击 CP 导航中的 用户手册 链接。

配置

所有设置都可以通过配置文件任意配置。以下描述了包含在 config.php 中的值。

pluginNameOverride

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

templateOverride

为了更好地控制输出，您可以任意覆盖默认模板。

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

section

此部分中的条目必须具有关联的 URL。当从 usermanua.php 文件设置此值时，它必须使用部分 ID 作为值，而不是部分处理。

enabledSideBar

在手册页上启用侧边栏

默认为 true。

一些说明

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

谢谢

本插件灵感来源于70kft团队，他们致力于70kft的工作，特别是Craft-Help。虽然他们的插件在自定义Markdown文档方面更加灵活，但我们希望创建一个无需更改服务器即可轻松编辑文档的插件。这对于需要多人（尤其是非开发人员）共同编写CMS使用说明的大型项目来说尤其有效。

版本发布

5.0.1 - 要求"section"配置设置为一个整数。添加了"enabledSideBar"配置设置，以在手册页上启用/禁用侧边栏。此修复有助于解决Craft 4到Craft 5迁移中可能出现的问题。
5.0.0 - 支持 Craft 5！感谢John Morton和Dalton Rooney的贡献。
4.0.0 - 支持 Craft 4！感谢Chris DuCharme将Craft迁移到Craft 4。
2.1.0 - 合并来自JorgeAnzola和sameerast的PR。
2.0.3 - 强制更新到插件商店。
2.0.2 - 合并@aaronbushnell的修复对资产包的错误引用。
2.0.1 - 合并@mgburns的修复Craft 3弃用警告。
2.0.0 - 合并@jcdarwin的Craft 3版本端口。Craft 3版本的Craft User Manual。
1.1.1 - 添加对RTL语言的支持。
1.1.0 - 合并@timkelty的工作，包括模板覆盖、更新错误提示和其他改进。
1.0.1 - 在Craft 2.5中添加对插件自定义图标的支持。
1.0.0 - Craft User Manual的初始发布。

我们希望这个插件对您有所帮助，并欢迎您提出任何建议或问题。@erskinerob。

由Rob Erskine提供。

hillholliday / craft-user-manual

维护者

详细信息