online - xml validator
¿Cómo convertir xsd a documentación legible para humanos? (8)
Tenemos algunas interfaces basadas en XML que están bastante bien documentadas en los esquemas XSD. Las interfaces ahora estarán disponibles públicamente y nos gustaría crear documentación de referencia para ellas.
¿Hay alguna herramienta que pueda convertir automáticamente archivos XSD en un formato más legible?
He generado documentación en el pasado usando una herramienta que encontré en Freshmeat.net llamada xsddoc . Al buscarlo justo ahora (para obtener el enlace directo), veo que ha sido reemplazado por sus desarrolladores con una herramienta llamada xnsdoc . La más nueva es gratuita para el uso de proyectos de código abierto, pero si está utilizando esto para un producto comercial, es posible que deba licenciarlo. Si la última versión publicada bajo el banner "xsddoc" se adapta a sus propósitos, entonces puede usarla.
La documentación que produce tiene el aspecto y la sensación de Javadoc, y permite cierto grado de control en la hoja de estilos, etc.
Insertar esto en la parte superior de la XSD
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
Luego puede ver directamente el archivo XSD usando un navegador web. El navegador web realiza la conversión a HTML utilizando el XSLT especificado.
No necesita un procesador XSL, pero las hojas de estilo como xs3p no generarán enlaces utilizando este enfoque. Uso el navegador web Firefox, IE8 parece inútil para esto.
He intentado estas hojas de estilo xsl: https://sourceforge.net/projects/xs3p/files/xs3p-1.1.3.zip/download http://crism.maden.org/consulting/pub/xsl/xsd2html.xsl
Creo que prefiero xs3p.
Las probabilidades son bastante buenas de que no desee utilizar una herramienta genérica para documentar su esquema. Las herramientas de documentación de esquemas (estoy muy familiarizado con el de XML Spy) están diseñadas para hacer que los esquemas sean legibles. Según tu descripción, parece que eso no es realmente lo que quieres; lo que desea es usar la información en su esquema como la base de la documentación del software.
Cuando tuve que hacer esto, el enfoque que tomé fue diseñar HTML que se veía de la manera en que necesitaba la documentación para buscar, y luego averiguar qué información en el esquema necesitaría obtener para rellenarla. Usando eso como plantilla, es bastante sencillo extraer información relevante del esquema usando XSLT.
Si está listo para profundizar en las complejidades de Sandcastle , recomiendo XML Schema Documenter, que es un complemento para el excelente Sandcastle Help File Builder .
Los posibles resultados son los mismos que Sandcastle: un sitio web, un archivo de Ayuda HTML (CHM), contenido de MS Help 2 , MS Help Viewer 1 ...
Un script XSLT puede hacer el trabajo.
x3sp puede hacer lo que quieras: http://xml.fiforms.org/xs3p/
oXygen tiene una herramienta de documentación de esquemas XSD muy agradable que permite una fácil personalización a través de opciones y archivos CSS adicionales.
No lo he usado antes, pero DocFlex/XML es una herramienta de documentación XML con un componente de documentación XSD llamado XSD Doc que parece interesante.
Por supuesto, como se señaló en las otras respuestas, XSD es solo un archivo XML, por lo que se podría escribir un XSLT personalizado para generar cualquier resultado de documentación que desee.