Get-HelpPreview

Référence

Module:: platyPS

Affiche votre aide externe générée en tant que Get-Help sortie.

Syntax

Get-HelpPreview
   -Path <String[]>
   [-ConvertNotesToList]
   [-ConvertDoubleDashLists]
   [<CommonParameters>]

Description

L’applet Get-HelpPreview de commande affiche votre aide externe générée en tant que Get-Help sortie. Spécifiez un ou plusieurs fichiers au format MAML (Microsoft Assistance Markup Language).

Exemples

Exemple 1 : Aperçu de l’aide de 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 dans $Help.

Paramètres

-ConvertDoubleDashLists

Indique que cette applet de commande convertit les puces de liste à double trait d’union en puces à trait d’union unique. Les listes de doubles traits d’union sont courantes dans Windows PowerShell documentation. Markdown accepte les traits d’union simples pour les listes.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Spécifie un tableau de chemins d’accès de fichiers d’aide externes MAML.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

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.

Partager via