Update-MarkdownHelp

Referência

Módulo:: platyPS

Atualize os ficheiros de ajuda de markdown do PlatyPS.

Syntax

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

Description

O Update-MarkdownHelp cmdlet atualiza os ficheiros de ajuda de markdown do PlatyPS sem substituir completamente o conteúdo dos ficheiros.

Alguns atributos de parâmetros mudam ao longo do tempo. Por exemplo, conjuntos de parâmetros, tipos, valor predefinido e obrigatório. Esta markdown de atualizações de cmdlets ajuda a refletir essas alterações. Também adiciona texto do marcador de posição ao ficheiro markdown para qualquer novo parâmetro.

Para propagar alterações aos ficheiros de ajuda markdown, faça o seguinte:

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

Exemplos

Exemplo 1: Atualizar todos os ficheiros numa 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 ficheiros de ajuda markdown no caminho especificado para corresponder aos cmdlets atuais.

Exemplo 2: Atualizar um ficheiro e capturar o registo

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 ficheiro de ajuda markdown. Escreve informações de registo no markdown.log ficheiro.

Parâmetros

-AlphabeticParamsOrder

Ordenar parâmetros alfabeticamente por nome na secção PARAMETERS. Existem 5 exceções: -Confirm, -WhatIf, -IncludeTotalCount, -Skip, e -First os parâmetros serão os últimos. Estes parâmetros são comuns e, por conseguinte, têm um comportamento bem definido.

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

-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:	1
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeDontShow

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

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

-Force

Remover ficheiros de ajuda que já não existem em sessões (por exemplo, se a função tiver sido eliminada)

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

-LogAppend

Indica que este cmdlet acrescenta informações ao registo em vez de as substituir.

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

-LogPath

Especifica um caminho de ficheiro para informações de registo. O cmdlet escreve o fluxo VERBOSE no registo. Se especificar o parâmetro Verbose , este cmdlet também escreve essas informações na consola.

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

-Path

Especifica uma matriz de caminhos de ficheiros e pastas markdown para atualizar.

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

-Session

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

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

-UpdateInputOutput

Atualiza a secçã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.

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

-UseFullTypeName

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

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

Entradas

String[]

Pode encaminhar uma matriz de caminhos para este cmdlet.

Saídas

FileInfo[]

Este cmdlet devolve um objeto FileInfo[] para ficheiros atualizados.

Notas

O módulo para o qual pretende atualizar a ajuda deve ser importado primeiro a partir da localização que contém a versão anterior da ajuda. Se esta condição não for cumprida, a ordem dos parâmetros será alfabética na ajuda atualizada, mesmo que o parâmetro AlphabeticParamsOrder não tenha sido utilizado.

Partilhar via