Bagikan melalui

Mendukung Bantuan Online

Nota

Penulisan manual bantuan berbasis XML sangat sulit. Modul PlatyPS memungkinkan Anda menulis bantuan di Markdown lalu mengonversinya ke bantuan berbasis XML. Ini membuatnya jauh lebih mudah untuk menulis dan memelihara bantuan. PlatyPS juga dapat membuat paket Bantuan yang Dapat Diperbarui untuk Anda. Untuk informasi selengkapnya, lihat Membuat bantuan berbasis XML menggunakan PlatyPS.

Dimulai di PowerShell 3.0, ada dua cara untuk mendukung fitur Get-Help Online untuk perintah PowerShell. Topik ini menjelaskan cara mengimplementasikan fitur ini untuk berbagai jenis perintah.

Tentang Bantuan Online

Bantuan online selalu menjadi bagian penting dari PowerShell. Meskipun cmdlet Get-Help menampilkan topik bantuan di prompt perintah, banyak pengguna lebih suka pengalaman membaca secara online, termasuk pengkodian warna, hyperlink, dan berbagi ide dalam Konten Komunitas dan dokumen berbasis wiki. Yang terpenting, sebelum munculnya Bantuan yang Dapat Diperbarui, bantuan online memberikan versi file bantuan yang paling up-to-date.

Dengan munculnya Bantuan yang Dapat Diperbarui di PowerShell 3.0, bantuan online masih memainkan peran penting. Selain pengalaman pengguna yang fleksibel, bantuan online memberikan bantuan kepada pengguna yang tidak atau tidak dapat menggunakan Bantuan yang Dapat Diperbarui untuk mengunduh topik bantuan.

Cara Kerja Get-Help -Online

Untuk membantu pengguna menemukan topik bantuan online untuk perintah, perintah Get-Help memiliki parameter Online yang membuka versi online topik bantuan untuk perintah di browser internet default pengguna.

Misalnya, perintah berikut membuka topik bantuan online untuk cmdlet Invoke-Command.

Get-Help Invoke-Command -Online

Untuk menerapkan Get-Help -Online, cmdlet Get-Help mencari Pengidentifikasi Sumber Daya Seragam (URI) untuk topik bantuan versi online di lokasi berikut.

  • Tautan pertama di bagian Tautan Terkait dari topik bantuan untuk perintah tersebut. Topik bantuan harus diinstal pada komputer pengguna. Fitur ini diperkenalkan di PowerShell 2.0.

  • Properti HelpUri dari perintah apa pun. Properti HelpUri dapat diakses bahkan ketika topik bantuan untuk perintah tidak diinstal di komputer pengguna. Fitur ini diperkenalkan di PowerShell 3.0.

    Get-Help mencari URI di entri pertama di bagian Tautan Terkait sebelum mendapatkan nilai properti HelpUri. Jika nilai properti salah atau telah berubah, Anda dapat mengambil alihnya dengan memasukkan nilai yang berbeda di tautan terkait pertama. Namun, tautan terkait pertama hanya berfungsi ketika topik bantuan diinstal di komputer pengguna.

Anda dapat mendukung Get-Help -Online untuk perintah apa pun dengan menambahkan URI yang valid ke entri pertama di bagian Tautan Terkait dari topik bantuan berbasis XML untuk perintah tersebut. Opsi ini hanya valid dalam topik bantuan berbasis XML dan hanya berfungsi ketika topik bantuan diinstal pada komputer pengguna. Ketika topik bantuan diinstal dan URI diisi, nilai ini lebih diutamakan daripada properti HelpUri perintah.

Untuk mendukung fitur ini, URI harus muncul di elemen maml:uri di bawah elemen maml:relatedLinks/maml:navigationLink pertama dalam elemen maml:relatedLinks.

XML berikut menunjukkan penempatan URI yang benar. Teks Online version: dalam elemen maml:linkText adalah praktik terbaik, tetapi tidak diperlukan.

<maml:relatedLinks>
    <maml:navigationLink>
        <maml:linkText>Online version:</maml:linkText>
        <maml:uri>https://go.microsoft.com/fwlink/?LinkID=113279</maml:uri>
    </maml:navigationLink>
    <maml:navigationLink>
        <maml:linkText>about_History</maml:linkText>
        <maml:uri/>
    </maml:navigationLink>
</maml:relatedLinks>

Menambahkan properti HelpUri ke perintah

Bagian ini memperlihatkan cara menambahkan properti HelpUri ke perintah dari berbagai jenis.

Menambahkan Properti HelpUri ke Cmdlet

Untuk cmdlet yang ditulis dalam C#, tambahkan atribut HelpUri ke kelas Cmdlet. Nilai atribut harus URI yang dimulai dengan http atau https.

Kode berikut menunjukkan atribut HelpUri dari kelas cmdlet Get-History.

[Cmdlet(VerbsCommon.Get, "History", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=001122")]

Menambahkan properti HelpUri ke fungsi tingkat lanjut

Untuk fungsi tingkat lanjut, tambahkan properti HelpUri ke atribut CmdletBinding. Nilai properti harus URI yang dimulai dengan "http" atau "https".

Kode berikut menunjukkan atribut HelpUri fungsi New-Calendar

function New-Calendar {
    [CmdletBinding(SupportsShouldProcess=$true,
    HelpUri="https://go.microsoft.com/fwlink/?LinkID=01122")]

Menambahkan atribut HelpUri ke perintah cim

Untuk perintah CIM, tambahkan atribut HelpUri ke elemen CmdletMetadata dalam file CDXML. Nilai atribut harus URI yang dimulai dengan http atau https.

Kode berikut menunjukkan atribut HelpUri dari perintah CIM Start-Debug

<CmdletMetadata Verb="Debug" HelpUri="https://go.microsoft.com/fwlink/?LinkID=001122"/>

Menambahkan atribut HelpUri ke alur kerja

Untuk alur kerja yang ditulis dalam bahasa PowerShell, tambahkan kata kunci komentar .EXTERNALHELP ke kode alur kerja. Nilai kata kunci harus URI yang dimulai dengan http atau https.

Nota

Properti HelpUri tidak didukung untuk alur kerja berbasis XAML di PowerShell.

Kode berikut menunjukkan kata kunci .EXTERNALHELP dalam file alur kerja.

# .EXTERNALHELP "https://go.microsoft.com/fwlink/?LinkID=138338"
  • Last updated on