Export-YamlCommandHelp
Hiermee exporteert u CommandHelp objecten naar YAML-bestanden.
Syntaxis
__AllParameterSets
Export-YamlCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Met deze opdracht exporteert u een CommandHelp -object naar een Yaml-bestand. U kunt frontmatter voor metagegevens toevoegen aan het Yaml-bestand met behulp van de parameter Metagegevens . U kunt een CommandHelp -object ophalen met behulp van de Export-YamlCommandHelp-cmdlet of een van de Import-* cmdlets.
Voorbeelden
Voorbeeld 1: Help-inhoud van markdown-opdrachten converteren naar Yaml-indeling
In dit voorbeeld importeert u Markdown Help in de oude indeling uit de .\v1 map en exporteert u deze naar de .\v2 map in de nieuwe indeling.
$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Export-YamlCommandHelp -OutputFolder .\v2\yaml
Directory: D:\Git\PS-Src\platyPS\v2docs\v2\yaml
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/26/2024 3:56 PM 3535 Compare-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 4776 Export-MamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 8150 Export-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4998 Export-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 6357 Export-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5396 Export-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 3019 Import-MamlHelp.yml
-a--- 8/26/2024 3:56 PM 4235 Import-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4318 Import-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 4391 Import-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3862 Import-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 2325 Measure-PlatyPSMarkdown.yml
-a--- 8/26/2024 3:56 PM 5190 New-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 8335 New-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4697 New-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 3468 Test-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3172 Update-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 3908 Update-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5217 Update-MarkdownModuleFile.yml
Parameters
-CommandHelp
Het CommandHelp -object dat u wilt exporteren. U kunt het CommandHelp- -object doorgeven aan de pijplijn of met behulp van de parameter Command .
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
De metagegevens die moeten worden toegevoegd aan de frontmatter van het Markdown-bestand. De metagegevens zijn een hashtabel waarbij u de sleutel- en waardeparen opgeeft die moeten worden toegevoegd aan de frontmatter. Nieuwe sleutelnamen worden toegevoegd aan de bestaande frontmatter. De waarden van bestaande sleutels worden overschreven.
Type: Hashtable
Default value: None Ondersteunt jokertekens: False DontShow: False
(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: Named Verplicht: False 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_CommonParameters voor meer informatie.
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Uitvoerwaarden