Documentação de Recursos

Além da visualização de recursos, pode ser necessário documentar os aplicativos que estão sendo construídos. O WebSphere Integration Developer fornece uma ferramenta para gerar a documentação para os recursos em seus módulos, módulos de mediação e bibliotecas.

Inicie a geração da documentação chamando um assistente. É possível customizar o conteúdo da documentação selecionando vários recursos de um ou mais módulos e bibliotecas para que todas as informações sejam gravadas em um único relatório, que é um arquivo PDF. Também é possível especificar o layout e as fontes da saída. Consulte as tarefas relacionadas para obter instruções detalhadas sobre como gerar a documentação.

Documentação de Recursos

O gerador de documentação produz as seguintes informações para estes recursos:

Outros recursos não serão documentados pelo gerador de documentação.

Arquivos Referidos

O gerador de documentação também pode produzir documentação para os recursos selecionados e para os recursos aos quais eles se referem. Por exemplo, no assistente de Geração da Documentação, é possível selecionar o processo de negócios e a opção Incluir Arquivos Referidos. Por isso, o relatório PDF gerado também terá informações para os recursos (como interfaces chamadas por suas atividades) os quais o processo se refere.

Estrutura da Documentação

O relatório PDF gerado possui a seguinte estrutura:

  • Página do Título

    Possui o título do relatório, nome do autor e data do relatório.

  • Índice

    Lista as seções e números de páginas no relatório.

  • Seções de Documentação de Recursos

    Lista as propriedades dos recursos. Exceto para o módulo e a biblioteca, todos os recursos também possuem figuras dos recursos abertos na visualização do Editor.

  • Referência Cruzada

    Listas para cada recurso documentado, qual recurso o utiliza (lista Provedores) e onde ele é utilizado (lista Receptores).

  • Apêndice: Configurações da Geração da Documentação

    Lista as configurações da geração da documentação especificadas no assistente de Geração da Documentação e utilizadas para o relatório PDF.

Layout e Estilo da Documentação

O layout e o estilo do relatório PDF gerado podem ser customizados com o Assistente de Geração da Documentação. 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.

As seguintes configurações de layout podem ser modificadas:

  • Tamanho do Papel

    Define o tamanho do papel da documentação gerada.

    Valor padrão: Carta

  • Nível de Índice

    Define o nível máximo de tópicos a serem listados no índice do relatório.

    Valor padrão: 7

  • Fonte
    Define a família da fonte, o tamanho da fonte e o estilo da fonte para a saída. As configurações de fonte padrão são:
    • Texto Corrido

      • Utilizado para a descrição e documentação de artefatos diferentes. A família da fonte de texto corrido também é utilizada para a página do título, o cabeçalho e o rodapé.
      • Família da fonte padrão: Helvetica
      • Tamanho da fonte padrão: 10
      • Estilo da fonte padrão: regular
    • Título do Capítulo

      • Utilizado para títulos numerados, o cabeçalho do índice e o cabeçalho do apêndice
      • Família da fonte padrão: Helvetica
      • Tamanho da fonte padrão: 14
      • Estilo da fonte padrão: negrito
    • Texto do Código-fonte

      • Utilizado para a documentação do código-fonte, como por exemplo, Java
      • Família da fonte padrão: Courier
      • Tamanho da fonte padrão: 10
      • Estilo da fonte padrão: regular
    • Texto da Legenda

      • Utilizado para legendas de imagens
      • Família da fonte padrão: Helvetica
      • Tamanho da fonte padrão: 10
      • Estilo da fonte padrão: negrito
    • Texto de Definição

      • Utilizado para a documentação de pares chave-valor
      • Família da fonte padrão: Helvetica
      • Tamanho da fonte padrão: 10
      • Estilo da fonte padrão: regular
    • Texto do Cabeçalho

      • Utilizado para títulos não numerados
      • Família da fonte padrão: Helvetica
      • Tamanho da fonte padrão: 11
      • Estilo da fonte padrão: negrito
    • Índice

      • Utilizado para o índice
      • Família da fonte padrão: Helvetica
      • Tamanho da fonte padrão: 9
      • Estilo da fonte padrão: regular

Arquivos Principais para Salvar Configurações

Um arquivo principal é um perfil de recurso que define o conteúdo (não os estilos da fonte) a ser incluído na documentação gerada. Quando utilizar o assistente de Geração da Documentação, crie um arquivo principal para salvar as seleções de recursos e, na próxima vez em que utilizar o assistente para gerar o mesmo relatório, basta selecionar o arquivo principal.

Registrar Novas Fontes

O gerador de documentação fornece três fontes padrão que podem ser utilizadas na documentação. Estas fontes são Helvetica, Courier e Times com os estilos de fonte: regular, itálico, negrito e itálico negrito.

É possível incluir uma nova fonte, que é um arquivo de fonte true type (.ttf) ou um arquivo de coleta true type (.ttc), registrando-a. O registro da fonte é feito no assistente de Geração da Documentação. Quando uma fonte é registrada, ela pode ser utilizada para todos os relatórios, até que seja removida. As fontes padrão não podem ser removidas. Consulte "Gerando a Documentação" nas tarefas relacionadas para obter instruções sobre como trabalhar com o assistente de Geração de 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.

Arquivo de Rastreio

O gerador de documentação pode gravar mensagens de rastreio de geração da documentação em um arquivo de rastreio. Nota: Não ative esta função de rastreio, a menos que ocorra um problema com o gerador de documentação, porque o rastreio impacta o desempenho do sistema e pode consumir uma grande quantidade de espaço em disco. O rastreio é configurado na janela Preferências e a saída é gravada em um arquivo de texto no diretório de metadados (workspace-name\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). As entradas de registro são anexadas e nunca apagadas.

Conceitos relacionados
Módulos e Bibliotecas
Dependências de Módulos e de Bibliotecas
Recursos e Funções de Integração de Negócios
Folhas de Dicas de Integração de Negócios
Tarefas relacionadas
Criando um Módulo para Serviços de Negócios
Criando um Módulo de Mediação
Alterando Espaços de Nomes Padrão
Ativando Recursos de Ferramentas
Incluindo Dependências em Módulos e Bibliotecas
Criando a Biblioteca
Gerando Documentação

Informações relacionadas

Tutorial: Trabalhar com Módulos e Bibliotecas

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