【问题标题】:How to generate HTML from Emacs Lisp documentation?如何从 Emacs Lisp 文档生成 HTML?
【发布时间】:2011-05-18 08:04:28
【问题描述】:

Emacs 称自己为自文档化。这意味着您可以使用 Emacs 阅读 Emacs-Lisp 文件中编码的文档。

有没有一种简单的方法可以将此文档导出为 HTML,以便将文档放置在网站上?我知道 FSF 在http://www.gnu.org/software/emacs/manual/emacs.html 上发布了文档,但并非所有 Emacs 模块都在此处列出。

更新:我对 elisp 文件中的文档感兴趣,而不是 texinfo 文件。我还想要函数和“主要模式”的文档。在 Emacs 文档查看器中,这一切都被很好地超链接了,如果它们保存在 HTML 中会很棒。

【问题讨论】:

标签: html emacs documentation


【解决方案1】:

我不认为文档是“在 Emacs-Lisp 文件中编码的”。它们被存储为可以导出为 HTML 的 texinfo 文档(我认为这是 GNU 文档站点的生成方式)。 texi2html可以将texinfo文件转换成HTML。

函数的文档字符串直接存储在 elisp 文件中。如果你想要这些,你必须遍历函数列表,获取文档字符串并创建一个 HTML 文件。我认为它应该在几行 elisp 中是可行的。

Xah Lee cmets here 了解他们应该如何使用 HTML。

【讨论】:

  • 如果您能帮助了解这几行 elisp,那就太好了。
【解决方案2】:

部分答案可能是简单地使用/扩展现有的 Lisp 自动文档生成器。这里有一些链接可能会让你到达那里:

【讨论】:

  • 这些都不是 elisp 的吗?
  • 不,它们适用于 Common Lisp。这就是我所说的“使用/扩展”;一种选择是采用更“主流”的 CL autodoc 工具并破解它以正确解析 elisp。可能比从头开始更省力。
  • 有没有支持按名称搜索的工具?
猜你喜欢
  • 1970-01-01
  • 2010-10-22
  • 2012-03-27
  • 1970-01-01
  • 2020-10-22
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-02-17
相关资源
最近更新 更多