Merge-MarkdownHelp

Referentie

Module:: platyPS

Voeg meerdere Markdown-versies van dezelfde cmdlet samen in één Markdown-bestand.

Syntaxis

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

Description

Vergelijkbare modules, of verschillende versies van dezelfde module, bevatten vaak dubbele inhoud.

Merge-MarkdownHelp voegt de meerdere Markdown-bestanden samen in één Markdown-bestand. Het maakt gebruik van het applicable: yaml-metagegevensveld om te bepalen welke versies of tags van toepassing zijn. Het werkt op twee niveaus: voor de hele cmdlet en voor afzonderlijke parameters.

De resulterende Markdown bevat de applicable: tags en alle inhoud van de oorspronkelijke Markdown-bestanden. Dubbele inhoud wordt gewoon genegeerd. Inhoud die uniek is voor elk bestand wordt samengevoegd met samenvoegmarkeringen, gevolgd door een door komma's gescheiden lijst met toepasselijke tags. Een samenvoegmarkering is een tekenreeks met tekst die fungeert als een markering om de inhoud te beschrijven die is samengevoegd. De standaardmarkering samenvoegmarkering tekst bestaat uit drie uitroeptekens !! dit kan echter worden gewijzigd in alle relevante tekst met behulp van de vlag -MergeMarker.

Voorbeelden

Voorbeeld 1

De Test-CsPhoneBootstrap.md cmdlet is opgenomen in zowel Lync Server 2010 als Lync Server 2013. Veel van de inhoud wordt gedupliceerd en daarom willen we één bestand voor de cmdlet hebben met unieke inhoud die uit elk afzonderlijk bestand is samengevoegd.

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

Het resulterende bestand bevindt zich op lync\Test-CsPhoneBootstrap.md.

Parameters

-Encoding

Hiermee geeft u de tekencodering voor uw externe Help-bestand. Geef een System.Text.Encoding--object op. Zie about_Character_Encodingvoor meer informatie.

Type:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ExplicitApplicableIfAll

Schrijf altijd een volledige lijst met toepasselijke tags. Standaard krijgen cmdlets en parameters die aanwezig zijn in alle variaties geen toepassingstag.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Force

Hiermee wordt aangegeven dat met deze cmdlet een bestaand bestand met dezelfde naam wordt overschreven.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-MergeMarker

Tekenreeks die moet worden gebruikt als een samenvoegtekstindicator. Toepasselijke taglijst wordt na de markering opgenomen

Type:	String
Position:	3
Default value:	'!!! '
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-OutputPath

Hiermee geeft u het pad op van de map waarin deze cmdlet de gecombineerde Markdown Help-bestanden maakt.

Type:	String
Position:	1
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Path

Hiermee geeft u een matrix van paden van Markdown-bestanden of -mappen. Met deze cmdlet maakt u gecombineerde Markdown-help op basis van deze bestanden en mappen.

Type:	String[]
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	True

Invoerwaarden

String[]

Uitvoerwaarden

FileInfo[]

Delen via