Gerando Arquivos de Documentação

Você pode gerar conjuntos de arquivos de projeto que incluem informações padrão sobre a biblioteca de padrões e seu conteúdo. Os arquivos gerados são abertos pelo aplicador do padrão a partir da visualização Explorador de Padrões e são exibidos como parte da hierarquia de tópicos da ajuda on-line.

Cinco tipos de arquivos são gerados: biblioteca, padrão, parâmetros, descrição e visão geral. Os arquivos de padrão e de visão geral compartilham as mesmas informações. Dados estáticos nos arquivos incluem propriedades, como nomes de biblioteca, nomes de padrão e nomes de parâmetro, versões, autores, grupos, multiplicidade, descrições resumidas e tipos de parâmetros UML 2.0. Você pode importar um arquivo de descrição para cada padrão e cada um de seus parâmetros. As descrições de padrões são inseridas nos arquivos de descrição e as descrições de parâmetros são todas inseridas no arquivo de parâmetros do padrão.

Você tem a opção de gerar esses conjuntos de arquivos para o projeto inteiro ou para padrões individuais. Se você gerar ajuda para pelo menos um padrão no projeto, o arquivo de biblioteca individual também será gerado automaticamente. Embora não sejam essenciais, informações adicionais sobre a biblioteca de padrões podem ser incluídas, utilizando o editor de Manifesto RAS.

Se você não gerar esses arquivos, eles não serão incluídos com o projeto de padrão. Se o aplicador do padrão tentar visualizar os arquivos, uma mensagem informará que nenhuma documentação está disponível. Se você alterar qualquer informação contida nesses arquivos, deverá gerar os arquivos de ajuda novamente para atualizá-los.

A captura de tela a seguir mostra uma seção da janela Ajuda on-line que mostra os tópicos específicos do padrão. A ajuda on-line do padrão é exibida sob os tópicos Aplicando Padrões. Neste exemplo, o nome da biblioteca de padrões é sample.


A janela da ajuda on-line com um arquivo de ajuda do padrão de exemplo aberto.

Para gerar arquivos de ajuda on-line, na visualização Autoria de Padrões, execute uma das etapas a seguir:
Uma pasta PatternHelp com o arquivo HTML gerado para a biblioteca é incluída no espaço de trabalho na pasta \x\PatternFiles, em que x é o nome do projeto de padrão. Dependendo de como a ajuda foi gerada, uma pasta PatternHelp com os três arquivos HTML gerados é incluída em uma ou todas as pastas \PatternFiles\y, em que y é o nome do padrão.
Conceitos relacionados
Padrões de Design do IBM Rational
Código e Arquivos de Suporte de Padrões
Recursos de Padrão do RAS
Conteúdo do Projeto de Padrão
Tarefas relacionadas
Fornecendo Texto de Descrição Resumida
Incluindo Diagramas de Visão Geral
Importando Documentação
Incluindo Documentação em Bibliotecas de Padrões
Termos de uso | Feedback
(C) Copyright IBM Corporation 2004, 2005. Todos os Direitos Reservados.