mirror of
https://github.com/halo-dev/docs.git
synced 2026-01-13 06:03:55 +08:00
refactor: update permission control docs for plugin (#443)
### What this PR does? 重构权限控制部分文档并调整相应结构 ```release-note None ```
This commit is contained in:
guqing
@@ -5,7 +5,7 @@ description: 扩展附件数据列表操作菜单 - attachment:list-item:operati
|
||||
|
||||
此扩展点用于扩展附件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件选择组件的选项卡 - attachment:selector:create
|
||||
|
||||
此扩展点用于扩展附件选择组件的选项卡，目前 Halo 仅包含内置的附件库，你可以通过此扩展点添加自定义的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份数据列表操作菜单 - backup:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展备份数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份页面选项卡 - backup:tabs:create
|
||||
|
||||
此扩展点可以针对备份页面扩展更多关于 UI 的功能，比如定时备份设置、备份到第三方云存储等。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ Console 的评论管理列表的评论来源默认仅支持显示来自文章和
|
||||
此扩展点需要后端配合使用，请参考 [评论主体展示](../../server/extension-points/comment-subject.md)。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ export interface ExtensionOptions {
|
||||
|
||||
编辑器顶部功能区域内容的扩展，通常用于增加用户常用操作，例如文本加粗、变更颜色等。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对顶部工具栏的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolbarItems` 函数即可，如：
|
||||
|
||||
@@ -128,7 +128,7 @@ addOptions() {
|
||||
|
||||
编辑器工具箱区域的扩展，可用于增加编辑器附属操作，例如插入表格，插入第三方组件等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/27](https://github.com/halo-sigs/richtext-editor/pull/27) 中，我们实现了对编辑器工具箱区域的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolboxItems` 函数即可，如：
|
||||
|
||||
@@ -199,7 +199,7 @@ addOptions() {
|
||||
|
||||
Slash Command （斜杠命令）的扩展，可用于在当前行快捷执行功能操作，例如转换当前行为标题、在当前行添加代码块等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对 Slash Command 指令的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getCommandMenuItems` 函数即可，如：
|
||||
|
||||
@@ -261,7 +261,7 @@ addOptions() {
|
||||
|
||||
编辑器悬浮菜单的扩展。可用于支持目标元素组件的功能扩展及操作简化。例如 `Table` 扩展中的添加下一列、添加上一列等操作。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/38](https://github.com/halo-sigs/richtext-editor/pull/38) 中，我们重构了对编辑器悬浮区域的扩展，如果需要对某个块进行支持，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getBubbleMenu` 函数即可，如：
|
||||
|
||||
@@ -371,7 +371,7 @@ addOptions() {
|
||||
|
||||
拖拽功能的扩展，可用于支持当前块元素的拖拽功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/48](https://github.com/halo-sigs/richtext-editor/pull/48) 中，我们实现了对所有元素的拖拽功能，如果需要让当前扩展支持拖拽，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getDraggable` 函数，并让其返回 true 即可。如：
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 通过实现扩展点为文章提供新的编辑器 - editor:create
|
||||
|
||||
此扩展点可以为文章提供新的独立编辑器。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件安装界面选项卡 - plugin:installation:tabs:create
|
||||
|
||||
目前 Halo 原生支持本地上传和远程下载的方式安装插件，此扩展点用于扩展插件安装界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展插件数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表操作菜单 - plugin:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展插件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展当前插件的详情选项卡 - plugin:self:tabs:create
|
||||
|
||||
此扩展点用于在 Console 的插件详情页面中添加自定义选项卡，可以用于自定义插件的配置页面。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展文章数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表操作菜单 - post:list-item:operation:cre
|
||||
|
||||
此扩展点用于扩展文章数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题数据列表操作菜单 - theme:list-item:operation:cr
|
||||
|
||||
此扩展点用于扩展主题数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题管理界面选项卡 - theme:list:tabs:create
|
||||
|
||||
目前在 Halo 的主题管理中原生支持本地上传和远程下载的方式安装主题，此扩展点用于扩展主题管理界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展个人中心的个人资料选项卡 - uc:user:profile:tabs:c
|
||||
|
||||
此扩展点用于扩展个人中心的个人资料选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展用户详情选项卡 - user:detail:tabs:create
|
||||
|
||||
此扩展点用于扩展用户详情页面的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ description: 了解如何与我们的社区分享你的插件
|
||||
|
||||
## 创建 Release
|
||||
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](./introduction.md#版本控制)。
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](#版本控制)。
|
||||
|
||||
## 自动构建
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件数据列表操作菜单 - attachment:list-item:operati
|
||||
|
||||
此扩展点用于扩展附件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件选择组件的选项卡 - attachment:selector:create
|
||||
|
||||
此扩展点用于扩展附件选择组件的选项卡，目前 Halo 仅包含内置的附件库，你可以通过此扩展点添加自定义的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份数据列表操作菜单 - backup:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展备份数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份页面选项卡 - backup:tabs:create
|
||||
|
||||
此扩展点可以针对备份页面扩展更多关于 UI 的功能，比如定时备份设置、备份到第三方云存储等。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ Console 的评论管理列表的评论来源默认仅支持显示来自文章和
|
||||
此扩展点需要后端配合使用，请参考 [评论主体展示](../../server/extension-points/comment-subject.md)。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ export interface ExtensionOptions {
|
||||
|
||||
编辑器顶部功能区域内容的扩展，通常用于增加用户常用操作，例如文本加粗、变更颜色等。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对顶部工具栏的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolbarItems` 函数即可，如：
|
||||
|
||||
@@ -128,7 +128,7 @@ addOptions() {
|
||||
|
||||
编辑器工具箱区域的扩展，可用于增加编辑器附属操作，例如插入表格，插入第三方组件等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/27](https://github.com/halo-sigs/richtext-editor/pull/27) 中，我们实现了对编辑器工具箱区域的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolboxItems` 函数即可，如：
|
||||
|
||||
@@ -199,7 +199,7 @@ addOptions() {
|
||||
|
||||
Slash Command （斜杠命令）的扩展，可用于在当前行快捷执行功能操作，例如转换当前行为标题、在当前行添加代码块等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对 Slash Command 指令的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getCommandMenuItems` 函数即可，如：
|
||||
|
||||
@@ -261,7 +261,7 @@ addOptions() {
|
||||
|
||||
编辑器悬浮菜单的扩展。可用于支持目标元素组件的功能扩展及操作简化。例如 `Table` 扩展中的添加下一列、添加上一列等操作。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/38](https://github.com/halo-sigs/richtext-editor/pull/38) 中，我们重构了对编辑器悬浮区域的扩展，如果需要对某个块进行支持，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getBubbleMenu` 函数即可，如：
|
||||
|
||||
@@ -371,7 +371,7 @@ addOptions() {
|
||||
|
||||
拖拽功能的扩展，可用于支持当前块元素的拖拽功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/48](https://github.com/halo-sigs/richtext-editor/pull/48) 中，我们实现了对所有元素的拖拽功能，如果需要让当前扩展支持拖拽，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getDraggable` 函数，并让其返回 true 即可。如：
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 通过实现扩展点为文章提供新的编辑器 - editor:create
|
||||
|
||||
此扩展点可以为文章提供新的独立编辑器。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件安装界面选项卡 - plugin:installation:tabs:create
|
||||
|
||||
目前 Halo 原生支持本地上传和远程下载的方式安装插件，此扩展点用于扩展插件安装界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展插件数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表操作菜单 - plugin:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展插件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展当前插件的详情选项卡 - plugin:self:tabs:create
|
||||
|
||||
此扩展点用于在 Console 的插件详情页面中添加自定义选项卡，可以用于自定义插件的配置页面。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展文章数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表操作菜单 - post:list-item:operation:cre
|
||||
|
||||
此扩展点用于扩展文章数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题数据列表操作菜单 - theme:list-item:operation:cr
|
||||
|
||||
此扩展点用于扩展主题数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题管理界面选项卡 - theme:list:tabs:create
|
||||
|
||||
目前在 Halo 的主题管理中原生支持本地上传和远程下载的方式安装主题，此扩展点用于扩展主题管理界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展个人中心的个人资料选项卡 - uc:user:profile:tabs:c
|
||||
|
||||
此扩展点用于扩展个人中心的个人资料选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展用户详情选项卡 - user:detail:tabs:create
|
||||
|
||||
此扩展点用于扩展用户详情页面的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ description: 了解如何与我们的社区分享你的插件
|
||||
|
||||
## 创建 Release
|
||||
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](./introduction.md#版本控制)。
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](#版本控制)。
|
||||
|
||||
## 自动构建
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件数据列表操作菜单 - attachment:list-item:operati
|
||||
|
||||
此扩展点用于扩展附件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件选择组件的选项卡 - attachment:selector:create
|
||||
|
||||
此扩展点用于扩展附件选择组件的选项卡，目前 Halo 仅包含内置的附件库，你可以通过此扩展点添加自定义的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份数据列表操作菜单 - backup:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展备份数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份页面选项卡 - backup:tabs:create
|
||||
|
||||
此扩展点可以针对备份页面扩展更多关于 UI 的功能，比如定时备份设置、备份到第三方云存储等。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ Console 的评论管理列表的评论来源默认仅支持显示来自文章和
|
||||
此扩展点需要后端配合使用，请参考 [评论主体展示](../../server/extension-points/comment-subject.md)。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ export interface ExtensionOptions {
|
||||
|
||||
编辑器顶部功能区域内容的扩展，通常用于增加用户常用操作，例如文本加粗、变更颜色等。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对顶部工具栏的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolbarItems` 函数即可，如：
|
||||
|
||||
@@ -128,7 +128,7 @@ addOptions() {
|
||||
|
||||
编辑器工具箱区域的扩展，可用于增加编辑器附属操作，例如插入表格，插入第三方组件等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/27](https://github.com/halo-sigs/richtext-editor/pull/27) 中，我们实现了对编辑器工具箱区域的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolboxItems` 函数即可，如：
|
||||
|
||||
@@ -199,7 +199,7 @@ addOptions() {
|
||||
|
||||
Slash Command （斜杠命令）的扩展，可用于在当前行快捷执行功能操作，例如转换当前行为标题、在当前行添加代码块等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对 Slash Command 指令的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getCommandMenuItems` 函数即可，如：
|
||||
|
||||
@@ -261,7 +261,7 @@ addOptions() {
|
||||
|
||||
编辑器悬浮菜单的扩展。可用于支持目标元素组件的功能扩展及操作简化。例如 `Table` 扩展中的添加下一列、添加上一列等操作。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/38](https://github.com/halo-sigs/richtext-editor/pull/38) 中，我们重构了对编辑器悬浮区域的扩展，如果需要对某个块进行支持，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getBubbleMenu` 函数即可，如：
|
||||
|
||||
@@ -371,7 +371,7 @@ addOptions() {
|
||||
|
||||
拖拽功能的扩展，可用于支持当前块元素的拖拽功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/48](https://github.com/halo-sigs/richtext-editor/pull/48) 中，我们实现了对所有元素的拖拽功能，如果需要让当前扩展支持拖拽，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getDraggable` 函数，并让其返回 true 即可。如：
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 通过实现扩展点为文章提供新的编辑器 - editor:create
|
||||
|
||||
此扩展点可以为文章提供新的独立编辑器。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件安装界面选项卡 - plugin:installation:tabs:create
|
||||
|
||||
目前 Halo 原生支持本地上传和远程下载的方式安装插件，此扩展点用于扩展插件安装界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展插件数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表操作菜单 - plugin:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展插件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展当前插件的详情选项卡 - plugin:self:tabs:create
|
||||
|
||||
此扩展点用于在 Console 的插件详情页面中添加自定义选项卡，可以用于自定义插件的配置页面。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展文章数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表操作菜单 - post:list-item:operation:cre
|
||||
|
||||
此扩展点用于扩展文章数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题数据列表操作菜单 - theme:list-item:operation:cr
|
||||
|
||||
此扩展点用于扩展主题数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题管理界面选项卡 - theme:list:tabs:create
|
||||
|
||||
目前在 Halo 的主题管理中原生支持本地上传和远程下载的方式安装主题，此扩展点用于扩展主题管理界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展个人中心的个人资料选项卡 - uc:user:profile:tabs:c
|
||||
|
||||
此扩展点用于扩展个人中心的个人资料选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展用户详情选项卡 - user:detail:tabs:create
|
||||
|
||||
此扩展点用于扩展用户详情页面的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ description: 了解如何与我们的社区分享你的插件
|
||||
|
||||
## 创建 Release
|
||||
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](./introduction.md#版本控制)。
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](#版本控制)。
|
||||
|
||||
## 自动构建
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件数据列表操作菜单 - attachment:list-item:operati
|
||||
|
||||
此扩展点用于扩展附件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件选择组件的选项卡 - attachment:selector:create
|
||||
|
||||
此扩展点用于扩展附件选择组件的选项卡，目前 Halo 仅包含内置的附件库，你可以通过此扩展点添加自定义的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份数据列表操作菜单 - backup:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展备份数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份页面选项卡 - backup:tabs:create
|
||||
|
||||
此扩展点可以针对备份页面扩展更多关于 UI 的功能，比如定时备份设置、备份到第三方云存储等。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展评论数据列表操作菜单 - comment:list-item:operation:
|
||||
|
||||
此扩展点用于扩展评论数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ Console 的评论管理列表的评论来源默认仅支持显示来自文章和
|
||||
此扩展点需要后端配合使用，请参考 [评论主体展示](../../server/extension-points/comment-subject.md)。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ export interface ExtensionOptions {
|
||||
|
||||
编辑器顶部功能区域内容的扩展，通常用于增加用户常用操作，例如文本加粗、变更颜色等。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对顶部工具栏的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolbarItems` 函数即可，如：
|
||||
|
||||
@@ -128,7 +128,7 @@ addOptions() {
|
||||
|
||||
编辑器工具箱区域的扩展，可用于增加编辑器附属操作，例如插入表格，插入第三方组件等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/27](https://github.com/halo-sigs/richtext-editor/pull/27) 中，我们实现了对编辑器工具箱区域的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolboxItems` 函数即可，如：
|
||||
|
||||
@@ -199,7 +199,7 @@ addOptions() {
|
||||
|
||||
Slash Command （斜杠命令）的扩展，可用于在当前行快捷执行功能操作，例如转换当前行为标题、在当前行添加代码块等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对 Slash Command 指令的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getCommandMenuItems` 函数即可，如：
|
||||
|
||||
@@ -261,7 +261,7 @@ addOptions() {
|
||||
|
||||
编辑器悬浮菜单的扩展。可用于支持目标元素组件的功能扩展及操作简化。例如 `Table` 扩展中的添加下一列、添加上一列等操作。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/38](https://github.com/halo-sigs/richtext-editor/pull/38) 中，我们重构了对编辑器悬浮区域的扩展，如果需要对某个块进行支持，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getBubbleMenu` 函数即可，如：
|
||||
|
||||
@@ -371,7 +371,7 @@ addOptions() {
|
||||
|
||||
拖拽功能的扩展，可用于支持当前块元素的拖拽功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/48](https://github.com/halo-sigs/richtext-editor/pull/48) 中，我们实现了对所有元素的拖拽功能，如果需要让当前扩展支持拖拽，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getDraggable` 函数，并让其返回 true 即可。如：
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 通过实现扩展点为文章提供新的编辑器 - editor:create
|
||||
|
||||
此扩展点可以为文章提供新的独立编辑器。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件安装界面选项卡 - plugin:installation:tabs:create
|
||||
|
||||
目前 Halo 原生支持本地上传和远程下载的方式安装插件，此扩展点用于扩展插件安装界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展插件数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展插件数据列表操作菜单 - plugin:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展插件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展当前插件的详情选项卡 - plugin:self:tabs:create
|
||||
|
||||
此扩展点用于在 Console 的插件详情页面中添加自定义选项卡，可以用于自定义插件的配置页面。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表显示字段 - plugin:list-item:field:creat
|
||||
|
||||
此扩展点用于扩展文章数据列表的显示字段。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展文章数据列表操作菜单 - post:list-item:operation:cre
|
||||
|
||||
此扩展点用于扩展文章数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展回复数据列表操作菜单 - reply:list-item:operation:cr
|
||||
|
||||
此扩展点用于扩展回复数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题数据列表操作菜单 - theme:list-item:operation:cr
|
||||
|
||||
此扩展点用于扩展主题数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展主题管理界面选项卡 - theme:list:tabs:create
|
||||
|
||||
目前在 Halo 的主题管理中原生支持本地上传和远程下载的方式安装主题，此扩展点用于扩展主题管理界面的选项卡，以支持更多的安装方式。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展个人中心的个人资料选项卡 - uc:user:profile:tabs:c
|
||||
|
||||
此扩展点用于扩展个人中心的个人资料选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展用户详情选项卡 - user:detail:tabs:create
|
||||
|
||||
此扩展点用于扩展用户详情页面的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ description: 了解如何与我们的社区分享你的插件
|
||||
|
||||
## 创建 Release
|
||||
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](./introduction.md#版本控制)。
|
||||
当你完成了你的插件并进行充分测试后，就可以在 GitHub 上创建新的 Release，其中版本规范可以参考[版本控制](#版本控制)。
|
||||
|
||||
## 自动构建
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ public interface ExtensionGetter {
|
||||
|
||||
通过使用 `ExtensionGetter`，开发者可以轻松地在插件中访问和管理各种扩展点，提升插件的功能和灵活性。
|
||||
|
||||
如果想了解 Halo 提供的扩展点请参考：[扩展点](./extension-points/index.md)。
|
||||
如果想了解 Halo 提供的扩展点请参考：[扩展点](../../extension-points/server/index.md)。
|
||||
:::
|
||||
|
||||
### 示例
|
||||
|
||||
@@ -123,4 +123,4 @@ export interface PluginModule {
|
||||
- `components`：组件列表，key 为组件名称，value 为组件对象，在此定义之后，加载插件时会自动注册到 Vue App 全局。
|
||||
- `routes`：Console 控制台路由定义，详细文档可参考 [路由定义](../../api-reference/ui/route.md)
|
||||
- `ucRoutes`：UC 个人中心路由定义，详细文档可参考 [路由定义](../../api-reference/ui/route.md)
|
||||
- `extensionPoints`：扩展点定义，详细文档可参考 [扩展点](../../api-reference/ui/extension-points/index.md)
|
||||
- `extensionPoints`：扩展点定义，详细文档可参考 [扩展点](../../extension-points/ui/index.md)
|
||||
|
||||
@@ -26,7 +26,7 @@ public interface CommentSubject<T extends Extension> extends ExtensionPoint {
|
||||
- `getSubjectDisplay` 方法用于获取评论主体的展示信息，返回值为 `Mono<SubjectDisplay>`，其中 `SubjectDisplay` 为评论主体的展示信息，包含标题、链接和类型名称，用于在主题端展示评论主体的信息。
|
||||
- `supports` 方法用于判断是否支持该评论主体，返回值为 `boolean`，如果支持则返回 `true`，否则返回 `false`。
|
||||
|
||||
实现该扩展点后，评论列表会通过 `get` 方法将主体的自定义模型对象带到评论列表中，可以配置前端的扩展点来决定如何展示评论主体的信息，参考：[UI 评论来源显示](../../ui/extension-points//comment-subject-ref-create.md)
|
||||
实现该扩展点后，评论列表会通过 `get` 方法将主体的自定义模型对象带到评论列表中，可以配置前端的扩展点来决定如何展示评论主体的信息，参考：[UI 评论来源显示](../ui/comment-subject-ref-create.md)
|
||||
|
||||
例如对于文章是支持评论的，所以文章的评论主体扩展点实现如下：
|
||||
|
||||
@@ -54,7 +54,7 @@ spec:
|
||||
单实例或多实例扩展点的实现也必须声明一个对应的 `ExtensionDefinition` 自定义模型对象被称之为扩展定义，用于描述该扩展的信息，例如：扩展的名称、描述、对应扩展点的对象名称等。
|
||||
:::
|
||||
|
||||
关于如何在插件中声明自定义模型对象请参考：[自定义模型](../../server/extension.md#declare-extension-object)
|
||||
关于如何在插件中声明自定义模型对象请参考：[自定义模型](../../api-reference/server/extension.md#declare-extension-object)
|
||||
|
||||
以下是目前已支持的扩展点列表：
|
||||
|
||||
@@ -34,7 +34,7 @@ spec:
|
||||
```
|
||||
|
||||
- `notifierExtName` 为通知器扩展的自定义模型对象名称
|
||||
- `senderSettingRef` 用于声明通知器的发送者配置，例如：邮件通知器的发送者配置为：SMTP 服务器地址、端口、用户名、密码等，如果没有可以不配置，参考：[表单定义](../../../../form-schema.md)
|
||||
- `senderSettingRef` 用于声明通知器的发送者配置，例如：邮件通知器的发送者配置为：SMTP 服务器地址、端口、用户名、密码等，如果没有可以不配置，参考：[表单定义](../../../form-schema.md)
|
||||
- `name` 为发送者配置的名称，它是一个 `Setting` 自定义模型对象的名称。
|
||||
- `group` 用于引用到一个具体的配置 Schema 组，它是一个 `Setting` 自定义模型对象中描述的 `formSchema` 的 `group`，由于 `Setting` 可以声明多个配置分组但通知器的发送者配置只能有在一个组，因此需要指定一个组。
|
||||
- `receiverSettingRef` 用于声明通知器的接收者配置，例如：邮件通知器的接收者配置为：接收者邮箱地址，如果没有可以不配置，`name` 和 `group` 配置同 `senderSettingRef`。
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件数据列表操作菜单 - attachment:list-item:operati
|
||||
|
||||
此扩展点用于扩展附件数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展附件选择组件的选项卡 - attachment:selector:create
|
||||
|
||||
此扩展点用于扩展附件选择组件的选项卡，目前 Halo 仅包含内置的附件库，你可以通过此扩展点添加自定义的选项卡。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份数据列表操作菜单 - backup:list-item:operation:c
|
||||
|
||||
此扩展点用于扩展备份数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展备份页面选项卡 - backup:tabs:create
|
||||
|
||||
此扩展点可以针对备份页面扩展更多关于 UI 的功能，比如定时备份设置、备份到第三方云存储等。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 扩展评论数据列表操作菜单 - comment:list-item:operation:
|
||||
|
||||
此扩展点用于扩展评论数据列表的操作菜单项。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
@@ -6,10 +6,10 @@ description: 扩展评论来源显示 - comment:subject-ref:create
|
||||
Console 的评论管理列表的评论来源默认仅支持显示来自文章和页面的评论，如果其他插件中的业务模块也使用了评论，那么就可以通过该拓展点来扩展评论来源的显示。
|
||||
|
||||
:::info 提示
|
||||
此扩展点需要后端配合使用，请参考 [评论主体展示](../../server/extension-points/comment-subject.md)。
|
||||
此扩展点需要后端配合使用，请参考 [评论主体展示](../server/comment-subject.md)。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
@@ -58,7 +58,7 @@ export interface ExtensionOptions {
|
||||
|
||||
编辑器顶部功能区域内容的扩展，通常用于增加用户常用操作，例如文本加粗、变更颜色等。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对顶部工具栏的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolbarItems` 函数即可，如：
|
||||
|
||||
@@ -128,7 +128,7 @@ addOptions() {
|
||||
|
||||
编辑器工具箱区域的扩展，可用于增加编辑器附属操作，例如插入表格，插入第三方组件等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/27](https://github.com/halo-sigs/richtext-editor/pull/27) 中，我们实现了对编辑器工具箱区域的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getToolboxItems` 函数即可，如：
|
||||
|
||||
@@ -199,7 +199,7 @@ addOptions() {
|
||||
|
||||
Slash Command （斜杠命令）的扩展，可用于在当前行快捷执行功能操作，例如转换当前行为标题、在当前行添加代码块等功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/16](https://github.com/halo-sigs/richtext-editor/pull/16) 中，我们实现了对 Slash Command 指令的扩展，如果需要添加额外的功能，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getCommandMenuItems` 函数即可，如：
|
||||
|
||||
@@ -261,7 +261,7 @@ addOptions() {
|
||||
|
||||
编辑器悬浮菜单的扩展。可用于支持目标元素组件的功能扩展及操作简化。例如 `Table` 扩展中的添加下一列、添加上一列等操作。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/38](https://github.com/halo-sigs/richtext-editor/pull/38) 中，我们重构了对编辑器悬浮区域的扩展，如果需要对某个块进行支持，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getBubbleMenu` 函数即可，如：
|
||||
|
||||
@@ -371,7 +371,7 @@ addOptions() {
|
||||
|
||||
拖拽功能的扩展，可用于支持当前块元素的拖拽功能。
|
||||
|
||||
|
||||
|
||||
|
||||
在 [https://github.com/halo-sigs/richtext-editor/pull/48](https://github.com/halo-sigs/richtext-editor/pull/48) 中，我们实现了对所有元素的拖拽功能，如果需要让当前扩展支持拖拽，只需要在具体的 Tiptap Extension 中的 `addOptions` 中定义 `getDraggable` 函数，并让其返回 true 即可。如：
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 通过实现扩展点为文章提供新的编辑器 - editor:create
|
||||
|
||||
此扩展点可以为文章提供新的独立编辑器。
|
||||
|
||||
|
||||
|
||||
|
||||
## 定义方式
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user