Update-MarkdownHelp
Perbarui file bantuan markdown PlatyPS.
Sintaks
Default (Default)
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
Deskripsi
Cmdlet Update-MarkdownHelp memperbarui file bantuan markdown PlatyPS tanpa sepenuhnya mengganti konten file.
Beberapa atribut parameter berubah dari waktu ke waktu. Misalnya, set parameter, jenis, nilai default, dan diperlukan. Cmdlet ini memperbarui markdown membantu mencerminkan perubahan tersebut. Ini juga menambahkan teks tempat penampung ke file markdown untuk parameter baru apa pun.
Untuk menyebarkan perubahan pada file bantuan markdown Anda, lakukan hal berikut:
- Muat versi baru modul ke sesi Windows PowerShell Anda.
- Jalankan cmdlet
Update-MarkdownHelpuntuk memperbarui file. - Periksa metadata parameter baru dalam file markdown.
Contoh
Contoh 1: Memperbarui semua file dalam folder
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
Perintah ini memperbarui semua file bantuan markdown di jalur yang ditentukan agar sesuai dengan cmdlet saat ini.
Contoh 2: Memperbarui satu file dan mengambil log
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
Perintah ini memperbarui file bantuan markdown. Ini menulis informasi log ke file markdown.log.
Parameter
-AlphabeticParamsOrder
Urutan parameter menurut abjad berdasarkan nama di bagian PARAMETERS. Ada 5 pengecualian: parameter -Confirm, -WhatIf, -IncludeTotalCount, -Skip, dan -First akan menjadi yang terakhir. Parameter ini umum dan karenanya memiliki perilaku yang terdefinisi dengan baik.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Encoding
Menentukan pengodean karakter untuk file bantuan eksternal Anda. Tentukan objek System.Text.Encoding. Untuk informasi selengkapnya, lihat about_Character_Encoding.
Properti parameter
| Jenis: | Encoding |
| Nilai default: | UTF8 without BOM |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | 1 |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-ExcludeDontShow
Kecualikan parameter yang ditandai dengan DontShow di atribut parameter dari konten bantuan.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Force
Hapus file bantuan yang tidak lagi ada dalam sesi (misalnya jika fungsi dihapus)
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-LogAppend
Menunjukkan bahwa cmdlet ini menambahkan informasi ke log sebagai gantinya menimpanya.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-LogPath
Menentukan jalur file untuk informasi log. Cmdlet menulis aliran VERBOSE ke log. Jika Anda menentukan parameter Verbose, cmdlet ini juga menulis informasi tersebut ke konsol.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | 2 |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Path
Menentukan array jalur file markdown dan folder yang akan diperbarui.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | True |
| DontShow: | False |
Set parameter
(All)
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | True |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Session
Menyediakan dukungan untuk perintah jarak jauh. Lewati sesi yang Anda gunakan untuk membuat perintah dengan Import-PSSession. Ini diperlukan untuk mendapatkan metadata parameter yang akurat dari sesi jarak jauh.
Properti parameter
| Jenis: | PSSession |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-UpdateInputOutput
Refresh bagian Input dan Output untuk mencerminkan status cmdlet saat ini. PERINGATAN: parameter ini akan menghapus penambahan manual apa pun ke bagian ini.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-UseFullTypeName
Menunjukkan bahwa dokumen target akan menggunakan nama jenis lengkap alih-alih nama pendek untuk parameter.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.
Input
String
Anda dapat menyalurkan array jalur ke cmdlet ini.
Output
FileInfo
Cmdlet ini mengembalikan objek FileInfo[] untuk file yang diperbarui.
Catatan
Modul yang ingin Anda perbarui bantuannya harus terlebih dahulu diimpor dari lokasi yang berisi versi bantuan sebelumnya. Jika kondisi ini tidak terpenuhi, urutan parameter akan menjadi alfabet dalam bantuan yang diperbarui, bahkan jika parameter AlphabeticParamsOrder belum digunakan.
