新版用户文档草稿
本目录用于编写全新的用户向文档。
这里的内容不直接替换正式文档,而是先作为重写草稿使用。
本目录的写作目标
新版草稿将优先解决这些问题:
- 第一次安装后应该先看什么
- 配置文件和工作空间分别负责什么
- 怎么尽快做出第一个可用物品
- 改完配置后为什么没有生效
- 什么时候该用模板、标签、动作和脚本
写作原则
- 面向使用者,而不是开发者
- 先给能抄的示例,再解释配置含义
- 尽量避免一上来讲底层实现
- 所有示例优先使用 YAML
- 以当前插件行为为准,不沿用旧字段和旧说法
当前已开始重写
- 安装与部署(重写版)
- 快速开始(重写版)
- 配置与工作空间(重写版)
- 物品系统(重写版)
- 物品动作(重写版)
- 物品数据(重写版)
- 物品标签(重写版)
- 模板继承(重写版)
- 动态物品(重写版)
- 命令与重载(重写版)
- 使用案例(重写版)
- 脚本与内联脚本(重写版)
命名规则说明
新版草稿统一采用以下规则:
- 允许跨元素类型使用相同的元素名
- 不允许同一元素类型下出现多个同名元素
说明
如果某些正式文档页仍然保留旧写法,请以本目录中的新版草稿为重写起点。