Compartilhar via

Como criar um arquivo XML HelpInfo

  • Artigo

Este tópico nesta seção explica como criar e popular um arquivo de informações de ajuda, normalmente conhecido como "arquivo XML HelpInfo", para o recurso ajuda atualizável do PowerShell.

Visão geral do arquivo XML HelpInfo

O arquivo XML HelpInfo é a principal fonte de informações sobre a Ajuda Atualizável para o módulo. Ele inclui o local dos arquivos de ajuda para os módulos, as culturas de interface do usuário com suporte e os números de versão que a Ajuda Atualizável usa para determinar se o usuário tem os arquivos de ajuda mais novos.

Cada módulo tem apenas um arquivo XML HelpInfo, mesmo que o módulo inclua vários arquivos de ajuda para várias culturas de interface do usuário. O autor do módulo cria o arquivo XML HelpInfo e o coloca no local da Internet especificado pela chave HelpInfoUri no manifesto do módulo. Quando os arquivos de ajuda do módulo são atualizados e carregados, o autor do módulo atualiza o arquivo XML HelpInfo e substitui o arquivo XML HelpInfo original pela nova versão.

É essencial que o arquivo XML HelpInfo seja mantido cuidadosamente. Se você carregar novos arquivos, mas esquecer de incrementar os números de versão, a Ajuda Atualizável não baixará os novos arquivos nos computadores dos usuários. Se você adicionar arquivos de ajuda para uma nova cultura de interface do usuário, mas não atualizar o arquivo XML HelpInfo ou colocar-o no local correto, a Ajuda Atualizável não baixará os novos arquivos.

Nesta seção

Esta seção inclui os seguintes tópicos.

Consulte Também

Suporte à ajuda atualizável