From e39e3ed7c2350638e5519a7f4fcd72c1761242d3 Mon Sep 17 00:00:00 2001 From: weigan <1831197727@qq.com> Date: Wed, 3 Jan 2024 23:03:12 +0800 Subject: [PATCH] update document catalog --- src/zh/docs/README.md | 17 ++-- src/zh/docs/cavitylibrary/README.md | 7 ++ .../docs/{ => cavitylibrary}/cavitylibrary.md | 0 src/zh/docs/{ => commands}/Floor.md | 0 src/zh/docs/commands/README.md | 7 ++ src/zh/docs/{ => commands}/align.md | 0 src/zh/docs/{ => commands}/block.md | 0 src/zh/docs/{ => commands}/cavities.md | 0 src/zh/docs/{ => commands}/cavity.md | 0 src/zh/docs/{ => commands}/clearancecheck.md | 0 src/zh/docs/{ => commands}/clerance.md | 0 src/zh/docs/{ => commands}/connect.md | 0 src/zh/docs/{ => commands}/connectioncheck.md | 0 src/zh/docs/{ => commands}/cross.md | 0 src/zh/docs/{ => commands}/delete.md | 0 src/zh/docs/{ => commands}/depoly.md | 0 src/zh/docs/{ => commands}/drawing.md | 0 src/zh/docs/{ => commands}/edit.md | 0 src/zh/docs/{ => commands}/footprintcavity.md | 0 src/zh/docs/{ => commands}/leancavity.md | 0 src/zh/docs/{ => commands}/move.md | 0 src/zh/docs/{ => commands}/quickrotate.md | 0 src/zh/docs/{ => commands}/ringcavity.md | 0 src/zh/docs/{ => commands}/rotate.md | 0 src/zh/docs/{ => commands}/strenchblock.md | 0 src/zh/docs/{ => commands}/strenchcavity.md | 0 src/zh/docs/{ => commands}/text.md | 0 src/zh/docs/getstarted/README.md | 7 ++ .../docs/{ => getstarted}/basicknowledge.md | 5 +- src/zh/docs/{ => getstarted}/settings.md | 5 +- src/zh/docs/{ => getstarted}/tutorial.md | 19 +---- src/zh/docs/installation/README.md | 15 ++++ src/zh/docs/installation/apply.md | 23 ++++++ .../docs/{ => installation}/installation.md | 77 +++++++++++-------- src/zh/docs/installation/uninstall.md | 22 ++++++ 35 files changed, 142 insertions(+), 62 deletions(-) create mode 100644 src/zh/docs/cavitylibrary/README.md rename src/zh/docs/{ => cavitylibrary}/cavitylibrary.md (100%) rename src/zh/docs/{ => commands}/Floor.md (100%) create mode 100644 src/zh/docs/commands/README.md rename src/zh/docs/{ => commands}/align.md (100%) rename src/zh/docs/{ => commands}/block.md (100%) rename src/zh/docs/{ => commands}/cavities.md (100%) rename src/zh/docs/{ => commands}/cavity.md (100%) rename src/zh/docs/{ => commands}/clearancecheck.md (100%) rename src/zh/docs/{ => commands}/clerance.md (100%) rename src/zh/docs/{ => commands}/connect.md (100%) rename src/zh/docs/{ => commands}/connectioncheck.md (100%) rename src/zh/docs/{ => commands}/cross.md (100%) rename src/zh/docs/{ => commands}/delete.md (100%) rename src/zh/docs/{ => commands}/depoly.md (100%) rename src/zh/docs/{ => commands}/drawing.md (100%) rename src/zh/docs/{ => commands}/edit.md (100%) rename src/zh/docs/{ => commands}/footprintcavity.md (100%) rename src/zh/docs/{ => commands}/leancavity.md (100%) rename src/zh/docs/{ => commands}/move.md (100%) rename src/zh/docs/{ => commands}/quickrotate.md (100%) rename src/zh/docs/{ => commands}/ringcavity.md (100%) rename src/zh/docs/{ => commands}/rotate.md (100%) rename src/zh/docs/{ => commands}/strenchblock.md (100%) rename src/zh/docs/{ => commands}/strenchcavity.md (100%) rename src/zh/docs/{ => commands}/text.md (100%) create mode 100644 src/zh/docs/getstarted/README.md rename src/zh/docs/{ => getstarted}/basicknowledge.md (98%) rename src/zh/docs/{ => getstarted}/settings.md (93%) rename src/zh/docs/{ => getstarted}/tutorial.md (66%) create mode 100644 src/zh/docs/installation/README.md create mode 100644 src/zh/docs/installation/apply.md rename src/zh/docs/{ => installation}/installation.md (70%) create mode 100644 src/zh/docs/installation/uninstall.md diff --git a/src/zh/docs/README.md b/src/zh/docs/README.md index 887c9ba..06e0026 100644 --- a/src/zh/docs/README.md +++ b/src/zh/docs/README.md @@ -1,20 +1,17 @@ --- -title: 文档 -index: false +title: 目录 +index: true icon: discover category: - Help --- -## Catalog +## 目录 -- [1.安装](installation.md) +- [1. 软件安装](installation/README.md) -- [2.基础知识](basicknowledge.md) +- [2. 开始使用](getstarted/README.md) -- [3.教程](tutorial.md) - - [3.1 创建块](block.md) - - [3.2 插入孔腔](cavity.md) - - [3.3 插入组合孔](cavities.md) +- [3. 探索功能](commands/README.md) -- [4.孔腔库](cavitylibrary.md) \ No newline at end of file +- [4.孔腔库](cavitylibrary/README.md) \ No newline at end of file diff --git a/src/zh/docs/cavitylibrary/README.md b/src/zh/docs/cavitylibrary/README.md new file mode 100644 index 0000000..d3293bb --- /dev/null +++ b/src/zh/docs/cavitylibrary/README.md @@ -0,0 +1,7 @@ +--- +title: 4. 孔腔库 +index: false +icon: discover +category: + - Help +--- \ No newline at end of file diff --git a/src/zh/docs/cavitylibrary.md b/src/zh/docs/cavitylibrary/cavitylibrary.md similarity index 100% rename from src/zh/docs/cavitylibrary.md rename to src/zh/docs/cavitylibrary/cavitylibrary.md diff --git a/src/zh/docs/Floor.md b/src/zh/docs/commands/Floor.md similarity index 100% rename from src/zh/docs/Floor.md rename to src/zh/docs/commands/Floor.md diff --git a/src/zh/docs/commands/README.md b/src/zh/docs/commands/README.md new file mode 100644 index 0000000..27070ba --- /dev/null +++ b/src/zh/docs/commands/README.md @@ -0,0 +1,7 @@ +--- +title: 3. 探索功能 +index: false +icon: discover +category: + - Help +--- \ No newline at end of file diff --git a/src/zh/docs/align.md b/src/zh/docs/commands/align.md similarity index 100% rename from src/zh/docs/align.md rename to src/zh/docs/commands/align.md diff --git a/src/zh/docs/block.md b/src/zh/docs/commands/block.md similarity index 100% rename from src/zh/docs/block.md rename to src/zh/docs/commands/block.md diff --git a/src/zh/docs/cavities.md b/src/zh/docs/commands/cavities.md similarity index 100% rename from src/zh/docs/cavities.md rename to src/zh/docs/commands/cavities.md diff --git a/src/zh/docs/cavity.md b/src/zh/docs/commands/cavity.md similarity index 100% rename from src/zh/docs/cavity.md rename to src/zh/docs/commands/cavity.md diff --git a/src/zh/docs/clearancecheck.md b/src/zh/docs/commands/clearancecheck.md similarity index 100% rename from src/zh/docs/clearancecheck.md rename to src/zh/docs/commands/clearancecheck.md diff --git a/src/zh/docs/clerance.md b/src/zh/docs/commands/clerance.md similarity index 100% rename from src/zh/docs/clerance.md rename to src/zh/docs/commands/clerance.md diff --git a/src/zh/docs/connect.md b/src/zh/docs/commands/connect.md similarity index 100% rename from src/zh/docs/connect.md rename to src/zh/docs/commands/connect.md diff --git a/src/zh/docs/connectioncheck.md b/src/zh/docs/commands/connectioncheck.md similarity index 100% rename from src/zh/docs/connectioncheck.md rename to src/zh/docs/commands/connectioncheck.md diff --git a/src/zh/docs/cross.md b/src/zh/docs/commands/cross.md similarity index 100% rename from src/zh/docs/cross.md rename to src/zh/docs/commands/cross.md diff --git a/src/zh/docs/delete.md b/src/zh/docs/commands/delete.md similarity index 100% rename from src/zh/docs/delete.md rename to src/zh/docs/commands/delete.md diff --git a/src/zh/docs/depoly.md b/src/zh/docs/commands/depoly.md similarity index 100% rename from src/zh/docs/depoly.md rename to src/zh/docs/commands/depoly.md diff --git a/src/zh/docs/drawing.md b/src/zh/docs/commands/drawing.md similarity index 100% rename from src/zh/docs/drawing.md rename to src/zh/docs/commands/drawing.md diff --git a/src/zh/docs/edit.md b/src/zh/docs/commands/edit.md similarity index 100% rename from src/zh/docs/edit.md rename to src/zh/docs/commands/edit.md diff --git a/src/zh/docs/footprintcavity.md b/src/zh/docs/commands/footprintcavity.md similarity index 100% rename from src/zh/docs/footprintcavity.md rename to src/zh/docs/commands/footprintcavity.md diff --git a/src/zh/docs/leancavity.md b/src/zh/docs/commands/leancavity.md similarity index 100% rename from src/zh/docs/leancavity.md rename to src/zh/docs/commands/leancavity.md diff --git a/src/zh/docs/move.md b/src/zh/docs/commands/move.md similarity index 100% rename from src/zh/docs/move.md rename to src/zh/docs/commands/move.md diff --git a/src/zh/docs/quickrotate.md b/src/zh/docs/commands/quickrotate.md similarity index 100% rename from src/zh/docs/quickrotate.md rename to src/zh/docs/commands/quickrotate.md diff --git a/src/zh/docs/ringcavity.md b/src/zh/docs/commands/ringcavity.md similarity index 100% rename from src/zh/docs/ringcavity.md rename to src/zh/docs/commands/ringcavity.md diff --git a/src/zh/docs/rotate.md b/src/zh/docs/commands/rotate.md similarity index 100% rename from src/zh/docs/rotate.md rename to src/zh/docs/commands/rotate.md diff --git a/src/zh/docs/strenchblock.md b/src/zh/docs/commands/strenchblock.md similarity index 100% rename from src/zh/docs/strenchblock.md rename to src/zh/docs/commands/strenchblock.md diff --git a/src/zh/docs/strenchcavity.md b/src/zh/docs/commands/strenchcavity.md similarity index 100% rename from src/zh/docs/strenchcavity.md rename to src/zh/docs/commands/strenchcavity.md diff --git a/src/zh/docs/text.md b/src/zh/docs/commands/text.md similarity index 100% rename from src/zh/docs/text.md rename to src/zh/docs/commands/text.md diff --git a/src/zh/docs/getstarted/README.md b/src/zh/docs/getstarted/README.md new file mode 100644 index 0000000..043cc42 --- /dev/null +++ b/src/zh/docs/getstarted/README.md @@ -0,0 +1,7 @@ +--- +title: 2. 开始使用 +index: false +icon: discover +category: + - Help +--- \ No newline at end of file diff --git a/src/zh/docs/basicknowledge.md b/src/zh/docs/getstarted/basicknowledge.md similarity index 98% rename from src/zh/docs/basicknowledge.md rename to src/zh/docs/getstarted/basicknowledge.md index 7885b92..30dda27 100644 --- a/src/zh/docs/basicknowledge.md +++ b/src/zh/docs/getstarted/basicknowledge.md @@ -1,5 +1,6 @@ --- -title: 2. 基础知识 +title: 基础知识 +order: 1 icon: markdown category: - Help @@ -7,7 +8,7 @@ tag: - Markdown --- -# 2. 基础知识 +# 基础知识 ## 孔腔的定义 diff --git a/src/zh/docs/settings.md b/src/zh/docs/getstarted/settings.md similarity index 93% rename from src/zh/docs/settings.md rename to src/zh/docs/getstarted/settings.md index 1732a03..2e47b8e 100644 --- a/src/zh/docs/settings.md +++ b/src/zh/docs/getstarted/settings.md @@ -1,5 +1,6 @@ --- -title: 3.26 设置 +title: 设置 +order: 6 icon: markdown category: - Help @@ -7,7 +8,7 @@ tag: - Help --- -# 3-26. 设置 +# 设置 > 主要实现对阀块软件的基本设置内容，可以设置： diff --git a/src/zh/docs/tutorial.md b/src/zh/docs/getstarted/tutorial.md similarity index 66% rename from src/zh/docs/tutorial.md rename to src/zh/docs/getstarted/tutorial.md index 5c1e3a6..b4e2abe 100644 --- a/src/zh/docs/tutorial.md +++ b/src/zh/docs/getstarted/tutorial.md @@ -1,5 +1,6 @@ --- -title: 3. 教程 +title: 简介 +order: 4 icon: markdown category: - Help @@ -7,22 +8,6 @@ tag: - Markdown --- -# 1. 引言 - -## 1-1. 编写目的 - -* 本用户手册的编写主要是为了帮助用户更快的理解和操作液压阀块设计软件(TouchMDesign)。 - -## 1-2. 阅读建议 - -* 阅读对象，针对所有正在使用或即将使用该软件的工程师。 - -* 该软件是基于SolidWorks平台开发的液压阀块设计软件，首先要求读者熟悉SolidWorks软件的基本操作，其次要求读者熟悉液压阀块设计过程的业务流程及专业知识。 - -* 基于以上条件，用户才能更好地学习和使用本软件系统。 - -## 1-3. 系统简介 - ![图片](/images/28330553.png) •基于Solidworks软件定制开发，采用Solidworks界面风格，简单易用。 diff --git a/src/zh/docs/installation/README.md b/src/zh/docs/installation/README.md new file mode 100644 index 0000000..5d20d40 --- /dev/null +++ b/src/zh/docs/installation/README.md @@ -0,0 +1,15 @@ +--- +title: 1. 软件安装 +index: false +icon: discover +category: + - Help +--- + +## 目录 + +- [1. 申请试用](apply.md) + +- [2. 安装](installation.md) + +- [3. 卸载](uninstall.md) \ No newline at end of file diff --git a/src/zh/docs/installation/apply.md b/src/zh/docs/installation/apply.md new file mode 100644 index 0000000..837ef1f --- /dev/null +++ b/src/zh/docs/installation/apply.md @@ -0,0 +1,23 @@ +--- +title: 使用申请 +category: + - Help +tag: + - installtion +--- + +# 使用申请 + + + +--- + +如果无法通过上述表单参与，可以使用如下链接： + +[点击申请]([点击申请试用](https://p.lm.virbox.com/activity/index.html#/join?no=83104)) + +--- + +# 下一步 + +[安装](installation.md) \ No newline at end of file diff --git a/src/zh/docs/installation.md b/src/zh/docs/installation/installation.md similarity index 70% rename from src/zh/docs/installation.md rename to src/zh/docs/installation/installation.md index bb3d17c..3dee2d0 100644 --- a/src/zh/docs/installation.md +++ b/src/zh/docs/installation/installation.md @@ -1,103 +1,118 @@ --- -title: 1. 软件安装 +title: 下载安装 +order: 2 category: - Help tag: - installtion --- -# 1.引言 +# 开始 -## 1-1. 编写目的 -本用户手册的编写主要是为了帮助用户更快的理解和安装更新液压阀块智慧设计软件软件 +## 介绍 -## 1-2. 阅读建议 -阅读对象，针对所有阀块设计工程师。 该软件是基于SolidWorks2018平台开发的液压阀块智慧设计软件，首先要求读者熟悉SolidWorks2018软件的基本操作，其次要求读者熟悉油路块设计过程的业务流程及专业知识。 基于以上条件，用户才能更好地学习和使用本软件系统。 -## 1-3. 环境要求 +## 安装环境 + 本软件系统是基于SolidWorks2018平台所做的二次开发，故其电脑运行环境不低于SolidWorks2018软件当前版本运行的最低要求即可。 以下数据来源于SolidWorks官网： + ![图片](/images/24240188.png)   -# 2. 软件安装 +# 软件安装 + +## 获取安装包 -## 2-1. 获取安装包 -从南京拓勤对接负责人处，索取软件安装包； +[Download](https://sncz4-my.sharepoint.com/:f:/g/personal/weigan_sncz4_onmicrosoft_com/ErLz4eHMqJ5Dtoj1g08ES9sBEsLNDLfsMUIi9_5qfSBKZQ?e=auby3O) + +## 安装包文件 -## 2-2. 安装包文件 ![图片](/images/28329539.png) -**1、TouchManifoldDesign 是阀块设计软件的主程序安装包； -2、sense_shield_installer 是阀块软件对应许可服务安装包； -3、ndp472-kb4054530 是Windows系统.net 4.72框架组件安装包； -4、软件安装与卸载手册 是指导用户安装和卸载软件的操作手册。** -## 2-3. 安装顺序 +1. TouchManifoldDesign 是阀块设计软件的主程序安装包； +2. sense_shield_installer 是阀块软件对应许可服务安装包； + +## 安装顺序 + 先安装许可服务程序，且在保证许可认证成功后，再安装软件主程序。 +> [申请试用](apply.md) + **注意：安装主程序需要以管理员权限运行，若弹出缺失.net 4.72...的提示，则需要先安装.net 4.72框架组件后，再安装主程序文件。** -# 3.许可安装与设置 + +# 许可安装与设置 ### 步骤一： + 将许可安装包复制至本地电脑某目录下，右键“以管理员身份运行”； + ![图片](/images/28329545.png) ### 步骤二： + 在弹出界面中，单击“立即安装”命令，软件将自动安装； + ![图片](/images/28329546.png) + ![图片](/images/28329549.png) ### 步骤三： + 安装完成后，单击“立即体验”将弹出许可软件界面； + ![图片](/images/28329553.png) ### 步骤四： 在许可软件界面中，依次单击“云/软锁”>“云账号”后的加号+，输入已获得的账号及其密码，单击“确定”后登录云账号，即可看到已有许可数； + ![图片](/images/28329554.png) ### 步骤五： + 单击登录的账号后，可以看到当前账号的许可信息，如正常许可数等等； + ![图片](/images/28329555.png) ### 步骤六： + 关闭当前许可服务程序窗口即可。 -# 4.主程序的安装 +# 主程序的安装 + 注意：安装插件之前，需要关闭当前所有Solidworks软件； ### 步骤一： + 将软件安装包复制至本地电脑某目录下，右键“以管理员身份运行”； + ![图片](/images/28329560.png) + 注意：若弹出“许可未连接...”等字样，需要“重试”或“取消”，则请先保证许可认证成功后再进行安装。 ### 步骤二： + 在弹出界面中，勾选“我接受…”后，单击“Accept and Install”进行安装，如下图： + ![图片](/images/28329561.png) ### 步骤三： + 正在安装TouchMDesign阀块智慧设计软件软件 + ![图片](/images/28329562.png) ### 步骤四： -稍等几分钟后，软件安装完成，单击“完成”即可； -![图片](/images/28329565.png) -# 3. 软件卸载 -注意：卸载插件之前，需要关闭当前所有Solidworks软件； - -## 3-1. 卸载步骤 - -**1、打开电脑的“控制面板“ – “程序和功能”，找到“TouchMDesign”的程序；** -![图片](/images/28329568.png) +稍等几分钟后，软件安装完成，单击“完成”即可； -**2、右键“卸载”，将自动卸载该软件，期间会弹出小黑窗，无需操作，直至卸载完成；** -注意：若弹出“许可未连接...”等字样，需要“重试”或“取消”，则请先保证许可认证成功后再进行卸载，或者先卸载许可服务程序后再按照常规软件卸载方式卸载即可。 +![图片](/images/28329565.png) -# 4. 软件更新 +# 软件更新 说明：可直接安装覆盖原程序（操作步骤同软件安装），也可以先卸载（操作步骤同软件卸载）再安装（操作步骤同软件安装）； -# 5. 常见问题 +# 常见问题 **Q1：SolidWorks启动后，未成功加载插件菜单** A1:查看插件列表中是否存在“TouchMDesign”插件，若有，则勾选加载，若没有，则说明插件未注册成功，需要联系管理员重新注册激活插件即可。 diff --git a/src/zh/docs/installation/uninstall.md b/src/zh/docs/installation/uninstall.md new file mode 100644 index 0000000..f0ec1ce --- /dev/null +++ b/src/zh/docs/installation/uninstall.md @@ -0,0 +1,22 @@ +--- +title: 卸载 +order: 2 +category: + - Help +tag: + - installtion +--- + +# 软件卸载 + +注意：卸载插件之前，需要关闭当前所有Solidworks软件； + +# 卸载步骤 + +**打开电脑的“控制面板“ – “程序和功能”，找到“TouchMDesign”的程序；** + +![图片](/images/28329568.png) + +**右键“卸载”，将自动卸载该软件，期间会弹出小黑窗，无需操作，直至卸载完成；** + +注意：若弹出“许可未连接...”等字样，需要“重试”或“取消”，则请先保证许可认证成功后再进行卸载，或者先卸载许可服务程序后再按照常规软件卸载方式卸载即可。 \ No newline at end of file