工具文档结构
下图显示了桌面帮助系统,其内容列表在分析工具箱的邻域分析工具集上展开。该图显示了由所有工具箱共享的内容列表结构。
- 每个工具箱都有一个描述工具箱用途的概述主题。概述中还包括一个列出了工具箱内所有工具集的表,同时包含指向每个工具集概述主题的链接。此外,还有一个部分包含您可能感兴趣的相关主题的链接。
- 每个工具箱都有一个包含有关工具箱内每个工具的许可信息的许可主题。
- 每个工具集都有一个概述页面,其结构与工具箱概述页面非常相似。工具集的组织原则汇总于工具集概述页面。
- 位于工具集概述之后的是工具集中各工具的参考页面。有关工具参考页面的详细信息,请参阅下文。
- 最后,可能会有一本工具集概念书。概念书中的主题包含有关工具集内的工具的详细信息。
文档和许可
- 已安装的桌面文档包含有关所有工具的主题,而不管您的许可如何。例如,始终会安装 Network Analyst 工具箱,即使它要求具有 ArcGIS Network Analyst 扩展模块许可也是如此。又例如 Analysis 工具箱中的识别工具,它要求具有 ArcGIS Desktop Advanced 级别许可,但如果您有 ArcGIS Desktop Basic 级别许可,也会安装该文档。
- 工具许可位于每个工具的参考页面底部。此外,每个工具箱都包含一个列出了各工具许可要求的许可主题。
- 不会安装独立产品的工具文档。例如,除非安装 ArcInfo Workstation,否则不会安装 Coverage 工具箱文档。
工具参考页面
所有工具参考页面都使用如下所述的相同布局。
部分 | 目录 |
---|---|
摘要 | 工具用途的简短摘要。此摘要可能包含一个指向包含工具工作原理的详细介绍的另一主题的链接。 |
插图 | 有助于解释工具用途的可选插图。 |
用法 | 有关工具用法的注释和说明。如果注释指的是某一参数,则使用该参数的标注(出现在对话框上),而不使用该参数的名称(出现在语法中)。参数标注与名称之间的对应关系通常很明确,但在某些情况下会对参数名称进行注释以免混淆。 |
语法 | 用于在脚本中执行工具的准确语法。它后跟一张列出所有参数及其名称、解释和数据(值)类型的表。有关全部详细信息,请参阅了解工具语法。 |
代码示例 | 包含一个或多个使用工具的 Python 代码示例。 |
环境 | 这是工具所遵循的环境设置的列表。每类环境设置都链接到环境设置参考页面。如果某类环境设置对工具特别重要,则可能包含有关此环境的详细信息。 |
相关主题 | 始终包括工具集概述页面的相关主题列表。 |
许可信息 |
使用工具所需的许可。 |