Gambaran umum PlatyPS

PlatyPS adalah alat utama untuk membuat bantuan PowerShell yang ditampilkan menggunakan Get-Help. File bantuan PowerShell ditulis dalam format Microsoft Assistance Markup Language (MAML). MAML mendefinisikan skema XML untuk struktur file bantuan.

Ada dua versi utama PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 adalah versi PlatyPS yang didukung. Versi ini adalah penulisan ulang lengkap di C# yang memanfaatkan markdig untuk mengurai Markdown. Rilis ini mencakup beberapa peningkatan:
  • Memberikan deskripsi yang lebih akurat tentang cmdlet PowerShell dan parameternya
  • Peningkatan performa - memproses 1000 file Markdown dalam hitungan detik
  • Membuat model objek file bantuan yang dapat Anda manipulasi dalam memori
  • Menyediakan cmdlet yang dapat Anda rantai bersama untuk melakukan operasi yang kompleks
  • Menentukan skema Markdown baru yang mencakup semua elemen yang diperlukan untuk Get-Help, ditambah informasi yang sebelumnya tidak tersedia.
  • Berikan konversi otomatis Markdown yang ada (menggunakan skema lama) ke objek baru, memungkinkan Anda untuk mengekspor ke Markdown, YAML, atau MAML baru.
• platyPS v0.14.2 adalah implementasi asli dari PlatyPS. Versi ini tidak lagi didukung.

Manfaat menggunakan PlatyPS

Sebelum PlatyPS, file bantuan ditulis tangan dengan bantuan terbatas dari alat dan editor yang ada. PlatyPS menyederhanakan proses dengan memungkinkan Anda menulis file bantuan di Markdown dan kemudian mengonversinya ke MAML.

Markdown mudah dipelajari, banyak digunakan di komunitas open source, dan didukung oleh banyak editor termasuk Visual Studio Code. Markdown juga mudah dikonversi ke format lain seperti HTML dan PDF. Anda dapat menggunakan file Markdown ini untuk membuat file bantuan MAML dan membuat halaman HTML untuk situs web.

Mulai dengan PlatyPS

Sebelum memulai dengan PlatyPS, Anda harus memahami jenis bantuan yang didukung oleh PowerShell. Untuk informasi selengkapnya, lihat Jenis bantuan di PowerShell.

Membuat file bantuan dengan PlatyPS adalah proses empat langkah:

1. Buat baru atau perbarui file bantuan Markdown yang ada.
2. Edit file bantuan Markdown untuk menambahkan deskripsi dan contoh.
3. Uji file bantuan Markdown untuk memastikannya dirender dengan benar.
4. Konversi dan publikasikan file bantuan.