2009-10-17 111 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解決方案。好消息是,有一個龐大的社區和許多工具和示例。這實際上是一個標準,因此您可以在任何地方發送此類文檔,並期望人們能夠處理。但它可能相當複雜。