У нас есть несколько интерфейсов на основе XML, которые хорошо документированы в схемах XSD. Теперь интерфейсы будут общедоступными, и мы хотели бы создать для них справочную документацию.
Есть ли инструмент, который может автоматически конвертировать XSD файлы в некоторый более читаемый формат?
xs3p может делать то, что вы хотите (см. также их страницу SourceForce).
Вставьте это вверху 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 для создания любого документа, который вам понравится.
XSLT script может выполнять эту работу.
Скорее всего, вы не хотите использовать общий инструмент для документирования вашей схемы. Инструменты документации схемы (я больше всего знаком с тем, что есть в XML-шпионаже) предназначены для чтения схем. Из вашего описания это звучит не так, как вы хотите; вы хотите использовать информацию в своей схеме в качестве основы для документации по программному обеспечению.
Когда мне нужно было это сделать, подход, который я принял, заключался в разработке HTML, который выглядел так, как мне нужна документация для просмотра, а затем выяснить, какую информацию в схеме мне нужно будет захватить, чтобы заполнить ее. Используя это как шаблон, довольно просто вывести релевантную информацию из схемы с помощью XSLT.
В прошлом я сгенерировал документацию, используя инструмент, который я нашел на Freshmeat.net, называемый xsddoc. Посмотрев его сейчас (чтобы получить прямую ссылку), я вижу, что его разработчики были заменены инструментом xnsdoc, Новинка бесплатна для использования проектами с открытым исходным кодом, но если вы используете это для коммерческого продукта, вам, возможно, придется лицензировать его. Если последняя версия, выпущенная под баннером "xsddoc", подходит для ваших целей, вы можете просто использовать ее.
Документация, которую он производит, имеет внешний вид Javadoc и позволяет осуществлять некоторую степень контроля в таблице стилей и т.д.
Если вы готовы вникать в тонкости Sandcastle, я настоятельно рекомендую XML Schema Documenter, который является плагином для отличного Sandcastle Help File Builder.
Возможные выходы такие же, как Sandcastle: веб-сайт, файл справки HTML (CHM), MS Help 2 content, MS Help Viewer 1...
Не следует пытаться преобразовать его (или записать заранее) в docbook.