refman.rtf 无法在 doxygen 中使用来自“*.md”的方程式
refman.rtf fails to use equation from '*.md' in doxygen
我使用'.md'生成'(index).html'和'(refman*).rtf'文档以及doxygen 1.8.14。
“*.md”中的数学方程式在 html 输出中给出了正确的方程式,但在文件 'refman.rtf' 中却没有。其他理论部分,如段落和其他内容在 *.md 和 rtf 输出之间运行良好。
我猜 *.rtf 无法识别 *.md 文件的方程式部分。
通过doxygen生成RTF是否读取*.md文件?
我是否需要更改任何标签才能使 *.md 使用 rtf 输出?
不仅对于 markdown,对于 "normal" doxygen 输入公式也不起作用。
来自文档:
Doxygen allows you to put LATEX formulas in the output (this works
only for the HTML and LATEX output, not for the RTF nor for the man
page output).
目前对于非内联公式的解决方法是:
- 使用公式创建一个图像,例如在不使用 MATHJAX 的虚拟 doxygen 运行 中,这将生成一个名称如下的图像:'form_0.png'.
在代码中必须放置一个 if 结构,例如:
\if rtf_run
\image rtf form_0.png
\else
\f... with the formula
\endif
现在必须 运行 doxygen 两次:
- 一次用于没有rtf的输出,即没有在
ENABLED_SECTIONS
中设置rtf_run
- 通过在
ENABLED_SECTIONS
中设置rtf_run
输出rtf一次
编辑 2018 年 6 月 5 日:我刚刚将提议的补丁推送到 github pull request 756。这里的公式呈现为 png
图像并包含在 RTF 文档中。
编辑:2018/06/10:推送请求已集成到 github 的主版本中。
我使用'.md'生成'(index).html'和'(refman*).rtf'文档以及doxygen 1.8.14。
“*.md”中的数学方程式在 html 输出中给出了正确的方程式,但在文件 'refman.rtf' 中却没有。其他理论部分,如段落和其他内容在 *.md 和 rtf 输出之间运行良好。
我猜 *.rtf 无法识别 *.md 文件的方程式部分。
通过doxygen生成RTF是否读取*.md文件?
我是否需要更改任何标签才能使 *.md 使用 rtf 输出?
不仅对于 markdown,对于 "normal" doxygen 输入公式也不起作用。
来自文档:
Doxygen allows you to put LATEX formulas in the output (this works only for the HTML and LATEX output, not for the RTF nor for the man page output).
目前对于非内联公式的解决方法是:
- 使用公式创建一个图像,例如在不使用 MATHJAX 的虚拟 doxygen 运行 中,这将生成一个名称如下的图像:'form_0.png'.
在代码中必须放置一个 if 结构,例如:
\if rtf_run
\image rtf form_0.png
\else
\f... with the formula
\endif
现在必须 运行 doxygen 两次:
- 一次用于没有rtf的输出,即没有在
ENABLED_SECTIONS
中设置 - 通过在
ENABLED_SECTIONS
中设置
rtf_run
rtf_run
输出rtf一次
编辑 2018 年 6 月 5 日:我刚刚将提议的补丁推送到 github pull request 756。这里的公式呈现为 png
图像并包含在 RTF 文档中。
编辑:2018/06/10:推送请求已集成到 github 的主版本中。