Get-HelpPreview

Ссылка

Модуль:: platyPS

Отображает созданную внешнюю справку в виде Get-Help выходных данных.

Синтаксис

Get-HelpPreview
   -Path <String[]>
   [-ConvertNotesToList]
   [-ConvertDoubleDashLists]
   [<CommonParameters>]

Описание

Командлет Get-HelpPreview отображает созданную внешнюю справку как Get-Help выходные данные. Укажите один или несколько файлов в формате MAML.

Примеры

Пример 1. Предварительная версия справки по PlatyPS

PS C:\> $Help = Get-HelpPreview -Path ".\out\platyPS\en-US\PlatyPS-help.xml"
PS C:\> $Help.Name

Get-HelpPreview
Get-MarkdownMetadata
New-ExternalHelp
New-ExternalHelpCab
New-MarkdownHelp
Update-MarkdownHelp
Update-MarkdownHelpModule
Update-MarkdownHelpSchema

Первая команда создает объект справки справки для указанного MAML-файла. Команда сохраняет ее в переменной $Help.

Вторая команда отображает свойство Name для каждого объекта в $Help.

Параметры

-ConvertDoubleDashLists

Указывает, что этот командлет преобразует маркеры списка двойного дефиса в маркеры с одним дефисом. Списки двойного дефиса распространены в документации по Windows PowerShell. Markdown принимает одно дефисы для списков.

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

-ConvertNotesToList

Указывает, что этот командлет форматирует несколько элементов абзаца в разделе NOTES в виде элементов одного списка. Эти выходные данные соответствуют форматированию TechNet.

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

-Path

Задает массив путей внешних вспомогательных файлов MAML.

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

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

String[]

Вы можете передать массив путей к этому командлету.

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

Help Object

Этот командлет возвращает объект справки , который совпадает с выходными данными Get-Help.

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