В HTML-документации для схемы XML содержится такая о ней информация, как contains имя, расположение, пространство имён, а также сведения о её компонентах (элементах или сложных типах). Она может быть полезна в виде сводке по содержимому схемы.
Следующие инструкции написаны для проекции Ресурсы, но будут работать и в других проекциях.
Для того чтобы сгенерировать HTML-документацию по схеме XML:
- Вызовите контекстное меню схемы в панели Схема.
- Выберите . Откроется соответствующее окно.
- Выберите форму документации HTML:
- Для помещения информации в один большой файл выберите Один файл HTML без фреймов.
- В противном случае выберите Несколько файлов HTML с фреймами. При этом будет сгенерирован набор файлов по типу Javadoc.
- В случае выбора Один файл HTML без фреймов можно сразу нажать Готово и получить файл HTML с таким же именем, как и исходный, или нажать Далее для выбора другой целевой папки и другого имени. Нажмите после этого Готово. Будет создан файл HTML. Теперь его можно открыть в редакторе HTML.
- В случае выбора Несколько файлов HTML с фреймами, нажмите Далее для указания целевой папки для файлов HTML, затем нажмите Готово. В указанной папке будет создана группа файлов HTML.
В HTML-документацию включается следующие данные:
- Имя схемы.
- Расположение схемы.
- Целевое пространство имен схемы.
- Документация, содержащаяся в самой схеме.
- Данные о каждом компоненте схемы, как-то: тип компонента, его исходный код.
Кроме того, возможно предоставление дополнительной информации (вручную).
При выборе кодировки ISO-8859-8-I для файлов HTML (, раздел "Создание файлов"), HTML-файлы документации, генерируемые по схемам XML, будут по-прежнему иметь кодировку UTF-8.
Это известная неполадка.