代码之家  ›  专栏  ›  技术社区  ›  Juan Delgado

单一源文档工具

  •  6
  • Juan Delgado  · 技术社区  · 7 年前

    什么 OSS (或免费)工具可用于起草可用于生成手册的文档的单一来源?具体来说,格式如下:

    • HTML网站
    • PDF文档
    • 嵌入(在应用程序中;可能是HTML) 一
    • 文本(可选)
    • 手册页(可选)

    附加要求:

    • 工具适用于技术作者(不必是WYSIWYG)。
    • XML/SGML源
    • 高质量PDF输出(与Tex相当)
    • 多平台

    扩大需求 一

    相同的命令行应用程序是用两种语言编写的(C语言和Java语言)。使用XML来描述命令行选项(其中一些特定于一种语言或另一种语言),将XML转换成Java类或C函数,这是简单的,它将帮助写入标准输出。这样可以确保帮助可以嵌入到二进制文件中,而无需依赖外部文件。

    似乎asciidoc没有这个能力。还有别的选择吗?

    4 回复  |  直到 17 年前
        1
  •  6
  •   Greg Hewgill    17 年前

    我以前用过的满足你大部分需求的方法是 AsciiDoc .

    尽管asciidoc不是XML源格式,但它选择的是简单的文本格式。它可以输出HTML和DocBook,可以呈现为PDF或其他格式。源文本对于纯文本表示也几乎足够好。

    同样流行的另一种选择是 reStructuredText .

        2
  •  2
  •   D.Shawley    17 年前

    我一直在考虑传福音 DocBook 在我们的工程组中作为一个词的替代。有许多可用的工具链。对工程师来说最简单的可能是 DocBook XSL , Apache FOP ,或者 Ant 或 Make . 我就是这样做的。如果你真的对乳胶感兴趣,那么你可能想看看 DBLaTeX 对于DocBook到LaTex的发布环境。

    如果你不介意走出自由环境,那么 <oXygen/> XML Editor 提供了一个相当不错的Wysiwyg DocBook编辑器。我用的不多,但看起来很有前途。

        3
  •  2
  •   ars    17 年前

    Doxygen 文档生成器是否非常流行并可以在 variety of formats . 虽然它的主要目的是构建从源代码注释(来自多种语言)中提取的文档,但它也可以作为通用的手工编写工具使用。事实上,doxygen网站和手册是以这种方式生成的。

        4
  •  1
  •   Ned Deily    17 年前

    Sphinx 是一个向docutils添加许多特性的工具,允许在restructuredtext中编写“智能而漂亮的文档”。它最初是为生成新的Python文档而创建的,但现在正被许多其他项目所采用。