Поделиться через

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'
    OutputPath      = 'C:\Module\Cab\'
}
New-ExternalHelpCab @params

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

Параметры

-CabFilesFolder

Указывает папку, содержащую содержимое справки, которое этот командлет упаковывает в .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 имени файла. Для необходимых метаданных выполните команду New-MarkdownHelp с параметром WithLandingPage .

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

-OutputFolder

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

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

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

None

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

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

None

Этот командлет не создает выходные данные. Командлет сохраняет результаты в выходной папке, указанной параметром OutputPath .