Gerando a Documentação HTML a partir de um Arquivo de Esquema XML

A documentação HTML gerada a partir de um esquema XML contém várias informações sobre o esquema, como seu nome, local e espaço de nomes, e também detalhes sobre diversos componentes (como elementos ou tipos complexos) contidos no esquema. Ela pode ser útil para fornecer um resumo do conteúdo do esquema.
Antes de Iniciar
Por Que e Quando Desempenhar Esta Tarefa

As instruções a seguir foram criadas para a perspectiva Recurso (Resource), mas também funcionarão em muitas outras perspectivas.

Para gerar a documentação HTML com base em um arquivo de esquema XML:

  1. No Project Explorer, clique com o botão direito do mouse no esquema XML.
  2. Clique em Gerar > HTML. O diálogo Gerar Documentação do Esquema XML (Generate XML Schema Documentation) é aberto.
  3. Selecione o estilo da documentação HTML desejado:
    1. Para ter um arquivo HTML por esquema, selecione Gerar Documentação do XSD Sem Quadros.
    2. Caso contrário, selecione Gerar Documentação do XSD Com Quadros. Se você selecionar essa opção, vários arquivos HTML são gerados. Eles serão configurados de forma semelhante aos arquivos Javadoc.
  4. Clique em Avançar para especificar a pasta de destino dos seus arquivos HTML.
  5. Clique em Concluir. Os arquivos HTML são criados no local especificado.
Resultados

Os arquivos HTML gerados podem conter qualquer um dos seguintes detalhes:

Detalhes Descrição
Esquema O nome do esquema XML, local e espaço de nomes de destino.
Namespace O espaço de nomes de destino do componente do esquema XML.
Diagrama Um modelo visual dos componentes do esquema XML (como elementos ou tipos complexos). Você pode clicar no cabeçalho de um componente pai para navegar pelos detalhes da documentação de tal componente. No caso de tipos complexos, clique no nome do tipo de elemento para navegar pelos detalhes da documentação do referido tipo.
Digitar Um tipo de componente (por exemplo, um tipo complexo).
Hierarquia da Herança Uma hierarquia de componentes dos tipos herdados. Você pode clicar em um tipo herdado para navegar pelos detalhes da documentação do referido tipo.
Detalhes do Conteúdo A lista de elementos em um tipo complexo e em qualquer documentação associada a tais elementos conforme definido no arquivo de esquema XML.
Valores Admissíveis A lista de valores admissíveis (ou enumerações) para um tipo simples e sua documentação associada.
Origem O código-fonte do componente de esquema XML.

Quando a codificação Lógica Hebraica (ISO-8859-8-I) estiver selecionada como uma preferência para a codificação de arquivos HTML (Janela (Window) > Preferências (Preferences) > Arquivos da Web e XML (Web and XML Files) > Arquivos HTML (HTML Files) na seção "Ao Criar Arquivos"), os arquivos da documentação HTML gerados a partir de um arquivo de esquema XML ainda possuirão uma codificação UTF-8. Esse é um problema conhecido.

O que Fazer Depois

Feedback