2009-08-16 63 views
6

什麼OSS(或免費)工具可用於起草單個來源的文檔,可用於生成手冊?具體而言,在以下格式:單一來源文檔工具

  • HTML網站
  • PDF文檔
  • 嵌入式(在應用程序中,可能是HTML)
  • 文本(可選)
  • 手冊頁(可選)

附加要求:

  • 工具適用於技術作家(不必是所見即所得)。
  • XML/SGML源
  • 高品質的PDF輸出(相當於特)
  • 多平臺

膨化要求

相同的命令行應用程序被寫入以兩種語言(C和Java)。使用XML來描述命令行選項(其中一些特定於一種語言或另一種語言),將XML轉換爲Java類或C函數可以直接將它們寫入標準輸出。這確保可以將幫助嵌入到二進制文件中,而無需依賴外部文件。

看起來AsciiDoc沒有這個能力。還有其他選擇嗎?

回答

6

滿足您以前使用過的大部分要求的是AsciiDoc

儘管AsciiDoc不是XML源格式,但它選擇了簡單的文本格式。它可以輸出HTML和Docbook,可以呈現爲PDF或其他格式。源文本對於純文本演示文件來說也已經足夠好了。

沿着同一條線的另一種流行選擇是reStructuredText

+0

AsciiDoc看起來不錯。你將如何將它與命令行應用程序集成? – 2009-08-18 08:08:43

+0

一種方法可能是使用描述應用程序的命令行選項的XML源文件,然後通過轉換來運行該轉換,該轉換爲您的應用程序的特定配置(C或Java,僅選擇適當的部分)生成AsciiDoc源代碼, 。聽起來不像AsciiDoc是生成實際的C/Java源代碼的正確工具;我會爲此使用不同的工具。但是,對於命令行的所有渲染來說,確實有一個共同的XML源代碼,這聽起來像是一件好事。 – 2009-08-18 11:48:15

2

我一直在考慮以福傳DocBook作爲我們工程組中Word的替代品。有一些工具鏈可用。工程師最容易的可能是DocBook XSL,Apache FOP,以及AntMake。這就是我一直在做我的DocBook的東西。如果你真的進入了LaTeX,那麼你可能想要查看DBLaTeX的DocBook到LaTeX發佈環境。

如果您不介意在免費環境之外進行操作,那麼<oXygen/> XML Editor提供了一個相當不錯的所見即所得的DocBook編輯器。我沒有那麼用,但看起來很有希望。

+1

DocBook非常適合編寫手冊,它可以讓您自動保存大量關於文本的元數據。 我相信O'Reilly的技術書籍是用DocBook編寫的。 – 2009-08-16 09:51:40

+0

在編寫DocBook時,還有Maven docbkx插件http://code.google.com/p/docbkx-tools/用來製作HTML/pdf /等。 – Verhagen 2010-02-04 07:12:07

1

Sphinx是一個爲Docutils添加了許多功能的工具,允許在reStructuredText中編寫「智能且美觀的文檔」。它最初是爲了生成新的Python文檔而創建的,但其他許多項目正在採用它。

2

Doxygen是非常流行的文檔生成器,可以在variety of formats中輸出文檔。雖然它的主要目的是構建從源語言(從多種語言)中提取的文檔,但它作爲一種通用的手工寫作工具也非常有用。事實上,Doxygen網站和手冊是以這種方式生成的。