通过

New-ExternalHelpCab

模块:
platyPS Module

生成 .cab 文件。

语法

Default （默认值） 

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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-IncrementHelpVersion

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-LandingPagePath

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-OutputFolder

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

None

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

输出

None

此 cmdlet 不生成输出。 该 cmdlet 将其结果保存在 OutputPath 参数指定的输出文件夹中。