如何将xsd转换为人类可读的文档?

时间:2008-10-26 12:11:56

标签: xml xsd

我们有一些基于XML的接口,在XSD架构中有很好的文档记录。接口现在将公开,我们希望为它们创建参考文档。

是否有可以自动将XSD文件转换为更易读的格式的工具?

8 个答案:

答案 0 :(得分:18)

x3sp可能会做你想做的事:http://xml.fiforms.org/xs3p/

答案 1 :(得分:16)

将其插入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。

答案 2 :(得分:6)

oXygen非常友好XSD schema documentation tool,可以通过选项和其他CSS文件轻松自定义。

我之前没有使用它,但FlexDoc/XML是一个XML文档工具,其中包含一个名为XSDDoc的XSD文档组件,看起来很有趣。

当然,正如其他答案所指出的,XSD只是一个XML文件,因此可以编写自定义XSLT来生成您喜欢的任何文档输出。

答案 3 :(得分:2)

XSLT脚本可以完成这项工作。

答案 4 :(得分:2)

您不希望使用通用工具来记录架构的可能性非常大。模式文档工具(我最熟悉XML Spy中的工具)旨在使模式可读。根据你的描述,听起来并不是你想要的;您想要的是使用模式中的信息作为软件文档的基础。

当我需要这样做时,我采用的方法是设计HTML,看起来像我需要文档的样子,然后找出我需要抓取的架构中的哪些信息来填充它。使用它作为模板,使用XSLT从模式中提取相关信息非常简单。

答案 5 :(得分:1)

我以前使用我在Freshmeat.net上找到的名为xsddoc的工具生成了文档。刚刚查看(为了获得直接链接),我发现它已被其开发人员用名为xnsdoc的工具取代。较新的一个可以免费供开源项目使用,但如果您将其用于商业产品,则可能需要对其进行许可。如果在“xsddoc”横幅下发布的最新版本适合您的目的,那么您可以使用该版本。

它生成的文档具有Javadoc的外观,并允许在样式表等中进行某种程度的控制。

答案 6 :(得分:1)

如果您准备深入研究Sandcastle的复杂性,我强烈推荐XML Schema Documenter这是优秀Sandcastle Help File Builder的插件。

可能的输出与Sandcastle相同:网站,HTML帮助(CHM)文件,MS Help 2内容,MS Help Viewer 1 ...

答案 7 :(得分:-3)

不应该很难将其转换(或提前写入)为docbook格式。