Vue d’ensemble de PlatyPS

PlatyPS est l’outil principal permettant de créer l’aide PowerShell affichée à l’aide de Get-Help. Les fichiers d’aide PowerShell sont écrits au format MAML ( Microsoft Assistance Markup Language ). MAML définit un schéma XML pour la structure des fichiers d’aide.

Il existe deux versions principales de PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 est la version prise en charge de PlatyPS. Cette version est une réécriture complète en C# utilisant markdig pour analyser Markdown. Cette version comprend plusieurs améliorations :
  • Fournit une description plus précise d’une applet de commande PowerShell et de ses paramètres
  • Amélioration des performances : traite les 1 000 fichiers Markdown en secondes
  • Crée un modèle objet du fichier d’aide que vous pouvez manipuler en mémoire
  • Fournit des applets de commande que vous pouvez chaîner pour effectuer des opérations complexes
  • Définit un nouveau schéma Markdown qui inclut tous les éléments nécessaires pour Get-Help, ainsi que les informations qui étaient précédemment indisponibles.
  • Fournissez une conversion automatique de Markdown existant (à l’aide de l’ancien schéma) vers de nouveaux objets, ce qui vous permet d’exporter vers de nouveaux Markdown, YAML ou MAML.
• platyPS v0.14.2 est l’implémentation originale de PlatyPS. Cette version n’est plus prise en charge.

Avantages de l’utilisation de PlatyPS

Avant PlatyPS, les fichiers d’aide étaient écrits à la main avec l’aide limitée des outils et éditeurs existants. PlatyPS simplifie le processus en vous permettant d’écrire les fichiers d’aide en Markdown, puis de les convertir en MAML.

Markdown est facile à apprendre, largement utilisé dans la communauté open source et pris en charge par de nombreux éditeurs, dont Visual Studio Code. Markdown est également facile à convertir en d’autres formats tels que HTML et PDF. Vous pouvez utiliser ces fichiers Markdown pour créer des fichiers d’aide MAML et des pages HTML pour un site Web.

Démarrer avec PlatyPS

Avant de commencer à utiliser PlatyPS, vous devez comprendre les types d’aide pris en charge par PowerShell. Pour plus d’informations, consultez Types d’aide dans PowerShell.

La création de fichiers d’aide avec PlatyPS se fait en quatre étapes :

1. Créez de nouveaux fichiers d’aide Markdown ou mettez à jour des fichiers d’aide Markdown existants.
2. Modifiez les fichiers d’aide Markdown pour ajouter des descriptions et des exemples.
3. Testez les fichiers d’aide Markdown pour vous assurer qu’ils s’affichent correctement.
4. Convertissez et publiez les fichiers d’aide.