Update-MarkdownHelp
PlatyPS markdown yardım dosyalarını güncelleştirin.
Syntax
Default (Varsayılan)
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
Description
Update-MarkdownHelp cmdlet'i PlatyPS markdown yardım dosyalarını, dosyaların içeriğini tamamen değiştirmeden güncelleştirir.
Bazı parametre öznitelikleri zaman içinde değişir. Örneğin, parametre kümeleri, türler, varsayılan değer ve gerekli. Bu cmdlet markdown güncelleştirmeleri bu değişiklikleri yansıtmaya yardımcı olur. Ayrıca, herhangi bir yeni parametre için markdown dosyasına yer tutucu metin ekler.
Markdown yardım dosyalarınızda değişiklikleri yaymak için aşağıdakileri yapın:
- Modülün yeni sürümünü Windows PowerShell oturumunuza yükleyin.
- Dosyaları güncelleştirmek için
Update-MarkdownHelpcmdlet'ini çalıştırın. - Markdown dosyalarındaki yeni parametre meta verilerini denetleyin.
Örnekler
Örnek 1: Klasördeki tüm dosyaları güncelleştirme
PS C:\> Update-MarkdownHelp -Path ".\docs"
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
Bu komut, belirtilen yoldaki tüm markdown yardım dosyalarını geçerli cmdlet'lerle eşleşecek şekilde güncelleştirir.
Örnek 2: Bir dosyayı güncelleştirme ve günlüğü yakalama
PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"
Directory: D:\Working\PlatyPS\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 8:20 PM 9993 New-MarkdownHelp.md
Bu komut bir markdown yardım dosyasını güncelleştirir. günlük bilgilerini markdown.log dosyasına yazar.
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 |
-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: | 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 |
-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
Oturumlarda artık mevcut olmayan yardım dosyalarını kaldırın (örneğin işlev silindiyse)
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 |
-LogAppend
Bu cmdlet'in üzerine yazmak yerine bilgileri günlüğe eklediğini 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 |
-LogPath
Günlük bilgileri için bir dosya yolu belirtir. cmdlet,VERBOSE akışını günlüğe yazar. Ayrıntılı parametresini belirtirseniz, bu cmdlet bu bilgileri konsola da yazar.
Parametre özellikleri
| Tür: | String |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | 2 |
| 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
Güncelleştirilecek markdown dosyalarının ve klasörlerinin yol dizisini belirtir.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | True |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | 0 |
| 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 |
-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
(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 |
-UpdateInputOutput
Giriş ve Çıkış bölümünü, cmdlet'in geçerli durumunu yansıtacak şekilde yeniler. UYARI: Bu parametre, bu bölümlere el ile yapılan tüm eklemeleri kaldırır.
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 |
-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 |
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, güncelleştirilmiş dosyalar için bir FileInfo[] nesnesi döndürür.
Notlar
Yardım güncelleştirmesini istediğiniz modül önce yardımın önceki sürümünü içeren konumdan içeri aktarılmalıdır. Bu koşul karşılanmazsa, AlphabeticParamsOrder parametresi kullanılmamış olsa bile parametre sırası güncelleştirilmiş yardımda alfabetik olarak sıralanır.
