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 muito útil para fornecer um resumo do
conteúdo de seu esquema.
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:
- Na visualização Esboço (Outline), clique com o botão direito do mouse no esquema XML.
- Clique em . O diálogo Gerar Documentação do Esquema XML (Generate XML Schema Documentation)
é aberto.
- Selecione o estilo da documentação HTML desejado:
- Se você deseja que um arquivo XML contenha todas as informações, selecione Arquivo HTML Único sem Quadros (Single
HTML File with no Frames).
- Caso contrário, selecione Vários Arquivos HTML com Quadros (Multiple HTML File with Frames). Se você selecionar esta opção, vários arquivos HTML serão gerados,
não apenas um. Eles serão configurados de forma semelhante aos arquivos Javadoc.
- Se você selecionou Arquivo HTML Único sem Quadros (Single HTML File with no Frames),
poderá clicar em Concluir (Finish) e o arquivo HTML será
gerado automaticamente com o mesmo nome do arquivo de origem e no mesmo
local ou você poderá clicar em Avançar (Next) para selecionar a
pasta na qual deseja que a documentação HTML seja criada; especifique o nome do
arquivo HTML e clique em Concluir (Finish). O arquivo HTML
será criado. Agora você pode abri-lo no editor HTML.
- Se você selecionou Vários Arquivos HTML com Quadros (Multiple HTML File with Frames),
clique em Avançar (Next) para especificar a pasta de destino para seus
arquivos HTML e, em seguida, clique em Concluir (Finish). Os arquivos HTML
são criados no local especificado.
A documentação HTML contém as seguintes informações:
- O nome do esquema.
- O local do esquema.
- O espaço de nomes de destino do esquema.
- Qualquer documentação fornecida no esquema.
- Informações sobre cada componente no esquema, como o tipo do
componente e seu código-fonte. Informações adicionais sobre o componente
podem ser fornecidas dependendo do componente.
Quando a codificação Lógica Hebraica (ISO-8859-8-I) estiver selecionada como uma preferência para a codificação de
arquivos HTML ( 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.