Get-HelpPreview

Reference

Modul:: platyPS

Zobrazí vygenerovanou externí nápovědu jako Get-Help výstup.

Syntax

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

Description

Rutina Get-HelpPreview zobrazí vygenerovanou externí nápovědu jako Get-Help výstup. Zadejte jeden nebo více souborů ve formátu MAML (Microsoft Assistance Markup Language).

Příklady

Příklad 1: Náhled nápovědy 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

První příkaz vytvoří objekt Nápovědy pro zadaný soubor MAML. Příkaz ho uloží do proměnné $Help.

Druhý příkaz zobrazí vlastnost Name pro každý objekt v $Help.

Parametry

-ConvertDoubleDashLists

Označuje, že tato rutina převede odrážky seznamu se dvěma spojovníky na odrážky s jedním spojovníkem. Seznamy dvojitých spojovníků jsou v dokumentaci Windows PowerShell běžné. Markdown přijímá jednoduché spojovníky pro seznamy.

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

-ConvertNotesToList

Označuje, že tato rutina formátuje více položek odstavce v oddílu POZNÁMKY jako položky jednoho seznamu. Tento výstup se řídí formátováním TechNetu.

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

-Path

Určuje pole cest k externím souborům nápovědy MAML.

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

Vstupy

String[]

K této rutině můžete připojit pole cest.

Výstupy

Help Object

Tato rutina vrátí objekt Help , který má stejný výstup jako Get-Help.