Delen via

Get-HelpPreview

Module:
platyPS Module

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

Syntaxis

Default (Standaard) 

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.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten: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.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Path

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

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

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.