46

我们有一些基于 XML 的接口，这些接口在 XSD 模式中有很好的记录。这些接口现在将公开可用，我们希望为它们创建参考文档。

有没有工具可以自动将 XSD 文件转换成更易读的格式？

4

8 回答 8

19

xs3p可能会做你想做的事（另请参阅他们的 SourceForce 页面）。

于 2008-10-27T04:22:42.370 回答
17

将其插入 XSD 的顶部

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="xs3p.xsl"?>

然后您可以使用网络浏览器直接查看 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。

于 2010-02-01T12:16:20.763 回答
6

oXygen有非常好的XSD 模式文档工具，允许通过选项和附加 CSS 文件轻松自定义。

我以前没有使用过它，但FlexDoc/XML是一个 XML 文档工具，带有一个名为XSDDoc的 XSD 文档组件，看起来很有趣。

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

于 2008-10-26T19:20:27.130 回答
2

您不想使用通用工具来记录您的模式的可能性很大。模式文档工具（我最熟悉 XML Spy 中的那个）旨在使模式可读。根据您的描述，这听起来并不是您真正想要的；您想要的是使用架构中的信息作为软件文档的基础。

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

于 2008-10-27T02:36:51.193 回答
1

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

它生成的文档具有 Javadoc 的外观和感觉，并允许对样式表等进行某种程度的控制。

于 2008-10-27T04:10:14.687 回答
1

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

于 2008-10-26T15:00:02.117 回答
1

如果您准备好深入研究Sandcastle的复杂性，我强烈推荐XML Schema Documenter，它是出色的Sandcastle Help File Builder的插件。

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

于 2010-09-23T07:07:11.137 回答
-3

将它（或提前编写）转换为docbook格式应该不难。

于 2008-10-26T12:59:18.583 回答