PlatyPS-Übersicht

PlatyPS- ist das primäre Tool zum Erstellen der PowerShell-Hilfe, die mithilfe von Get-Helpangezeigt wird. PowerShell-Hilfedateien sind im MAML-Format ( Microsoft Assistance Markup Language ) geschrieben. MAML definiert ein XML-Schema für die Struktur von Hilfedateien.

Es gibt zwei Hauptversionen von PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 ist die unterstützte Version von PlatyPS. Diese Version ist eine vollständige Neuschreibung in C#, die markdig zum Analysieren von Markdown nutzt. Diese Version enthält mehrere Verbesserungen:
  • Stellt eine genauere Beschreibung eines PowerShell-Cmdlets und seiner Parameter bereit.
  • Erhöhte Leistung – verarbeitet 1000 Markdown-Dateien in Sekunden
  • Erstellt ein Objektmodell der Hilfedatei, die Sie im Arbeitsspeicher bearbeiten können.
  • Stellt Cmdlets bereit, die Sie verketten können, um komplexe Vorgänge auszuführen.
  • Definiert ein neues Markdown-Schema, das alle Elemente enthält, die für Get-Helperforderlich sind, sowie Informationen, die zuvor nicht verfügbar waren.
  • Stellen Sie die automatische Konvertierung vorhandener Markdown -Objekte (mit dem alten Schema) in neue Objekte bereit, sodass Sie in neue Markdown-, YAML- oder MAML-Dateien exportieren können.
• platyPS v0.14.2 ist die ursprüngliche Implementierung von PlatyPS. Diese Version wird nicht mehr unterstützt.

Vorteile der Verwendung von PlatyPS

Vor PlatyPS wurden die Hilfedateien mit begrenzter Hilfe von vorhandenen Tools und Editoren von Hand geschrieben. PlatyPS vereinfacht den Prozess, indem es Ihnen ermöglicht, die Hilfedateien in Markdown zu schreiben und sie dann in MAML zu konvertieren.

Markdown ist leicht zu erlernen, in der Open Source-Community weit verbreitet und wird von vielen Editoren, einschließlich Visual Studio Code, unterstützt. Markdown lässt sich auch leicht in andere Formate wie HTML und PDF konvertieren. Sie können diese Markdowndateien verwenden, um MAML-Hilfedateien und HTML-Seiten für eine Website zu erstellen.

Erste Schritte mit PlatyPS

Bevor Sie mit PlatyPS beginnen, sollten Sie die Arten von Hilfe verstehen, die von PowerShell unterstützt werden. Weitere Informationen finden Sie unter Arten von Hilfe in PowerShell.

Das Erstellen von Hilfedateien mit PlatyPS ist ein vierstufiger Prozess:

1. Erstellen Sie neue Markdown-Hilfedateien, oder aktualisieren Sie vorhandene Markdown-Dateien.
2. Bearbeiten Sie die Markdown-Hilfedateien , um Beschreibungen und Beispiele hinzuzufügen.
3. Testen Sie die Markdown-Hilfedateien , um sicherzustellen, dass sie korrekt gerendert werden.
4. Konvertieren und veröffentlichen Sie die Hilfedateien.