Contextual Help for an Add-on-如何创建文档文件目录树
-
本示例教程你将学到的内容
-
CAADoc 示例用例
- CAADoc 的功能作用
- 如何运行启动 CAADoc
- CAADoc 相关文件存放路径
-
分步操作指南
-
内容小结
-
参考资料
本用例学习目标
本用例旨在向你演示，CATIA 应用插件 对应的文档文件目录树的整体结构与内容构成 [1]。
CAADoc 用例
CAADoc 的作用
- 点击开始菜单，选择基础架构，再选中 CAA V5：几何创建
- 在文件新建对话框中选择 CAAGeometry，点击确定
- 点击工具菜单，选择选项
- 在常规选项中切换到帮助选项卡页面
- 在技术文档编辑栏中输入路径：
<安装根目录>/CAADoc/CAAApplicationFrame.edu/CAADoc
其中 <安装根目录> 为 CAA 安装盘的安装目录。 - 最后点击确定即可。
- 启动点命令
![图片]()
- 按下 F1 键
随即会弹出如下 HTML 帮助页面：
图 1：点命令帮助页面
页面顶部包含一个指向插件主页的链接（主页图标），见图 3。
- 框架左上：CATIA 标题栏页面，显示软件版本、当前发行版本及主页图标；
- 框架右上：与 CAAGeometry 工作台集关联的标题栏页面，包含工作台集名称和专属图标；
- 顶部中间：CATIA 标题栏与 CAAGeometry 工作台集标题栏之间为空白页面，在达索标准文档中，该位置用于放置导航工具；
- 框架左侧：工作台集对应的目录页面，通过上下文帮助唤起时该页面为空；
- 框架居中：当前命令对应的帮助详情页面。
- 启动长方体命令
- 按下 F1 键，将显示如下 HTML 帮助页面：
图 2：长方体命令帮助页面
- 点击该图标
![图片]()
随即展示以下 HTML 页面：
图 3：主页页面
这是该插件的主页。页面中可以看到工作台集图标以及每个独立工作台的图标，点击对应图标，即可进入相关主体的信息介绍页面。
点击此图标。
随后将显示如下 HTML 页面：
图 4：CAA V5 几何分析工作台主页
为展示该页面，V5 应用会自动在 CATIAfr_C2 目录下创建一个框架集文件（AnaWbCATIAfrs.htm）。该框架集调用几何分析工作台的相关 HTML 页面，并划分为四个区域：
- 框架左上角：CATIA 标题栏页面，显示软件版本、当前发行版本及主页图标；
- 框架右上角：几何分析工作台对应的标题栏页面，包含工作台名称与专属图标；
- 框架左侧：几何分析工作台的目录页面；
- 框架居中：工作台对应的详情主页页面。
- 在浏览器中点击返回
- 点击该图标
![图片]()
随即显示如下 HTML 页面：
图 5：CAA V5 几何创建工作台主页
该默认页面关联注册表项：CATFrame.HelpTopics LongHelpId。若要将此页面纳入自有产品帮助体系，需自行创建对应的 HTML 帮助主题页面，并在专属的 CommonId2url.CATNls 文件中，将该页面与 CATFrame.HelpTopics 关键字进行关联配置。
如何启动 CAADoc
- CAAApplicationFrame.edu
- CAACATIAApplicationFrame.edu
- CAADialogEngine.edu
- CAASystem.edu
- CAAVisualization.edu
CAADoc 文件存放位置
<安装根目录>\CAADoc\CAAApplicationFrame.edu\CAADoc\<安装根目录>/CAADoc/CAAApplicationFrame.edu/CAADoc/<安装根目录> 指 CAA 安装包的安装目录。分步说明
- 创建文档文件目录结构与内容
- 插入法语版本文档
创建文档文件树形目录结构
首先创建两个子目录：online 目录和 resources 目录。
online 目录内容
CATIAfr_C2 目录包含以下文件：
CATIA 标题栏页面：CATIAbnr.htm 文件
分析工作台框架页面：AnaWbCATIAfrs.htm 文件
分析工作台标题栏页面：AnaWbCATIAbnr.htm 文件
几何创建工作台框架页面：CreWbCATIAfrs.htm 文件
几何创建工作台标题栏页面：CreWbCATIAbnr.htm 文件
几何工作台框架页面：GeoWsCATIAfrs.htm 文件
几何工作台标题栏页面：GeoWbCATIAbnr.htm 文件
AnaWb_C2、CreWb_C2 和 GeoWs_C2 分别是与 CAA V5 几何分析工作台、CAA V5 几何创建工作台 以及 CAAGeometry 设计模块 对应的目录。
- AnaWbboundingelement.htm：边界元素（Bounding Elements）命令对应的帮助页面
- AnaWbCATIAtoc.htm：空白页面，可用于存放 AnaWb 目录相关工具
- AnaWbpr01.htm：关联 CAA V5 几何分析工作台 的帮助页面
- AnaWbtoc.htm：包含同一模块下其他命令跳转链接的目录页面
icons_C2 目录中包含 no_navigation.htm 文件。
resources 目录的内容该目录下仅包含 msgcatalog 这一个子目录。
该 msgcatalog 目录中包含 CommonId2url.CATNls 文件。
CAAAfrGeometryWksHeader.CAAAfrPointHdr = "GeoWs_C2/GeoWspoint.htm" ;
CAAAfrGeometryWksHeader.CAAAfrPlaneHdr = "GeoWs_C2/GeoWsplane.htm" ;
CAAAfrGeometryWksHeader.CAAAfrExploreHdr = "GeoWs_C2/GeoWsexplore.htm" ;
CAAAfrDumpCommandHeader.CAAAfrDumpHdr = "GeoWs_C2/GeoWsdump.htm" ;
CAAAfrGeoAnalysisWkbHeader.CAAAfrBoundingEltHdr = "AnaWb_C2/AnaWbboundingelement.htm" ;
CAAAfrGeoCreationWkbHeader.CAAAfrCuboidHdr = "CreWb_C2/CreWbcuboid.htm" ;
CAAAfrGeoCreationWkbHeader.CAAAfrCylinder1Hdr = "CreWb_C2/CreWbcylinder1.htm" ;
CAAAfrGeoCreationWkbHeader.CAAAfrCylinder2Hdr = "CreWb_C2/CreWbcylinder2.htm" ;
CAAAfrGeoChartWindowAdnHeader.CAAAfrHistogramChartWindowHdr = "GeoWs_C2/GeoWsChartWindow.htm" 在与 CAAAfrGeometryWksHeader 类关联的资源文件 CAAAfrGeometryWksHeader.CATRsc 中，可以看到如下配置：
CAAAfrGeometryWksHeader.CAAAfrPointHdr.LongHelpId = "CAAAfrGeometryWksHeader.CAAAfrPointHdr" ;
CAAAfrGeometryWksHeader.CAAAfrPlaneHdr.LongHelpId = "CAAAfrGeometryWksHeader.CAAAfrPlaneHdr" ;
CAAAfrGeometryWksHeader.CAAAfrExploreHdr.LongHelpId = "CAAAfrGeometryWksHeader.CAAAfrExploreHdr"插入法语版本
法语版本文档
online 目录内容
法语版目录中包含 HomePage.htm 文件（见图 3），以及与英文版结构一致的一系列子目录。
resources 目录
CommonId2url.CATNls 文件需放置在文档目录树的 resources 目录中，路径位于法语目录下的 msgcatalog 目录内部。该文件内容与英文版完全一致。
简而言之
References
| [1] | Contextual Help |
| [2] | Building and Launching a CAA V5 Use Case |
浙公网安备 33010602011771号