Export-YamlCommandHelp
CommandHelp nesnelerini YAML dosyalarına aktarır.
Syntax
__AllParameterSets
Export-YamlCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Bu komut, bir CommandHelp nesnesini Yaml dosyasına aktarır. meta veri parametresini kullanarak Yaml dosyasına meta veri ön ekleyebilirsiniz.
cmdlet'ini veya Export-YamlCommandHelp cmdlet'lerinden birini kullanarak Import-* nesnesi alabilirsiniz.
Örnekler
Örnek 1 - Markdown komutu yardım içeriğini Yaml biçimine dönüştürme
Bu örnek, Markdown yardımını .\v1 klasöründen eski biçimde içeri aktarır ve yeni biçimde .\v2 klasörüne aktarır.
$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
Parametreler
-CommandHelp
Dışarı aktaracak CommandHelp nesnesi.
CommandHelp nesnesini işlem hattında veya Command parametresini kullanarak geçirebilirsiniz.
Parametre özellikleri
Tür: Microsoft.PowerShell.PlatyPS.Model.CommandHelp [ ]
Default value: None Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: 0 Zorunlu: True İşlem hattından gelen değer: True Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
-Confirm
Cmdlet'i çalıştırmadan önce sizden onay ister.
Parametre özellikleri
Tür: SwitchParameter
Default value: False Joker karakterleri destekler: False DontShow: False Diğer adlar: Cf
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
-Encoding
Markdown dosyası yazılırken kullanılacak kodlama. Değer belirtilmezse kodlama varsayılan olarak $OutputEncoding tercih değişkeninin değerine ayarlanır.
Parametre özellikleri
Tür: Encoding
Default value: False Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
-Force
Çıktı dosyasının zaten varsa üzerine yazmak için Zorla parametresini kullanın.
Parametre özellikleri
Tür: SwitchParameter
Default value: False Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
Markdown dosyasının ön modeline eklenecek meta veriler. Meta veriler, ön modele eklenecek anahtar ve değer çiftlerini belirttiğiniz bir karma tablodur. Mevcut ön modele yeni anahtar adları eklenir. Varolan anahtarların değerlerinin üzerine yazılır.
Tür: Hashtable
Default value: None Joker karakterleri destekler: False DontShow: False
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
-OutputFolder
Markdown dosyasının kaydedildiği klasör. Klasör yoksa oluşturulur.
Parametre özellikleri
Tür: String
Default value: None Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
-WhatIf
Komutu, eylemleri gerçekleştirmeden yalnızca ne olacağını bildiren bir modda çalıştırır.
Parametre özellikleri
Tür: SwitchParameter
Default value: False Joker karakterleri destekler: False DontShow: False Diğer adlar: Wi
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Özellik adına göre işlem hattından gelen değer: False Kalan bağımsız değişkenlerden elde edilen değer: False
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters .
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Çıkışlar