New-ExternalHelpCab

Ссылка

Модуль:: platyPS

Создает файл .cab.

Синтаксис

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

Описание

Командлет New-ExternalHelpCab создает файл .cab, содержащий все не рекурсивное содержимое в папке. Этот командлет сжимает предоставленные файлы.

Замечание

Этот командлет зависит от собственной команды MakeCab.exe, доступной только в Windows. Этот командлет вызывает ошибку при использовании на компьютерах, отличных от Windows.

Мы рекомендуем предоставить в качестве содержимого только разделы about_ и выходные данные командлета New-ExternalHelp для этого командлета.

Этот командлет использует метаданные, хранящиеся в файле markdown модуля, для имени файла .cab. Это именование соответствует шаблону, который требуется системе справки PowerShell для использования в качестве обновляемой справки. Эти метаданные являются частью файла модуля, созданного с помощью командлет а new-MarkdownHelp с параметром WithModulePage.

Этот командлет также создает или обновляет существующий файл helpinfo.xml. Этот файл предоставляет сведения о версиях и языковых стандартах в системе справки PowerShell.

Примеры

Пример 1. Создание CAB-файла

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

Командлет создает файл .cab, содержащий файлы папки содержимого. Файл .cab называется для обновляемой справки на основе метаданных. Команда помещает файл .cab в выходную папку.

Параметры

-CabFilesFolder

Указывает папку, содержащую содержимое справки, которое этот командлет упаковывает в файл .cab.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-IncrementHelpVersion

Автоматически увеличивает версию справки в файле Markdown модуля.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-LandingPagePath

Указывает полный путь к файлу Markdown модуля, который содержит все метаданные, необходимые для имени файла .cab. Для требуемых метаданных запустите New-MarkdownHelp с параметром WithLandingPage.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-OutputFolder

Указывает расположение файла .cab и helpinfo.xml файла, который создает этот командлет.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

Входные данные

None

Невозможно передать значения в этот командлет.

Выходные данные