Update-MarkdownHelpModule

Referenz

Modul:: platyPS

Aktualisieren Sie alle Dateien in einem Markdown-Hilfemodulordner.

Syntax

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

Beschreibung

Das Update-MarkdownHelpModule Cmdlet aktualisiert vorhandene Hilfemarkdowndateien und erstellt Markdowndateien für neue Cmdlets in einem Modul. Dieses Cmdlet kombiniert die Funktionen der Cmdlets Update-MarkdownHelp und New-MarkdownHelp , um ein Massenupdate durchzuführen.

Beispiele

Beispiel 1: Aktualisieren eines Markdownhilfemoduls

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

Dieser Befehl aktualisiert alle Dateien im angegebenen Ordner basierend auf den Cmdlets, die in Ihre aktuelle Sitzung geladen werden. Der Befehl erstellt Markdown-Hilfethemen für alle Cmdlets, die noch nicht im Ordner .\docs enthalten sind.

Parameter

-AlphabeticParamsOrder

Ordnen Sie Parameter alphabetisch nach Name im Abschnitt PARAMETERS an. Es gibt fünf Ausnahmen: -ConfirmDie Parameter , -WhatIf, -IncludeTotalCount, -Skipund -First sind die letzten. Diese Parameter sind üblich und weisen daher ein klar definiertes Verhalten auf.

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

-Encoding

Gibt die Zeichencodierung für Ihre externe Hilfedatei an. Geben Sie ein System.Text.Encoding-Objekt an. Weitere Informationen finden Sie unter about_Character_Encoding.

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

-ExcludeDontShow

Schließen Sie die mit im Parameter-Attribut gekennzeichneten DontShow Parameter aus dem Hilfeinhalt aus.

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

-Force

Entfernen Sie Hilfedateien, die nicht mehr in Sitzungen vorhanden sind (z. B. wenn die Funktion gelöscht wurde).

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

-LogAppend

Gibt an, dass dieses Cmdlet Informationen an das Protokoll anhängt, anstatt es zu überschreiben.

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

-LogPath

Gibt einen Dateipfad für Protokollinformationen an. Das Cmdlet schreibt den VERBOSE-Stream in das Protokoll. Wenn Sie den Parameter Verbose angeben, schreibt dieses Cmdlet diese Informationen auch in die Konsole.

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

-ModulePagePath

Wenn -RefreshModulePage standardmäßig verwendet wird, wird die MD-Datei an demselben Speicherort wie alle anderen Dokumentationen platziert. Mit diesem Parameter können Sie einen neuen Namen/Standort angeben, um bessere Platzierungsoptionen zu bieten.

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

-Path

Gibt ein Array von Pfaden mit zu aktualisierenden Markdownordnern an. Der Ordner muss eine Modulseite enthalten, von der dieses Cmdlet den Modulnamen abrufen kann.

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

-RefreshModulePage

Aktualisieren Sie die Modulseite beim Aktualisieren des Hilfemoduls.

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

-Session

Bietet Unterstützung für Remotebefehle. Übergeben Sie die Sitzung, die Sie zum Erstellen der Befehle mit Import-PSSessionverwendet haben. Dies ist erforderlich, um genaue Parametermetadaten aus der Remotesitzung abzurufen.

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

-UpdateInputOutput

Aktualisiert die Abschnitte Eingabe und Ausgabe, um den aktuellen Zustand des Cmdlets widerzuspiegeln. WARNUNG: Mit diesem Parameter werden alle manuellen Ergänzungen zu diesen Abschnitten entfernt.

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

-UseFullTypeName

Gibt an, dass das Zieldokument einen vollständigen Typnamen anstelle eines kurzen Namens für Parameter verwendet.

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

Eingaben

String[]

Sie können ein Array von Pfaden an dieses Cmdlet weiterleiten.

Ausgaben

FileInfo[]

Dieses Cmdlet gibt ein FileInfo[]-Objekt für aktualisierte und neue Dateien zurück.

Hinweise

Das Modul, für das Sie die Hilfe aktualisieren möchten, sollte zuerst aus dem Speicherort importiert werden, der die vorherige Version der Hilfe enthält. Wenn diese Bedingung nicht erfüllt ist, ist die Parameterreihenfolge in der aktualisierten Hilfe alphabetisch, auch wenn der Parameter AlphabeticParamsOrder nicht verwendet wurde.

Freigeben über