PlatyPS'ye genel bakış

PlatyPS, Get-Helpkullanılarak görüntülenen PowerShell yardımını oluşturmaya yönelik birincil araçtır. PowerShell yardım dosyaları Microsoft Yardım Biçimlendirme Dili (MAML) biçiminde yazılır. MAML, yardım dosyalarının yapısı için bir XML şeması tanımlar.

PlatyPS'nin iki ana sürümü vardır.

• Microsoft.PowerShell.PlatyPS v1.0.1, PlatyPS'nin desteklenen sürümüdür. Bu sürüm, Markdown ayrıştırmak için markdig yararlanarak C# dilinde tam bir yeniden yazma işlemidir. Bu sürüm çeşitli iyileştirmeler içerir:
  • PowerShell cmdlet'inin ve parametrelerinin daha doğru bir açıklamasını sağlar
  • Artan performans - saniyeler içinde 1000 sn Markdown dosyasını işler
  • Yardım dosyasının bellekte işleyebileceğiniz bir nesne modeli oluşturur
  • Karmaşık işlemleri gerçekleştirmek için birbirine zincirleyebileceğiniz cmdlet'ler sağlar
  • Get-Helpiçin gereken tüm öğeleri ve daha önce kullanılamayan bilgileri içeren yeni bir Markdown şeması tanımlar.
  • Mevcut Markdown'ın (eski şemayı kullanarak) yeni nesnelere otomatik olarak dönüştürülerek yeni Markdown, YAML veya MAML'ye dışarı aktarmanızı sağlar.
• platyPS v0.14.2, PlatyPS'nin orijinal uygulamasıdır. Bu sürüm artık desteklenmiyor.

PlatyPS kullanmanın faydaları

PlatyPS'den önce, yardım dosyaları mevcut araçlardan ve editörlerden sınırlı yardım alınarak elle yazılmıştı. PlatyPS , yardım dosyalarını Markdown'a yazmanıza ve ardından MAML'ye dönüştürmenize izin vererek süreci basitleştirir.

Markdown'ın öğrenilmesi kolaydır, açık kaynak topluluğunda yaygın olarak kullanılır ve Visual Studio Code dahil birçok düzenleyici tarafından desteklenir. Markdown'ın HTML ve PDF gibi diğer formatlara dönüştürülmesi de kolaydır. Bu Markdown dosyalarını MAML yardım dosyaları oluşturmak ve bir web sitesi için HTML sayfaları oluşturmak için kullanabilirsiniz.

PlatyPS'yi kullanmaya başlayın

PlatyPS'yi kullanmaya başlamadan önce PowerShell tarafından desteklenen yardım türlerini anlamanız gerekir. Daha fazla bilgi için bkz: PowerShell'de yardım türleri.

PlatyPS ile yardım dosyaları oluşturmak dört adımlı bir işlemdir:

1. Yeni Markdown yardım dosyaları oluşturun veya mevcut Markdown yardım dosyalarını güncelleştirin .
2. Açıklamalar ve örnekler eklemek için Markdown yardım dosyalarını düzenleyin.
3. Doğru işlendiklerinden emin olmak için Markdown yardım dosyalarını test edin.
4. Yardım dosyalarını dönüştürün ve yayınlayın .