Get-HelpPreview

Moduł:

platyPS

Wyświetla wygenerowaną zewnętrzną pomoc jako Get-Help dane wyjściowe.

Składnia

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

Opis

Polecenie Get-HelpPreview cmdlet wyświetla wygenerowaną zewnętrzną pomoc jako Get-Help dane wyjściowe. Określ co najmniej jeden plik w formacie znaczników pomocy firmy Microsoft (MAML).

Przykłady

Przykład 1. Podgląd pomocy platformy 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

Pierwsze polecenie tworzy obiekt Pomocy dla określonego pliku MAML. Polecenie przechowuje je w zmiennej $Help.

Drugie polecenie wyświetla właściwość Name dla każdego obiektu w $Help.

Parametry

-ConvertDoubleDashLists

Wskazuje, że to polecenie cmdlet konwertuje punktory listy podwójnych łączników na punktory z jednym łącznikem. Listy łączników podwójnych są wspólne w dokumentacji Windows PowerShell. Język Markdown akceptuje łączniki jednokrotne dla list.

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

-ConvertNotesToList

Wskazuje, że to polecenie cmdlet formatuje wiele elementów akapitu w sekcji UWAGI jako pojedyncze elementy listy. Te dane wyjściowe są zgodne z formatowaniem TechNet.

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

-Path

Określa tablicę ścieżek plików pomocy zewnętrznej MAML.

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

Dane wejściowe

String[]

Możesz przekazać tablicę ścieżek do tego polecenia cmdlet.

Dane wyjściowe

Help Object

To polecenie cmdlet zwraca obiekt Pomocy , który jest taki sam jak Get-Help.