New-ExternalHelpCab

  • 參考
模組:
platyPS

產生檔案 .cab 。

Syntax

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

Description

Cmdlet New-ExternalHelpCab 會產生包含 .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'
    OutputPath      = 'C:\Module\Cab\'
}
New-ExternalHelpCab @params

Cmdlet 會建立包含 .cab 內容資料夾檔案的檔案。 檔案 .cab 會根據中繼資料命名為可更新的說明。 命令會將 .cab 檔案放在輸出檔案夾中。

參數

-CabFilesFolder

指定資料夾，其中包含此 Cmdlet 封裝至 .cab 檔案的說明內容。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IncrementHelpVersion

自動遞增模組 Markdown 檔案中的說明版本。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LandingPagePath

指定模組 Markdown 檔案的完整路徑，其中包含命名 .cab 檔案所需的所有中繼資料。 針對必要的中繼資料，請使用WithLandingPage參數執行 New-MarkdownHelp 。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OutputFolder

指定這個 Cmdlet 所建立之 .cab 檔案和 helpinfo.xml 檔案的位置。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

輸入

None

您無法使用管線將值傳送至此 Cmdlet。

輸出

None

此 Cmdlet 不會產生輸出。 Cmdlet 會將其結果儲存在 OutputPath 參數指定的輸出檔案夾中。