Partager via

Update-MarkdownHelpModule

Module:
platyPS Module

Mettez à jour tous les fichiers dans un dossier de module d’aide Markdown.

Syntaxe

Default (Par défaut) 

Update-MarkdownHelpModule
    [-Path] <String[]>
    [[-Encoding] <Encoding>]
    [-RefreshModulePage]
    [-ModulePagePath <String>]
    [[-LogPath] <String>]
    [-LogAppend]
    [-AlphabeticParamsOrder]
    [-UseFullTypeName]
    [-UpdateInputOutput]
    [-Force]
    [-Session <PSSession>]
    [-ExcludeDontShow]
    [<CommonParameters>]

Description

L’applet de commande Update-MarkdownHelpModule met à jour les fichiers markdown d’aide existants et crée des fichiers Markdown pour les nouvelles applets de commande dans un module. Cette applet de commande combine les fonctionnalités des Update-MarkdownHelp et applets de commande New-MarkdownHelp pour effectuer une mise à jour en bloc.

Exemples

Exemple 1 : Mettre à jour un module d’aide Markdown

PS C:\> Update-MarkdownHelpModule -Path ".\docs"

    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

Cette commande met à jour tous les fichiers du dossier spécifié en fonction des applets de commande chargées dans votre session active. La commande crée des rubriques d’aide markdown pour toutes les applets de commande qui ne sont pas déjà incluses dans le dossier .\docs.

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

-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:1
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

Supprimez les fichiers d’aide qui n’existent plus dans les sessions (par exemple, si la fonction a été supprimée).

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

-LogAppend

Indique que cette applet de commande ajoute des informations au journal au lieu de l’écraser.

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

-LogPath

Spécifie un chemin d’accès de fichier pour les informations de journal. L’applet de commande écrit le flux VERBOSE dans le journal. Si vous spécifiez le paramètre Verbose, cette applet de commande écrit également ces informations dans la console.

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:2
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ModulePagePath

Lorsque -RefreshModulePage 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

(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 dossiers Markdown à mettre à jour. Le dossier doit contenir une page de module à partir de laquelle cette applet de commande peut obtenir le nom du module.

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:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RefreshModulePage

Mettre à jour la page du module lors de la mise à jour du module 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

-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

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

-UpdateInputOutput

Actualise les sections Entrée et Sortie pour refléter l’état actuel de l’applet de commande. AVERTISSEMENT : ce paramètre supprime les ajouts manuels à ces sections.

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

-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

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 mis à jour et nouveaux.

Notes

Le module pour lequel vous souhaitez mettre à jour l’aide doit d’abord être importé à partir de l’emplacement contenant la version précédente de l’aide. Si cette condition n’est pas remplie, l’ordre des paramètres est alphabétique dans l’aide mise à jour, même si le paramètre AlphabeticParamsOrder n’a pas été utilisé.