Merge-MarkdownHelp

Reference

Modul:: platyPS

Sloučit více verzí markdownu stejné rutiny do jednoho souboru markdownu.

Syntax

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

Description

Podobné moduly nebo různé verze stejného modulu často obsahují duplicitní obsah.

Merge-MarkdownHelp sloučí více souborů markdownu do jednoho souboru markdownu. applicable: Používá pole metadat yaml k identifikaci, které verze nebo značky jsou použitelné. Funguje na dvou úrovních: pro celou rutinu a pro jednotlivé parametry.

Výsledný markdown obsahuje applicable: značky a veškerý obsah původních souborů markdownu. Duplicitní obsah se jednoduše ignoruje. Obsah, který je pro každý soubor jedinečný, se sloučí pomocí značek sloučení a po nich následuje seznam použitelných značek oddělených čárkami. Značka sloučení je řetězec textu, který funguje jako značka k popisu sloučeného obsahu. Výchozí text značky sloučení se skládá ze tří vykřičníků !! to však lze změnit na libovolný relevantní text pomocí příznaku -MergeMarker .

Příklady

Příklad 1

Rutina Test-CsPhoneBootstrap.md je součástí Lync Serveru 2010 i Lync Serveru 2013. Většina obsahu je duplikovaná, a proto chceme mít jeden soubor pro rutinu s jedinečným obsahem sloučeným z každého jednotlivého souboru.

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

Výsledný soubor bude umístěn na adrese lync\Test-CsPhoneBootstrap.md.

Parametry

-Encoding

Určuje kódování znaků pro externí soubor nápovědy. Zadejte objekt System.Text.Encoding . Další informace najdete v tématu about_Character_Encoding.

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

-ExplicitApplicableIfAll

Vždy zapište úplný seznam použitelných značek. Rutiny a parametry, které jsou přítomné ve všech variantách, ve výchozím nastavení nezískají značku aplikace.

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

-Force

Označuje, že tato rutina přepíše existující soubor se stejným názvem.

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

-MergeMarker

Řetězec, který se má použít jako indikátor textu hromadné korespondence. Seznam použitelných značek by se zahrnul za značku.

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

-OutputPath

Určuje cestu ke složce, ve které tato rutina vytvoří kombinované soubory nápovědy Markdownu.

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

-Path

Určuje pole cest k souborům nebo složkám markdownu. Tato rutina vytvoří kombinovanou nápovědu markdownu na základě těchto souborů a složek.

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

Vstupy

String[]

Výstupy

FileInfo[]