Ringkasan Bantuan yang Dapat Diperbarui

Dokumen ini menyediakan pengenalan dasar tentang desain dan pengoperasian fitur Bantuan PowerShell yang Dapat Diperbarui. Ini dirancang untuk penulis modul dan orang lain yang memberikan topik bantuan Windows PowerShell kepada pengguna.

Pendahuluan

Topik bantuan PowerShell adalah bagian integral dari pengalaman PowerShell. Seperti modul PowerShell, topik bantuan terus diperbarui dan ditingkatkan oleh penulis dan oleh kontribusi komunitas pengguna PowerShell.

Fitur Bantuan yang Dapat Diperbarui, yang diperkenalkan di Windows PowerShell 3.0, memastikan bahwa pengguna memiliki versi terbaru topik bantuan pada prompt perintah, bahkan untuk perintah PowerShell bawaan, tanpa mengunduh modul baru atau menjalankan Windows Update. Bantuan yang dapat diperbarui mempermudah pembaruan dengan menyediakan cmdlet yang mengunduh versi terbaru topik bantuan dari internet dan menginstalnya di subdirektori yang benar di komputer lokal pengguna. Bahkan pengguna yang berada di belakang firewall dapat menggunakan cmdlet baru untuk mendapatkan bantuan yang diperbarui dari berbagi file internal.

Bantuan yang Dapat Diperbarui didukung sepenuhnya oleh semua modul Windows PowerShell di Windows 8 dan Windows Server 2012, dan fiturnya tersedia untuk semua penulis modul Windows PowerShell. Bantuan yang Dapat Diperbarui hanya mendukung file bantuan berbasis XML. Ini tidak mendukung bantuan berbasis komentar.

Bantuan yang Dapat Diperbarui mencakup fitur berikut.

• cmdlet Update-Help, yang menentukan apakah pengguna memiliki file bantuan terbaru untuk modul dan, jika tidak, mengunduh file bantuan terbaru dari internet, membongkarnya, dan menginstalnya di subdirektori modul yang benar di komputer pengguna. Pengguna dapat menggunakan cmdlet Get-Help untuk melihat topik bantuan yang baru diinstal segera. Mereka tidak perlu menghidupkan ulang PowerShell.

• cmdlet Save-Help, yang mengunduh file bantuan terbaru dari internet dan menyimpannya dalam direktori sistem file. Pengguna dapat menggunakan cmdlet Update-Help untuk mendapatkan file bantuan dari direktori sistem file, dan membongkar dan menginstalnya di subdirektori modul di komputer pengguna. cmdlet Save-Help dirancang untuk pengguna yang memiliki akses internet terbatas atau tidak ada dan untuk perusahaan yang lebih suka membatasi akses internet.

• Bantuan untuk modul. File bantuan untuk modul dikelola dan dikirimkan sebagai unit, sehingga pengguna bisa mendapatkan semua file bantuan untuk modul yang mereka gunakan. Bantuan yang dapat diperbarui hanya didukung untuk modul, bukan untuk snap-in Windows PowerShell.

• Dukungan versi. Bantuan yang dapat diperbarui menggunakan posisi empat standar (N1. N2. N3. N4) nomor versi. Bantuan yang Dapat Diperbarui mengunduh file bantuan ketika nomor versi file bantuan di komputer pengguna (atau di direktori Save-Help) lebih rendah dari nomor versi file bantuan di lokasi internet.

• Dukungan multi-bahasa. Bantuan yang Dapat Diperbarui mendukung file bantuan modul dalam beberapa budaya UI. Nama file Bantuan yang dapat diperbarui mencakup kode bahasa standar, seperti "en-US" dan "ja-JP", dan cmdlet Update-Help dan Save-Help menempatkan file bantuan ke dalam subdirektori khusus bahasa direktori modul.

• bantuan yang dihasilkan secara otomatis. Cmdlet Get-Help menampilkan bantuan dasar untuk perintah yang tidak memiliki file bantuan. Bantuan yang dihasilkan secara otomatis mencakup sintaks perintah dan alias, dan instruksi untuk menggunakan bantuan online dan Bantuan yang Dapat Diperbarui.

• bantuan Online yang Ditingkatkan. Akses mudah ke bantuan online tidak lagi memerlukan file bantuan. Parameter Online cmdlet Get-Help sekarang mendapatkan URL topik bantuan online dari nilai HelpUri properti perintah apa pun, jika tidak dapat menemukan URL bantuan online dalam file bantuan. Anda dapat mengisi properti HelpUri dengan menambahkan atribut HelpUri ke kode cmdlet, fungsi, dan perintah CIM, atau menggunakan kata kunci bantuan berbasis komentar .LINK dalam alur kerja dan skrip.

  Untuk membuat file bantuan kami dapat diperbarui, modul Windows PowerShell di Windows tidak dilengkapi dengan file bantuan. Pengguna dapat menggunakan Bantuan yang Dapat Diperbarui untuk menginstal file bantuan dan memperbaruinya. Penulis modul lain dapat menyertakan file bantuan dalam modul atau menghilangkannya. Dukungan untuk Bantuan yang Dapat Diperbarui bersifat opsional, tetapi disarankan.