New-YamlHelp

Modül:
platyPS Module

Dış araçlar tarafından kolayca okunabilmesi için Markdown yardımını YAML'ye dönüştürür

Syntax

Default (Varsayılan) 

New-YamlHelp
    [-Path] <String[]>
    -OutputFolder <String>
    [-Encoding <Encoding>]
    [-Force]
    [<CommonParameters>]

Description

New-YamlHelp cmdlet'i New-ExternalHelp cmdlet'ine benzer şekilde çalışır, ancak Get-Helpdestekleyecek bir MAML dosyası oluşturmak yerine, yardım sayfalarının özel işlenmesini sağlamak için dış araçlar tarafından okunabilen bir YAML dosyaları kümesi oluşturur.

Örnekler

Örnek 1: YAML dosyaları oluşturma

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

Bu, dış araçların her cmdlet için yapılandırılmış verileri okuyabilmesi için her cmdlet için bir YAML dosyası oluşturur.

Örnek 2: Belirli kodlama ile YAML dosyaları oluşturma

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml -Force -Encoding ([System.Text.Encoding]::Unicode)

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

Bu, belirtilen -Encoding dosyasındaki dosyaları hem okur hem de yazar. Zorla parametresi, zaten var olan dosyaların üzerine yazar.

Parametreler

-Encoding

Dış yardım dosyanız için karakter kodlamasını belirtir. System.Text.Encoding nesnesini belirtin. Daha fazla bilgi için bkz. about_Character_Encoding.

Parametre özellikleri

Tür:Encoding
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

-Force

Bu cmdlet'in aynı ada sahip mevcut bir dosyanın üzerine yazdığını gösterir.

Parametre özellikleri

Tür:SwitchParameter
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

-OutputFolder

YAML dosyalarının oluşturulacağı klasörü belirtir

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:True
İş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

-Path

Markdown dosya veya klasörlerinin yol dizisini belirtir. Bu cmdlet, bu dosya ve klasörleri temel alarak dış yardım oluşturur.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:1
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:True
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.

Girişler

String

Bir yol dizisini bu cmdlet'e yöneltebilirsiniz.

Çıkışlar

FileInfo

Bu cmdlet, oluşturulan dosyalar için bir FileInfo[] nesnesi döndürür.