五月xs:文档包含HTML标签?

时间:2013-05-28 19:27:05

标签: xsd

我的目标是为我的网络服务编写程序员手册。有许多工具直接从XSD源生成手册,这些工具使用<xs:documentation>密集。

所以我在我的XSD上添加了尽可能多的<xs:documentation>标签。

问题:<xs:documentation>可能包含HTML代码,例如超链接?在形式上,它包含的HTML是有效的XML。但是,这些内容是否会受到上述手动生成器等第三方工具的支持?

2 个答案:

答案 0 :(得分:1)

五月xs:文档包含XHTML?是的,可能。也就是说,架构文档的架构允许这样做。

工具会对它有用吗?有些人(至少the stylesheet I wrote for displaying XSD schema documents in the browser确实如此),其他人可能没有。如果您要使用的工具在xs:documentation元素中不能很好地处理XHTML,请向开发人员或供应商提出问题。

答案 1 :(得分:1)

xs3p支持文档元素中的HTML标记。 HTML内容必须是格式良好的XML,HTML标签应该声明http://www.w3.org/1999/xhtml名称空间:

<xs:element ...>
  <xs:annotation>
    <xs:documentation>
      Here is 
      <code xmlns="http://www.w3.org/1999/xhtml">source code<code> 
      example
    </xs:documentation>
  </xs:annotation>
</xs:element>