Как преобразовать xsd в удобочитаемую документацию?
У нас есть несколько интерфейсов на основе XML, которые достаточно хорошо документированы в схемах XSD. Теперь интерфейсы станут общедоступными, и мы хотели бы создать для них справочную документацию.
Существует ли инструмент, который может автоматически конвертировать файлы XSD в более читаемый формат?
8 ответов
x3sp может делать то, что вы хотите: http://xml.fiforms.org/xs3p/
Вставьте это в верхней части XSD
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
Затем вы можете напрямую просмотреть файл XSD с помощью веб-браузера. Веб-браузер выполняет преобразование в HTML с использованием указанного XSLT.
Вам не нужен XSL-процессор, но таблицы стилей, такие как xs3p, не будут генерировать ссылки с использованием этого подхода. Я использую браузер Firefox, IE8 кажется бесполезным для этого.
Я попробовал эти таблицы стилей xsl: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.zip/download http://crism.maden.org/consulting/pub/xsl/xsd2html.xsl
Я думаю, что я предпочитаю xs3p.
oXygen имеет очень хороший инструмент для документирования схемы XSD, который позволяет легко настраивать опции и дополнительные CSS-файлы.
Я не использовал его раньше, но FlexDoc/XML - это инструмент XML-документации с компонентом XSD-документации под названием XSDDoc, который выглядит интересно.
Конечно, как указывалось в других ответах, XSD - это просто XML-файл, поэтому можно написать собственный XSLT для создания любого документа, который вам понравится.
Скорее всего, вы не захотите использовать универсальный инструмент для документирования вашей схемы. Инструменты документирования схем (я больше всего знаком с инструментом в XML Spy) разработаны для того, чтобы сделать схемы читабельными. Из вашего описания звучит так, будто это не совсем то, что вы хотите; вы хотите использовать информацию в вашей схеме как основу документации программного обеспечения.
Когда мне нужно было сделать это, я выбрал подход к разработке HTML, который выглядел так, как мне требовалась документация, а затем выяснил, какую информацию в схеме мне нужно получить, чтобы заполнить ее. Используя его в качестве шаблона, довольно просто получить соответствующую информацию из схемы с помощью XSLT.
Если вы готовы вникать в тонкости Sandcastle, я настоятельно рекомендую XML Schema Documenter, который является плагином для отличного построителя файлов справки Sandcastle.
Возможные результаты аналогичны Sandcastle: веб-сайт, файл справки HTML (CHM), содержимое справки MS 2, средство просмотра справки MS 1...
В прошлом я создавал документацию, используя инструмент, который я нашел на Freshmeat.net и который называется xsddoc. Просматривая его только сейчас (чтобы получить прямую ссылку), я вижу, что его разработчики заменили его инструментом под названием xnsdoc. Более новая версия бесплатна для использования в проектах с открытым исходным кодом, но если вы используете ее для коммерческого продукта, вам, возможно, придется ее лицензировать. Если последняя версия, выпущенная под баннером "xsddoc", соответствует вашим целям, то вы можете просто использовать ее.
Документация, которую он создает, имеет внешний вид Javadoc и допускает некоторую степень контроля в таблице стилей и т. Д.
Это не должно быть трудно конвертировать (или написать заранее) в формате docbook.