Přehled PlatyPS

PlatyPS je primárním nástrojem pro vytvoření nápovědy PowerShellu zobrazené pomocí Get-Help. Soubory nápovědy PowerShellu jsou uložené ve formátu XML, který se označuje jako jazyka MAML (Microsoft Assistance Markup Language). Před PlatyPSbyly soubory nápovědy ručně vytvořené pomocí složitých řetězců nástrojů. Markdownu se široce používá v opensourcové komunitě, kterou podporuje mnoho editorů, včetně editoru Visual Studio Code a snadnějšího vytváření. PlatyPS proces zjednodušuje tím, že vám umožní psát soubory nápovědy v Markdownu a poté převedeny na MAML.

Existují dvě hlavní verze PlatyPS.

• platyPS v0.14.2 je aktuální verze PlatyPS, která se používá k vytváření souborů nápovědy PowerShellu ve formátu Markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 je nová verze PlatyPS. Tato verze je kompletní přepsání v jazyce C# s využitím markdigu pro analýzu Markdownu. Tato verze obsahuje několik vylepšení:
  • Poskytuje přesnější popis rutiny PowerShellu a jeho parametrů.
  • Zvýšení výkonu – procesy 1 000 souborů Markdownu v sekundách
  • Vytvoří objektový model souboru nápovědy, se kterým můžete manipulovat v paměti.
  • Poskytuje rutiny, které můžete zřetězit za účelem provádění složitých operací.
  • Definuje nové schéma Markdownu, které obsahuje všechny prvky potřebné pro Get-Helpa informace, které byly dříve nedostupné.
  • Zadejte automatický převod existujícího Markdownu (pomocí starého schématu) na nové objekty, které umožňují exportovat do nového Markdownu, YAML nebo MAML.