标记语言中的文档规范?

时间:2009-10-17 11:56:35

标签: xml documentation

我不确定这是否有意义,所以事先道歉:是否有专门用于创建文档规范的标记语言?例如,如果不是为人们提供他们需要创建的给定文档的模板Word文档,而是使用标记语言为文档必须包含的提供规范,并且如何< / em>它应该是结构化的。我认为这可以通过使用XML来实现,但我想知道是否有更聪明的东西:

<document>
 <chapter number="1" title="Introduction">
 <description>A short introduction about yourself</description>
</chapter>
...
</document>

谢谢

编辑:

感谢您的回复。我认为上面的例子最好用一个例子说。为了向组织中的第三方发布数据,他们需要填写一份安全策略,其中包含一些有关如何确保数据在其末端保持安全的信息。在大多数情况下,人们会为它下载Word模板,填写并发回。我想用标记语言创建该文档应该包含的内容的正式规范,以便人们可以围绕文档的创建构建工具或其他东西。

我意识到上面的例子是错误的,它的规范不应该包含文档的任何实际“内容”。

5 个答案:

答案 0 :(得分:2)

您作为代码段显示的内容几乎就是DocBook XML标记。

效果很好。问题在于它是XML并且编辑起来很痛苦。不过,有很好的编辑器。我使用了XMLMind XML Editor

然而,使用ReStructured Text和基于Python的Docutils来做这件事情会更快乐。

RST比任何其他标记语言更容易学习和编辑。

答案 1 :(得分:0)

它有点相关:新的Office 2007文件格式是基于XML的:Introducing the Office (2007) Open XML File Formats

我从来没有遇到过你所描述的XML格式,但是可以构建一个;可能你的主要问题是强制企业使用。

答案 2 :(得分:0)

答案 3 :(得分:0)

Docbook,如果您想要XML解决方案。好消息是,有一个庞大的社区和许多工具和示例。它实际上是一个标准,因此您可以在任何地方发送此类文档,并期望人们能够处理。然而,它可能非常复杂。

答案 4 :(得分:-1)

创建格式并规定,为了使文档有效,某些字段必须非空,这是一回事。另一个是验证特定文件是否符合该规定。

第一个可以用word doc实现,或者用这里描述的一些XML解决方案实现。然而,第二个问题是软件问题。对于简短形式,可能具有客户端或服务器端验证的HTML表单是合适的。对于长篇文章,也许使用服务器端验证的文件上传可以正常工作。

听起来所需数据结构的形式已经在docs这个词中定义。您打算如何强制提交有效数据?