Форматирование XSD-схемы для экспертной оценки
Вопрос
Я разработал модель данных, которая представлена схемой XSD.Модель данных также предоставляет типы, которые используются в качестве параметров веб-службы в дескрипторе WSDL.
Я хотел бы разослать схему XSD по всему миру и попросить вовлеченных людей провести экспертную оценку модели данных.
Какой инструмент или метод презентации вы бы предложили использовать в качестве основы для экспертных оценок?Модель данных должна быть удобочитаемой для неквалифицированных людей, по крайней мере, когда дело доходит до семантических значений параметров
Редактировать:
Чтобы быть более конкретным:Конечно, синтаксически схема верифицируется.На самом деле я уже работаю над кодом, который основан на классах, сгенерированных JAXB.Моя цель такова
- заморозить модели данных и тем самым входные параметры
- чтобы убедиться, что ничего не было потеряно или забыто с семантической (в смысле относящейся к бизнесу) точки зрения.
Правка 2
Я думал о том, как, вероятно, было бы лучше всего распространить модель данных по всему миру.Я подумываю о чем-то вроде JavaDoc для XSD-схем.Кто-нибудь знает, существует ли что-то подобное?По сути, это было бы сделано с помощью набора XSLT, не так ли?
Решение
Я знаю следующие инструменты, которые генерируют документацию из файлов XML-схемы (XSD):
- xs3p
- Таблица стилей XSLT, генерирующая отдельный XHTML из XSD
- xsddoc
- бесплатно / LGPL
- в основном на основе XSLT
- Вывод, подобный JavaDoc
- видишь примеры xsddoc
- xnsdoc
- улучшенная коммерческая версия xsddoc
- бесплатно для личного / образовательного использования
- Вывод, подобный JavaDoc
- XSDDoc 2.0
- коммерческий
- Вывод, подобный JavaDoc
Для небольшой XML-схемы я бы, вероятно, предложил использовать xs3p Таблица стилей XSLT.Для более сложной схемы я предлагаю использовать xsddoc.
Другие советы
Я рекомендую используя XSD для чего-то.В частности, покажите некоторые реальные приложения с примерами в виде реального кода.
Реальные приложения - это то, что делает схему интересной.Примеры не обязательно должны быть большими, сложными или полностью реалистичными.Их просто нужно скомпилировать.Другие люди захотят скопировать и вставить образцы кода.
Эти примеры являются "привет, мир" схемы.И они действуют как своего рода модульный тест для схемы.
Самая близкая вещь к Javadoc для XML-схемы, которую я видел, - это запуск инструмента Javadoc в исходном коде, сгенерированном на основе схемы.Для этого требуются две вещи:1) Что ваша схема имеет внутренние элементы аннотации, документирующие ее, и что 2) ваш генератор исходного кода использует эти аннотации как элементы Javadoc.
Очень полезный Oxygen XML developer также поддерживает создание документации, см. http://www.oxygenxml.com/xml_schema_documentation.html (коммерческая, но доступна полностью функциональная 30-дневная пробная версия)
Я попробую это сейчас, нужен простой способ сгенерировать документ со всеми типами и доступным описанием xsd:documentation в виде простого описания интерфейса...
** Раскрытие информации :Я работаю в Innovasys, производителе упомянутого ниже инструмента документирования *
Вы могли бы взглянуть на Документ Innovasys!X.Помимо автоматической генерации структурированной и связанной страницы для каждого элемента, простого типа, сложного типа, группы и группы атрибутов, она также будет генерировать связанные XSD-диаграммы (включая последовательности / выбор и т.д.) И структурные таблицы, которые включают аннотации из ваших XSD и проясняют взаимосвязи между элементами в ваших схемах.Выходные данные основаны на шаблонах, поэтому вы можете адаптировать их к своему предпочтительному стилю и структуре.Он создаст выходные данные в web ready html или скомпилированные файлы справки.
Уникально то, что он также включает редактор WYSIWYG, который позволяет вам создавать дополнительный контент в дополнение к материалу, который создается автоматически, и аннотациям из исходного кода XSD - так что вы можете предоставить дополнительную контекстуальную информацию для вашей экспертной оценки.Существует также функция расширения сообщества, которая позволяет людям просматривать сгенерированные выходные данные для записи комментариев и отзывов, и которые можно просматривать и выполнять действия непосредственно из Document!X.