安装 ArcGIS Documentation Center 及帮助组件
ArcGIS Documentation Center 是适用于所有 Esri 产品(包括 ArcGIS AllSource)的本地帮助系统。 Doc Center 是一款独立应用程序,关联至一个或多个已安装的 Esri 产品在本地安装的文档集。 通过 Doc Center,您可以查看现有的帮助内容、将文档集更新至最新版本,并下载其他 Esri 应用程序的相关内容。
要设置 Doc Center 应用程序和 AllSource 帮助内容,请按照以下通用步骤操作:
安装 ArcGIS AllSource 和 ArcGIS Pro 文档集。 ArcGIS AllSource 帮助内容需要这两个文档集。
详细步骤请参见以下部分。
下载 ArcGIS Documentation Center
在安装应用程序之前,需要先下载安装包。 可从 My Esri 下载 Doc Center。
为组织集中管理文档
Doc Center 允许您通过网络上的单个中心文件夹来配置和管理文档。 所有将该网络文件夹设为其根文件夹的 Doc Center 实例,均可调用其中安装的所有文档集。 这意味着您可以在单一位置统一管理所有 Esri 产品文档。 这种方式极大简化了文档维护与更新工作。
下载 ArcGIS Documentation Center。
配置一个客户端系统可访问的网络文件夹。 该文件夹将作为您的根文件夹。
安装 Doc Center 应用程序。
配置 Doc Center 以使用
appSettings.json,并将rootFolder参数设置为根文件夹。安装 ArcGIS AllSource 和 ArcGIS Pro 文档集。 文档集应安装在根文件夹中。
在客户端系统上安装 ArcGIS AllSource 和 Doc Center。
将
appSettings.json文件部署到客户端系统上的各用户账户。
安装 Doc Center
Doc Center 支持两种不同的安装方式:通过 .exe 文件运行安装向导,或通过命令行安装。
通过应用程序界面安装 Doc Center
请按照以下步骤,使用安装向导完成 Doc Center 的安装:
浏览至 ArcGIS Documentation Center 安装包的下载文件夹。
双击安装
.exe。系统将启动安装向导。
单击下一步继续。
查看主协议,然后选择选项:
若您同意相关条款,请单击我接受主协议。
如果不同意条款,则单击取消退出安装。
单击下一步。
选择安装上下文:
单击使用此计算机的任何人(所有用户)(默认值),进行按计算机安装。
单击仅限本人执行按用户安装。
注:
您必须具有管理权限才能执行按计算机安装。
单击下一步。
在目标文件夹下方,接受默认安装路径,或单击更改,指定其他文件夹。
针对按计算机安装的默认路径为:
<System Drive>\Program Files\ArcGIS\DocumentationCenter。 对于按用户安装,其默认文件夹为:<System Drive>\Users\<username>\AppData\Local\Programs\ArcGIS\DocumentationCenter注:
如果您选择非默认位置,建议该路径包含一个文件夹,而非驱动器的根位置。 默认情况下,不会在修改后的路径中追加 \ArcGIS\DocumentationCenter\。
单击下一步。
单击安装开始安装。
系统将显示状态对话框。
单击完成。
通过命令行安装 Doc Center
如果您是使用脚本或部署服务器的管理员,则可以静默安装 Doc Center。
以管理员身份启动命令提示符
运行以下命令安装 Doc Center
msiexec.exe /i <setup staging location>\DocCenter.msi ACCEPTEULA=YES /qb
例如:
msiexec.exe /i c:\temp\downloads\DocCenter.msi ACCEPTEULA=YES /qb
| 参数 | 描述 |
|---|---|
| /i <product msi\> | 通过 .msi 文件安装产品 |
| ACCEPTEULA=YES | 在静默安装过程中,需要提供此参数才能接受“最终用户许可协议”(EULA)。 指定 \`ACCEPTEULA=YES\` 将同意 EULA 并安装软件。 如果您指定 NO 或忽略此参数,则软件将不会安装。 |
| /q<b \| n \| r \| f\> | 进度和错误通知。 只使用一个选项。
|
| /help | 显示 msiexec 的完整帮助选项。 |
| /x <product code\> | 使用产品代码卸载产品。 |
使用 appSettings.json 配置 Doc Center 安装
您可以通过 appSettings.json 文件配置 Doc Center。 Doc Center 使用此文件来配置和存储用户可修改的参数。 该文件位于用户的 %LocalAppData%\ESRI\ArcGISDocCenter 文件夹中。
重要信息:
要覆盖设置,用户可以在应用程序的浏览历史记录等更多内容
中单击设置
进行修改。
创建
appSettings.json文件在每个用户的系统上安装 Doc Center。
将该文件部署到每个用户系统上的
%LocalAppData%\ESRI\ArcGISDocCenter目录中。
创建 appSettings.json 文件
创建该文件以管理 Doc Center 的设置。 请执行以下操作:
创建一个名为
appSettings.json的文件。将以下文本粘贴到文件中:
{ "init": true, "allowedHosts": "*", "endpoints": { "documentationSets": { "url": "https://doc.esri.com/offline-help/packages/all" }, "webHelp": { "url": "https://doc.esri.com/en/arcgis-doc-center/" }, "softwareUpdate": { "url": "https://doc.esri.com/offline-help/installer/" } }, "webServer": { "defaultFileNames": [ "index.html", "default.html" ], "portPreferences": [ { "order": 0, "port": 13774 }, { "order": 1, "port": 13322 }, { "order": 2, "port": 14357 } ], "portScan": { "minValue": 20000, "maxValue": 60000, "limit": 10 }, "rootFolder": "\\\\<server_name>\\<folder_path>" }, "language": "en", "theme": "Theme.Auto" }通过修改
webServer下的rootFolder更改根文件夹,如下所示:"rootFolder": "\\\\<server_name>\\<folder_path>"例如,名为
Polaris的服务器有一个用于存储文档集的共享文件夹arcgis_documentation:"rootFolder": "\\\\Polaris\\arcgis_documentation"(可选)通过修改
webServer下的portPreferences为本地帮助 Web 服务器设置静态端口,如下所示:"portPreferences": [ { "order": 0, "port": <first_port_number> }, { "order": 1, "port": <second_port_number> }, { "order": 2, "port": <third_port_number> } ],其中
port是可用的端口号,order是这些端口被使用时从零开始的序列号。 以下示例将所有三个端口都设置为自定义端口号:"portPreferences": [ { "order": 0, "port": 13445 }, { "order": 1, "port": 13447 }, { "order": 2, "port": 13449 } ],注:
默认端口号按顺序分别为:13774、13322 和 14357。
appSettings.json 示例
下方显示了 appSettings.json 文件的示例。 该示例使用了默认端口号,但添加了一个自定义根文件夹。
{
"init": true,
"allowedHosts": "*",
"endpoints": {
"documentationSets": {
"url": "https://doc.esri.com/offline-help/packages/all"
},
"webHelp": {
"url": "https://doc.esri.com/en/arcgis-doc-center/"
},
"softwareUpdate": {
"url": "https://doc.esri.com/offline-help/installer/"
}
},
"webServer": {
"defaultFileNames": [
"index.html",
"default.html"
],
"portPreferences": [
{
"order": 0,
"port": 13774
},
{
"order": 1,
"port": 13322
},
{
"order": 2,
"port": 14357
}
],
"portScan": {
"minValue": 20000,
"maxValue": 60000,
"limit": 10
},
"rootFolder": "\\\\Tycho\\doc_share\\arcgis_docsets"
},
"language": "en",
"theme": "Theme.Auto"
}
下载 ArcGIS AllSource 和 ArcGIS Pro 文档集
ArcGIS AllSource 使用 ArcGIS Pro 和自己的文档集。 这两款应用程序共享功能与特性。虽然帮助内容主要针对 ArcGIS Pro 编写,但其与这两款应用程序均相关。 了解有关 ArcGIS AllSource 帮助系统的详细信息。
安装 Doc Center 后,您需要下载适用于 ArcGIS AllSource 和 ArcGIS Pro 的文档集。 ArcGIS AllSource 需要这两个文档集。
打开 ArcGIS Documentation Center。
单击库选项卡。
单击产品名称过滤器并同时选择 ArcGIS AllSource 和 ArcGIS Pro。
随即显示这两款产品的文档集库。
找到相关版本的卡片,然后单击下载。
重要信息:
ArcGIS AllSource 与 ArcGIS Pro 的版本号不同。 如果您不确定已安装的 ArcGIS AllSource 版本所匹配的 ArcGIS Pro 帮助版本,可以在发布说明中找到兼容版本。 文档集适用于 ArcGIS AllSource 1.6 和 ArcGIS Pro 3.7 及其更高版本。 早期版本使用的是不同的本地文档系统。
当前,文档集安装在您的本地系统中,可随时用于 ArcGIS AllSource 或通过 Doc Center 打开。