Get-HelpPreview

Riferimento

Modulo:: platyPS

Visualizza la Guida esterna generata come Get-Help output.

Sintassi

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

Descrizione

Il Get-HelpPreview cmdlet visualizza la Guida esterna generata come Get-Help output. Specificare uno o più file nel formato MAML (Microsoft Assistance Markup Language).

Esempio

Esempio 1: Visualizzare in anteprima la Guida di 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

Il primo comando crea un oggetto Help per il file MAML specificato. Il comando lo archivia nella variabile $Help.

Il secondo comando visualizza la proprietà Name per ognuno degli oggetti in $Help.

Parametri

-ConvertDoubleDashLists

Indica che questo cmdlet converte i punti elenco a trattini doppie in punti elenco a trattini singoli. Gli elenchi di trattini doppie sono comuni nella documentazione di Windows PowerShell. Markdown accetta trattini singoli per gli elenchi.

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

-ConvertNotesToList

Indica che questo cmdlet formatta più elementi di paragrafo nella sezione NOTES come singoli elementi di elenco. Questo output segue la formattazione techNet.

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

-Path

Specifica una matrice di percorsi dei file della Guida esterna MAML.

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

Input

String[]

È possibile inviare una matrice di percorsi a questo cmdlet.

Output

Help Object

Questo cmdlet restituisce un oggetto Help , che corrisponde allo stesso output di Get-Help.

Condividi tramite