New-MarkdownCommandHelp

Modül:
Microsoft.PowerShell.PlatyPS Module

PowerShell modülleri ve komutları için Markdown yardım dosyaları oluşturur.

Syntax

__AllParameterSets 

New-MarkdownCommandHelp
    -OutputFolder <string>
    [-CommandInfo <CommandInfo[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpUri <string>]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-ModuleInfo <psmoduleinfo[]>]
    [-WithModulePage]
    [-AbbreviateParameterTypename]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

PowerShell modülleri ve komutları için Markdown yardım dosyaları oluşturur.

Örnekler

Örnek 1 - Modül için Markdown yardım dosyaları oluşturma

$newMarkdownCommandHelpSplat = @{
    ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Örnek 2 - Komut listesinden Markdown yardım dosyaları oluşturma

$newMarkdownCommandHelpSplat = @{
    CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Parametreler

-AbbreviateParameterTypename

Varsayılan olarak, bu komut parametre meta verilerinde ve giriş ve çıkış türleri için tam tür adları kullanır. Bu parametreyi kullandığınızda, cmdlet kısa tür adlarını döndürür.

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

-CommandInfo

Yardım oluşturulacak bir veya daha fazla komutun listesi.

Parametre özellikleri

Tür:

CommandInfo[]

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

Parametre kümeleri

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

Çıkış dosyalarını oluştururken kullanılan kodlama. Belirtilmezse, cmdlet $OutputEncodingtarafından belirtilen değeri kullanır.

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

Varsayılan olarak, bu komut var olan dosyaların üzerine yazmaz. Bu parametreyi kullandığınızda, cmdlet var olan dosyaların üzerine yazar.

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

-HelpInfoUri

Bu parametre, güncelleştirilebilir yardım için kullanılan URI'yi belirtmenize olanak tanır. Cmdlet varsayılan olarak modül bildiriminde belirtilen HelpInfoUri'yi kullanır.

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

-HelpUri

Bu parametre, çevrimiçi yardım için kullanılan URI'yi belirtmenize olanak tanır. Varsayılan olarak, cmdlet komutu için [CmdletBinding()] özniteliğinde tanımlanan URI'yi kullanır.

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

-HelpVersion

Bu parametre yardımın sürümünü belirtmenize olanak tanır. Varsayılan değer şudur: 1.0.0.0. Bu sürüm, güncelleştirilebilir yardım için kullanılan HelpInfo.xml dosyasına yazılır.

Parametre özellikleri

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

-Locale

Bu parametre, yardım dosyaları için dil yerel ayarını belirtmenize olanak tanır. Cmdlet varsayılan olarak geçerli CultureInfokullanır. Sisteminizdeki geçerli kültür ayarlarını görmek için Get-Culture cmdlet'ini kullanın.

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

-Metadata

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. document type veya PlatyPS schema version anahtarlarının değerlerinin üzerine yazamazsınız. Bu anahtarlar karma tablo içinde varsa, cmdlet değerleri yoksayar ve bir uyarı verir.

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

-ModuleInfo

Yardım oluşturulacak bir veya daha fazla modülün listesi. cmdlet'i modüldeki tüm komutlar için Markdown yardım dosyaları oluşturur. cmdlet'i, çıkış konumundaki modülün adıyla eşleşen bir klasör oluşturur. Tüm Markdown dosyaları modül klasörüne yazılır.

Parametre özellikleri

Tür:

PSModuleInfo[]

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

Parametre kümeleri

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

-OutputFolder

Markdown yardım dosyalarının yazıldığı konumu belirtir. cmdlet'i işlenen her modül için bir klasör oluşturur. Hedef komut bir modülle ilişkili değilse, cmdlet çıkış klasörünün kökünde bir Markdown dosyası oluşturur.

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

-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

-WithModulePage

Varsayılan olarak, bu cmdlet yalnızca komutlar için Markdown dosyaları oluşturur. Bu parametreyi kullandığınızda, cmdlet modül için bir Markdown dosyası oluşturur. Bu Markdown dosyası, modüldeki tüm komutların ve HelpInfo.xml dosyasını oluşturmak için kullanılan meta verilerin listesini içerir.

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

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

CommandInfo

PSModuleInfo

Çıkışlar

FileInfo