diff --git "a/\345\260\217\347\231\275\350\257\276\347\250\213/openKylin\347\224\250\346\210\267\346\211\213\345\206\214\345\216\237\347\220\206\350\247\243\346\236\220.md" "b/\345\260\217\347\231\275\350\257\276\347\250\213/openKylin\347\224\250\346\210\267\346\211\213\345\206\214\345\216\237\347\220\206\350\247\243\346\236\220.md" index 2629bab083b4693c416e1c45776b02c87c799e81..a0f90dc1b23659274a65aa5cd6ea8d53ccac3b85 100644 --- "a/\345\260\217\347\231\275\350\257\276\347\250\213/openKylin\347\224\250\346\210\267\346\211\213\345\206\214\345\216\237\347\220\206\350\247\243\346\236\220.md" +++ "b/\345\260\217\347\231\275\350\257\276\347\250\213/openKylin\347\224\250\346\210\267\346\211\213\345\206\214\345\216\237\347\220\206\350\247\243\346\236\220.md" @@ -11,13 +11,15 @@ openKylin用户手册是详细描述openKylin操作系统的功能和用户界 2.用户手册跳转的接口为了方便用户跳转到对应组件的帮助文档,用户手册提供了接口,使得其他组件调用接口传递参数后,可以直接打开用户手册对应内容,组件通过点击F1和菜单-帮助选项进行调用。DaemonIpcDbus::showGuideDaemonIpcDbus::showGuide提供了dbus接口,组件只需要传递对应参数调用,手册这边会根据参数,打开用户手册并跳转至对应内容。 -3.用户手册运行流程上面介绍了用户手册跳转接口,下面重点介绍下用户手册运行的大致流程。首先需要实例化QWebView,开启和禁用部分设置,加载用户手册网页文件。 +3.用户手册运行流程上面介绍了用户手册跳转接口,下面重点介绍下用户手册运行的大致流程。 + +首先需要实例化QWebView,开启和禁用部分设置,加载用户手册网页文件。 ![图片](https://www.openkylin.top/upload/202301/1673400403559673.png) ![图片](https://www.openkylin.top/upload/202301/1673400415449881.png) -载入html时发送信号,将QObject对象传给JS,这样JS就能调用QObject的public slots函数 +其次,载入html时发送信号,将QObject对象传给JS,这样JS就能调用QObject的public slots函数 ![图片](https://www.openkylin.top/upload/202301/1673400425220458.png) @@ -25,21 +27,25 @@ openKylin用户手册是详细描述openKylin操作系统的功能和用户界 ![图片](https://www.openkylin.top/upload/202301/1673400473845933.png) -web端调用qt接口,获取文档信息和目录结构,动态生成首页应用。js端调用qt端函数获取信息: +再次,web端调用qt接口,获取文档信息和目录结构,动态生成首页应用。js端调用qt端函数获取信息: ![图片](https://www.openkylin.top/upload/202301/1673400482997460.png) -qt端获取手册文件结构,获取首页图标名称和文件夹名称,以及对应的文档路径: +最后,qt端获取手册文件结构,获取首页图标名称和文件夹名称,以及对应的文档路径: ![图片](https://www.openkylin.top/upload/202301/1673400491336760.png) -通过获取到的图片名称、文档路径、文件夹名称;加载图标信息,完成首页应用的加载。openKylin用户手册首页的加载流程大致就如上面所述,但实际还会涉及到Markdown文件的渲染展示,目录和内容的跟随效果;手册目录级的跳转;自动读取文档的更新日期等,这里就不一一介绍啦。二、用户手册内容自定义大家系统在集成新组件时,会希望新增组件后,把对应的组件手册内容也自动加入用户手册中,并能够进行跳转;那么这里就给大家介绍一下如何集成自己的手册内容! +通过获取到的图片名称、文档路径、文件夹名称;加载图标信息,完成首页应用的加载。openKylin用户手册首页的加载流程大致就如上面所述,但实际还会涉及到Markdown文件的渲染展示,目录和内容的跟随效果;手册目录级的跳转;自动读取文档的更新日期等,这里就不一一介绍啦。 + +二、用户手册内容自定义 + +大家在系统集成新组件时,会希望新增组件后,把对应的组件手册内容也自动加入用户手册中并能够进行跳转;那么这里就给大家介绍一下如何集成自己的手册内容! 1.文件夹结构 ![图片](https://www.openkylin.top/upload/202301/1673400502196692.png) - +ull Requ 需要包含语言文件夹,一个图标;其中文件夹名称和图标名称保持一致,会用于首页图标展示以及用户手册dbus接口调用参数。 2.Markdown文件结构 @@ -60,4 +66,4 @@ qt端获取手册文件结构,获取首页图标名称和文件夹名称,以 来源:谢嘉华 -审核:openKylin \ No newline at end of file +审核:openKylin