将内联格式添加到使用消息的便捷方式

Question

使用Messages 的内置函数已嵌入内联格式。例如：

In[1]:= ActionMenu::usage // FullForm

Out[1]//FullForm= 
"\!\(\*RowBox[{\"ActionMenu\", \"[\", RowBox[{StyleBox[\"name\", \"TI\
\"], \",\", RowBox[{\"{\", \
RowBox[{RowBox[{SubscriptBox[StyleBox[\"lbl\", \"TI\"], \
StyleBox[\"1\", \"TR\"]], \":>\", SubscriptBox[StyleBox[\"act\", \"TI\
\"], StyleBox[\"1\", \"TR\"]]}], \",\", \
RowBox[{SubscriptBox[StyleBox[\"lbl\", \"TI\"], StyleBox[\"2\", \
\"TR\"]], \":>\", SubscriptBox[StyleBox[\"act\", \"TI\"], \
StyleBox[\"2\", \"TR\"]]}], \",\", StyleBox[\"\[Ellipsis]\", \
\"TR\"]}], \"}\"}]}], \"]\"}]\) represents an action menu with label \
\!\(\*StyleBox[\"name\", \"TI\"]\), and with items labeled \
\!\(\*SubscriptBox[StyleBox[\"lbl\", \"TI\"], StyleBox[\"i\", \
\"TI\"]]\), that evaluates the expression \
\!\(\*SubscriptBox[StyleBox[\"act\", \"TI\"], StyleBox[\"i\", \
\"TI\"]]\) if the corresponding item is chosen."

可以看出，这种内联格式基于 Core.nb 样式表的“内联格式的样式”部分中定义的一组样式。但我还没有找到任何关于这些样式的文档，也没有找到任何关于将格式添加到usageMessages 的便捷算法的描述。

在Mathematica 中向用户定义的usageMessages 添加内嵌格式的便捷方法是什么？ Core.nb 样式表中定义的内联格式的默认样式的使用规则是什么？我想使用 Mathematica 将内联格式添加到我的包中的 usage Messages，而不安装其他组件，如 Workbench 等。

附： Strings 中嵌入的内嵌格式的语法部分记录在教程页面“String Representation of Boxes”上。官方新闻组中有关此语法的相关问题：“(any documentation for) linear syntax?” 在前端显示此类字符串由Cell 的选项ShowStringCharacters->False 控制。

Answer 1

这样处理字符串的一个问题是，在 Mathematica 中，大多数字符串操作都会自动将反斜杠 (\) 替换为转义的反斜杠 (\\)。

如果你试试这个：

你可能认为你有你正在寻找的字符串（减去 \! 使其成为一个表达式），但实际上它是："\\(x\\_\\(1, 2\\) \[Equal] \\(\\(-b\\) \[PlusMinus] \\@\\(b\\^2 -\\(4\\ a\\ c\\)\\)\\)\\/\\(2\\ a\\)\\)"

我的解决方案远非优雅，但它确实有效。

1. 从格式化的表达式生成框：
2. 选择输出，然后转到菜单项Cell > Convert to > InputForm。结果：
3. 您现在可以编辑字符串，将\! 放在它前面并在它周围加上引号： "\!\(x \_ \(1, 2\) == \(\(-b\) \[PlusMinus] \@\(b \^2 - \(4\ a\ c\)\)\) \/ \(2\ a\)\)"

如果您在外部编辑器中执行第 3 步，请去掉引号，只在前面加上 \!，然后将结果粘贴回 MMA 中，它会直接转换为格式化表达式

Answer 2

我认为最简单的方法是使用前端来格式化您的字符串。 如果您正在编写一个包，您可以使用“自动保存包”（即当笔记本的初始化单元格的内容成为包时）。 如果您使用文本编辑器编写包，那么使用格式可能会太麻烦......

Answer 3

此答案是对 Sjoerd 答案的补充。

首先，我们不必使用 FrontEnd 命令Cell > Convert to > InputForm 来获得框的线性形式。我们只需将InputForm 应用于MakeBoxes 的输出即可得到它：

In[1]:= InputForm@MakeBoxes[Subscript[x, 1,2]==(-b\[PlusMinus]Sqrt[b^2-4 a c])/(2 a)]
Out[1]//InputForm=
\(x\_\(1, 2\) == \(\(-b\) \[PlusMinus] \@\(b\^2 - \(4\ a\ c\)\)\)\/\(2\ a\)\)

其次，我们可以通过以下两种方式导出盒子的最终排版行内字符串表示，结果等效（唯一的区别是Put将文本换行）：

OutputForm@
  StringInsert[
   ToString[
    InputForm@
     MakeBoxes[
      Subscript[x, 1, 2] == (-b \[PlusMinus] Sqrt[b^2 - 4 a c])/(
       2 a)], OutputForm], "\\!", 1] >> "C:\\input.txt"

Export["C:\\input.txt", 
 StringInsert[
  ToString[InputForm@
    MakeBoxes[
     Subscript[x, 1, 2] == (-b \[PlusMinus] Sqrt[b^2 - 4 a c])/(2 a)],
    OutputForm], "\\!", 1], "String"]

在这两种情况下，我们都会得到一个包含一行的文件：\!\(x\_\(1, 2\) == \(\(-b\) ± \@\(b\^2 - \(4\ a\ c\)\)\)\/\(2\ a\)\)。

在前端的 Notebook 中插入这一行会给出原始表达式（自己试试！）：