可更新帮助的工作原理

本主题介绍可更新帮助如何处理每个模块的 HelpInfo XML 文件和 CAB 文件,以及如何为用户安装更新的帮助。

Update-Help过程

以下列表描述了用户运行命令以更新特定 UI 区域性中模块的帮助文件时 Update-Help cmdlet 的操作。

  1. Update-Help 从模块清单中 HelpInfoURI 键的值指定的位置获取远程 HelpInfo XML 文件,并针对架构验证该文件。 (若要查看架构,请参阅 HelpInfo XML Schema.) 然后在用户计算机的模块目录中查找模块的本地 Update-Help HelpInfo XML 文件。

  2. Update-Help 比较模块的远程和本地 HelpInfo XML 文件中指定 UI 区域性的帮助文件的版本号。 如果远程文件的版本号大于本地文件的版本号,或者模块没有本地 HelpInfo XML 文件,则 Update-Help 准备下载新的帮助文件。

  3. Update-Help 从远程 HelpInfo XML 文件中 HelpContentUri 元素指定的位置中选择模块的 CAB 文件。 它使用模块名称、模块 GUID 和 UI 区域性来标识 CAB 文件。

  4. Update-Help 下载 CAB 文件,解压缩该文件,验证帮助内容文件,将帮助内容文件保存在用户计算机上模块目录的语言特定子目录中。

  5. Update-Help 通过复制远程 HelpInfo XML 文件创建本地 HelpInfo XML 文件。 它编辑本地 HelpInfo XML 文件,以便仅包含它安装的 CAB 文件的元素。 然后,它将本地 HelpInfo XML 文件保存在模块目录中,并结束更新。

Save-Help过程

以下列表描述了用户运行命令以更新文件共享中的帮助文件时 Save-HelpUpdate-Help cmdlet 的操作,然后使用这些文件更新用户计算机上的帮助文件。

cmdlet 执行以下操作以响应命令,将模块的帮助文件保存在 Save-Help DestinationPath 参数指定的文件共享中。

  1. Save-Help 从模块清单中 HelpInfoURI 键的值指定的位置获取远程 HelpInfo XML 文件,并针对架构验证该文件。 (若要查看架构,请参阅HelpInfo XML 架构.) 然后在 命令中的 DestinationPath 参数指定的目录中查找本地 Save-Help HelpInfo XML Save-Help 文件。

  2. Save-Help 比较模块的远程和本地 HelpInfo XML 文件中指定 UI 区域性的帮助文件的版本号。 如果远程文件的版本号大于本地文件的版本号,或者 DestinationPath 目录中没有模块的本地 HelpInfo XML 文件,则 准备下载新的 Save-Help 帮助文件。

  3. Save-Help 从远程 HelpInfo XML 文件中 HelpContentUri 元素指定的位置中选择模块的 CAB 文件。 它使用模块名称、模块 GUID 和 UI 区域性来标识 CAB 文件。

  4. Save-Help 下载 CAB 文件,并保存在 DestinationPath 目录中。 (它不会创建任何特定于语言的子目录.)

  5. Save-Help 通过复制远程 HelpInfo XML 文件创建本地 HelpInfo XML 文件。 它编辑本地 HelpInfo XML 文件,以便仅包含它保存的 CAB 文件的元素。 然后,它将本地 HelpInfo XML 文件保存在 DestinationPath 目录中,并结束更新。

    cmdlet 执行以下操作以响应从 SourcePath 参数指定的文件共享中的文件更新用户计算机上帮助文件 Update-Help 的命令。

  6. Update-HelpSourcePath 目录获取远程 HelpInfo XML 文件。 然后,它会在用户计算机的模块目录中查找本地 HelpInfo XML 文件。

  7. Update-Help 比较模块的远程和本地 HelpInfo XML 文件中指定 UI 区域性的帮助文件的版本号。 如果远程文件的版本号大于本地文件的版本号,或者没有本地 HelpInfo XML 文件,则 Update-Help 准备安装新的帮助文件。

  8. Update-HelpSourcePath 目录中选择模块的 CAB 文件。 它使用模块名称、模块 GUID 和 UI 区域性来标识 CAB 文件。

  9. Update-Help 解压缩 CAB 文件,验证帮助内容文件,将帮助内容文件保存在用户计算机上模块目录的语言特定子目录中。

  10. Update-Help 通过复制远程 HelpInfo XML 文件创建本地 HelpInfo XML 文件。 它编辑本地 HelpInfo XML 文件,以便仅包含它安装的 CAB 文件的元素。 然后,它将本地 HelpInfo XML 文件保存在模块目录中,并结束更新。