Overzicht van PlatyPS

PlatyPS- is het primaire hulpprogramma voor het maken van de PowerShell-help die wordt weergegeven met behulp van Get-Help. Help-bestanden van PowerShell worden opgeslagen in een XML-indeling die bekend staat als Microsoft Assistance Markup Language (MAML). Voorafgaand aan PlatyPS-, zijn de Help-bestanden met behulp van complexe toolketens gemaakt. Markdown- wordt veel gebruikt in de opensource-community, ondersteund door veel editors, waaronder Visual Studio Codeen eenvoudiger te ontwerpen. PlatyPS- vereenvoudigt het proces doordat u de Help-bestanden in Markdown kunt schrijven en vervolgens kunt converteren naar MAML.

Er zijn twee primaire versies van PlatyPS.

• platyPS v0.14.2 is de huidige versie van PlatyPS die wordt gebruikt voor het maken van PowerShell Help-bestanden in Markdown-indeling.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 is de nieuwe versie van PlatyPS. Deze versie is een volledig herschrijven in C# die gebruikmaakt van markdig- voor het parseren van Markdown. Deze release bevat verschillende verbeteringen:
  • Biedt een nauwkeurigere beschrijving van een PowerShell-cmdlet en de bijbehorende parameters
  • Verbeterde prestaties - verwerkt 1000 markdown-bestanden in seconden
  • Hiermee maakt u een objectmodel van het Help-bestand dat u in het geheugen kunt bewerken
  • Biedt cmdlets die u aan elkaar kunt koppelen om complexe bewerkingen uit te voeren
  • Definieert een nieuw Markdown-schema dat alle elementen bevat die nodig zijn voor Get-Help, plus informatie die eerder niet beschikbaar was.
  • Automatische conversie van bestaande Markdown (met behulp van het oude schema) naar nieuwe objecten, zodat u kunt exporteren naar nieuwe Markdown, YAML of MAML.