Get-HelpPreview
Affiche votre aide externe générée en tant que sortie Get-Help.
Syntaxe
Default (Par défaut)
Get-HelpPreview
-Path <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
Description
L’applet de commande Get-HelpPreview affiche votre aide externe générée en tant que sortie Get-Help.
Spécifiez un ou plusieurs fichiers au format MAML (Microsoft Assistance Markup Language).
Exemples
Exemple 1 : Aperçu de l’aide platyPS
PS C:\> $Help = Get-HelpPreview -Path ".\out\platyPS\en-US\PlatyPS-help.xml"
PS C:\> $Help.Name
Get-HelpPreview
Get-MarkdownMetadata
New-ExternalHelp
New-ExternalHelpCab
New-MarkdownHelp
Update-MarkdownHelp
Update-MarkdownHelpModule
Update-MarkdownHelpSchema
La première commande crée un objet Help pour le fichier MAML spécifié. La commande la stocke dans la variable $Help.
La deuxième commande affiche la propriété Name pour chacun des objets de $Help.
Paramètres
-ConvertDoubleDashLists
Indique que cette applet de commande convertit les puces de liste de traits d’union doubles en puces à trait d’union unique. Les listes de traits d’union doubles sont courantes dans la documentation Windows PowerShell. Markdown accepte des traits d’union uniques pour les listes.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ConvertNotesToList
Indique que cette applet de commande met en forme plusieurs éléments de paragraphe dans la section NOTES en tant qu’éléments de liste uniques. Cette sortie suit la mise en forme TechNet.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Path
Spécifie un tableau de chemins d’accès des fichiers d’aide externes MAML.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
String
Vous pouvez diriger un tableau de chemins vers cette applet de commande.
Sorties
Help Object
Cette applet de commande retourne un objet Help, qui est la même sortie que Get-Help.
