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

Question

内置函数的使用消息具有嵌入的内联格式。例如：

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 样式表的“内联格式的样式”部分中定义的一组样式。但我还没有找到这些样式的任何文档，也没有找到任何向 usage Message 添加格式的便捷算法的描述。

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

PS String 中嵌入的内联格式的语法部分记录在教程页面“框的字符串表示。"官方新闻组中有关此语法的相关问题：“ （任何文档）线性语法？”在前端中显示此类字符串是由选项 ShowStringCharacters->False 控制的单元格。

Answer 1

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

如果您尝试以下操作：

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

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

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

如果您在外部编辑器中执行步骤 3，请去掉引号，只需将 \! 放在前面并粘贴返回 MMA 中的结果，直接转换为格式化表达式

Answer 2

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

Answer 3

这个答案是对 Sjoerd 答案的补充。

首先，我们不必使用FrontEnd命令Cell>；转换为> 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\)\)。

在前端的笔记本中插入此行会给出原始表达式（您自己尝试一下！）：