diff --git a/docs/README/management-project/img/doc-diff1.png b/docs/README/management-document/img/doc-diff1.png similarity index 100% rename from docs/README/management-project/img/doc-diff1.png rename to docs/README/management-document/img/doc-diff1.png diff --git a/docs/README/management-project/img/doc-diff2.png b/docs/README/management-document/img/doc-diff2.png similarity index 100% rename from docs/README/management-project/img/doc-diff2.png rename to docs/README/management-document/img/doc-diff2.png diff --git a/docs/README/management-project/img/doc-diff3.png b/docs/README/management-document/img/doc-diff3.png similarity index 100% rename from docs/README/management-project/img/doc-diff3.png rename to docs/README/management-document/img/doc-diff3.png diff --git a/docs/README/management-project/img/doc-diff4.png b/docs/README/management-document/img/doc-diff4.png similarity index 100% rename from docs/README/management-project/img/doc-diff4.png rename to docs/README/management-document/img/doc-diff4.png diff --git a/docs/README/management-project/img/doc-diff5.png b/docs/README/management-document/img/doc-diff5.png similarity index 100% rename from docs/README/management-project/img/doc-diff5.png rename to docs/README/management-document/img/doc-diff5.png diff --git a/docs/README/management-project/img/project-export1.png b/docs/README/management-document/img/project-export1.png similarity index 100% rename from docs/README/management-project/img/project-export1.png rename to docs/README/management-document/img/project-export1.png diff --git a/docs/README/management-project/img/project-export2.png b/docs/README/management-document/img/project-export2.png similarity index 100% rename from docs/README/management-project/img/project-export2.png rename to docs/README/management-document/img/project-export2.png diff --git a/docs/README/management-document/img/template-edit1.png b/docs/README/management-document/img/template-edit1.png new file mode 100644 index 0000000..6b5a200 Binary files /dev/null and b/docs/README/management-document/img/template-edit1.png differ diff --git a/docs/README/management-document/img/template-edit2.png b/docs/README/management-document/img/template-edit2.png new file mode 100644 index 0000000..5d4511d Binary files /dev/null and b/docs/README/management-document/img/template-edit2.png differ diff --git a/docs/README/management-document/img/template-edit3.png b/docs/README/management-document/img/template-edit3.png new file mode 100644 index 0000000..fdec4d8 Binary files /dev/null and b/docs/README/management-document/img/template-edit3.png differ diff --git a/docs/README/management-document/index.md b/docs/README/management-document/index.md new file mode 100644 index 0000000..ff93e97 --- /dev/null +++ b/docs/README/management-document/index.md @@ -0,0 +1,83 @@ +## 文档导出 + +Databasir 支持多种类型的文档格式导出,该功能位于文档详情页面to,通过项目列表中点击指定项目的**查看文档**进入 + +![](img/project-export1.png) + + + +进入文档页面以后,鼠标指向**导出**按钮即可显示出目前支持的文档导出格式 + +![](img/project-export2.png) + + + +## 版本差异对比 + +如果成功同步了多个版本的文档,你可以随意的选择版本进行差异对比。 + +在文档页面,点击**显示版本差异**按钮 + +![](img/doc-diff1.png) + +启用以后会出现一个对比版本的下拉框,选择我们要对比的版本,默认情况下基础版本是最新的,也就是在对比新版本比老版本有什么变化 + +![](img/doc-diff2.png) + +选中版本以后就自动出现了差异标记 + +- 绿色:标识新增 +- 红色:标识删除 +- 黄色:标识修改 +- 灰色:标识无变化 + +![](img/doc-diff3.png) + +比如下图 + +- 删除了 document_remark 表 +- 修改了 table_column_document、table_document 表 +- 新增了 table_foreign_key_document 表 + +![](img/doc-diff4.png) + +切换到修改表的地方,可以查看具体的修改内容,比如下图就展示了 + +- type 字段的类型由 text 改为了 varchar +- comment 字段的类型由 text 改为了 varchar + +![](img/doc-diff5.png) + + + +## 自定义文档表头 + +目前 Databasir 的文档主要是以表格形式进行内容展示,包括了一下内容 + +- 表信息 +- 列信息 +- 索引信息 +- 外键信息 +- 触发器信息 + +这其中除了表信息以外,其他的表格内容都支持自定义表头(默认表头为英文)。 + +该操作需要拥有系统管理员权限,操作之前需要注意表格头名称的更改是全局的,即所有的项目都会生效。 + +页面入口位于侧边菜单栏的**文档模板** + +![](img/template-edit1.png) + + + +点击就会跳转编辑页面,在页面我们可以看见四个 Tab 页,就对应了 4 个表格的配置。 + +默认情况下,**值**是空的,我们可以通过填入新的名称替代默认值,比如我修改了列的字段名配置 + +![](img/template-edit2.png) + +修改完成以后记得点击保存按钮进行保存, + +如果你想验证变更后的效果,可以通过预览按钮查看 + +![](img/template-edit3.png) \ No newline at end of file diff --git a/docs/README/management-project/index.md b/docs/README/management-project/index.md index 4dba1b7..7519ed7 100644 --- a/docs/README/management-project/index.md +++ b/docs/README/management-project/index.md @@ -145,52 +145,3 @@ 点击保存即可完成配置 -## 文档导出 - -Databasir 支持多种类型的文档格式导出,该功能位于文档详情页面to,通过项目列表中点击指定项目的**查看文档**进入 - -![](img/project-export1.png) - - - -进入文档页面以后,鼠标指向**导出**按钮即可显示出目前支持的文档导出格式 - -![](img/project-export2.png) - - - -## 版本差异对比 - -如果成功同步了多个版本的文档,你可以随意的选择版本进行差异对比。 - -在文档页面,点击**显示版本差异**按钮 - -![](img/doc-diff1.png) - -启用以后会出现一个对比版本的下拉框,选择我们要对比的版本,默认情况下基础版本是最新的,也就是在对比新版本比老版本有什么变化 - -![](img/doc-diff2.png) - -选中版本以后就自动出现了差异标记 - -- 绿色:标识新增 -- 红色:标识删除 -- 黄色:标识修改 -- 灰色:标识无变化 - -![](img/doc-diff3.png) - -比如下图 - -- 删除了 document_remark 表 -- 修改了 table_column_document、table_document 表 -- 新增了 table_foreign_key_document 表 - -![](img/doc-diff4.png) - -切换到修改表的地方,可以查看具体的修改内容,比如下图就展示了 - -- type 字段的类型由 text 改为了 varchar -- comment 字段的类型由 text 改为了 varchar - -![](img/doc-diff5.png) \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md index a4a9fe7..13cbece 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -9,9 +9,10 @@ * 基础操作 * [分组管理](README/management-group/index.md) * [项目管理](README/management-project/index.md) + * [文档管理](README/management-document/index.md) * [用户管理](README/management-user/index.md) * [邮箱设置](README/management-email/index.md) - + * 进阶操作 * [启用 Github 第三方认证登录](README/github-oauth2/github-oauth2.md) * [启用 Gitlab 第三方认证登录](README/gitlab-oauth2/gitlab-oauth2.md)