Get-HelpPreview
Zeigt Die generierte externe Hilfe als Get-Help
Ausgabe an.
Syntax
Get-HelpPreview
-Path <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
Beschreibung
Das Get-HelpPreview
Cmdlet zeigt Die generierte externe Hilfe als Get-Help
Ausgabe an.
Geben Sie eine oder mehrere Dateien im MAML-Format (Microsoft Assistance Markup Language) an.
Beispiele
Beispiel 1: Vorschau der PlatyPS-Hilfe
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
Der erste Befehl erstellt ein Hilfeobjekt für die angegebene MAML-Datei. Der Befehl speichert sie in der variablen $Help.
Der zweite Befehl zeigt die Name-Eigenschaft für jedes objekt in $Help an.
Parameter
-ConvertDoubleDashLists
Gibt an, dass dieses Cmdlet Aufzählungsaufzählungszeichen mit doppeltem Bindestrich in Einzelbindestriche konvertiert. Listen mit doppelten Bindestrichen sind in Windows PowerShell Dokumentation üblich. Markdown akzeptiert einzelne Bindestriche für Listen.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConvertNotesToList
Gibt an, dass dieses Cmdlet mehrere Absatzelemente im ABSCHNITT NOTES als einzelne Listenelemente formatiert. Diese Ausgabe folgt der TechNet-Formatierung.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Gibt ein Array von Pfaden externer MAML-Hilfedateien an.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Eingaben
String[]
Sie können ein Array von Pfaden an dieses Cmdlet übergeben.
Ausgaben
Help Object
Dieses Cmdlet gibt ein Hilfeobjekt zurück, das dieselbe Ausgabe wie Get-Help
ist.