Lua脚本生成LaTeX命令遇未定义控制序列错误求助

问题重现 #

你尝试用Lua脚本自动生成LaTeX命令，相关代码如下：

Lua脚本（test.lua） #

my_array = {
  cmdone = {1, 2},
  cmdtwo = {2, 3}
}

cmd_template = "\\newcommand*{\\%s}{number one: %s, number two: %s}"

function mkcommands()
  for k, v in pairs(my_array) do
    -- print(string.format(cmd_template, k, v[1], v[2]))
    tex.print(string.format(cmd_template, k, v[1], v[2]))
  end
end

TeX文件（test.tex） #

\documentclass[12pt]{article}

\usepackage{luacode}

\begin{luacode}
dofile("test.lua")
mkcommands()
\end{luacode}

%\newcommand*{\cmdtwo}{number one: 2, number two: 3}
%\newcommand*{\cmdone}{number one: 1, number two: 2}

\begin{document}

\cmdone

\cmdtwo

\end{document}

运行lualatex test.tex时出现错误提示：Undefined control sequence l. 15 \cmdone，但手动粘贴print()输出的命令到TeX文件中却能正常运行。

错误原因 #

问题出在你使用的luacode环境特性上：

• luacode环境会自动对Lua输出的内容进行TeX转义，比如把反斜杠\转换成LaTeX的\textbackslash命令。
• 这导致Lua脚本生成的\newcommand*{\cmdone}{...}被转换成了\newcommand*{\textbackslash cmdone}{...}，实际定义的是\textbackslash cmdone命令，而非你需要的\cmdone，所以调用\cmdone时会提示未定义。

解决方案 #

把TeX文件中的luacode环境替换为luacode*环境（注意末尾的星号），该环境会直接将Lua输出的内容传递给TeX，不进行额外转义：

修改后的TeX文件片段：

\begin{luacode*}
dofile("test.lua")
mkcommands()
\end{luacode*}

如果不想修改环境，也可以在Lua脚本中用四个反斜杠表示一个要传递给TeX的反斜杠（Lua中两个反斜杠表示一个实际反斜杠，luacode环境再转义一次，所以需要四层），但这种方式可读性较差，优先推荐使用luacode*环境。

验证结果 #

修改后重新运行lualatex test.tex，文档会正常输出预期内容：

number one: 1, number two: 2 number one: 2, number two: 3

这种通过Lua脚本批量生成LaTeX命令的实现方式完全可行，适合处理格式统一的批量命令定义，能有效提升编写效率。

内容的提问来源于stack exchange，提问作者Peter Baker