Merge-MarkdownHelp

Referenz

Modul:: platyPS

Führen Sie mehrere Markdownversionen desselben Cmdlets in einer einzelnen Markdowndatei zusammen.

Syntax

Merge-MarkdownHelp
     [-Path] <String[]>
     [-OutputPath] <String>
     [-Encoding <Encoding>]
     [-ExplicitApplicableIfAll]
     [-Force]
     [[-MergeMarker] <String>]
     [<CommonParameters>]

Beschreibung

Ähnliche Module oder verschiedene Versionen desselben Moduls enthalten häufig doppelte Inhalte.

Merge-MarkdownHelp führt die mehrere Markdowndateien in einer einzelnen Markdowndatei zusammen. Es verwendet das applicable: Yaml-Metadatenfeld, um zu identifizieren, welche Versionen oder Tags anwendbar sind. Sie funktioniert auf zwei Ebenen: für das gesamte Cmdlet und für einzelne Parameter.

Das resultierende Markdown enthält die applicable: Tags sowie den gesamten Inhalt der ursprünglichen Markdowndateien. Doppelte Inhalte werden einfach ignoriert. Inhalte, die für jede Datei eindeutig sind, werden mithilfe von Mergemarkern zusammengeführt, gefolgt von einer durch Trennzeichen getrennten Liste der anwendbaren Tags. Ein Mergemarker ist eine Textzeichenfolge, die als Marker fungiert, um den zusammengeführten Inhalt zu beschreiben. Der Standardmäßige Mergemarkertext besteht aus drei Ausrufezeichen !! dies kann jedoch mithilfe des Flags -MergeMarker in jeden relevanten Text geändert werden.

Beispiele

Beispiel 1

Das Cmdlet Test-CsPhoneBootstrap.md ist sowohl in Lync Server 2010 als auch in Lync Server 2013 enthalten. Ein Großteil des Inhalts wird dupliziert, sodass wir eine einzelne Datei für das Cmdlet mit eindeutigen Inhalten haben möchten, die aus jeder einzelnen Datei zusammengeführt werden.

Merge-MarkdownHelp -Path @('Lync Server 2010\Test-CsPhoneBootstrap.md', 'Lync Server 2013\Test-CsPhoneBootstrap.md') -OutputPath lync

Die resultierende Datei befindet sich unter lync\Test-CsPhoneBootstrap.md.

Parameter

-Encoding

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

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

-ExplicitApplicableIfAll

Schreiben Sie immer eine vollständige Liste der anwendbaren Tags. Standardmäßig erhalten Cmdlets und Parameter, die in allen Variationen vorhanden sind, kein Anwendungstag.

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

-Force

Gibt an, dass dieses Cmdlet eine vorhandene Datei mit demselben Namen überschreibt.

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

-MergeMarker

Zeichenfolge, die als Mergetextindikator verwendet werden soll. Zutreffende Tagliste würde nach dem Marker eingeschlossen werden

Type:	String
Position:	3
Default value:	'!!! '
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputPath

Gibt den Pfad des Ordners an, in dem dieses Cmdlet die kombinierten Markdown-Hilfedateien erstellt.

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

-Path

Gibt ein Array von Pfaden von Markdowndateien oder -ordnern an. Dieses Cmdlet erstellt basierend auf diesen Dateien und Ordnern eine kombinierte Markdownhilfe.

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

Eingaben

String[]

Ausgaben

FileInfo[]

Freigeben über