我们有一个在XSD架构相当有据可查的几个基于XML的接口。现在的接口将是公开的,我们要为他们创造的参考文档。
是否有一个工具,可以XSD文件自动转换成一些更可读的格式?
xs3p可能做你想要的(另见their SourceForce page)什么。
在XSD的顶部插入此
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>
然后,您可以使用Web浏览器直接查看XSD文件。 Web浏览器执行转换使用指定的XSLT为HTML。
你并不需要一个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 schema documentation tool允许通过选择和额外的CSS文件很容易定制。
我以前没有使用过它,但FlexDoc/XML是与XSD文件组件调用XSDDoc自己感兴趣的XML文档工具。
当然,在指出了其他的答案中,XSD就是这么一个自定义的XSLT可以写入生成任何你喜欢的文档输出的XML文件。
一个XSLT脚本可以做的工作。
赔率是相当不错的,你不希望使用一个通用的工具,记录您的架构。架构文档工具(我最熟悉的一个以XML间谍)的设计使模式的可读性。从你的描述,这听起来像那不是你真正想要的东西;你想要的是使用你的架构中的信息作为软件文档的基础。
当我需要做到这一点,我采取的方法是设计的HTML看起来我需要的文档的样子,然后找出我需要抢来填充它在架构的信息。使用作为模板,这是非常简单的使用XSLT相关信息拉从架构。
如果你正准备深入到Sandcastle的复杂性,我强烈建议XML Schema Documenter这对优秀Sandcastle Help File Builder插件。
可能的输出是一样的沙堡:一个网站,一个HTML帮助(CHM)文件,MS Help 2内容,MS Help Viewer 1 ...
这是不应该硬将其转换(或提前写)到docbook格式。