Merge-MarkdownHelp

Referência

Módulo:: platyPS

Mescle várias versões de markdown do mesmo cmdlet em um único arquivo de markdown.

Sintaxe

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, geralmente contêm conteúdo duplicado.

Merge-MarkdownHelp mescla os vários arquivos de marcação em um único arquivo de marcação. Ele usa o campo applicable: metadados yaml para identificar quais versões ou tags são aplicáveis. Ele atua em dois níveis: para todo o cmdlet e para parâmetros individuais.

O markdown resultante contém as tags applicable:, bem como todo o conteúdo dos arquivos de markdown originais. O conteúdo duplicado é simplesmente ignorado. O conteúdo exclusivo de cada arquivo é mesclado usando marcadores de mesclagem, seguido por uma lista separada por vírgulas de tags aplicáveis. Um marcador de mesclagem é uma cadeia de caracteres de texto que atua como um marcador para descrever o conteúdo que foi mesclado. O marcador de mesclagem padrão texto consiste em três pontos de exclamação !! no entanto, isso pode ser alterado para qualquer texto relevante usando o -MergeMarker sinalizador.

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, portanto, queremos ter um único arquivo para o cmdlet com conteúdo exclusivo mesclado de cada arquivo individual.

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

O arquivo resultante será localizado em lync\Test-CsPhoneBootstrap.md.

Parâmetros

-Encoding

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

Tipo:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ExplicitApplicableIfAll

Sempre escreva a lista completa de tags aplicáveis. Por padrão, cmdlets e parâmetros que estão presentes em todas as variações não recebem uma marca de aplicativo.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Force

Indica que esse cmdlet substitui um arquivo existente com o mesmo nome.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-MergeMarker

String a ser usada como um indicador de texto de mesclagem. A lista de tags aplicável seria incluída após o marcador

Tipo:	String
Position:	3
Default value:	'!!! '
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-OutputPath

Especifica o caminho da pasta onde esse cmdlet cria os arquivos de ajuda de marcação combinados.

Tipo:	String
Position:	1
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Path

Especifica uma matriz de caminhos de arquivos ou pastas de marcação. Este cmdlet cria uma ajuda de marcação combinada com base nesses arquivos e pastas.

Tipo:	String[]
Position:	0
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	True

Entradas

String[]

Saídas

FileInfo[]

Partilhar via