Ö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 är skrivna i MAML-format ( Microsoft Assistance Markup Language ). MAML definierar ett XML-schema för strukturen för hjälpfiler.

Det finns två huvudversioner av PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 är den version av PlatyPS som stöds. 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.
• platyPS v0.14.2 är den ursprungliga implementeringen av PlatyPS. Den här versionen stöds inte längre.

Fördelar med att använda PlatyPS

Före PlatyPS, var hjälpfilerna handskrivna med begränsad hjälp från befintliga verktyg och redigerare. PlatyPS förenklar processen genom att du kan skriva hjälpfilerna i Markdown och sedan konvertera dem till MAML.

Markdown är lätt att lära sig, används ofta i communityn för öppen källkod och stöds av många redigerare, inklusive Visual Studio Code. Markdown är också lätt att konvertera till andra format som HTML och PDF. Du kan använda dessa Markdown-filer för att skapa MAML-hjälpfiler och för att skapa HTML-sidor för en webbplats.

Kom igång med PlatyPS

Innan du börjar med PlatyPS bör du förstå vilka typer av hjälp som stöds av PowerShell. Mer information finns i Typer av hjälp i PowerShell.

Att skapa hjälpfiler med PlatyPS är en process i fyra steg:

1. Skapa nya eller uppdatera befintliga Markdown-hjälpfiler.
2. Redigera Markdown-hjälpfilerna för att lägga till beskrivningar och exempel.
3. Testa Markdown-hjälpfilerna för att se till att de återges korrekt.
4. Konvertera och publicera hjälpfilerna.