Update-MarkdownHelpModule

Referência

Módulo:: platyPS

Atualize todos os ficheiros numa pasta do módulo de ajuda markdown.

Syntax

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

Description

O Update-MarkdownHelpModule cmdlet atualiza os ficheiros markdown de ajuda existentes e cria ficheiros markdown para novos cmdlets num módulo. Este cmdlet combina a funcionalidade dos cmdlets Update-MarkdownHelp e New-MarkdownHelp para efetuar uma atualização em massa.

Exemplos

Exemplo 1: atualizar um módulo de ajuda markdown

PS C:\> Update-MarkdownHelpModule -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 na pasta especificada com base nos cmdlets carregados para a sua sessão atual. O comando cria tópicos de ajuda de markdown para quaisquer cmdlets que ainda não estejam incluídos na pasta .\docs.

Parâmetros

-AlphabeticParamsOrder

Ordenar parâmetros alfabeticamente por nome na secção PARÂMETROS. Existem 5 exceções: -Confirm, -WhatIf, -IncludeTotalCount, , -Skipe -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 parameter do conteúdo da ajuda.

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

-Force

Remova os 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 Verboso , 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

-ModulePagePath

Quando -RefreshModulePage é utilizado por predefinição, coloca o ficheiro .md na mesma localização que todos os outros documentos. Com este parâmetro, pode especificar um novo nome/localização, fornecendo melhores opções de colocação.

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

-Path

Especifica uma matriz de caminhos de pastas markdown a atualizar. A pasta tem de conter uma página de módulo a partir da qual este cmdlet pode obter o nome do módulo.

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

-RefreshModulePage

Página atualizar módulo ao atualizar o módulo de ajuda.

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

-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 as secções 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 e novos.

Notas

O módulo para o qual pretende atualizar a ajuda deve ser importado primeiro 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