New-MarkdownHelp

Module:: platyPS Module

Crée de l’aide au format Markdown.

Syntaxe

FromModule

New-MarkdownHelp
    -Module <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

FromCommand

New-MarkdownHelp
    -Command <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-OnlineVersionUrl <String>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-ExcludeDontShow]
    [<CommonParameters>]

FromMaml

New-MarkdownHelp
    -MamlFile <String[]>
    -OutputFolder <String>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ModuleName <String>]
    [-ModuleGuid <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

Description

L’applet de commande New-MarkdownHelp crée de l’aide au format Markdown en fonction d’un module, d’une commande ou d’un fichier au format MAML (Microsoft Assistance Markup Language).

Exemples

Exemple 1 : Créer de l’aide à partir d’une commande

PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"


    Directory: D:\Working\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:53 PM            664 Command03.md

La première commande crée une fonction nommée Command03 à l’aide de la syntaxe Windows PowerShell standard.

La deuxième commande crée de l’aide pour cette fonction stub dans le dossier .\docs.

Exemple 2 : Créer de l’aide à partir d’un module

PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force


    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

La première commande charge le module PlatyPS dans la session active à l’aide de l’applet de commande Import-Module.

La deuxième commande crée de l’aide pour toutes les applets de commande du module PlatyPS. Il les stocke dans le dossier .\docs. Cette commande spécifie le paramètre Force . Par conséquent, il remplace les fichiers markdown d’aide existants portant le même nom.

Exemple 3 : Créer de l’aide à partir d’un fichier MAML existant

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'

    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:56 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:56 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM          15320 Set-PSReadLineOption.md

Cette commande crée de l’aide au format Markdown pour le fichier MAML d’aide spécifié. Vous n’avez pas besoin de charger le module, comme dans l’exemple précédent. Si le module est déjà chargé, cette commande crée de l’aide en fonction du fichier MAML, et non sur le module actuellement installé.

Exemple 4 : Créer de l’aide à partir d’un fichier MAML existant à utiliser dans un fichier CAB

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage  -Force -ModuleName "PSReadLine"


    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:59 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:59 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM          15320 Set-PSReadLineOption.md
-a----        5/22/2016   6:59 PM            942 PSReadLine.md

Cette commande crée de l’aide au format Markdown pour le fichier MAML d’aide spécifié, comme dans l’exemple précédent. Cette commande spécifie également le paramètre WithModulePage et le paramètre ModuleName. La commande crée un fichier nommé PSReadLine.md qui contient des liens vers les autres fichiers markdown de ce module et des métadonnées qui peuvent être utilisées pour créer des fichiers .cab.

Paramètres

-AlphabeticParamsOrder

Commandez les paramètres par ordre alphabétique par nom dans la section PARAMETERS. Il existe 5 exceptions : -Confirm, -WhatIf, -IncludeTotalCount, -Skipet les paramètres de -First seront les derniers. Ces paramètres sont courants et ont donc un comportement bien défini.

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

-Command

Spécifie le nom d’une commande dans votre session active. Il peut s’agir de n’importe quelle commande prise en charge par l’aide de PowerShell, telle qu’une applet de commande ou une fonction.

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

FromCommand

Position:	Named
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-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

FromMaml

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.

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

FromMaml

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

-ExcludeDontShow

Excluez les paramètres marqués avec DontShow dans l’attribut de paramètre du contenu d’aide.

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

-Force

Indique que cette applet de commande remplace les fichiers existants qui ont les mêmes noms.

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

-FwLink

Spécifie le lien vers l’avant de la page du module. Cette valeur est requise pour la création de fichiers .cab. Cette valeur est utilisée comme métadonnées d’en-tête Markdown dans la page du module.

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

FromModule

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

FromMaml

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HelpVersion

Spécifie la version de votre aide. Cette valeur est requise pour la création de fichiers .cab. Cette valeur est utilisée comme métadonnées d’en-tête Markdown dans la page du module.

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

FromModule

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

FromMaml

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Locale

Spécifie les paramètres régionaux de votre aide. Cette valeur est requise pour la création de fichiers .cab. Cette valeur est utilisée comme métadonnées d’en-tête Markdown dans la page du module.

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

FromModule

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

FromMaml

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-MamlFile

Spécifie un tableau de chemins d’accès de maML .xml fichiers d’aide.

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

FromMaml

Position:	Named
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Metadata

Spécifie les métadonnées que cette applet de commande inclut dans les fichiers markdown d’aide sous la forme d’une table de hachage de paires clé-valeur string-to-sting. Cette applet de commande écrit les métadonnées dans l’en-tête de chaque fichier d’aide Markdown.

L’applet de commande New-ExternalHelp n’utilise pas ces métadonnées. Les outils externes peuvent utiliser ces métadonnées.

Propriétés du paramètre

Type:	Hashtable
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

-Module

Spécifie un tableau de noms de modules pour lesquels cette applet de commande crée de l’aide au format Markdown.

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

FromModule

Position:	Named
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ModuleGuid

Spécifie le GUID du module de votre aide. Cette valeur est requise pour la création de fichiers .cab. Cette valeur est utilisée comme métadonnées d’en-tête Markdown dans la page du module.

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

FromMaml

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ModuleName

Spécifie le nom du module de votre aide. Cette valeur est requise pour la création de fichiers .cab. Cette valeur est utilisée comme métadonnées d’en-tête Markdown dans la page du module.

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

FromMaml

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ModulePagePath

Quand paramètre WithModule est utilisé par défaut, il place le fichier .md au même emplacement que tous les autres documents. Avec ce paramètre, vous pouvez spécifier un nouveau nom/emplacement fournissant de meilleures options de placement.

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

FromModule

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

FromMaml

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-NoMetadata

Indique que cette applet de commande n’écrit aucune métadonnées dans le markdown généré.

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

-OnlineVersionUrl

Spécifie l’adresse à laquelle la fonction d’aide pouvant être mise à jour télécharge l’aide mise à jour. Si vous ne spécifiez pas de valeur, l’applet de commande utilise une chaîne vide.

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

FromCommand

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-OutputFolder

Spécifie le chemin d’accès du dossier dans lequel cette applet de commande crée les fichiers d’aide markdown.

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

-Session

Fournit la prise en charge des commandes distantes. Passez la session que vous avez utilisée pour créer les commandes avec Import-PSSession. Il est nécessaire d’obtenir des métadonnées de paramètres précises à partir de la session distante.

Propriétés du paramètre

Type:	PSSession
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

FromModule

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

FromCommand

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-UseFullTypeName

Indique que le document cible utilise un nom de type complet au lieu d’un nom court pour les paramètres.

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

-WithModulePage

Indique que cette applet de commande crée une page de module dans le dossier de sortie. Ce fichier porte le nom spécifié par le paramètre ModuleName. Si vous n’avez pas spécifié ce paramètre, l’applet de commande fournit le nom par défaut MamlModule. Vous pouvez remplacer ce paramètre à l’aide de ModulePagePath qui vous permet de définir différents chemins d’accès pour la page du module

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

FromModule

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

FromMaml

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 les noms de module vers cette applet de commande. Il s’agit des modules à partir desquels cette applet de commande crée un markdown d’aide.

Sorties

FileInfo

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

Commentaires

Cette page a-t-elle été utile ?

Partager via

New-MarkdownHelp

Syntaxe

FromModule

FromCommand

FromMaml

Description

Exemples

Exemple 1 : Créer de l’aide à partir d’une commande

Exemple 2 : Créer de l’aide à partir d’un module

Exemple 3 : Créer de l’aide à partir d’un fichier MAML existant

Exemple 4 : Créer de l’aide à partir d’un fichier MAML existant à utiliser dans un fichier CAB

Paramètres

-AlphabeticParamsOrder

Propriétés du paramètre

Jeux de paramètres

-Command

Propriétés du paramètre

Jeux de paramètres

-ConvertDoubleDashLists

Propriétés du paramètre

Jeux de paramètres

-ConvertNotesToList

Propriétés du paramètre

Jeux de paramètres

-Encoding

Propriétés du paramètre

Jeux de paramètres

-ExcludeDontShow

Propriétés du paramètre

Jeux de paramètres

-Force

Propriétés du paramètre

Jeux de paramètres

-FwLink

Propriétés du paramètre

Jeux de paramètres

-HelpVersion

Propriétés du paramètre

Jeux de paramètres

-Locale

Propriétés du paramètre

Jeux de paramètres

-MamlFile

Propriétés du paramètre

Jeux de paramètres

-Metadata

Propriétés du paramètre

Jeux de paramètres

-Module

Propriétés du paramètre

Jeux de paramètres

-ModuleGuid

Propriétés du paramètre

Jeux de paramètres

-ModuleName

Propriétés du paramètre

Jeux de paramètres

-ModulePagePath

Propriétés du paramètre

Jeux de paramètres

-NoMetadata

Propriétés du paramètre

Jeux de paramètres

-OnlineVersionUrl

Propriétés du paramètre

Jeux de paramètres

-OutputFolder

Propriétés du paramètre

Jeux de paramètres

-Session

Propriétés du paramètre

Jeux de paramètres

-UseFullTypeName

Propriétés du paramètre

Jeux de paramètres

-WithModulePage

Propriétés du paramètre

Jeux de paramètres

CommonParameters