Merge-MarkdownHelp

Reference

Modul:: platyPS

Sloučení více verzí markdownu stejné rutiny do jednoho souboru Markdownu

Syntaxe

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. Používá applicable: pole metadat yaml k identifikaci verzí nebo značek, které jsou použitelné. Funguje na dvou úrovních: pro celou rutinu a pro jednotlivé parametry.

Výsledný markdown obsahuje značky applicable: i 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í slučovacích značeknásledovaný čárkami odděleným seznamem použitelných značek. slučovací značka je řetězec textu, který slouží jako značka pro popis sloučeného obsahu. Výchozí značka sloučení textu se skládá ze tří vykřičníků !! lze však 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. Velká část obsahu je duplicitní, 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 v 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.

Typ:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ExplicitApplicableIfAll

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

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Force

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

Typ:	SwitchParameter
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-MergeMarker

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

Typ:	String
Position:	3
Default value:	'!!! '
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-OutputPath

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

Typ:	String
Position:	1
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Path

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

Typ:	String[]
Position:	0
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	True

Vstupy

String[]

Výstupy

FileInfo[]

Sdílet prostřednictvím