当前位置:网站首页 > 更多 > 玩电脑 > 正文

[玩转系统] 如何创建 HelpInfo XML 文件

作者:精品下载站 日期:2024-12-14 02:31:14 浏览:13 分类:玩电脑

如何创建 HelpInfo XML 文件


笔记

手动编写基于 XML 的帮助非常困难。 PlatyPS 模块允许您在 Markdown 中编写帮助,然后将其转换为基于 XML 的帮助。这使得编写和维护帮助变得更加容易。 PlatyPS 还可以为您创建可更新的帮助包。有关详细信息,请参阅使用 PlatyPS 创建基于 XML 的帮助。

本节中的主题介绍如何为 PowerShell 可更新帮助功能创建和填充帮助信息文件(通常称为“HelpInfo XML 文件”)。

HelpInfo XML 文件概述

HelpInfo XML 文件是有关模块的可更新帮助的信息的主要来源。它包括模块的帮助文件的位置、支持的 UI 区域性以及可更新帮助用于确定用户是否拥有最新帮助文件的版本号。

每个模块都只有一个 HelpInfo XML 文件,即使该模块包含针对多种 UI 区域性的多个帮助文件也是如此。模块作者创建 HelpInfo XML 文件,并将其放置在模块清单中的 HelpInfoUri 键指定的 Internet 位置。当模块帮助文件更新和上传时,模块作者会更新 HelpInfo XML 文件并用新版本替换原始 HelpInfo XML 文件。

仔细维护 HelpInfo XML 文件至关重要。如果您上传新文件,但忘记增加版本号,可更新帮助将不会将新文件下载到用户的计算机。如果您为新的 UI 区域性添加帮助文件,但不更新 HelpInfo XML 文件或将其放置在正确的位置,可更新帮助将不会下载新文件。

在这个部分

本节包括以下主题。

  • 帮助信息 XML 架构
  • 帮助信息 XML 示例文件
  • 如何命名 HelpInfo XML 文件
  • 如何设置 HelpInfo XML 版本号

参见

支持可更新的帮助

您需要 登录账户 后才能发表评论

取消回复欢迎 发表评论:

关灯