Merge-MarkdownHelp

Moduł:

platyPS

Scal wiele wersji języka Markdown tego samego polecenia cmdlet w jednym pliku markdown.

Składnia

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

Opis

Podobne moduły lub różne wersje tego samego modułu często zawierają zduplikowaną zawartość.

Merge-MarkdownHelp scala wiele plików markdown z jednym plikiem markdown. Używa applicable: pola metadanych yaml do identyfikowania wersji lub tagów, które mają zastosowanie. Działa na dwóch poziomach: dla całego polecenia cmdlet i dla poszczególnych parametrów.

Wynikowy kod markdown zawiera applicable: tagi, a także całą zawartość oryginalnych plików markdown. Zduplikowana zawartość jest po prostu ignorowana. Zawartość, która jest unikatowa dla każdego pliku, jest scalona przy użyciu znaczników scalania, a następnie rozdzielaną przecinkami listę odpowiednich tagów. Znacznik scalania to ciąg tekstu, który działa jako znacznik opisujący scaloną zawartość. Domyślny tekst znacznika scalania składa się z trzech wykrzykników !! można to jednak zmienić na dowolny odpowiedni tekst za pomocą flagi -MergeMarker .

Przykłady

Przykład 1

Polecenie cmdlet Test-CsPhoneBootstrap.md jest zawarte zarówno w programie Lync Server 2010, jak i Lync Server 2013. Duża część zawartości jest duplikowana, dlatego chcemy mieć jeden plik polecenia cmdlet z unikatową zawartością scaloną z każdego pojedynczego pliku.

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

Wynikowy plik będzie znajdować się w lokalizacji lync\Test-CsPhoneBootstrap.md.

Parametry

-Encoding

Określa kodowanie znaków dla zewnętrznego pliku pomocy. Określ obiekt System.Text.Encoding . Aby uzyskać więcej informacji, zobacz about_Character_Encoding.

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

-ExplicitApplicableIfAll

Zawsze zapisuj pełną listę odpowiednich tagów. Domyślnie polecenia cmdlet i parametry, które są obecne we wszystkich odmianach, nie otrzymują tagu aplikacji.

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

-Force

Wskazuje, że to polecenie cmdlet zastępuje istniejący plik o tej samej nazwie.

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

-MergeMarker

Ciąg, który ma być używany jako wskaźnik tekstu scalania. Odpowiednia lista tagów zostanie dołączona po znaczniku

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

-OutputPath

Określa ścieżkę folderu, w którym to polecenie cmdlet tworzy połączone pliki pomocy markdown.

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

-Path

Określa tablicę ścieżek plików lub folderów markdown. To polecenie cmdlet tworzy połączoną pomoc języka Markdown na podstawie tych plików i folderów.

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

Dane wejściowe

String[]

Dane wyjściowe

FileInfo[]