Dela via

Export-MamlCommandHelp

Modul:
Microsoft.PowerShell.PlatyPS Module

Exporterar CommandHelp objekt till en MAML-fil.

Syntax

__AllParameterSets 

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

Description

Det här kommandot konverterar CommandHelp objekt till en MAML-fil. MAML-filen innehåller hjälpinnehåll i det format som används av kommandot Get-Help.

Exempel

Exempel 1 – Skapa MAML-hjälpfilen för en modul

$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

Parametrar

-CommandHelp

Ett eller flera CommandHelp objekt att exportera.

Parameteregenskaper

Typ:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Encoding

Den kodning som ska användas när du skriver markdown-filen. Om inget värde anges kodas som standard värdet för $OutputEncoding-inställningsvariabeln.

Parameteregenskaper

Typ:Encoding
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Force

Använd parametern Force för att skriva över utdatafilen om den redan finns.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OutputFolder

Mappen där markdown-filen sparas. Om mappen inte finns skapas den.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Utdata

FileInfo