New-ExternalHelpCab

參考

模組:: platyPS

產生 .cab 檔案。

語法

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

Description

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。

輸出

None

此 Cmdlet 不會產生輸出。 Cmdlet 會將結果儲存在 output 資料夾中，OutputPath 參數所指定。