New-ExternalHelpCab

参考

模块:: platyPS

生成 .cab 文件。

语法

New-ExternalHelpCab
   -CabFilesFolder <String>
   -LandingPagePath <String>
   -OutputFolder <String>
   [-IncrementHelpVersion]
   [<CommonParameters>]

说明

New-ExternalHelpCab cmdlet 生成一个包含文件夹中所有非递归内容的 .cab 文件。此 cmdlet 压缩提供的文件。

注释

此 cmdlet 取决于 MakeCab.exe 本机命令，该命令仅在 Windows 上可用。如果在非 Windows 计算机上使用，此 cmdlet 将引发错误。

建议仅提供about_主题的内容，以及 New-ExternalHelp cmdlet 到此 cmdlet 的输出。

此 cmdlet 使用存储在模块 markdown 文件中的元数据来命名 .cab 文件。此命名与 PowerShell 帮助系统需要用作可更新帮助的模式匹配。此元数据是使用 New-MarkdownHelp cmdlet 和 WithModulePage 参数创建的模块文件的一部分。

此 cmdlet 还会生成或更新现有 helpinfo.xml 文件。该文件为 PowerShell 帮助系统提供版本控制和区域设置详细信息。

示例

示例 1：创建 CAB 文件

$params = @{
    CabFilesFolder  = 'C:\Module\ExternalHelpContent'
    LandingPagePath = 'C:\Module\ModuleName.md'
    OutputFolder    = 'C:\Module\Cab\'
}
New-ExternalHelpCab @params

该 cmdlet 创建一个包含内容文件夹文件的 .cab 文件。 .cab 文件命名为基于元数据的可更新帮助。该命令将 .cab 文件放在输出文件夹中。

参数

-CabFilesFolder

指定包含此 cmdlet 将帮助内容打包到 .cab 文件中的文件夹。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-IncrementHelpVersion

自动递增模块 Markdown 文件中的帮助版本。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-LandingPagePath

指定模块 Markdown 文件的完整路径，其中包含命名 .cab 文件所需的所有元数据。对于所需的元数据，请使用 New-MarkdownHelp 参数运行。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-OutputFolder

指定此 cmdlet 创建的 .cab 文件和 helpinfo.xml 文件的位置。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

输入

None

无法通过管道将值传递给此 cmdlet。

输出