Get-HelpPreview

Referência

Módulo:: platyPS

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

Syntax

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

Description

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

Exemplos

Exemplo 1: Pré-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 Ajuda para o ficheiro MAML especificado. O comando armazena-o na variável $Help.

O segundo comando apresenta a propriedade Nome para cada um dos objetos no $Help.

Parâmetros

-ConvertDoubleDashLists

Indica que este cmdlet converte marcas de lista de hífen duplo em marcas de hífen único. As listas de hífen duplo são comuns na documentação Windows PowerShell. Markdown aceita hífenes únicos para listas.

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

-ConvertNotesToList

Indica que este cmdlet formata vários itens de parágrafo na secção NOTAS como itens de lista única. Esta saída segue a formatação techNet.

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

-Path

Especifica uma matriz de caminhos de ficheiros de ajuda externa MAML.

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

Entradas

String[]

Pode encaminhar uma matriz de caminhos para este cmdlet.

Saídas

Help Object

Este cmdlet devolve um objeto de Ajuda , que é o mesmo resultado que Get-Help.

Partilhar via