New-MarkdownHelp

Modul:

platyPS Module

Membuat bantuan dalam format markdown.

Sintaks

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

Deskripsi

Cmdlet New-MarkdownHelp membuat bantuan dalam format markdown berdasarkan modul, perintah, atau file dalam format Microsoft Assistance Markup Language (MAML).

Contoh

Contoh 1: Membuat bantuan dari perintah

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

Perintah pertama membuat fungsi bernama Command03 menggunakan sintaks Windows PowerShell standar.

Perintah kedua membuat bantuan untuk fungsi stub tersebut di folder .\docs.

Contoh 2: Membuat bantuan dari modul

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

Perintah pertama memuat modul PlatyPS ke sesi saat ini menggunakan cmdlet Import-Module.

Perintah kedua membuat bantuan untuk semua cmdlet dalam modul PlatyPS. Ini menyimpannya di folder .\docs. Perintah ini menentukan parameter Force . Oleh karena itu, ini menimpa file markdown bantuan yang ada yang memiliki nama yang sama.

Contoh 3: Membuat bantuan dari file MAML yang ada

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

Perintah ini membuat bantuan dalam format markdown untuk file MAML bantuan yang ditentukan. Anda tidak perlu memuat modul, seperti pada contoh sebelumnya. Jika modul sudah dimuat, perintah ini membuat bantuan berdasarkan file MAML, bukan pada modul yang saat ini diinstal.

Contoh 4: Membuat bantuan dari file MAML yang ada untuk digunakan dalam file CAB

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

Perintah ini membuat bantuan dalam format markdown untuk file MAML bantuan yang ditentukan, seperti pada contoh sebelumnya. Perintah ini juga menentukan parameter WithModulePage dan parameter ModuleName. Perintah membuat file bernama PSReadLine.md yang berisi tautan ke file markdown lainnya dalam modul dan metadata ini yang dapat digunakan untuk membuat file .cab.

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

-Command

Menentukan nama perintah dalam sesi Anda saat ini. Ini bisa menjadi perintah apa pun yang didukung oleh bantuan PowerShell, seperti cmdlet atau fungsi.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromCommand

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ConvertDoubleDashLists

Menunjukkan bahwa cmdlet ini mengonversi poin daftar tanda hubung ganda menjadi poin tanda hubung tunggal. Daftar tanda hubung ganda umum di dokumentasi Windows PowerShell. Markdown menerima tanda hubung tunggal untuk daftar.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ConvertNotesToList

Menunjukkan bahwa cmdlet ini memformat beberapa item paragraf di bagian CATATAN sebagai item daftar tunggal.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromMaml

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

Menunjukkan bahwa cmdlet ini menimpa file yang ada yang memiliki nama yang sama.

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

-FwLink

Menentukan tautan teruskan untuk halaman modul. Nilai ini diperlukan untuk pembuatan file .cab. Nilai ini digunakan sebagai metadata header markdown di halaman modul.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromModule

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-HelpVersion

Menentukan versi bantuan Anda. Nilai ini diperlukan untuk pembuatan file .cab. Nilai ini digunakan sebagai metadata header markdown di halaman modul.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromModule

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Locale

Menentukan lokal bantuan Anda. Nilai ini diperlukan untuk pembuatan file .cab. Nilai ini digunakan sebagai metadata header markdown di halaman modul.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromModule

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-MamlFile

Menentukan array jalur file bantuan .xml MAML.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromMaml

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Metadata

Menentukan metadata yang disertakan cmdlet ini dalam file markdown bantuan sebagai tabel hash pasangan nilai kunci string-to-sting. Cmdlet ini menulis metadata di header setiap file bantuan markdown.

Cmdlet New-ExternalHelp tidak menggunakan metadata ini. Alat eksternal dapat menggunakan metadata ini.

Properti parameter

Jenis:	Hashtable
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

-Module

Menentukan array nama modul yang cmdlet ini membuat bantuan dalam format markdown.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromModule

Position:	Named
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ModuleGuid

Menentukan GUID modul bantuan Anda. Nilai ini diperlukan untuk pembuatan file .cab. Nilai ini digunakan sebagai metadata header markdown di halaman modul.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ModuleName

Menentukan nama modul bantuan Anda. Nilai ini diperlukan untuk pembuatan file .cab. Nilai ini digunakan sebagai metadata header markdown di halaman modul.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ModulePagePath

Ketika parameter WithModule digunakan secara default, parameter tersebut menempatkan file .md di lokasi yang sama dengan semua dokumen lainnya. Dengan parameter ini, Anda dapat menentukan nama/lokasi baru yang menyediakan opsi penempatan yang lebih baik.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromModule

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

FromMaml

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-NoMetadata

Menunjukkan bahwa cmdlet ini tidak menulis metadata apa pun dalam markdown yang dihasilkan.

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

-OnlineVersionUrl

Menentukan alamat tempat fungsi bantuan yang dapat diperbarui mengunduh bantuan yang diperbarui. Jika Anda tidak menentukan nilai, cmdlet menggunakan string kosong.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromCommand

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-OutputFolder

Menentukan jalur folder tempat cmdlet ini membuat file bantuan markdown.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	True
Nilai dari alur:	False
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

FromModule

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

FromCommand

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

-WithModulePage

Menunjukkan bahwa cmdlet ini membuat halaman modul di folder output. File ini memiliki nama yang ditentukan parameter ModuleName. Jika Anda tidak menentukan parameter tersebut, cmdlet menyediakan nama default MamlModule. Anda dapat menimpa pengaturan ini menggunakan ModulePagePath yang memungkinkan Anda menentukan jalur yang berbeda untuk halaman modul

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

FromModule

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

FromMaml

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 nama modul ke cmdlet ini. Ini adalah modul tempat cmdlet ini membuat markdown bantuan.

Output

FileInfo

Cmdlet ini mengembalikan objek FileInfo[] untuk file yang dibuat.