New-ExternalHelp
Crée un fichier d’aide externe basé sur Markdown pris en charge par PlatyPS.
Syntaxe
Default (Par défaut)
New-ExternalHelp
-Path <String[]>
-OutputPath <String>
[-ApplicableTag <String[]>]
[-Encoding <Encoding>]
[-MaxAboutWidth <Int32>]
[-ErrorLogFile <String>]
[-Force]
[-ShowProgress]
[<CommonParameters>]
Description
L’applet de commande New-ExternalHelp crée un fichier d’aide externe basé sur les fichiers d’aide Markdown pris en charge par PlatyPS. Vous pouvez l’envoyer avec un module pour fournir de l’aide à l’aide de l’applet de commande Get-Help.
Si les fichiers markdown que vous spécifiez ne suivent pas l'de 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 meilleure pratique que le nom de 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 Forcer, par conséquent, il 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 meilleure pratique que le nom de 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 de balises à utiliser comme filtre. Si l’applet de commande a applicable dans les métadonnées yaml et qu’aucune des balises passées n’est mentionnée, l’applet de commande est ignorée dans l’aide générée. La même chose s’applique au niveau paramètre applicable métadonnées yaml. 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.
Propriétés du paramètre
| Type: | String[] |
| 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 |
-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.
Propriétés du paramètre
| Type: | Encoding |
| Valeur par défaut: | UTF8 without BOM |
| 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 |
-ErrorLogFile
Chemin d’accès où cette applet de commande enregistre 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 de fichier avec l’extension json. L’objet JSON contient trois propriétés : Message, filePathet de gravité (avertissement ou erreur).
Si ce chemin n’est pas fourni, aucun journal n’est généré.
Propriétés du paramètre
| Type: | String |
| 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 |
-Force
Indique que cette applet de commande remplace un fichier existant portant le même nom.
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 |
-MaxAboutWidth
Spécifie la longueur maximale de ligne lors de la génération de fichiers texte d’aide « about ». 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
Propriétés du paramètre
| Type: | Int32 |
| Valeur par défaut: | 80 |
| 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 |
-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\.
Propriétés du paramètre
| Type: | String |
| 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: | True |
| 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 de fichiers ou de dossiers Markdown. Cette applet de commande crée une aide externe basée sur ces fichiers et dossiers.
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é: | True |
| Valeur des arguments restants: | False |
-ShowProgress
Affichez les barres de progression sous l’analyse des fichiers Markdown existants.
Si cela est utilisé, la génération d’aide est beaucoup plus lente.
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 |
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
FileInfo
Cette applet de commande retourne un objet FileInfo[] pour les fichiers créés.
