Omówienie platformy PlatyPS

PlatyPS to podstawowe narzędzie do tworzenia pomocy programu PowerShell wyświetlanej przy użyciu Get-Help. Pliki pomocy programu PowerShell są przechowywane w formacie XML znanym jako Microsoft Assistance Markup Language (MAML). Przed platyPSpliki pomocy zostały ręcznie utworzone przy użyciu złożonych łańcuchów narzędzi. markdown jest powszechnie używany w społeczności open source, obsługiwane przez wiele edytorów, w tym visual Studio Codei łatwiejsze do tworzenia. PlatyPS upraszcza proces, umożliwiając zapisanie plików pomocy w języku Markdown, a następnie przekonwertowanie na aplikację MAML.

Istnieją dwie główne wersje platformy PlatyPS.

• platyPS v0.14.2 to bieżąca wersja platformy PlatyPS używana do tworzenia plików pomocy programu PowerShell w formacie markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 to nowa wersja platformy PlatyPS. Ta wersja jest kompletnym ponownym zapisywaniem w języku C# przy użyciu markdig na potrzeby analizowania języka Markdown. Ta wersja zawiera kilka ulepszeń:
  • Zawiera dokładniejszy opis polecenia cmdlet programu PowerShell i jego parametrów
  • Zwiększona wydajność — procesy 1000 plików Markdown w sekundach
  • Tworzy model obiektu pliku pomocy, który można manipulować w pamięci
  • Udostępnia polecenia cmdlet, które można połączyć w łańcuch w celu wykonywania złożonych operacji
  • Definiuje nowy schemat języka Markdown zawierający wszystkie elementy potrzebne do Get-Help, oraz informacje, które były wcześniej niedostępne.
  • Zapewnij automatyczną konwersję istniejącego języka Markdown (przy użyciu starego schematu) na nowe obiekty, umożliwiając eksportowanie do nowych języków Markdown, YAML lub MAML.