2009-10-17 80 views
2

我不确定这样做是否有意义,所以事前要道歉:是否有专门用于创建文档规范的标记语言?例如,如果不给人们一个他们需要创建的给定文档的模板Word文档,而是给他们提供的标记语言的规范,该文档必须包含什么以及它应该如何构建。我想这可能是可能仅仅通过使用XML,但我想知道是否有一些更聪明,这:标记语言的文档规范?

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

谢谢

编辑:

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

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

+0

我们是在谈论强制/验证XML文档结构(DTD/XSD),还是如何创建描述该任务(元数据)的文档? – 2009-10-17 12:05:07

+0

@divo现货我在约 – spiros 2009-10-17 12:10:55

回答

2

你出什么作为一个片段几乎正是DocBook XML标记。

它工作的很好。问题在于它是XML并且很难编辑。不过,这里有不错的编辑。我用XMLMind XML Editor

但是,使用ReStructured Text以及基于Python的Docutils来处理这类事情会让你感到高兴得多。

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

+0

同意。我们将我们的文档(http://phpcompiler.org/doc/latest/manual.html)从乳胶转换为docbook,只是为了增加它们的麻烦。我们再次转换到RST,并且使它更新无痛苦,因此我们实际上编写了更多文档。 – 2009-12-27 18:59:34

0
+0

@sztomi你的链接都指向XML /架构页面 – aviraldg 2009-10-17 12:05:06

+0

谢谢,修复它。 – 2009-10-17 12:24:54

+0

DTD不是标记语言。 XSD Schema仅用于描述其他matkup语言 – 2009-10-17 13:08:57

-1

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

第一个可以实现为单词doc或者这里描述的一些XML解决方案。然而,第二个是软件问题。对于一个简短的表单,可能是一个客户端或服务器端验证的HTML表单。很长一段时间,也许文件上传与服务器端验证工作。

这听起来像所需的数据结构的形式已经定义在单词文档。你打算如何强制提交有效数据?

0

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