New-MarkdownHelp

Modül:: platyPS Module

Markdown biçiminde yardım oluşturur.

Syntax

FromModule

New-MarkdownHelp
    -Module <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

FromCommand

New-MarkdownHelp
    -Command <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-OnlineVersionUrl <String>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-ExcludeDontShow]
    [<CommonParameters>]

FromMaml

New-MarkdownHelp
    -MamlFile <String[]>
    -OutputFolder <String>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ModuleName <String>]
    [-ModuleGuid <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

Description

New-MarkdownHelp cmdlet'i, microsoft yardım biçimlendirme dili (MAML) biçimindeki bir modüle, komuta veya dosyaya göre markdown biçiminde yardım oluşturur.

Örnekler

Örnek 1: Komuttan yardım oluşturma

PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"


    Directory: D:\Working\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:53 PM            664 Command03.md

İlk komut, standart Windows PowerShell söz dizimini kullanarak Command03 adlı bir işlev oluşturur.

İkinci komut, .\docs klasöründe bu saplama işlevi için yardım oluşturur.

Örnek 2: Modülden yardım oluşturma

PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force


    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

İlk komut, cmdlet'ini kullanarak Import-Module modülünü geçerli oturuma yükler.

İkinci komut, PlatyPS modülündeki tüm cmdlet'ler için yardım oluşturur. Bunları .\docs klasöründe depolar. Bu komut Force parametresini belirtir. Bu nedenle, aynı ada sahip mevcut yardım markdown dosyalarının üzerine yazar.

Örnek 3: Mevcut bir MAML dosyasından yardım oluşturma

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'

    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:56 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:56 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM          15320 Set-PSReadLineOption.md

Bu komut, belirtilen yardım MAML dosyası için markdown biçiminde yardım oluşturur. Önceki örnekte olduğu gibi modülü yüklemeniz gerekmez. Modül zaten yüklüyse, bu komut şu anda yüklü olan modülde değil MAML dosyasını temel alarak yardım oluşturur.

Örnek 4: CAB dosyasında kullanmak üzere mevcut bir MAML dosyasından yardım oluşturma

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage  -Force -ModuleName "PSReadLine"


    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:59 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:59 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM          15320 Set-PSReadLineOption.md
-a----        5/22/2016   6:59 PM            942 PSReadLine.md

Bu komut, önceki örnekte olduğu gibi belirtilen yardım MAML dosyası için markdown biçiminde yardım oluşturur. Bu komut ayrıca WithModulePage parametresini ve ModuleName parametresini belirtir. komutu, bu modüldeki diğer markdown dosyalarının bağlantılarını ve .cab dosyaları oluşturmak için kullanılabilecek meta verileri içeren PSReadLine.md adlı bir dosya oluşturur.

Parametreler

-AlphabeticParamsOrder

PARAMETRELER bölümünde parametreleri ada göre alfabetik olarak sırala. 5 özel durum vardır: -Confirm, -WhatIf, -IncludeTotalCount, -Skipve -First parametreleri son olacaktır. Bu parametreler ortaktır ve bu nedenle iyi tanımlanmış davranışlara sahiptir.

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

-Command

Geçerli oturumunuzda bir komutun adını belirtir. Bu, PowerShell yardımı tarafından desteklenen cmdlet veya işlev gibi herhangi bir komut olabilir.

Parametre özellikleri

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

Parametre kümeleri

FromCommand

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

-ConvertDoubleDashLists

Bu cmdlet'in çift kısa çizgili liste madde işaretlerini tek kısa çizgi madde işaretlerine dönüştürdüğünü gösterir. Çift kısa çizgi listeleri Windows PowerShell belgelerinde yaygındır. Markdown, listeler için tek kısa çizgi kabul eder.

Parametre özellikleri

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

Parametre kümeleri

FromMaml

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

-ConvertNotesToList

Bu cmdlet'in NOTES bölümündeki birden çok paragraf öğesini tek liste öğeleri olarak biçimlendirdiğini gösterir.

Parametre özellikleri

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

Parametre kümeleri

FromMaml

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

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:	UTF8 without BOM
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

-ExcludeDontShow

parametre özniteliğinde DontShow ile işaretlenmiş parametreleri yardım içeriğinin dışında tutun.

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

-Force

Bu cmdlet'in aynı adlara sahip mevcut dosyaları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

-FwLink

Modül sayfasının ileriye doğru bağlantısını belirtir. Bu değer .cab dosya oluşturmak için gereklidir. Bu değer modül sayfasında markdown üst bilgisi meta verileri olarak kullanılır.

Parametre özellikleri

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

Parametre kümeleri

FromModule

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

FromMaml

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

-HelpVersion

Yardımınızın sürümünü belirtir. Bu değer .cab dosya oluşturmak için gereklidir. Bu değer modül sayfasında markdown üst bilgisi meta verileri olarak kullanılır.

Parametre özellikleri

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

Parametre kümeleri

FromModule

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

FromMaml

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

-Locale

Yardımınızın yerel ayarını belirtir. Bu değer .cab dosya oluşturmak için gereklidir. Bu değer modül sayfasında markdown üst bilgisi meta verileri olarak kullanılır.

Parametre özellikleri

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

Parametre kümeleri

FromModule

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

FromMaml

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

-MamlFile

MAML .xml yardım dosyalarının yol yolu dizisini belirtir.

Parametre özellikleri

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

Parametre kümeleri

FromMaml

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

-Metadata

Bu cmdlet'in yardım markdown dosyalarına dizeden iğneye anahtar-değer çiftlerinin karma tablosu olarak içerdiği meta verileri belirtir. Bu cmdlet, meta verileri her markdown yardım dosyasının üst bilgisine yazar.

New-ExternalHelp cmdlet'i bu meta verileri kullanmaz. Dış araçlar bu meta verileri kullanabilir.

Parametre özellikleri

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

-Module

Bu cmdlet'in markdown biçiminde yardım oluşturduğu modüllerin ad dizisini belirtir.

Parametre özellikleri

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

Parametre kümeleri

FromModule

Position:	Named
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

-ModuleGuid

Yardımınızın modülünün GUID değerini belirtir. Bu değer .cab dosya oluşturmak için gereklidir. Bu değer modül sayfasında markdown üst bilgisi meta verileri olarak kullanılır.

Parametre özellikleri

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

Parametre kümeleri

FromMaml

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

-ModuleName

Yardımınızın modülünün adını belirtir. Bu değer .cab dosya oluşturmak için gereklidir. Bu değer modül sayfasında markdown üst bilgisi meta verileri olarak kullanılır.

Parametre özellikleri

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

Parametre kümeleri

FromMaml

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

-ModulePagePath

WithModule parametresi varsayılan olarak kullanıldığında.md dosyasını diğer tüm belgelerle aynı konuma yerleştirir. Bu parametreyle, daha iyi yerleştirme seçenekleri sağlayan yeni ad/konum belirtebilirsiniz.

Parametre özellikleri

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

Parametre kümeleri

FromModule

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

FromMaml

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

-NoMetadata

Bu cmdlet'in oluşturulan markdown'a meta veri yazmadığı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

-OnlineVersionUrl

Güncelleştirilebilir yardım işlevinin güncelleştirilmiş yardımı indirdiği adresi belirtir. Bir değer belirtmezseniz, cmdlet boş bir dize kullanır.

Parametre özellikleri

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

Parametre kümeleri

FromCommand

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

Bu cmdlet'in markdown yardım dosyalarını oluşturduğu klasörün yolunu 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

-Session

Uzak komutlar için destek sağlar. Import-PSSessionile komutları oluşturmak için kullandığınız oturumu geçirin. Bu, uzak oturumdan doğru parametre meta verilerini almak için gereklidir.

Parametre özellikleri

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

Parametre kümeleri

FromModule

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

FromCommand

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

-UseFullTypeName

Hedef belgenin parametreler için kısa bir ad yerine tam tür bir ad kullanacağı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

-WithModulePage

Bu cmdlet'in çıkış klasöründe bir modül sayfası oluşturduğunu gösterir. Bu dosya, ModuleName parametresinin belirttiği ada sahiptir. Bu parametreyi belirtmediyseniz, cmdlet MamlModulevarsayılan adı sağlar. Modül sayfası için farklı yol tanımlamanızı sağlayan ModulePagePath kullanarak bu ayarın üzerine yazabilirsiniz

Parametre özellikleri

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

Parametre kümeleri

FromModule

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

FromMaml

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.

Girişler

String

Modül adlarını bu cmdlet'e aktarabilirsiniz. Bunlar, bu cmdlet'in yardım markdown'ını oluşturduğu modüllerdir.