Visão geral da ajuda atualizável

Este documento fornece uma introdução básica ao design e à operação do recurso de Ajuda Atualizável do PowerShell. Ele foi projetado para autores de módulos e outros que fornecem tópicos de ajuda do Windows PowerShell aos usuários.

Introdução

Os tópicos de ajuda do PowerShell são parte integrante da experiência do PowerShell. Assim como os módulos do PowerShell, os tópicos de ajuda são atualizados e aprimorados continuamente pelos autores e pelas contribuições da comunidade de usuários do PowerShell.

O recurso ajuda atualizável, introduzido no Windows PowerShell 3.0, garante que os usuários tenham as versões mais recentes dos tópicos de ajuda no prompt de comando, mesmo para comandos internos do PowerShell, sem baixar novos módulos ou executar o Windows Update. A Ajuda Atualizável simplifica a atualização fornecendo cmdlets que baixam as versões mais recentes dos tópicos de ajuda da Internet e os instalam nos subdiretórios corretos no computador local do usuário. Mesmo os usuários que estão por trás de firewalls podem usar os novos cmdlets para obter ajuda atualizada de um compartilhamento de arquivos interno.

A Ajuda Atualizável é totalmente compatível com todos os módulos do Windows PowerShell no Windows 8 e no Windows Server 2012, e seus recursos estão disponíveis para todos os autores de módulos do Windows PowerShell. A Ajuda Atualizável dá suporte apenas a arquivos de ajuda baseados em XML. Ele não dá suporte à ajuda baseada em comentários.

A Ajuda Atualizável inclui os seguintes recursos.

• O cmdlet Update-Help, que determina se os usuários têm os arquivos de ajuda mais recentes para um módulo e, se não, baixa os arquivos de ajuda mais recentes da Internet, os descompacta e os instala nos subdiretórios de módulo corretos no computador do usuário. Os usuários podem usar o cmdlet Get-Help para exibir os tópicos de ajuda recém-instalados imediatamente. Eles não precisam reiniciar o PowerShell.

• O cmdlet Save-Help, que baixa os arquivos de ajuda mais recentes da Internet e os salva em um diretório do sistema de arquivos. Os usuários podem usar o cmdlet Update-Help para obter arquivos de ajuda do diretório do sistema de arquivos e desempacotar e instalá-los nos subdiretórios do módulo no computador do usuário. O cmdlet Save-Help foi projetado para usuários que têm acesso limitado ou não à Internet e para empresas que preferem limitar o acesso à Internet.

• ajuda para um módulo. Os arquivos de ajuda de um módulo são gerenciados e entregues como uma unidade, para que os usuários possam obter todos os arquivos de ajuda para os módulos que usam. A ajuda atualizável tem suporte apenas para módulos, não para snap-ins do Windows PowerShell.

• versão de suporte. A Ajuda Atualizável usa n1 (quatro posições padrão). N2. N3. N4) números de versão. A Ajuda Atualizável baixa arquivos de ajuda quando o número de versão dos arquivos de ajuda no computador do usuário (ou no diretório Save-Help) é menor do que o número de versão dos arquivos de ajuda no local da Internet.

• suporte a vários idiomas. A Ajuda Atualizável dá suporte a arquivos de ajuda de módulo em várias culturas de interface do usuário. Os nomes de arquivo de Ajuda atualizáveis incluem códigos de idioma padrão, como "en-US" e "ja-JP", e os cmdlets Update-Help e Save-Help colocam os arquivos de ajuda em subdiretórios específicos do idioma do diretório do módulo.

• ajuda gerada automaticamente. O cmdlet Get-Help exibe ajuda básica para comandos que não têm arquivos de ajuda. A ajuda gerada automaticamente inclui a sintaxe de comando e aliases e instruções para usar a ajuda online e a Ajuda Atualizável.

• de ajuda do Enhanced Online. O fácil acesso à ajuda online não requer mais arquivos de ajuda. O parâmetro Online do cmdlet Get-Help agora obtém a URL de um tópico de ajuda online do valor da propriedade HelpUri de qualquer comando, caso não encontre a URL de ajuda online em um arquivo de ajuda. Você pode preencher a propriedade HelpUri adicionando um atributo HelpUri ao código de cmdlets, funções e comandos CIM ou usando a palavra-chave de ajuda baseada em comentários .LINK em fluxos de trabalho e scripts.

  Para tornar nossos arquivos de ajuda atualizáveis, os módulos do Windows PowerShell no Windows não vêm com arquivos de ajuda. Os usuários podem usar a Ajuda Atualizável para instalar arquivos de ajuda e atualizá-los. Os autores de outros módulos podem incluir arquivos de ajuda em módulos ou omitê-los. O suporte à Ajuda Atualizável é opcional, mas recomendado.