Update-MarkdownHelp

Référence

Module:: platyPS

Mettre à jour les fichiers d’aide Markdown De PlatyPS.

Syntax

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

Description

L’applet Update-MarkdownHelp de commande met à jour les fichiers d’aide Markdown PlatyPS sans remplacer complètement le contenu des fichiers.

Certains attributs de paramètre changent au fil du temps. Pour instance, jeux de paramètres, types, valeur par défaut et obligatoire. Cette applet de commande met à jour l’aide markdown pour refléter ces modifications. Il ajoute également du texte d’espace réservé au fichier markdown pour tout nouveau paramètre.

Pour propager les modifications à vos fichiers d’aide Markdown, procédez comme suit :

Chargez la nouvelle version du module dans votre session Windows PowerShell.
Exécutez l’applet Update-MarkdownHelp de commande pour mettre à jour les fichiers.
Vérifiez les métadonnées des nouveaux paramètres dans les fichiers markdown.

Exemples

Exemple 1 : Mettre à jour tous les fichiers d’un dossier

PS C:\> Update-MarkdownHelp -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 d’aide markdown dans le chemin spécifié pour qu’ils correspondent aux applets de commande actuelles.

Exemple 2 : Mettre à jour un fichier et capturer le journal

PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"

    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   8:20 PM           9993 New-MarkdownHelp.md

Cette commande met à jour un fichier d’aide Markdown. Il écrit les informations de journal dans le markdown.log fichier.

Paramètres

-AlphabeticParamsOrder

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

Type:	SwitchParameter
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:	1
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeDontShow

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

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

-Force

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

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

-LogAppend

Indique que cette applet de commande ajoute des informations au journal au lieu de le remplacer.

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

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

-Path

Spécifie un tableau de chemins de fichiers et de dossiers Markdown à mettre à jour.

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

-Session

Prend en charge les commandes à distance. Passez la session que vous avez utilisée pour créer les commandes avec Import-PSSession. Cela est nécessaire pour obtenir des métadonnées de paramètres précis à partir de la session à distance.

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

-UpdateInputOutput

Actualise la section 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.

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

-UseFullTypeName

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

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 objet FileInfo[] pour les fichiers mis à jour.

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é.

Partager via