Instalando sua Própria Documentação no z/OS Explorer

Se sua organização tiver processos e procedimentos operacionais do sistema, talvez você queira incluí-los no Conteúdo da Ajuda do z/OS® Explorer para que fiquem disponíveis enquanto você usa o z/OS Explorer. É possível criar o seu próprio plug-in de documentação e integrá-lo totalmente ao Conteúdo da Ajuda do z/OS Explorer ou, como uma etapa temporária, é possível integrar arquivos HTML e de texto existentes à função de procura da Ajuda do z/OS Explorer.

Criando um Plug-in

O z/OS Explorer é criado na plataforma de software livre do Eclipse que fornece um ambiente de desenvolvimento integrado extensível. Usando a plataforma Eclipse, qualquer pessoa pode criar ferramentas que se integram com perfeição ao ambiente e a outras ferramentas. A chave para a integração com perfeição de ferramentas com o Eclipse é o plug-in. Com exceção de um pequeno kernel de tempo de execução, tudo no Eclipse é um plug-in. Isso significa que um plug-in que você desenvolve se integra ao Eclipse e portanto ao z/OS Explorer, exatamente da mesma maneira que com outros plug-ins.

Quando você cria um plug-in da documentação, ele é totalmente integrado ao z/OS Explorer e o conteúdo é exibido no Conteúdo da Ajuda.

Você pode criar o seu próprio plug-in de documentação usando o Ambiente de Desenvolvimento do Plug-in (PDE) do Eclipse que está disponível no Ambiente de Desenvolvimento Integrado (PDE) do Eclipse. O IDE do Eclipse é um software livre e pode ser transferido por download do website do Eclipse em http://www.eclipse.org. A documentação explica como iniciar e uma folha de dicas é fornecida com instruções etapa por etapa para a criação de um plug-in.

Integrando Arquivos HTML e de texto à Procura da Ajuda do z/OS Explorer

Se você ainda não criou um plug-in de documentação, mas possui arquivos HTML ou de texto que deseja acessar no z/OS Explorer, poderá colocar os arquivos em uma pasta especial para que eles possam ser incluídos no índice de procura do z/OS Explorer. Quando você executa uma procura por informações da ajuda, quaisquer correspondências com sua documentação são exibidas junto com os resultados do z/OS Explorer. Entretanto, quando você visualiza o conteúdo da Ajuda, seus documentos não aparecerão.

Esse método de integração de arquivos HTML e de texto deve ser apenas uma solução temporária até que você crie um plug-in de documentação.

Para incluir seus arquivos HTML ou de texto na procura da Ajuda do z/OS Explorer, execute as seguintes etapas:

  1. Clique em Ajuda > Gerenciar Documentação Customizada no menu do ambiente de trabalho. O gerenciador de arquivos abre uma janela em sua área de trabalho mostrando o conteúdo da pasta mydocs no z/OS Explorer.
  2. Copie quaisquer arquivos HTML ou de texto que você deseja incluir no z/OS Explorer e cole-os na pasta mydocs.
  3. Feche a janela mydocs.
  4. Clique em Ajuda > Recriar Índice de Procura no menu do ambiente de trabalho. Um diálogo é apresentado solicitando confirmação. A operação requer que o z/OS Explorer seja reiniciado.
  5. Clique em OK para continuar ou clique em Cancelar se não desejar reiniciar o z/OS Explorer nesse momento. Você deve executar a etapa de recriação para os arquivos a serem incluídos na procura da Ajuda.

Quando o z/OS Explorer reiniciar, qualquer procura da Ajuda que você executar irá procurar agora em sua própria documentação, bem como na documentação do z/OS Explorer. Quaisquer resultados localizados em sua própria documentação são listados antes dos resultados localizados na documentação do z/OS Explorer.

Nota: Quando resultados da procura forem localizados nos arquivos HTML, será exibido o nome do arquivo nas tags <Title></Title>. Entretanto, os arquivos de texto não incluem tags de título, portanto os resultados nos arquivos de texto exibem o caminho do arquivo, como mostrado nesta captura de tela Uma captura de tela dos resultados da procura mostrando resultados na documentação própria do cliente, na parte superior dos resultados. Os dois primeiros resultados têm títulos próprios, pois estão em arquivos HTML. Os próximos 3 resultados mostram os caminhos de arquivos, uma vez que são arquivos de texto..

Tópico-pai: Tarefas