Vue d’ensemble de l’aide actualisable

Ce document fournit une présentation de base de la conception et de l’opération de la fonctionnalité d’aide pouvant être mise à jour PowerShell. Il est conçu pour les auteurs de modules et d’autres personnes qui fournissent des rubriques d’aide Windows PowerShell aux utilisateurs.

Présentation

Les rubriques d’aide PowerShell font partie intégrante de l’expérience PowerShell. Comme les modules PowerShell, les rubriques d’aide sont continuellement mises à jour et améliorées par les auteurs et par les contributions de la communauté des utilisateurs PowerShell.

La fonctionnalité d’aide mise à jour, introduite dans Windows PowerShell 3.0, garantit que les utilisateurs disposent des dernières versions des rubriques d’aide à l’invite de commandes, même pour les commandes PowerShell intégrées, sans télécharger de nouveaux modules ou exécuter Windows Update. L’aide pouvant être mise à jour facilite la mise à jour en fournissant des applets de commande qui téléchargent les dernières versions des rubriques d’aide à partir d’Internet et les installent dans les sous-répertoires appropriés sur l’ordinateur local de l’utilisateur. Même les utilisateurs qui sont derrière des pare-feu peuvent utiliser les nouvelles applets de commande pour obtenir de l’aide mise à jour à partir d’un partage de fichiers interne.

L’aide pouvant être mise à jour est entièrement prise en charge par tous les modules Windows PowerShell dans Windows 8 et Windows Server 2012, et ses fonctionnalités sont disponibles pour tous les auteurs de modules Windows PowerShell. L’aide pouvant être mise à jour prend uniquement en charge les fichiers d’aide XML. Elle ne prend pas en charge l’aide basée sur les commentaires.

L’aide pouvant être mise à jour inclut les fonctionnalités suivantes.

• L’applet de commande Update-Help, qui détermine si les utilisateurs ont les fichiers d’aide les plus récents pour un module et, si ce n’est pas le cas, télécharge les fichiers d’aide les plus récents à partir d’Internet, les décompresse et les installe dans les sous-répertoires de module appropriés sur l’ordinateur de l’utilisateur. Les utilisateurs peuvent utiliser l’applet de commande Get-Help pour afficher immédiatement les rubriques d’aide nouvellement installées. Ils n’ont pas besoin de redémarrer PowerShell.

• L’applet de commande Save-Help, qui télécharge les fichiers d’aide les plus récents à partir d’Internet et les enregistre dans un répertoire de système de fichiers. Les utilisateurs peuvent utiliser l’applet de commande Update-Help pour obtenir des fichiers d’aide à partir du répertoire du système de fichiers, puis les décompresser et les installer dans les sous-répertoires du module sur l’ordinateur de l’utilisateur. L’applet de commande Save-Help est conçue pour les utilisateurs qui n’ont pas d’accès Internet limité ou inexistant et pour les entreprises qui préfèrent limiter l’accès à Internet.

• aide pour un module. Les fichiers d’aide d’un module sont gérés et remis en tant qu’unité, afin que les utilisateurs puissent obtenir tous les fichiers d’aide pour les modules qu’ils utilisent. L’aide pouvant être mise à jour est prise en charge uniquement pour les modules, et non pour les composants logiciels enfichables Windows PowerShell.

• prise en charge de la version. L’aide pouvant être mise à jour utilise quatre positions standard (N1. N2. N3. Numéros de version N4). L’aide pouvant être mise à jour télécharge les fichiers d’aide lorsque le numéro de version des fichiers d’aide sur l’ordinateur de l’utilisateur (ou dans le répertoire Save-Help) est inférieur au numéro de version des fichiers d’aide à l’emplacement Internet.

• prise en charge multi language. L’aide pouvant être mise à jour prend en charge les fichiers d’aide de module dans plusieurs cultures d’interface utilisateur. Les noms de fichiers d’aide pouvant être mis à jour incluent des codes de langue standard, tels que «en-US» et «ja-JP», et les applets de commande Update-Help et Save-Help placent les fichiers d’aide dans des sous-répertoires propres à la langue du répertoire de module.

• aide générée automatiquement. L’applet de commande Get-Help affiche l’aide de base pour les commandes qui n’ont pas de fichiers d’aide. L’aide générée automatiquement inclut la syntaxe de commande et les alias, ainsi que les instructions d’utilisation de l’aide en ligne et de l’aide pouvant être mise à jour.

• aide améliorée en ligne. L’accès facile à l’aide en ligne n’a plus besoin de fichiers d’aide. Le paramètre Online de l’applet de commande Get-Help obtient désormais l’URL d’une rubrique d’aide en ligne à partir de la valeur de la propriété HelpUri d’une commande, si elle ne trouve pas l’URL d’aide en ligne dans un fichier d’aide. Vous pouvez remplir la propriété HelpUri en ajoutant un attribut HelpUri au code des applets de commande, des fonctions et des commandes CIM, ou en utilisant le mot clé d’aide basé sur les commentaires .LINK dans les workflows et les scripts.

  Pour rendre nos fichiers d’aide pouvant être mis à jour, les modules Windows PowerShell dans Windows ne sont pas fournis avec des fichiers d’aide. Les utilisateurs peuvent utiliser l’aide pouvant être mise à jour pour installer des fichiers d’aide et les mettre à jour. Les auteurs d’autres modules peuvent inclure des fichiers d’aide dans des modules ou les omettre. La prise en charge de l’aide pouvant être mise à jour est facultative, mais recommandée.