Update-MarkdownHelp

Referenz

Modul:: platyPS

Aktualisieren Sie die PlatyPS Markdown-Hilfedateien.

Syntax

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

Beschreibung

Das Update-MarkdownHelp Cmdlet aktualisiert PlatyPS Markdown-Hilfedateien, ohne den Inhalt der Dateien vollständig zu ersetzen.

Einige Parameterattribute ändern sich im Laufe der Zeit. Für instance Parametersätze, Typen, Standardwert und erforderlich. Dieses Cmdlet aktualisiert Markdown hilft, diese Änderungen widerzuspiegeln. Außerdem fügt sie der Markdowndatei Platzhaltertext für jeden neuen Parameter hinzu.

Gehen Sie wie folgt vor, um Änderungen an Ihre Markdown-Hilfedateien weiterzuverbreiten:

Laden Sie die neue Version des Moduls in Ihre Windows PowerShell Sitzung.
Führen Sie das Update-MarkdownHelp Cmdlet aus, um die Dateien zu aktualisieren.
Überprüfen Sie die Metadaten neuer Parameter in den Markdowndateien.

Beispiele

Beispiel 1: Aktualisieren aller Dateien in einem Ordner

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

Mit diesem Befehl werden alle Markdownhilfedateien im angegebenen Pfad so aktualisiert, dass sie mit den aktuellen Cmdlets übereinstimmen.

Beispiel 2: Aktualisieren einer Datei und eines Aufzeichnungsprotokolls

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

Mit diesem Befehl wird eine Markdownhilfedatei aktualisiert. Es schreibt Protokollinformationen in die markdown.log Datei.

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 von Hilfedateien, die in Sitzungen nicht mehr 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

-Path

Gibt ein Array von Pfaden mit zu aktualisierenden Markdowndateien und Ordnern an.

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

-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 den Abschnitt 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 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