通过

New-HelpCabinetFile

模块:
Microsoft.PowerShell.PlatyPS Module

为可以作为可更新帮助内容发布的模块创建帮助内阁文件。

语法

__AllParameterSets 

New-HelpCabinetFile
    [-CabinetFilesFolder] <string>
    [-MarkdownModuleFile] <string>
    [-OutputFolder] <string>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

此 cmdlet 创建 .cab 和 .zip 文件，其中包含模块的帮助文件。

注释

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

此 cmdlet 使用存储在模块 Markdown 文件中的元数据来命名 .cab 和 .zip 文件。 此命名与 PowerShell 帮助系统需要用作可更新帮助的模式匹配。

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

示例

示例 1 - 为模块创建可更新帮助文件

$params = @{
    CabinetFilesFolder = '.\maml\Microsoft.PowerShell.PlatyPS'
    MarkdownModuleFile = '.\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md'
    OutputFolder       = '.\cab'
}
New-HelpCabinetFile @params

参数

-CabinetFilesFolder

包含要打包的 MAML 文件的文件夹的路径。

参数属性

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

参数集

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

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

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

参数集

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

-MarkdownModuleFile

指定模块 Markdown 文件的完整路径。

参数属性

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

参数集

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

-OutputFolder

要写入 .cab、.zip和 HelpInfo.xml 文件的位置。

参数属性

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

参数集

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

-WhatIf

在仅报告将发生的情况而不执行作的模式下运行命令。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

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

CommonParameters

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

输出

FileInfo

FileInfo 表示此 cmdlet 创建的文件的对象。