Partager via

New-ExternalHelp

  • Référence
Module:
platyPS

Crée un fichier d’aide externe basé sur markdown pris en charge par PlatyPS.

Syntax

New-ExternalHelp
   -Path <String[]>
   -OutputPath <String>
   [-ApplicableTag <String[]>]
   [-Encoding <Encoding>]
   [-MaxAboutWidth <Int32>]
   [-ErrorLogFile <String>]
   [-Force]
   [-ShowProgress]
   [<CommonParameters>]

Description

L’applet New-ExternalHelp de commande crée un fichier d’aide externe basé sur les fichiers d’aide markdown pris en charge par PlatyPS. Vous pouvez l’expédier avec un module pour fournir de l’aide à l’aide de l’applet de Get-Help commande.

Si les fichiers markdown que vous spécifiez ne suivent pas le schéma PlatyPS, cette applet de commande retourne des messages d’erreur.

Exemples

Exemple 1 : Créer une aide externe basée sur le contenu d’un dossier

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US"

    Directory: D:\Working\PlatyPS\out\platyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/19/2016  12:32 PM          46776 platyPS-help.xml

Cette commande crée un fichier d’aide externe à l’emplacement spécifié. Cette commande utilise la bonne pratique selon laquelle le nom du dossier inclut les paramètres régionaux.

Exemple 2 : Créer de l’aide qui utilise l’encodage personnalisé

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\PlatyPS\en-US" -Force -Encoding ([System.Text.Encoding]::Unicode)


    Directory: D:\Working\PlatyPS\out\PlatyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:34 PM         132942 platyPS-help.xml

Cette commande crée un fichier d’aide externe à l’emplacement spécifié. Cette commande spécifie le paramètre Force . Par conséquent, elle remplace un fichier existant. La commande spécifie l’encodage Unicode pour le fichier créé.

Exemple 3 : Écrire des avertissements et des erreurs dans un fichier

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US" -ErrorLogFile ".\WarningsAndErrors.json"

    Directory: D:\Working\PlatyPS\out\platyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/19/2016  12:32 PM          46776 platyPS-help.xml

Cette commande crée un fichier d’aide externe à l’emplacement spécifié. Cette commande utilise la bonne pratique selon laquelle le nom du dossier inclut les paramètres régionaux. Cette commande écrit les avertissements et les erreurs dans le fichier WarningsAndErrors.json.

Paramètres

-ApplicableTag

Spécifiez un tableau d’étiquettes à utiliser comme filtre. Si l’applet de commande contient applicable les métadonnées yaml et qu’aucune des balises passées n’y est mentionnée, l’applet de commande est ignorée dans l’aide générée. Il en va de même pour les métadonnées yaml au niveau applicable du paramètre. Si applicable est omis, l’applet de commande ou le paramètre est toujours présent. Pour plus d’informations, consultez Problème de conception .

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

-Encoding

Spécifie l’encodage de caractères pour votre fichier d’aide externe. Spécifiez un objet System.Text.Encoding . Pour plus d’informations, consultez about_Character_Encoding.

Type:Encoding
Position:Named
Default value:UTF8 without BOM
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorLogFile

Chemin d’accès où cette applet de commande enregistrera le fichier journal des résultats mis en forme.

Le chemin d’accès doit inclure l’emplacement et le nom du dossier et du nom du fichier avec l’extension json. L’objet JSON contient trois propriétés : Message, FilePath et Severity (Avertissement ou Erreur).

Si ce chemin n’est pas fourni, aucun journal n’est généré.

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

-Force

Indique que cette applet de commande remplace un fichier existant portant le même nom.

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

-MaxAboutWidth

Spécifie la longueur maximale de ligne lors de la génération de fichiers texte d’aide « à propos ». Les autres types de fichiers d’aide ne sont pas affectés par ce paramètre. Pour plus d’informations, consultez New-MarkdownAboutHelp.

Les lignes à l’intérieur des blocs de code ne sont pas encapsulées et ne sont pas affectées par le paramètre MaxAboutWidth .

Type:Int32
Position:Named
Default value:80
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputPath

Spécifie le chemin d’accès d’un dossier dans lequel cette applet de commande enregistre votre fichier d’aide externe. Le nom du dossier doit se terminer par un dossier de paramètres régionaux, comme dans l’exemple suivant : .\out\PlatyPS\en-US\.

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

-Path

Spécifie un tableau de chemins d’accès de fichiers ou dossiers markdown. Cette applet de commande crée une aide externe basée sur ces fichiers et dossiers.

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

-ShowProgress

Affichez les barres de progression sous l’analyse des fichiers markdown existants.

Si cela est utilisé, générer de l’aide est beaucoup plus lent.

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

Entrées

String[]

Vous pouvez diriger un tableau de chemins vers cette applet de commande.

Sorties

FileInfo[]

Cette applet de commande retourne un FileInfo[] objet pour les fichiers créés.