Update-MarkdownHelpModule

Referência

Módulo:: platyPS

Atualize todos os arquivos em uma pasta do módulo de ajuda de marcação.

Sintaxe

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

Description

O cmdlet Update-MarkdownHelpModule atualiza os arquivos de marcação de ajuda existentes e cria arquivos de marcação para novos cmdlets em um módulo. Este cmdlet combina a funcionalidade do Update-MarkdownHelp e cmdlets New-MarkdownHelp para executar uma atualização em massa.

Exemplos

Exemplo 1: Atualizar um módulo de ajuda de marcação

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 arquivos na pasta especificada com base nos cmdlets conforme carregados na sessão atual. O comando cria tópicos de ajuda de marcação para quaisquer cmdlets que ainda não estejam incluídos na pasta .\docs.

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

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

-ModulePagePath

Quando -RefreshModulePage é usado por padrão, ele coloca o arquivo .md no mesmo local que todos os outros documentos. Com este parâmetro, você pode especificar um novo nome/local, fornecendo melhores opções de posicionamento.

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

-Path

Especifica uma matriz de caminhos de pastas de marcação a serem atualizadas. A pasta deve conter uma página de módulo a partir da qual esse cmdlet possa obter o nome do módulo.

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

-RefreshModulePage

Atualize a página do módulo ao atualizar o módulo de ajuda.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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.

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

-UpdateInputOutput

Atualiza as seçõ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.

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 novos e 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