Översikt över PlatyPS

PlatyPS är det primära verktyget för att skapa PowerShell-hjälpen som visas med hjälp av Get-Help. PowerShell-hjälpfiler lagras i ett XML-format som kallas Microsoft Assistance Markup Language (MAML). Innan PlatyPSskapades hjälpfilerna för hand med hjälp av komplexa verktygskedjor. Markdown- används ofta i communityn med öppen källkod, som stöds av många redigerare, inklusive Visual Studio Codeoch enklare att skapa. PlatyPS förenklar processen genom att låta dig skriva hjälpfilerna i Markdown och sedan konverteras till MAML.

Det finns två huvudversioner av PlatyPS.

• platyPS v0.14.2 är den aktuella versionen av PlatyPS som används för att skapa PowerShell-hjälpfiler i Markdown-format.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 är den nya versionen av PlatyPS. Den här versionen är en fullständig omskrivning i C# som utnyttjar markdig- för parsning av Markdown. Den här versionen innehåller flera förbättringar:
  • Ger en mer exakt beskrivning av en PowerShell-cmdlet och dess parametrar
  • Ökad prestanda – bearbetar 1 000-talets Markdown-filer på några sekunder
  • Skapar en objektmodell av hjälpfilen som du kan ändra i minnet
  • Tillhandahåller cmdletar som du kan länka samman för att utföra komplexa åtgärder
  • Definierar ett nytt Markdown-schema som innehåller alla element som behövs för Get-Helpplus information som tidigare inte var tillgänglig.
  • Ange automatisk konvertering av befintlig Markdown (med det gamla schemat) till nya objekt, så att du kan exportera till nya Markdown, YAML eller MAML.