Overzicht van PlatyPS

PlatyPS- is het primaire hulpprogramma voor het maken van de PowerShell-help die wordt weergegeven met behulp van Get-Help. PowerShell-helpbestanden worden geschreven in de MAML-indeling ( Microsoft Assistance Markup Language ). MAML definieert een XML-schema voor de structuur van helpbestanden.

Er zijn twee primaire versies van PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 is de ondersteunde 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.
• platyPS v0.14.2 is de oorspronkelijke implementatie van PlatyPS. Deze versie wordt niet meer ondersteund.

Voordelen van het gebruik van PlatyPS

Voorafgaand aan PlatyPS, werden de helpbestanden met de hand geschreven met beperkte hulp van bestaande tools en editors. PlatyPS vereenvoudigt het proces door u in staat te stellen de helpbestanden in Markdown te schrijven en deze vervolgens naar MAML te converteren.

Markdown is gemakkelijk te leren, wordt veel gebruikt in de open source-gemeenschap en wordt ondersteund door veel editors, waaronder Visual Studio Code. Markdown is ook eenvoudig te converteren naar andere formaten zoals HTML en PDF. U kunt deze Markdown-bestanden gebruiken om MAML-helpbestanden te maken en HTML-pagina's voor een website te maken.

Aan de slag met PlatyPS

Voordat u aan de slag gaat met PlatyPS, moet u de soorten hulp begrijpen die door PowerShell worden ondersteund. Zie Typen hulp in PowerShell voor meer informatie.

Het maken van hulpbestanden met PlatyPS is een proces in vier stappen:

1. Maak nieuwe Help-bestanden met Markdown of werk bestaande bij.
2. Bewerk de Markdown-helpbestanden om beschrijvingen en voorbeelden toe te voegen.
3. Test de Markdown-helpbestanden om er zeker van te zijn dat ze correct worden weergegeven.
4. Converteer en publiceer de helpbestanden.