2025-10-02 07:10:01

使用帮助查看器在本地部署帮助 - Visual Studio (Windows)

可以使用 Microsoft Help Viewer 在本地计算机上安装、查看和管理Microsoft产品和技术的本地文档安装。这些技术包括 Visual Studio、.NET、语言参考、SQL Server 和 Windows 开发。

本文介绍如何使用帮助查看器在有或没有互联网访问的网络环境中部署和管理本地帮助安装。本地帮助内容按每台计算机进行配置。默认情况下，用户必须具有管理员权限才能更新其本地帮助安装。

如果网络环境允许客户端访问 Internet，则可以使用帮助内容管理器可执行文件从 Internet 部署本地帮助内容。有关 HlpCtntMgr.exe 命令行语法的详细信息，请参阅帮助内容管理器的命令行参数。

有关创建内容、创建 Intranet 服务终结点和类似类型的活动的信息，请参阅帮助查看器 SDK。

如果在网络环境中没有 Internet 访问权限，帮助查看器可以从 Intranet 或网络共享部署本地帮助内容。还可以使用注册表项重写功能禁用 Visual Studio IDE 帮助选项，比如：

联机与脱机帮助

首次启动 IDE 时安装内容

指定内部网内容服务

管理内容

从 Internet 部署本地帮助内容

可以使用帮助内容管理器（HlpCtntMgr.exe）将本地帮助内容从 Internet 部署到客户端计算机。使用以下语法：

\\%ProgramFiles(x86)%\Microsoft Help Viewer\v2.3\HlpCtntmgr.exe /operation \<*name*> /catalogname \<*catalog name*> /locale \<*locale*>

有关 HlpCtntMgr.exe 命令行语法的详细信息，请参阅帮助内容管理器的命令行参数。

要求：

客户端计算机必须有权访问 Internet。

安装本地帮助内容后，用户必须具有更新、添加或删除本地帮助内容的管理员权限。

注意：

帮助的默认源仍将处于联机状态。

示例：

以下示例将 Visual Studio 的英语内容安装到客户端计算机。

从 Internet 安装英语内容

选择 “开始” ，然后选择“ 运行”。

键入下列命令：

C:\Program Files (x86)\Microsoft Help Viewer\v2.3\hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us

按 Enter。

在客户端计算机上部署预安装的本地帮助内容

可以将一组内容从联机安装到一台计算机，然后将该安装的内容集复制到其他计算机。

要求：

要安装一组内容的计算机必须有权访问 Internet。

安装本地帮助内容后，用户必须具有更新、添加或删除本地帮助内容的管理员权限。

小窍门

如果用户没有管理员权限，建议禁用帮助查看器中的 “管理内容 ”选项卡。有关详细信息，请参阅替代帮助查看器默认值。

注意：

帮助的默认源仍将处于联机状态。

创建内容集

必须先卸载目标计算机上的所有本地 Visual Studio 内容，然后才能创建基本内容集。

卸载本地帮助

在帮助查看器中，选择“ 管理内容 ”选项卡。

导航到 Visual Studio 文档集。

选择每个子项旁边的 “删除 ”。

选择更新以卸载。

浏览到 %ProgramData%\Microsoft\HelpLibrary2\Catalogs\VisualStudio15 ，并验证文件夹是否仅包含文件 catalogType.xml。

删除以前安装的所有本地 Visual Studio 帮助内容后，即可下载基本内容集。

下载内容

在帮助查看器中，选择“ 管理内容 ”选项卡。

在 “建议的文档 ”或 “可用文档”下，导航到要下载的文档集，然后选择“ 添加”。

选择 “更新”。

接下来，需要打包内容，以便将其部署到客户端计算机。

对内容进行打包

创建一个文件夹，将内容复制到以后的部署。例如： C：\VSHelp。

使用管理员权限打开 cmd.exe 。

导航到在步骤 1 中创建的文件夹。

键入下列命令：

Xcopy %ProgramData%\Microsoft\HelpLibrary2 \<*foldername*>\ /y /e /k /o

例如：Xcopy %ProgramData%\Microsoft\HelpLibrary2 c:\VSHelp\ /y /e /k /o

部署内容

创建网络共享并将帮助内容复制到该位置。

例如，将 C：\VSHelp 中的内容复制到 \\myserver\VSHelp。

创建 .bat 文件以包含帮助内容的部署脚本。由于客户端可能在推送过程中删除的任何文件具有读取锁定，因此在推送更新之前，应该关闭客户端。例如：

REM - copy pre-ripped content to ProgramData

Xcopy %~dp0HelpLibrary2 %SYSTEMDRIVE%\ProgramData\Microsoft\HelpLibrary2\ /y /e /k /o

if ERRORLEVEL 1 ECHO *** ERROR COPYING Help Library files to ProgramData (%ERRORLEVEL%)

在要在其中安装帮助内容的本地计算机上运行 .bat 文件。