How Updatable Help Works (Como Funciona a Ajuda Atualizável)

Este tópico explica como o Updatable Help processa o ficheiro XML HelpInfo e os ficheiros CAB de cada módulo, e instala a ajuda atualizada para os utilizadores.

O Processo Update-Help

A lista seguinte descreve as ações do cmdlet Update-Help quando um utilizador executa um comando para atualizar os ficheiros de ajuda de um módulo numa determinada cultura de interface.

1. Update-Help obtém o ficheiro XML remoto HelpInfo da localização especificada pelo valor da chave HelpInfoURI no manifesto do módulo e valida o ficheiro contra o esquema. (Para visualizar o esquema, consulte HelpInfo XML Schema.) Depois Update-Help procura um ficheiro XML local HelpInfo para o módulo no diretório do módulo no computador do utilizador.

2. Update-Help compara o número de versão dos ficheiros de ajuda para a cultura de interface especificada nos ficheiros XML HelpInfo remotos e locais para o módulo. Se o número de versão no ficheiro remoto for superior ao número de versão do ficheiro local, ou se não houver ficheiro XML HelpInfo local para o módulo, Update-Help preparar-se para descarregar novos ficheiros de ajuda.

3. Update-Help seleciona o ficheiro CAB do módulo a partir da localização especificada pelo elemento HelpContentUri no ficheiro XML HelpInfo remoto. Utiliza o nome do módulo, o GUID do módulo e a cultura da interface para identificar o ficheiro CAB.

4. Update-Help descarrega o ficheiro CAB, desempacota-o, valida os ficheiros de conteúdo de ajuda e guarda os ficheiros de conteúdo de ajuda no subdiretório específico da linguagem do diretório de módulos no computador do utilizador.

5. Update-Help cria um ficheiro HelpInfo XML local copiando o ficheiro HelpInfo XML remoto. Edita o ficheiro local HelpInfo XML para incluir apenas elementos para o ficheiro CAB que instalou. Depois, guarda o ficheiro local HelpInfo XML no diretório do módulo e conclui a atualização.

O Processo Save-Help

A lista seguinte descreve as ações dos comandos Save-Help e Update-Help quando um utilizador executa comandos para atualizar os ficheiros de ajuda numa partilha de ficheiros, e depois usa esses ficheiros para atualizar os ficheiros de ajuda no computador do utilizador.

O Save-Help cmdlet executa as seguintes ações em resposta a um comando para guardar os ficheiros de ajuda de um módulo numa partilha de ficheiros especificada pelo parâmetro DestinationPath .

1. Save-Help obtém o ficheiro XML remoto HelpInfo da localização especificada pelo valor da chave HelpInfoURI no manifesto do módulo e valida o ficheiro contra o esquema. (Para visualizar o esquema, consulte HelpInfo XML Schema.) Depois Save-Help procura um ficheiro local HelpInfo XML no diretório especificado pelo parâmetro DestinationPath no Save-Help comando.

2. Save-Help compara o número de versão dos ficheiros de ajuda para a cultura de interface especificada nos ficheiros XML HelpInfo remotos e locais para o módulo. Se o número de versão no ficheiro remoto for maior do que o número de versão do ficheiro local, ou se não houver ficheiro XML HelpInfo local para o módulo no diretório DestinationPath , Save-Help preparar-se para descarregar novos ficheiros de ajuda.

3. Save-Help seleciona o ficheiro CAB do módulo a partir da localização especificada pelo elemento HelpContentUri no ficheiro XML HelpInfo remoto. Utiliza o nome do módulo, o GUID do módulo e a cultura da interface para identificar o ficheiro CAB.

4. Save-Help descarrega o ficheiro CAB e guarda-o no diretório DestinationPath . (Não cria subdiretórios específicos da língua.)

5. Save-Help cria um ficheiro HelpInfo XML local copiando o ficheiro HelpInfo XML remoto. Edita o ficheiro local HelpInfo XML para incluir apenas elementos para o ficheiro CAB que guardou. Depois guarda o ficheiro local HelpInfo XML no diretório DestinationPath e conclui a atualização.

   O Update-Help cmdlet executa as seguintes ações em resposta a um comando para atualizar os ficheiros de ajuda no computador do utilizador a partir dos ficheiros numa partilha de ficheiros especificada pelo parâmetro SourcePath .

6. Update-Help obtém o ficheiro XML remoto HelpInfo do diretório SourcePath . Depois procura um ficheiro local HelpInfo XML no diretório do módulo no computador do utilizador.

7. Update-Help compara o número de versão dos ficheiros de ajuda para a cultura de interface especificada nos ficheiros XML HelpInfo remotos e locais para o módulo. Se o número de versão no ficheiro remoto for maior do que o número de versão do ficheiro local, ou se não houver ficheiro HelpInfo XML local, Update-Help prepara-se para instalar novos ficheiros de ajuda.

8. Update-Help seleciona o ficheiro CAB para o módulo a partir do diretório SourcePath . Utiliza o nome do módulo, o GUID do módulo e a cultura da interface para identificar o ficheiro CAB.

9. Update-Help desempacota o ficheiro CAB, valida os ficheiros de conteúdo de ajuda e guarda os ficheiros de conteúdo de ajuda no subdiretório específico da linguagem do diretório do módulo no computador do utilizador.

10. Update-Help cria um ficheiro HelpInfo XML local copiando o ficheiro HelpInfo XML remoto. Edita o ficheiro local HelpInfo XML para incluir apenas elementos para o ficheiro CAB que instalou. Depois, guarda o ficheiro local HelpInfo XML no diretório do módulo e conclui a atualização.