Panoramica di PlatyPS

platyPS è lo strumento principale per la creazione della Guida di PowerShell visualizzata usando Get-Help. I file della Guida di PowerShell sono scritti in formato MAML ( Microsoft Assistance Markup Language ). MAML definisce uno schema XML per la struttura dei file della Guida.

Esistono due versioni principali di PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 è la versione supportata di PlatyPS. Questa versione è una riscrittura completa in C# sfruttando markdig per l'analisi di Markdown. Questa versione include diversi miglioramenti:
  • Fornisce una descrizione più accurata di un cmdlet di PowerShell e dei relativi parametri
  • Miglioramento delle prestazioni: processi 1000 di file Markdown in secondi
  • Crea un modello a oggetti del file della Guida che è possibile modificare in memoria
  • Fornisce cmdlet che è possibile concatenare per eseguire operazioni complesse
  • Definisce un nuovo schema Markdown che include tutti gli elementi necessari per Get-Help, oltre a informazioni precedentemente non disponibili.
  • Fornire la conversione automatica di Markdown esistente (usando lo schema precedente) in nuovi oggetti, consentendo di esportare in un nuovo markdown, YAML o MAML.
• platyPS v0.14.2 è l'implementazione originale di PlatyPS. Questa versione non è più supportata.

Vantaggi dell'utilizzo di PlatyPS

Prima di PlatyPS, i file di aiuto erano scritti a mano con l'aiuto limitato degli strumenti e degli editor esistenti. PlatyPS semplifica il processo consentendo di scrivere i file della guida in Markdown e quindi convertirli in MAML.

Markdown è facile da imparare, ampiamente utilizzato nella comunità open source e supportato da molti editor tra cui Visual Studio Code. Markdown è anche facile da convertire in altri formati come HTML e PDF. È possibile utilizzare questi file Markdown per creare file di aiuto MAML e per creare pagine HTML per un sito Web.

Inizia con PlatyPS

Prima di iniziare a usare PlatyPS, è necessario comprendere i tipi di assistenza supportati da PowerShell. Per altre informazioni, vedere Tipi di Guida in PowerShell.

La creazione di file di aiuto con PlatyPS è un processo in quattro fasi:

1. Crea nuovi file della Guida Markdown o aggiorna quelli esistenti .
2. Modifica i file della guida Markdown per aggiungere descrizioni ed esempi.
3. Testare i file della Guida Markdown per assicurarsi che vengano visualizzati correttamente.
4. Converti e pubblica i file della guida.