Get-HelpPreview

Referência

Módulo:: platyPS

Exibe a ajuda externa gerada como Get-Help saída.

Sintaxe

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

Description

O cmdlet Get-HelpPreview exibe a ajuda externa gerada como Get-Help saída. Especifique um ou mais arquivos no formato MAML (Microsoft Assistance Markup Language).

Exemplos

Exemplo 1: Visualizar a ajuda do 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

O primeiro comando cria um objeto de da Ajuda do para o arquivo MAML especificado. O comando armazena-o na variável $Help.

O segundo comando exibe a propriedade Name para cada um dos objetos no $Help.

Parâmetros

-ConvertDoubleDashLists

Indica que esse cmdlet converte marcadores de lista de hífen duplo em marcadores de hífen único. Listas de hífen duplo são comuns na documentação do Windows PowerShell. Markdown aceita hífenes único para listas.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ConvertNotesToList

Indica que esse cmdlet formata vários itens de parágrafo na seção NOTAS como itens de lista únicos. Esta saída segue a formatação do TechNet.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Path

Especifica uma matriz de caminhos de arquivos de ajuda externos MAML.

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	True

Entradas

String[]

Você pode canalizar uma matriz de caminhos para esse cmdlet.

Saídas

Help Object

Este cmdlet retorna um objeto Help, que é a mesma saída que Get-Help.

Partilhar via