Gerando Documentação

Você pode gerar a documentação para os recursos em seus módulos e bibliotecas.

Para gerar a documentação, siga estas instruções:

  1. Selecione o recurso da visualização Business Integration.
  2. Clique em Gerar Documentação na barra de ferramentas, botão Gerar Documentação na barra de ferramentas ou clique com o botão direito do mouse para selecionar Gerar Documentação.... É aberto o assistente de Geração de Documentação.
    Nota: Todos os campos neste assistente possuem informações de ajuda de F1 para ajudá-lo a concluir a especificação. Utilize a tecla Tab para mover o foco para o campo ou botão e, em seguida, pressione a tecla F1 (Ctrl+F1 para Linux) para exibir ajuda adicional.
  3. No assistente de Geração de Documentação, especifique o Nome do autor, o Título da documentação e um local para o arquivo PDF que será gerado. O nome do arquivo padrão é reportFile.pdf e o local padrão é seu espaço de trabalho. Consulte a ajuda (F1) para obter instruções sobre como alterar o nome do relatório.
  4. Você pode aceitar os padrões e clicar em Concluir para gerar a documentação. Entretanto, se você quiser selecionar recursos adicionais para serem incluídos no saída ou alterar o layout da documentação, clique em Avançar.
    Nota: Se o botão Concluir não estiver ativado, isto indica que você selecionou um recurso não suportado pelo gerador de documentação. Clique em Avançar para criar um novo arquivo principal. Posteriormente, será possível selecionar um recurso suportado pelo gerador de documentação. Consulte "Documentação ou Recursos" nos conceitos relacionados para obter informações adicionais sobre a documentação de recursos.
    1. Na página Selecionar Conteúdo, especifique se você deseja personalizar o conteúdo da saída gerada.
      • Selecione Gerar Documentação a partir do Recurso Selecionado se não desejar incluir ou remover recursos para a geração da documentação.
      • Selecione Gerar Documentação a partir de um Arquivo Principal Existente e um arquivo principal para executar novamente um perfil de recurso salvo anteriormente.
      • Selecione Criar um Novo Arquivo Principal para incluir ou remover recursos para esta geração da documentação.
      Consulte "Documentação ou Recursos" nos conceitos relacionados para obter informações adicionais sobres arquivos principais. Clique em Avançar.
    2. Na página de conteúdo do Editor, você pode incluir e remover recursos da documentação. Selecione um recurso e clique em > para incluí-lo na tabela Recursos de Entrada da Documentação. Você também pode selecionar itens na tabela e clicar em < para remover o conteúdo da documentação a ser gerada. Selecione a caixa de opções Incluir Arquivo de Referência também para gerar informações para artefatos referidos pelos recursos selecionados. Consulte "Documentação ou Recursos" nos conceitos relacionados para obter informações adicionais sobre arquivos de referência.

      O botão Salvar Como... salva o novo arquivo principal para que seja possível gerar novamente o mesmo relatório utilizando o arquivo principal. Clique em Avançar.

    3. Na página de configuração de Layout, selecione o layout da documentação desejado e clique em Concluir para gerar a documentação.
      Nota: Se você alterar as configurações de layout e de estilo, elas serão salvas para todas as gerações de documentações subseqüentes, até que sejam alteradas novamente.
      Para incluir novas fontes a serem utilizadas na documentação, consulte "Incluindo Fontes" a seguir.
  5. Procure o arquivo PDF no local especificado e abra-o com o Acrobat Reader.

Incluindo Fontes

Se desejar incluir novas fontes para que elas sejam utilizadas na documentação gerada, ative o assistente de Geração de Documentação e clique em Avançar até aparecer a página Configurações de Layout:

Página Configurações de Layout do assistente de Geração de Documentação

Depois, siga estas etapas:

  1. Selecione a caixa de opções Sobrescrever Fontes Padrão. O botão Fontes... será ativado.
  2. Clique em Fontes... e será aberta a página Configurações de Estilo da Documentação:

    Página Configurações de Estilo da Documentação

  3. Clique em Gerenciar Fontes... e será aberta a janela Gerenciar Fontes da Documentação.

    Janela Gerenciar Fontes da Documentação

  4. Clique no botão Incluir.... É aberta a janela Incluir Fonte da Documentação.

    Janela Incluir Fonte da Documentação

  5. Clique em Procurar para acessar a janela Abrir e localizar o arquivo TTF ou TTC e selecioná-lo.
    Nota: (Apenas Windows) Se desejar selecionar fontes do diretório do Windows, por exemplo, WINNT ou WINDOWS, deverá digitar novamente o nome do arquivo TTF ou TTC na janela Abrir, que é mostrada aqui:
    Janela Abrir no diretório WINNT
    Por padrão, se você der um clique duplo no arquivo no diretório WINNT, o Windows abrirá o arquivo TTF ou TTC em vez de selecioná-lo; pois, para fazer uma seleção, é necessário digitar o nome. Para utilizar o mouse para esta seleção, copie o arquivo TTF ou TTC para outro diretório. Em seguida, será possível utilizar o mouse para clicar e selecionar o arquivo de fonte.

    Se um arquivo TTC for selecionado, deverá ser digitado um nome de fonte válido.

  6. Clique em OK na janela Fonte da Documentação para concluir a seleção. A nova fonte deve aparecer na janela Gerenciar Fontes da Documentação.
    Nota: No assistente de Geração da Documentação, os nomes de fontes registradas, incluindo nomes de fontes do conjunto de caracteres de byte duplo, são exibidos apenas em letras do idioma Latim.
  7. Clique em OK para retornar à página Configurações de Estilo da Documentação, na qual agora é possível selecionar a nova fonte para os tipos de texto listados.

A nova fonte agora está registrada, ficando disponível para todas as gerações de documentações subseqüentes. As fontes padrão não podem ser removidas.

Referências relacionadas
Documentação de Recursos

Feedback
(C) Direitos Autorais IBM Corporation 2005, 2006. Todos os Direitos Reservados.