New-MarkdownAboutHelp

Modül:
platyPS Module

Şablondan yeni bir Konu Hakkında MD dosyası oluşturur.

Syntax

Default (Varsayılan) 

New-MarkdownAboutHelp
    [-OutputFolder] <String>
    [[-AboutName] <String>]
    [<CommonParameters>]

Description

New-MarkdownAboutHelp cmdlet'i, Hakkında Konusunun standart öğeleriyle önceden doldurulmuş bir Markdown dosyası oluşturur. Cmdlet şablonu MD'yi kopyalar, üst bilgileri ve dosya adını AboutName parametresine göre yeniden adlandırır ve dosyayı OutputFolder parametresi tarafından belirlenen dizine aktarır.

Konu Hakkında txt biçimine dönüştürülebilir. Hakkında konuların txt biçiminde olması gerekir, aksi takdirde PowerShell Yardım altyapısı belgeyi ayrıştıramaz. Konu Hakkında markdown dosyalarını Konu Hakkında txt dosyalarına dönüştürmek için New-ExternalHelp cmdlet'ini kullanın.

Örnekler

Örnek 1

PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test

    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:12 PM           1491 about_TestAboutTopic.md

Konu Başlığı Markdown Dosyası Hakkında PowerShell için dosya bilgileri oluşturun ve görüntüleyin.

Örnek 2

PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test


    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:15 PM           1550 about_TestAboutTopic.help.txt

Mevcut Markdown Hakkında dosyasından Konu Hakkında PowerShell Txt dosyası oluşturun.

Parametreler

-AboutName

Hakkında konusunun adı.

Parametre özellikleri

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

Parametre kümeleri

(All)
Position:1
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

hakkında konusunun oluşturulacağı dizin.

Parametre özellikleri

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

Parametre kümeleri

(All)
Position:0
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

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

None

Çıkışlar

Object

Bu cmdlet, oluşturulan dosyalar için bir nesne döndürür.

Notlar

Güncelleştirilebilir yardımdan yararlanmak için hakkında konuların bir cab dosyasına eklenmesi gerekir.