Update-MarkdownModuleFile

Modül:
Microsoft.PowerShell.PlatyPS Module

Markdown modül dosyasını güncelleştirir.

Syntax

path 

Update-MarkdownModuleFile
    [-Path] <string>
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

literalpath 

Update-MarkdownModuleFile
    [-CommandHelp] <CommandHelp[]>
    -LiteralPath <string>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Bu cmdlet, Markdown komut dosyalarından içeri aktarılan CommandHelp nesne bilgileriyle bir Markdown modül dosyasını güncelleştirir.

Örnekler

Örnek 1 - Yeni komut yardım dosyalarından modül dosyasını güncelleştirme

$mdfiles = Measure-PlatyPSMarkdown -Path .\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Update-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md

Parametreler

-CommandHelp

CommandHelp dışarı aktaracak nesneleri. CommandHelp nesnesini işlem hattında veya bu parametreyi 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:1
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: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

Çı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

-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

-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

-LiteralPath

Bir veya daha fazla modül markdown dosyasının yolunu belirtir. LiteralPath değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, yolu tek tırnak işaretleriyle çevreleyin. Tek tırnak işaretleri, PowerShell'in hiçbir karakteri kaçış dizisi olarak yorumlamamasını sağlar.

Daha fazla bilgi için bkz. about_Quoting_Rules.

Parametre özellikleri

Tür:String
Default value:False
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:PSPath, LP

Parametre kümeleri

literalpath
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

-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

-NoBackup

Varsayılan olarak, cmdlet özgün Markdown dosyasını güncelleştirmeden önce bir yedek oluşturur. Yedekleme dosyasının oluşturulmasını engellemek için bu parametreyi 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

-Path

Bir veya daha fazla modül markdown dosyasının yolunu belirtir.

Parametre özellikleri

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

Parametre kümeleri

path
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

-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.

Girişler

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Çıkışlar

FileInfo