单源文档工具 [英] Single source documentation tool
问题描述
OSS （或免费）工具可用于起草单个来源的文档用于生成手册？具体而言，采用以下格式：
What OSS (or free) tools are available for drafting a single source for documentation that can be used to generate manuals? Specifically, in the following formats:
- HTML网站
- PDF文档
- 嵌入式（在应用程序中;可能是HTML） 1
- 文本（可选）
- 手册页（可选）
- HTML website
- PDF document
- Embedded (within an application; possibly HTML)1
- Text (optional)
- Man pages (optional)
附加要求：
- 工具适合技术作者（不必是WYSIWYG）。
- XML / SGML来源
- 高质量PDF输出（与TeX相当）
- 多平台
- Tool is suitable for technical writers (need not be WYSIWYG).
- XML/SGML source
- High quality PDF output (comparable to TeX)
- Multi-platform
扩展需求 1
相同的命令行应用程序用两种语言（C和Java）编写。使用XML来描述命令行选项（其中一些特定于一种语言或另一种语言），可以直接将XML转换为Java类或C函数，该函数将帮助写入标准输出。这确保了帮助可以嵌入到二进制文件中而不必依赖于外部文件。
The same command-line application is written in two languages (C and Java). Using XML to describe the command-line options (some of which are specific to one language or the other), it is straightforward to transform the XML into a Java class, or a C function, which writes help to standard output. This ensures that the help can be embedded into the binary without having to depend on external files.
看来AsciiDoc没有这种能力。还有其他选择吗？
It appears AsciiDoc does not have this ability. Is there another option?
推荐答案
满足您以前用过的大多数要求的是 AsciiDoc 。
One that satisfies most of your requirements, that I've used before, is AsciiDoc.
AsciiDoc不是XML源代码但格式，而是选择简单的文本格式。它可以输出HTML和Docbook，可以呈现为PDF或其他格式。源文本也足以用于纯文本呈现。
AsciiDoc isn't an XML source format though, instead it opts for a simple text format. It can output HTML and Docbook, which can be rendered into PDF or other formats. The source text is nearly good enough for plain text presentation, too.
沿着同一行的另一个流行选择是 reStructuredText 。
Another popular choice along the same lines is reStructuredText.
这篇关于单源文档工具的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
