Update-MarkdownHelp
Atualize os arquivos de ajuda de markdown do PlatyPS.
Sintaxe
Default (Padrão)
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 markdown do PlatyPS sem substituir completamente o conteúdo dos arquivos.
Alguns atributos de parâmetro são alterados ao longo do tempo. Por exemplo, conjuntos de parâmetros, tipos, valor padrão e obrigatório. Esse cmdlet atualiza a ajuda de markdown para refletir essas alterações. Ele também adiciona texto de espaço reservado ao arquivo markdown para qualquer novo parâmetro.
Para propagar alterações nos arquivos de ajuda de markdown, faça o seguinte:
- Carregue a nova versão do módulo em sua sessão do Windows PowerShell.
- Execute o cmdlet
Update-MarkdownHelppara atualizar os arquivos. - Verifique os metadados de novos parâmetros nos arquivos 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
Esse comando atualiza todos os arquivos de ajuda de markdown 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
Esse comando atualiza um arquivo de ajuda de markdown. Ele grava informações de log no arquivo markdown.log.
Parâmetros
-AlphabeticParamsOrder
Ordenar parâmetros alfabéticos por nome na seção PARAMETERS. Há cinco exceções: os parâmetros -Confirm, -WhatIf, -IncludeTotalCount, -Skipe -First serão os últimos. Esses parâmetros são comuns e, portanto, têm um comportamento bem definido.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Encoding
Especifica a codificação de caracteres para o arquivo de ajuda externo. Especifique um objeto
Propriedades do parâmetro
| Tipo: | Encoding |
| Valor padrão: | UTF8 without BOM |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ExcludeDontShow
Exclua os parâmetros marcados com DontShow no atributo de parâmetro do conteúdo da ajuda.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Remover arquivos de ajuda que não existem mais em sessões (por exemplo, se a função foi excluída)
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-LogAppend
Indica que esse cmdlet acrescenta informações ao log em vez de substituí-lo.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 2 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Path
Especifica uma matriz de caminhos de arquivos e pastas markdown a serem atualizados.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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.
Propriedades do parâmetro
| Tipo: | PSSession |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UpdateInputOutput
Atualiza a seção Entrada e Saída para refletir o estado atual do cmdlet. AVISO: esse parâmetro removerá quaisquer adições manuais a estas seções.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UseFullTypeName
Indica que o documento de destino usará um nome de tipo completo em vez de um nome curto para parâmetros.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
String
Você pode canalizar uma matriz de caminhos para este cmdlet.
Saídas
FileInfo
Esse cmdlet retorna um objeto FileInfo[] para arquivos atualizados.
Observações
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 de parâmetro será alfabética na ajuda atualizada, mesmo se o parâmetro AlphabeticParamsOrder não tiver sido usado.
