☰

使用 LaTeX 为软件编写手册页/参考手册

tag-icon • tag-icon documentation
使用 LaTeX 为软件编写手册页/参考手册

使用 TeX 编写软件手册页 (manpages)/参考手册是个好主意吗？我是 TeX 新手，正在探索这方面的选择。

我可以随源代码一起提供 manpage.pdf，但我想将它们放在网上。不仅以 PDF 格式，还可以以 HTML 格式或 MediaWiki 格式。这可能吗？如何实现？

什么样的模板/示例适合作为入门模板/示例？是否有任何 .sty 文件可以添加手册页功能？

谢谢

答案1

我不确定如何用 编写手册页TeX。如果你在编辑器中打开它，你会看到它们是用 *roff 编写的。

有关参考手册，请参阅这个问题。

有多种方法可以从TeX文件生成 html 文件。以下提供了一些信息这个问题。

我从来没有听说过从中生成 MediaWiki 的标记LaTeX。

答案2

对于软件文档，有 texinfo 系统，主要用于 GNU 项目，并允许以各种格式输出，如 PDF、HTML、info、DocBook 和其他 XML 格式。PDF 输出由 TeX 生成，但 texinfo 源的语法不是通常的 LaTeX/Plain TeX 语法（例如，命令以 开头@，而不是\）。但是，它不以 man 作为输出格式（我不确定您的问题是关于 man 格式本身还是关于文档格式的一般问题。）

答案3

也许不是你想要的，但是狮身人面像非常适合文档编写。使用 Sphinx 编写文档后，您可以轻松生成 html、LaTeX 和 PDF。Python 文档是使用 Sphinx 编写的，我曾在 Sage 工作时了解 Sphinx，但 Sphinx 网页提供了许多使用它编写文档的项目的链接。可以在 Sphinx 中使用 LaTeX 数学命令，基本上是逐字逐句的；生成的 PDF 是由 LaTeX 生成的，因此您可以想象它看起来不错。如果将它与 jsMath 结合使用，生成的 html 看起来会最好，我希望 Sphinx 最终能够支持 MathJax。

答案4

我建议使用潘多克，您可以使用它将 LaTeX（至少是简单的 LaTeX）转换为 HTML、手册页、媒体 wiki 和其他几种格式。或者您也可以使用扩展的 markdown，并将其转换为几乎任何内容。

相关内容