Show-HelpPreview

Módulo:
Microsoft.PowerShell.PlatyPS Module

Visualize o conteúdo do arquivo MAML como ele apareceria quando a saída por Get-Help.

Sintaxe

Path 

Show-HelpPreview
    [-Path] <string[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

LiteralPath 

Show-HelpPreview
    [-LiteralPath] <string[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

Descrição

O cmdlet Show-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 - Exibir o conteúdo de um arquivo MAML

Este exemplo exibe o conteúdo do arquivo MAML PlatyPS como ele apareceria quando a saída por Get-Help.

Show-HelpPreview -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS-Help.xml

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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:False
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ConvertNotesToList

Indica que esse cmdlet formata vários itens de parágrafo na seção NOTAS como itens de lista únicos.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:False
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-LiteralPath

Especifica um ou mais caminhos para arquivos de ajuda MAML. Não há suporte para curingas.

Propriedades dos parâmetros

Tipo:

String[]

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:PSPath, LP

Conjuntos de parâmetros

LiteralPath
Posto:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Path

Especifica um ou mais caminhos para arquivos de ajuda MAML. O uso de caracteres universais é suportado.

Propriedades dos parâmetros

Tipo:

String[]

Valor predefinido:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

Path
Posto:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

Saídas

MamlCommandHelpInfo

Este cmdlet retorna um MamlCommandHelpInfo objetos. Este é o mesmo objeto que é retornado por Get-Help.