Mathematica：函数文档 [关闭]答案

【问题标题】：Mathematica: Function Documentation [closed]Mathematica：函数文档 [关闭]
【发布时间】：2011-09-24 20:18:28
【问题描述】：

有没有人遇到过为您在 Mathematica 中创建的函数创建文档的教程？我正在尝试组织我编写的一些功能，但到目前为止我做得很糟糕。我真的很想为函数创建一个文件，为文档创建一个文件，并以某种方式为 Mathematica 文档添加一个路径，以便 Mathematica 也可以搜索它。

以Sin 函数的文档为例：

当您单击箭头时，它会打开一个笔记本，其中包含有关Sin 函数的信息。我尝试复制该笔记本的内容并粘贴到一个新的笔记本中，以便我可以编辑它，但我无法修改内容。

我真的很喜欢 Mathematica 的文档格式，我想以同样的方式记录我的函数以供将来参考。有人知道如何像 Mathematica 一样记录函数吗？

【问题讨论】：

可以使用Workbench 创建完全集成到 Mathematica 帮助中的文档页面。 here 有一个不错的截屏教程（由 Adam Berry 编写）。其他 Workbench 截屏教程可用here
我认为这个问题是部分相关的：“Convenient way to add inline formatting to usage Messages”。
@Alexey，我认为您在此处发布的内容非常相关。我正在尝试编写一些 C 函数，并且希望能够格式化使用标签。我真的很想知道如何在消息中添加超链接。在阅读了所有答案后，我正在考虑Workbench，但我真的不想用 Wolfram 填写另一个表格来下载它。
@jmlopez 将超链接嵌入到字符串中就像任何其他内联格式（框）一样容易。例如："Here is embedded hyperlink: "<>ToString[Hyperlink["Wolfram Research, Inc.", "http://www.wolfram.com"],StandardForm].
@Alexey，太棒了。我可能不需要使用快捷方式来更改选项。您的链接将我引向此：FrontEndExecute[FrontEndToken["EditStyleDefinitions"]]。与前往Format->EditStyleSheet 相同。然后输入您要编辑的样式的名称。例如，您可以修改默认行为或Usage 和ObjectName。当您输入这些名称时，将出现一个单元格，然后转到Format->ObjectOptions 并使它们可编辑。现在，当您从文档中复制和粘贴内容时，您将能够对其进行编辑。

【解决方案1】：

您可以使用 Mathematica 的工作台来create documentation。

videos here 也很适合开始使用 Wolfram Workbench。

【讨论】：

【解决方案2】：

也许this 或this 会有用。

【讨论】：

【解决方案3】：

我认为您正在寻找 ::usage。查看文档中心的教程/DocumentationConstructs。

【讨论】：

我使用 ::usage 来获得简短的描述。但我真正感兴趣的是如何构建整个文档页面。通过这种方式，我将能够编写有关函数的更多信息和示例，就像他们编写 Mathematica 的其他函数一样。