Get-HelpPreview

Reference

Modul:: platyPS

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

Syntaxe

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

Description

Rutina Get-HelpPreview zobrazí vygenerovanou externí nápovědu jako výstup Get-Help. 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ý z objektů v $Help.

Parametry

-ConvertDoubleDashLists

Označuje, že tato rutina převádí odrážky seznamu s dvojitými spojovníky na odrážky s jedním spojovníkem. Seznamy dvojitých spojovníků jsou společné v dokumentaci k Prostředí Windows PowerShell. Markdown přijímá pro seznamy jednomlčky.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ConvertNotesToList

Označuje, že tato rutina formátuje více položek odstavců v oddílu NOTES jako položky s jedním seznamem. Tento výstup se řídí formátováním TechNetu.

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Path

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

Typ:	String[]
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	True

Vstupy

String[]

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

Výstupy

Help Object

Tato rutina vrátí objekt nápovědy, což je stejný výstup jako Get-Help.