Создание документации в формате HTML на основе файла схемы XML

В документации HTML для схемы XML содержится такая о ней информация, такой как имя, расположение, пространство имен, а также сведения о ее компонентах (элементах или сложных типах). Она может быть полезна в виде сводке по содержимому схемы.
Подготовка
Об этой задаче

Следующие инструкции написаны для проекции Ресурсы, но будут работать и в других проекциях.

Для того чтобы сгенерировать HTML-документацию по схеме XML:

  1. Вызовите контекстное меню схемы в панели Структура проекта.
  2. Выберите Генерирование > HTML. Откроется соответствующее окно.
  3. Выберите форму документации HTML:
    1. Если вам нужен один файл HTML для схемы, выберите Генерировать документацию XSD без фреймов.
    2. В противном случае выберите Генерировать документацию XSD с фреймами. При этом будет сгенерировано несколько файлов HTML по типу Javadoc.
  4. Выберите Далее чтобы указать целевую папку для файлов HTML.
  5. Нажмите Готово. В указанной папке будет создана группа файлов HTML.
Результат

Сгенерированные файлы HTML могут содержать следующие сведения:

Сведения Описание
Схема Имя схемы XML, расположение и целевое пространство имен.
Пространство имен Целевое пространство имен компонента схемы XML.
Диаграмма Визуальная модель компонентов схемы XML (таких как элементы или сложные типы). Можно щелкнуть по заголовку родительского компонента для перехода документации по этому компоненту. Для сложных типов можно щелкнуть на имени типа элемента для перехода к документации.
Тип Тип компонента (например, сложный тип).
Структура наследования Структура компонента для наследуемых типов. Можно щелкнуть на наследуемом типе для перехода к документации по этому типу.
Сведения о содержимом Список элементов в сложном типе и документации, связанной с этими элементами, согласно файлу схемы XML.
Допустимые значения Список допустимых значений (или их перечисление) для простого типа и связанной с ним документации.
Исходный код Исходный код XML для компонента схемы XML.

При выборе кодировки ISO-8859-8-I для файлов HTML (Окно > Параметры > Файлы Web и XML > Файлы HTML, раздел "Создание файлов"), HTML-файлы документации, генерируемые по схемам XML, будут по-прежнему иметь кодировку UTF-8. Это известная неполадка.

Дальнейшие действия

Комментарии