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 napsané ve formátu MAML (Microsoft Assistance Markup Language ). MAML definuje schéma XML pro strukturu souborů nápovědy.

Existují dvě hlavní verze PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 je podporovaná 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.
• platyPS v0.14.2 je původní implementací PlatyPS. Tato verze již není podporována.

Výhody používání PlatyPS

Před PlatyPSem byly soubory nápovědy psány ručně s omezenou pomocí existujících nástrojů a editorů. PlatyPS tento proces zjednodušuje tím, že vám umožňuje zapisovat soubory nápovědy do Markdown a poté je převést na MAML.

Markdown se snadno učí, široce se používá v open source komunitě a je podporován mnoha editory, včetně Visual Studio Code. Markdown lze také snadno převést do jiných formátů, jako je HTML a PDF. Tyto soubory Markdownu můžete použít k vytvoření souborů nápovědy MAML a k vytvoření stránek HTML pro web.

Začínáme s PlatyPS

Než začnete s PlatyPS, měli byste porozumět typům nápovědy podporované PowerShellem. Další informace najdete v tématu Typy nápovědy v PowerShellu.

Vytváření souborů nápovědy pomocí PlatyPS se skládá ze čtyř kroků:

1. Vytvořte nové nebo aktualizujte stávající soubory nápovědy Markdown.
2. Upravte soubory nápovědy Markdown a přidejte popisy a příklady.
3. Otestujte soubory nápovědy Markdown, abyste se ujistili, že se vykreslují správně.
4. Převeďte a publikujte soubory nápovědy.