Export-MamlCommandHelp

Module:

Microsoft.PowerShell.PlatyPS Module

Hiermee exporteert u CommandHelp objecten naar een MAML-bestand.

Syntaxis

__AllParameterSets

Export-MamlCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-OutputFolder] <string>
    [-Encoding <Encoding>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Met deze opdracht worden CommandHelp--objecten geconverteerd naar een MAML-bestand. Het MAML-bestand bevat Help-inhoud in de indeling die wordt gebruikt door de opdracht Get-Help.

Voorbeelden

Voorbeeld 1: het MAML-helpbestand voor een module maken

$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Export-MamlCommandHelp -OutputFolder .\maml

    Directory: D:\Git\PS-Src\platyPS\v2docs\maml

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:18 PM         160928 Microsoft.PowerShell.PlatyPS-Help.xml

Parameters

-CommandHelp

Een of meer CommandHelp objecten die u wilt exporteren.

Parametereigenschappen

Type:	Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

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

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	Cf

Parametersets

(All)

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

-Encoding

De codering die moet worden gebruikt bij het schrijven van het Markdown-bestand. Als er geen waarde is opgegeven, wordt standaard de waarde van de $OutputEncoding voorkeursvariabele gecodeerd.

Parametereigenschappen

Type:	Encoding
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

-Force

Gebruik de parameter Forceren om het uitvoerbestand te overschrijven als het al bestaat.

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

-OutputFolder

De map waarin het Markdown-bestand is opgeslagen. Als de map niet bestaat, wordt deze gemaakt.

Parametereigenschappen

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

Parametersets

(All)

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

-WhatIf

Voert de opdracht uit in een modus die alleen rapporteert wat er zou gebeuren zonder de acties uit te voeren.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	Wi

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
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

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Uitvoerwaarden

FileInfo

Verwante koppelingen

• Import-MarkdownCommandHelp