Get-HelpPreview

Referentie

Module:: platyPS

Geeft de gegenereerde externe Help weer als Get-Help uitvoer.

Syntaxis

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

Description

De Get-HelpPreview-cmdlet geeft de gegenereerde externe Help weer als Get-Help uitvoer. Geef een of meer bestanden op in DE MAML-indeling (Microsoft Assistance Markup Language).

Voorbeelden

Voorbeeld 1: Preview van de PlatyPS Help

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

Met de eerste opdracht maakt u een Help--object voor het opgegeven MAML-bestand. Met de opdracht wordt deze opgeslagen in de variabele $Help.

Met de tweede opdracht wordt de eigenschap Name voor elk van de objecten in $Help weergegeven.

Parameters

-ConvertDoubleDashLists

Geeft aan dat deze cmdlet opsommingstekens met dubbele afbreekstreepjes converteert naar opsommingstekens met één afbreekstreepje. Lijsten met dubbele afbreekstreepjes zijn gebruikelijk in windows PowerShell-documentatie. Markdown accepteert enkele afbreekstreepjes voor lijsten.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ConvertNotesToList

Hiermee wordt aangegeven dat met deze cmdlet meerdere alinea-items in de sectie NOTES als één lijstitem worden opgemaakt. Deze uitvoer volgt TechNet-opmaak.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Path

Hiermee geeft u een matrix van paden van externe MAML Help-bestanden.

Type:	String[]
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	True

Invoerwaarden

String[]

U kunt een matrix met paden naar deze cmdlet doorsluisen.

Uitvoerwaarden

Help Object

Met deze cmdlet wordt een Help--object geretourneerd. Dit is dezelfde uitvoer als Get-Help.

Delen via