Delen via

Show-HelpPreview

Module:
Microsoft.PowerShell.PlatyPS Module

Bekijk de inhoud van het MAML-bestand zoals deze zou worden weergegeven wanneer de uitvoer door Get-Help.

Syntaxis

Path 

Show-HelpPreview
    [-Path] <string[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

LiteralPath 

Show-HelpPreview
    [-LiteralPath] <string[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

Description

De Show-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: de inhoud van een MAML-bestand weergeven

In dit voorbeeld wordt de inhoud van het PlatyPS MAML-bestand weergegeven zoals deze wordt weergegeven wanneer de uitvoer door Get-Help.

Show-HelpPreview -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS-Help.xml

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:False
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.

Parametereigenschappen

Type:SwitchParameter
Default value:False
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

-LiteralPath

Hiermee geeft u een of meer paden naar MAML Help-bestanden. Wildcards worden niet ondersteund.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:PSPath, LP

Parametersets

LiteralPath
Position:1
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Path

Hiermee geeft u een of meer paden naar MAML Help-bestanden. Wildcards worden ondersteund.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

Path
Position:1
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

Uitvoerwaarden

MamlCommandHelpInfo

Met deze cmdlet wordt een MamlCommandHelpInfo-objecten geretourneerd. Dit is hetzelfde object dat wordt geretourneerd door Get-Help.