Merge-MarkdownHelp

Referência

Módulo:: platyPS

Intercale várias versões de markdown do mesmo cmdlet num único ficheiro markdown.

Syntax

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

Description

Módulos semelhantes, ou versões diferentes do mesmo módulo, contêm frequentemente conteúdo duplicado.

Merge-MarkdownHelp intercala os múltiplos ficheiros markdown num único ficheiro markdown. Utiliza o applicable: campo de metadados yaml para identificar que versões ou etiquetas são aplicáveis. Atua em dois níveis: para todo o cmdlet e para parâmetros individuais.

O markdown resultante contém as applicable: etiquetas, bem como todo o conteúdo dos ficheiros markdown originais. O conteúdo duplicado é simplesmente ignorado. O conteúdo exclusivo de cada ficheiro é intercalado com marcadores de impressão em série, seguido de uma lista separada por vírgulas de etiquetas aplicáveis. Um marcador de intercalação é uma cadeia de texto que atua como um marcador para descrever o conteúdo que foi intercalado. O texto do marcador de impressão em série predefinido consiste em três pontos de exclamação !! no entanto, isto pode ser alterado para qualquer texto relevante com o sinalizador -MergeMarker .

Exemplos

Exemplo 1

O cmdlet Test-CsPhoneBootstrap.md está incluído no Lync Server 2010 e no Lync Server 2013. Grande parte do conteúdo é duplicado e, por isso, queremos ter um único ficheiro para o cmdlet com conteúdo exclusivo intercalado a partir de cada ficheiro individual.

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

O ficheiro resultante estará localizado em lync\Test-CsPhoneBootstrap.md.

Parâmetros

-Encoding

Especifica a codificação de carateres para o ficheiro de ajuda externo. Especifique um objeto System.Text.Encoding . Para obter mais informações, veja about_Character_Encoding.

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

-ExplicitApplicableIfAll

Escreva sempre a lista completa de etiquetas aplicáveis. Por predefinição, os cmdlets e parâmetros que estão presentes em todas as variações não obtêm uma etiqueta de aplicação.

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

-Force

Indica que este cmdlet substitui um ficheiro existente que tem o mesmo nome.

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

-MergeMarker

Cadeia a ser utilizada como um indicador de texto de intercalação. A lista de etiquetas aplicável seria incluída após o marcador

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

-OutputPath

Especifica o caminho da pasta onde este cmdlet cria os ficheiros de ajuda de markdown combinados.

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

-Path

Especifica uma matriz de caminhos de ficheiros ou pastas markdown. Este cmdlet cria ajuda de markdown combinada com base nestes ficheiros e pastas.

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

Entradas

String[]

Saídas

FileInfo[]

Partilhar via