标记语言的文档规范？ [关闭]答案

【问题标题】：Document specification in markup language? [closed]标记语言的文档规范？ [关闭]
【发布时间】：2009-10-17 11:56:35
【问题描述】：

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

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

谢谢

编辑：

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

我意识到上面的示例是错误的，它是一个规范，因此不应包含文档的任何实际“内容”。

【问题讨论】：

我们是在谈论强制/验证 XML 文档结构 (DTD/XSD)，还是如何创建文档来描述该任务（元数据）？
@divo 了解我在做什么

标签： xml documentation

【解决方案1】：

您显示为 sn-p 的内容几乎正是 DocBook XML 标记。

效果很好。问题是它是 XML 并且编辑起来很痛苦。但是，有很好的编辑器。我用XMLMind XML Editor。

但是，使用 ReStructured Text 和基于 Python 的 Docutils 来处理这类事情会更快乐。

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

【讨论】：

同意。我们将我们的文档（phpcompiler.org/doc/latest/manual.html）从 Latex 切换到 docbook，却发现添加它们更麻烦。我们再次切换到 RST，它使更新它们变得轻松，因此我们实际上编写了更多文档。

【解决方案2】：

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

我从未遇到过像您描述的那样的 XML 格式，但可以构建一个；可能您的主要问题是强制企业使用。

【讨论】：

【解决方案3】：

DTD 或 XML Schema

【讨论】：

@sztomi 您的两个链接都指向 XML/Schema 页面
DTD 不是标记语言。 XSD Schema 仅用于描述其他 matkup 语言
您对 DTD 的看法是对的，但在 OP 澄清他的问题之前，我建议使用 XML Schema。

【解决方案4】：

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

【讨论】：

【解决方案5】：

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

第一个可以实现为 word doc，或者使用此处描述的一些 XML 解决方案。但是，第二个是软件问题。对于简短的表单，具有客户端或服务器端验证的 HTML 表单可能是合适的。对于很长的一个，也许使用服务器端验证的文件上传会起作用。

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

【讨论】：