Skip to content

Commit

Permalink
doc: update extend guide doc
Browse files Browse the repository at this point in the history
Log:
Change-Id: Iaa1c8133235d4c6200fb4770e5728c13da603f35
  • Loading branch information
deepin-mozart committed Oct 31, 2024
1 parent 009647d commit e307c4b
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions docs/extended-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@

## 一、扩展能力支持

| 能力 | 描述 | 是否支持 |
| ---------------- | ------------------------------------------------------------ | ------------------ |
| 插件扩展 | 按照规范编写插件,安装到指定位置后可以识别加载,目前仅支持C++插件 | 支持 |
| 界面元素扩展 | 调用对应接口,可以在 IDE 的导航栏、菜单栏、工具栏、底部窗口、右侧窗口插入自定义界面 | 支持 |
| 编程语言扩展 | 支持新的编程语言接入,实现编译、调试等功能 | 支持 |
| 工程信息获取 | 可以获取工程的目录、类型、参数等 | 支持 |
| 自定义调试器接入 | 支持接入除 DAP 调试器以外的自定义调试器 | 支持 |
| 编辑器交互能力 | 发布编辑器的各种事件,比如悬停、补全等,并提供编辑的各类接口,如插入、获取、统计等 | 计划在下一版本支持 |
| 模板扩展 | 支持导入外部工程模板,并支持创建新的引导界面 | 支持 |
对应的 deepin-unioncode 版本:**1.3.12**

在线文档:https://github.com/linuxdeepin/deepin-unioncode/blob/master/docs/extended-guide.md

| 能力 | 描述 | 是否支持 |
| ---------------- | ------------------------------------------------------------ | -------- |
| 插件扩展 | 按照规范编写插件,安装到指定位置后可以识别加载,目前仅支持C++插件 | 支持 |
| 界面元素扩展 | 调用对应接口,可以在 IDE 的导航栏、菜单栏、工具栏、底部窗口、右侧窗口插入自定义界面 | 支持 |
| 编程语言扩展 | 支持新的编程语言接入,实现编译、调试等功能 | 支持 |
| 工程信息获取 | 可以获取工程的目录、类型、参数等 | 支持 |
| 自定义调试器接入 | 支持接入除 DAP 调试器以外的自定义调试器 | 支持 |
| 编辑器交互能力 | 发布编辑器的各种事件,比如悬停、补全等,并提供编辑的各类接口,如插入、获取、统计等 | 支持 |
| 模板扩展 | 支持导入外部工程模板,并支持创建新的引导界面 | 支持 |



Expand Down Expand Up @@ -94,13 +98,13 @@ install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${PLUGIN_INSTALL_PATH})

​ 完成上述操作后,打开系统中安装的`deepin-unioncode`,可以在导航栏、底部窗口看到 Demo 控件:

### ![demo-widget](rc-guide/demo-widget.jpg)
![demo-widget](rc-guide/demo-widget.jpg)

- 编译安装(方式2)

先拉取`deepin-unioncode`源码,假设源码存储的路径为`project-path`,在该源码可以编译运行的基础上,创建插件模板,将插件模板的源码整个放入`project-path/src/plugins`目录下,修改`project-path/src/plugins/CMakelists.txt`,在中加入`add_subdirectory(xx)`其中xx为插件工程目录名,直接使用`deepin-unioncode`工程。

### 2、功能接口
### 2、扩展接口

[插件模板](#插件模板)讲述了如何接入一个 `IDE` 插件,本章将介绍如何在插件中调用 `IDE` 的能力,实现界面嵌入、菜单接入等常用功能。

Expand Down Expand Up @@ -239,9 +243,9 @@ services 是 IDE 提供的服务接口,该接口是通过动态绑定的形式
### 1、配置文件
**1、templates.json** 用于添加模板的类型和指定模板的位置
**templates.json** 用于添加模板的类型和指定模板的位置
**2、wizard.json** 用于配置模板工程的详细信息
**wizard.json** 用于配置模板工程的详细信息
### 2、创建步骤
Expand Down

0 comments on commit e307c4b

Please sign in to comment.