Update-MarkdownHelp

Referência

Módulo:: platyPS

Atualize os arquivos de ajuda de marcação PlatyPS.

Sintaxe

Update-MarkdownHelp
      [-Path] <String[]>
      [[-Encoding] <Encoding>]
      [[-LogPath] <String>]
      [-LogAppend]
      [-AlphabeticParamsOrder]
      [-UseFullTypeName]
      [-UpdateInputOutput]
      [-Force]
      [-Session <PSSession>]
      [-ExcludeDontShow]
      [<CommonParameters>]

Description

O cmdlet Update-MarkdownHelp atualiza os arquivos de ajuda de marcação PlatyPS sem substituir completamente o conteúdo dos arquivos.

Alguns atributos de parâmetros mudam ao longo do tempo. Por exemplo, conjuntos de parâmetros, tipos, valor padrão e obrigatório. Este cmdlet atualiza a marcação para refletir essas alterações. Ele também adiciona texto de espaço reservado ao arquivo de marcação para qualquer novo parâmetro.

Para propagar alterações em seus arquivos de ajuda de marcação, faça o seguinte:

Carregue a nova versão do módulo em sua sessão do Windows PowerShell.
Execute o cmdlet Update-MarkdownHelp para atualizar os arquivos.
Verifique os metadados de novos parâmetros nos arquivos de markdown.

Exemplos

Exemplo 1: Atualizar todos os arquivos em uma pasta

PS C:\> Update-MarkdownHelp -Path ".\docs"

    Directory: D:\working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

Este comando atualiza todos os arquivos de ajuda de marcação no caminho especificado para corresponder aos cmdlets atuais.

Exemplo 2: Atualizar um arquivo e capturar log

PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"

    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   8:20 PM           9993 New-MarkdownHelp.md

Este comando atualiza um arquivo de ajuda de marcação. Ele grava informações de log no arquivo markdown.log.

Parâmetros

-AlphabeticParamsOrder

Ordene os parâmetros alfabeticamente por nome na seção PARÂMETROS. Existem 5 exceções: -Confirm, -WhatIf, -IncludeTotalCount, -Skipe -First parâmetros serão os últimos. Estes parâmetros são comuns e, portanto, têm um comportamento bem definido.

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

-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:	1
Default value:	UTF8 without BOM
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ExcludeDontShow

Exclua os parâmetros marcados com DontShow no atributo parameter do conteúdo da ajuda.

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

-Force

Remover arquivos de ajuda que não existem mais nas sessões (por exemplo, se a função foi excluída)

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

-LogAppend

Indica que esse cmdlet acrescenta informações ao log em vez de substituí-las.

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

-LogPath

Especifica um caminho de arquivo para informações de log. O cmdlet grava o fluxo VERBOSE no log. Se você especificar o parâmetro Verbose, esse cmdlet também gravará essas informações no console.

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

-Path

Especifica uma matriz de caminhos de arquivos de marcação e pastas a serem atualizados.

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

-Session

Fornece suporte para comandos remotos. Passe a sessão que você usou para criar os comandos com Import-PSSession. Isso é necessário para obter metadados de parâmetros precisos da sessão remota.

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

-UpdateInputOutput

Atualiza a seção Entrada e Saída para refletir o estado atual do cmdlet. AVISO: este parâmetro removerá quaisquer adições manuais a estas secções.

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

-UseFullTypeName

Indica que o documento de destino usará um nome de tipo completo em vez de um nome curto para parâmetros.

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

Entradas

String[]

Você pode canalizar uma matriz de caminhos para esse cmdlet.

Saídas

FileInfo[]

Este cmdlet retorna um objeto FileInfo[] para arquivos atualizados.

Notas

O módulo para o qual você deseja atualizar a ajuda deve primeiro ser importado do local que contém a versão anterior da ajuda. Se essa condição não for atendida, a ordem dos parâmetros será alfabética na ajuda atualizada, mesmo que o parâmetro AlphabeticParamsOrder não tenha sido usado.

Partilhar via