6

哪些OSS（或免费）工具可用于起草可用于生成手册的文档的单一来源？具体来说，采用以下格式：

  • HTML网站
  • PDF文件
  • 嵌入（在应用程序中；可能是 HTML）1
  • 文字（可选）
  • 手册页（可选）

其他要求：

  • 工具适合技术作家（不必是所见即所得）。
  • XML/SGML 源
  • 高质量的 PDF 输出（与 TeX 相媲美）
  • 多平台

扩展要求1

同一个命令行应用程序是用两种语言（C 和 Java）编写的。使用 XML 描述命令行选项（其中一些特定于一种语言或另一种语言），可以直接将 XML 转换为 Java 类或 C 函数，后者将帮助写入标准输出。这确保了帮助可以嵌入到二进制文件中，而不必依赖外部文件。

AsciiDoc 似乎没有这种能力。还有其他选择吗？

4

4 回答 4

6

满足您大多数要求的一种，我以前使用过的，是AsciiDoc。

AsciiDoc 不是 XML 源格式，而是选择简单的文本格式。它可以输出 HTML 和 Docbook，可以渲染成 PDF 或其他格式。源文本也几乎足以用于纯文本演示。

另一个流行的选择是reStructuredText。

于 2009-08-16T03:05:46.380 回答
2

我一直在考虑宣传DocBook作为我们工程组中 Word 的替代品。有许多可用的工具链。对工程师来说最简单的可能是DocBook XSL、Apache FOP以及Ant或Make。这就是我一直在做我的 DocBook 工作的方式。如果您真的很喜欢 LaTeX，那么您可能想查看DBLaTeX以获得 DocBook 到 LaTeX 的发布环境。

如果您不介意跳出免费环境，那么<oXygen/>XML Editor提供了一个非常不错的 WYSIWYG DocBook 编辑器。我用的不多，但它看起来确实很有希望。

于 2009-08-16T03:20:30.247 回答
2

Doxygen是非常流行的文档生成器，可以输出多种格式的文档。尽管它的主要目的是构建从源注释（来自多种语言）中提取的文档，但它也可以用作通用的手动编写工具。其实Doxygen网站和手册就是这样生成的。

于 2009-08-16T03:38:26.630 回答
1

Sphinx是一个工具，它为 Docutils 添加了许多功能，允许用 reStructuredText 编写“智能和漂亮的文档”。它最初是为了生成新的 Python 文档而创建的，但已被许多其他项目采用。

于 2009-08-16T03:24:45.977 回答